Publication API endpoint

An article or preprint, linked to the projects it reports on.

Table of contents

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

Endpoints

  • Private portal: https://www.brainstem.org/api/private/dissemination/publication/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/dissemination/publication/ (read-only, public projects, no token)
  • Response keys: publication (detail, create, update), publications (list)
  • Permissions: see the permissions page
  • Uniqueness: title unique across BrainSTEM

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]
titlestring [required]; max 200 characters
authorsstring [required]; max 500 characters
journaljournal id [required]
abstractstring [required]
doistring; max 200 characters
publication_urlstring; max 300 characters
pdf_urlstring; max 300 characters
publication_datedate [required]

List

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

Use example (Python API tool)

resp = client.load('publication', load_all=True)
records = resp['publications']

Use example (MATLAB API tool)

resp = client.load('publication', 'load_all', true);
records = resp.publications;

Response example

{
    "publications": [
        {
            "id": "<id>",
            "title": "",
            "authors": "",
            "journal": "<journal-id>",
            "abstract": "",
            "doi": "",
            "publication_url": "",
            "pdf_url": "",
            "publication_date": "2024-03-22"
        }
    ],
    "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/publication/
  • 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('publication', data={"title": "<title>", "authors": "<authors>", "journal": "<journal-id>", "abstract": "<abstract>", "publication_date": "2024-03-22"})
record = resp.json()['publication']

Use example (MATLAB API tool)

created = client.save(struct('title', '<title>', 'authors', '<authors>', 'journal', '<journal-id>', 'abstract', '<abstract>', 'publication_date', '2024-03-22'), 'publication');
record = created.publication;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "publication": {
        "id": "<id>",
        "title": "",
        "authors": "",
        "journal": "<journal-id>",
        "abstract": "",
        "doi": "",
        "publication_url": "",
        "pdf_url": "",
        "publication_date": "2024-03-22"
    }
}

Change

  • Allowed portals: private
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/dissemination/publication/<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('publication', id='<id>', data={"title": "new value"})

Use example (MATLAB API tool)

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

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

The fields are described for the web forms on the Publication data model page.