Open Journal Systems - API Reference (3.2)

Download OpenAPI specification:Download

This guide documents the REST API endpoints which can be accessed with this version of Open Journal Systems. It is a technical reference for software developers who wish to build custom interactions with the platform.

Please consult the REST API Usage Guide for an introduction to using the API or the Developer Documentation Hub for documentation on the platform's internals.

Breaking changes

  • Major changes have been made to submission data to support versioning. All related endpoints have major changes. See the release notebook for further information.
  • The _parent property has been removed from issue galleys.
  • The Author property, isBrowseable, was renamed to includeInBrowse.
  • The Author property, isPrimaryContact, was renamed to primaryContact.
  • The Submission property, status, was changed from an object to an integer. Please see documentation for more information.
  • The /submissions/{submissionId}/galleys endpoint was removed. Galley data is provided with each publication.

Submissions

Get a list of submissions.

See /submissions/{submissionId} for notes about submission properties.

query Parameters
assignedTo
integer

Filter results by those assigned to this user ID. All users except managers and admins are automatically restricted to assigned submissions and do not need to pass this parameter.

count
integer

How many results to return in a single request. Default is 20. Max is 100.

daysInactive
integer

Filter the results by those which have not had activity for the last X days.

isIncomplete
boolean

Filter the results by those for which the author has not yet completed the submission process.

isOverdue
boolean

Filter the results by those for which a reviewer has missed a deadline.

issueIds
string

Filter the results by those with one or more publications assigned to an issue.

offset
integer

Offset the results returned. Use this to receive subsequent pages of requests. A count of 10 and offset of 15 will return results 15 to 25.

orderBy
string

Order the results returned. Must be one of dateSubmitted, dateLastActivity, lastModified or title. Default is dateSubmitted.

orderDirection
string

Return the results in ascending or descending order. Must be ASC or DESC. Default is DESC.

searchPhrase
string

Filter the results by a search phrase matched against the title and authors.

sectionIds
string

Filter the results by those with one or more publications assigned to a section.

status
string

Filter results by submission status. Pass more than one status in a comma-separated list (eg - 3,4). Must match the value of the STATUS_QUEUED, STATUS_PUBLISHED or STATUS_DECLINED constants in OJS 3.

Responses

Response samples

Content type
application/json
{
  • "itemsMax": 0,
  • "items": [