Regulatory authority approval API endpoint

A request to add or change a shared regulatory authority, reviewed before it takes effect.

Table of contents

  1. Endpoints
  2. Fields
  3. List
  4. Add
  5. Detail
  6. Change
  7. Delete
  8. Custom actions

Endpoints

  • Private portal: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/ (needs a token; one record: append <id>/)
  • Public portal: not available
  • Response keys: regulatoryauthority_approval (detail, create, update), regulatoryauthority_approvals (list)
  • Permissions: see the permissions page
  • Uniqueness: name unique across BrainSTEM

Form-only inputs (sent on create or update, not returned in responses):

  • merge_to_id [required].

Fields

[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.

FieldDescription
idUUID string [read-only]
namestring [required]; max 255 characters. Official name of the regulatory authority (e.g., “Home Office”, “Institutional Animal Care and Use Committee”)
abbreviationstring; max 32 characters. Common abbreviation (e.g., “IACUC”, “AWERB”, “IRB”, “CCAC”)
countrycomputed. Country where this authority operates (ISO country code)
authority_typeone of national, institutional, regional, international. Type of regulatory authority
websitestring; max 200 characters. Official website URL
descriptionstring. Description of the authority, its jurisdiction, and regulatory scope
is_activeboolean. Whether this authority is currently operational
commentsstring; nullable
instance_idUUID string [required]; nullable
actionone of Add, Change [required]
revieweruser id [required]; nullable
statusone of Pending, Accepted, Rejected, Cancelled, HoldForRejection, HoldForMerge, Merged, ChangesRequired [required]

List

  • Allowed portals: private
  • Request method: GET
  • URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/
  • Responses: 200 OK; 401 Not authenticated; 403 Not allowed

Use example (Python API tool)

resp = client.load('regulatoryauthorityapproval', load_all=True)
records = resp['regulatoryauthority_approvals']

Use example (MATLAB API tool)

resp = client.load('regulatoryauthorityapproval', 'load_all', true);
records = resp.regulatoryauthority_approvals;

Response example

{
    "regulatoryauthority_approvals": [
        {
            "id": "<id>",
            "name": "Regulatory authority approval 1",
            "abbreviation": "",
            "country": null,
            "authority_type": "national",
            "website": "",
            "description": "",
            "is_active": true,
            "comments": "",
            "instance_id": "<id>",
            "action": "Add",
            "reviewer": "<user-id>",
            "status": "Pending"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 100,
        "total_results": 1,
        "total_pages": 1
    }
}

Add

  • Allowed portals: private
  • Request method: POST
  • URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/
  • Data: JSON object with at least the required fields
  • Responses: 201 Created; 400 Bad request (validation errors per field); 403 Not allowed

Use example (Python API tool)

resp = client.save('regulatoryauthorityapproval', data={"name": "Regulatory authority approval 1", "instance_id": "<id>", "action": "Add", "reviewer": "<user-id>", "status": "Pending", "merge_to_id": "<merge_to_id>"})
record = resp.json()['regulatoryauthority_approval']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Regulatory authority approval 1', 'instance_id', '<id>', 'action', 'Add', 'reviewer', '<user-id>', 'status', 'Pending', 'merge_to_id', '<merge_to_id>'), 'regulatoryauthorityapproval');
record = created.regulatoryauthority_approval;

Detail

  • Allowed portals: private
  • Request method: GET
  • URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/<id>/
  • Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.load('regulatoryauthorityapproval', id='<id>')
record = resp.json()['regulatoryauthority_approval']

Use example (MATLAB API tool)

out = client.load('regulatoryauthorityapproval', 'id', '<id>');
record = out.regulatoryauthority_approval;

Response example

{
    "regulatoryauthority_approval": {
        "id": "<id>",
        "name": "Regulatory authority approval 1",
        "abbreviation": "",
        "country": null,
        "authority_type": "national",
        "website": "",
        "description": "",
        "is_active": true,
        "comments": "",
        "instance_id": "<id>",
        "action": "Add",
        "reviewer": "<user-id>",
        "status": "Pending"
    }
}

Change

  • Allowed portals: private
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/<id>/
  • Data: JSON object with the fields to change. Lists (projects, tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object.
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.save('regulatoryauthorityapproval', id='<id>', data={"name": "Regulatory authority approval 1 (renamed)"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Regulatory authority approval 1 (renamed)'), 'regulatoryauthorityapproval', 'method', 'patch');

Delete

  • Allowed portals: private
  • Request method: DELETE
  • URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/<id>/
  • Responses: 204 Deleted; 400 Still referenced by other records; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.delete('regulatoryauthorityapproval', id='<id>')

Use example (MATLAB API tool)

client.delete('<id>', 'regulatoryauthorityapproval');

Custom actions

ActionRequest
accept_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/accept/
cancel_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/cancel/
hold_for_merge_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/hold_for_merge/
hold_for_rejection_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/hold_for_rejection/
merge_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/merge/
reject_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/reject/
changes_required_approvalPATCH, POST /api/private/taxonomies/regulatoryauthorityapproval/<id>/require_changes/

Approval requests are reviewed by the admin team of the taxonomy or resource. The actions move a request through its lifecycle: accept, reject, require_changes, hold_for_merge, merge (merge into an existing record given by merge_to_id) and cancel (by the submitter).