Publication approval API endpoint

A request to add or change a shared publication, 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/dissemination/publicationapproval/ (needs a token; one record: append <id>/)
• Public portal: not available
• Response keys: publication_approval (detail, create, update), publication_approvals (list)
• Permissions: see the permissions page

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.

Field	Description
id	UUID string [read-only]
title	string [required]; max 200 characters
authors	string [required]; max 500 characters
journal	journal id [required]
abstract	string [required]
doi	string; max 200 characters
publication_url	string; max 300 characters
pdf_url	string; max 300 characters
publication_date	date [required]
comments	string; nullable
instance_id	UUID string [required]; nullable
action	one of Add, Change [required]
reviewer	user id [required]; nullable
status	one of Pending, Accepted, Rejected, Cancelled, HoldForRejection, HoldForMerge, Merged, ChangesRequired [required]

List

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

Use example (Python API tool)

resp = client.load('publicationapproval', load_all=True)
records = resp['publication_approvals']

Use example (MATLAB API tool)

resp = client.load('publicationapproval', 'load_all', true);
records = resp.publication_approvals;

Response example

{
    "publication_approvals": [
        {
            "id": "<id>",
            "title": "",
            "authors": "",
            "journal": "<journal-id>",
            "abstract": "",
            "doi": "",
            "publication_url": "",
            "pdf_url": "",
            "publication_date": "2024-03-22",
            "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/dissemination/publicationapproval/
• 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('publicationapproval', data={"title": "<title>", "authors": "<authors>", "journal": "<journal-id>", "abstract": "<abstract>", "publication_date": "2024-03-22", "instance_id": "<id>", "action": "Add", "reviewer": "<user-id>", "status": "Pending", "merge_to_id": "<merge_to_id>"})
record = resp.json()['publication_approval']

Use example (MATLAB API tool)

created = client.save(struct('title', '<title>', 'authors', '<authors>', 'journal', '<journal-id>', 'abstract', '<abstract>', 'publication_date', '2024-03-22', 'instance_id', '<id>', 'action', 'Add', 'reviewer', '<user-id>', 'status', 'Pending', 'merge_to_id', '<merge_to_id>'), 'publicationapproval');
record = created.publication_approval;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

out = client.load('publicationapproval', 'id', '<id>');
record = out.publication_approval;

Response example

{
    "publication_approval": {
        "id": "<id>",
        "title": "",
        "authors": "",
        "journal": "<journal-id>",
        "abstract": "",
        "doi": "",
        "publication_url": "",
        "pdf_url": "",
        "publication_date": "2024-03-22",
        "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/dissemination/publicationapproval/<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('publicationapproval', id='<id>', data={"title": "new value"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'title', 'new value'), 'publicationapproval', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Custom actions

Action	Request
accept_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/accept/
cancel_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/cancel/
hold_for_merge_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/hold_for_merge/
hold_for_rejection_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/hold_for_rejection/
merge_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/merge/
reject_approval	PATCH, POST /api/private/dissemination/publicationapproval/<id>/reject/
changes_required_approval	PATCH, POST /api/private/dissemination/publicationapproval/<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).