REST API - OJS (3.3)

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 technical documentation on the software.

Breaking changes since v3.2

Major changes were made to how galleys are fetched and new endpoints were added for submission files. See the documentation for full details.

Submissions

Get a list of submissions.

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

query Parameters

assignedTo	Array of integers Filter results by those assigned to one or more user ids. All users except managers and admins are automatically restricted to assigned submissions and do not need to pass this parameter.
count	integer Default: 20 How many results to return in a single request. 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	Array of integers 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 Default: "dateSubmitted" Enum: "dateSubmitted" "dateLastActivity" "lastModified" "title" Order the results returned.
orderDirection	string Default: "DESC" Enum: "ASC" "DESC" Return the results in ascending or descending order.
searchPhrase	string Filter the results by a search phrase matched against the title and authors.
sectionIds	Array of integers Filter the results by those with one or more publications assigned to a section.
status	Array of integers Items Enum: 1 3 4 5 Filter results by one or more submission statuses. Must match the value of one of the `STATUS_QUEUED`, `STATUS_SCHEDULED`, `STATUS_PUBLISHED` or `STATUS_DECLINED` constants.

Responses

Response samples

Content type

application/json

{"itemsMax": 0,
"items": [{"_href": "string",
"contextId": 0,
"currentPublicationId": 0,
"dateLastActivity": "string",
"dateSubmitted": "string",
"id": 0,
"lastModified": "string",
"locale": "string",
"publications": [{"_href": "http://example.com",
"abstract": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"accessStatus": 0,
"authors": [{"affiliation": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"biography": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"country": "string",
"email": "string",
"familyName": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"givenName": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"id": 0,
"includeInBrowse": true,
"orcid": "string",
"preferredPublicName": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"publicationId": 0,
"seq": 0,
"submissionLocale": "string",
"url": "string",
"userGroupId": 0
}
],
"authorsString": "string",
"authorsStringShort": "string",
"categoryIds": [0
],
"citations": ["string"
],
"citationsRaw": "string",
"copyrightHolder": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"copyrightYear": 0,
"coverImage": {"type": null,
"properties": null,
"en_US": {"dateUploaded": "string",
"uploadName": "string",
"altText": "string"
},
"fr_CA": {"dateUploaded": "string",
"uploadName": "string",
"altText": "string"
}
},
"coverage": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"datePublished": "string",
"disciplines": ["string"
],
"fullTitle": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"galleys": [{"file": {"_href": "http://example.com",
"assocId": 0,
"assocType": 0,
"caption": "string",
"copyrightOwner": "string",
"createdAt": "string",
"creator": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"credit": "string",
"dateCreated": "string",
"dependentFiles": [{ }
],
"description": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"documentType": "string",
"fileId": 0,
"fileStage": 0,
"genreId": 0,
"id": 0,
"language": "string",
"locale": "string",
"mimetype": "string",
"name": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"path": "string",
"publisher": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"revisions": [{"documentType": null,
"fileId": null,
"mimetype": null,
"path": null,
"url": null
}
],
"source": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"sourceSubmissionFileId": 0,
"sponsor": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"subject": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"submissionId": 0,
"terms": "string",
"updatedAt": "string",
"uploaderUserId": 0,
"url": "string"