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
_parent
property has been removed from issue galleys.isBrowseable
, was renamed to includeInBrowse
.isPrimaryContact
, was renamed to primaryContact
.status
, was changed from an object
to an integer
. Please see documentation for more information./submissions/{submissionId}/galleys
endpoint was removed. Galley data is provided with each publication.See /submissions/{submissionId}
for notes about submission properties.
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 |
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 |
orderBy | string Order the results returned. Must be one of |
orderDirection | string Return the results in ascending or descending order. Must be |
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 - |
{- "itemsMax": 0,
- "items": [
- {
- "_href": "string",
- "contextId": 0,
- "currentPublicationId": 0,
- "dateLastActivity": "string",
- "dateSubmitted": "string",
- "id": 0,
- "lastModified": "string",
- "publications": [
- {
- "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,
- "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": [
- {
- "dependentFiles": {
- "caption": "string",
- "copyrightOwner": "string",
- "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "credit": "string",
- "dateCreated": "string",
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "height": "string",
- "id": 0,
- "language": "string",
- "physicalHeight": "string",
- "physicalWidth": "string",
- "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "terms": "string",
- "width": "string"
}, - "file": {
- "caption": "string",
- "copyrightOwner": "string",
- "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "credit": "string",
- "dateCreated": "string",
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "height": "string",
- "id": 0,
- "language": "string",
- "physicalHeight": "string",
- "physicalWidth": "string",
- "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "terms": "string",
- "width": "string"
}, - "fileId": 0,
- "id": 0,
- "isApproved": true,
- "label": "string",
- "locale": "string",
- "pub-id::publisher-id": "string",
- "publicationId": 0,
- "seq": 0,
- "urlPublished": "string",
- "urlRemote": "string"
}
], - "hideAuthor": false,
- "id": 0,
- "issueId": 0,
- "keywords": [