Open Journal Systems - API Specification (3.1.x)

Download OpenAPI specification:Download

API to interact with Open Journal Systems 3.1.x.

Authentication

ApiTokenQueryParam

Security Scheme Type	API Key
Query parameter name:	apiToken

Submissions

Get a list of submissions.

OJS 3.1 Target:

See /submissions/{submissionId}.

Authorizations:

ApiTokenQueryParam

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`.
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.
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`, `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 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": [{"id": 0,
"_href": "string",
"issue": {"id": 0,
"_href": "string",
"title": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"description": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"identification": "string",
"volume": 0,
"number": 0,
"year": 0,
"doi": "string",
"datePublished": "string",
"publishedUrl": "string",
"coverImageUrl": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"coverImageAltText": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"galleys": [{"id": 0,
"_parent": "string",
"locale": "string",
"label": "string",
"seq": 0,
"urlRemote": "string",
"urlPublished": "string"
}
]
},
"section": {"id": 0,
"abbrev": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"title": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"seq": 0
},
"title": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"subtitle": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"fullTitle": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"prefix": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"authorString": "string",
"shortAuthorString": "string",
"authors": [{"id": 0,
"seq": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffix": "string",
"fullName": "string",
"country": "string",
"email": "string",
"url": "string",
"userGroupId": "string",
"isBrowseable": true,
"isPrimaryContact": true,
"affiliation": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"biography": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"orcid": "string"
}
],
"abstract": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"coverImageUrl": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"coverImageAltText": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"discipline": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"subject": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"type": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"language": "string",
"sponsor": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"pages": "string",
"copyrightHolder": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"copyrightYear": "string",
"licenseUrl": "string",
"locale": "string",
"dateSubmitted": "string",
"dateStatusModified": "string",
"lastModified": "string",
"datePublished": "string",
"status": {"id": 0,
"label": "string"
},
"submissionProgress": 0,
"stages": [{"id": 0,
"label": "string",
"isActiveStage": true,
"currentUserAssignedRoles": [0
]
}
],
"reviewRounds": [{"id": 0,
"round": 0,
"stageId": 0,
"statusId": 0,
"status": "string"
}
],
"reviewAssignments": [{"id": 0,
"assignedUserId": 0,
"isCurrentUserAssigned": true,
"statusId": 0,
"status": "string",
"due": "string",
"responseDue": "string",
"round": 0,
"roundId": 0
}
],
"urlWorkflow": "string",
"urlPublished": "string",
"galleys": [{"id": 0,
"_parent": "string",
"locale": "string",
"label": "string",
"seq": 0,
"urlRemote": "string",
"urlPublished": "string",
"file": {"id": 0,
"revision": 0,
"fileStage": 0,
"fileName": "string",
"genreId": 0,
"metadata": {"description": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"creator": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"publisher": {"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"
},
"sponsor": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"dateCreated": "string",
"language": "string",
"caption": "string",
"credit": "string",
"copyrightOwner": "string",
"terms": "string",
"width": "string",
"height": "string",
"physicalWidth": "string",
"physicalHeight": "string"
}
},
"dependentFiles": [{"id": 0,
"revision": 0,
"fileStage": 0,
"fileName": "string",
"genreId": 0,
"metadata": {"description": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"creator": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"publisher": {"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"
},
"sponsor": {"en_US": "Filename",
"fr_CA": "Nom de fichier"
},
"dateCreated": "string",
"language": "string",
"caption": "string",
"credit": "string",
"copyrightOwner": "string",
"terms": "string",
"width": "string",
"height": "string",
"physicalWidth": "string",
"physicalHeight": "string"
}
}
]
}
],
"doi": "string"
}
]
}

Get a submission by ID.

OJS 3.1 Target:

All keys except stages, reviewRounds and reviewAssignments

Additional notes:

Unpublished submissions are only returned for assigned participants, editors and admins.
abstract includes HTML markup.
pages is usually a string. But in some cases it may return an array of arrays. Each array contains two items: the start and end page. Example: [[25, 31], [45, 62]].
submissionProgress will be > 0 if the submission is incomplete.
stages, reviewRounds and reviewAssignments should only be returned for participants assigned to the submission.
reviewAssignments should only expose user-identifying information for editors and admins.

Authorizations:

ApiTokenQueryParam

path Parameters

submissionId

required

integer

Submission ID