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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "stageId": 1,
- "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
]
}
Details about the submission that should be created.
contextId | integer |
currentPublicationId | integer Which publication is the latest published version. |
dateLastActivity | string The last time activity was recorded related to this submission. |
dateSubmitted | string |
id | integer |
lastModified | string The last time a modification was made to this submission or any of its associated objects. |
stageId | integer Default: 1 The stage of the editorial workflow that this submission is currently in. One of the |
status | integer Default: 1 Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the |
submissionProgress | integer Default: 1 This number tracks a submission's progress before it is submitted to the journal or press. After submission, it will be set to |
{- "contextId": 0,
- "currentPublicationId": 0,
- "dateLastActivity": "string",
- "dateSubmitted": "string",
- "id": 0,
- "lastModified": "string",
- "stageId": 1,
- "status": 1,
- "submissionProgress": 1
}
{- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "reviewAssignments": [
- {
- "id": 0,
- "isCurrentUserAssigned": 0,
- "status": 0,
- "statusLabel": 0,
- "dateDue": 0,
- "dateResponseDue": 0,
- "round": 0,
- "reviewRoundId": 0
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "status": "string",
- "statusId": 0
}
], - "stageId": 1,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
], - "status": "string",
- "statusId": 0,
- "files": {
- "count": 0
}, - "queries": [
- null
]
}
], - "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
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.submissionId required | integer |
{- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "reviewAssignments": [
- {
- "id": 0,
- "isCurrentUserAssigned": 0,
- "status": 0,
- "statusLabel": 0,
- "dateDue": 0,
- "dateResponseDue": 0,
- "round": 0,
- "reviewRoundId": 0
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "status": "string",
- "statusId": 0
}
], - "stageId": 1,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
], - "status": "string",
- "statusId": 0,
- "files": {
- "count": 0
}, - "queries": [
- null
]
}
], - "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
submissionId required | integer |
The details about the submission that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.
contextId | integer |
currentPublicationId | integer Which publication is the latest published version. |
dateLastActivity | string The last time activity was recorded related to this submission. |
dateSubmitted | string |
id | integer |
lastModified | string The last time a modification was made to this submission or any of its associated objects. |
stageId | integer Default: 1 The stage of the editorial workflow that this submission is currently in. One of the |
status | integer Default: 1 Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the |
submissionProgress | integer Default: 1 This number tracks a submission's progress before it is submitted to the journal or press. After submission, it will be set to |
{- "contextId": 0,
- "currentPublicationId": 0,
- "dateLastActivity": "string",
- "dateSubmitted": "string",
- "id": 0,
- "lastModified": "string",
- "stageId": 1,
- "status": 1,
- "submissionProgress": 1
}
{- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "reviewAssignments": [
- {
- "id": 0,
- "isCurrentUserAssigned": 0,
- "status": 0,
- "statusLabel": 0,
- "dateDue": 0,
- "dateResponseDue": 0,
- "round": 0,
- "reviewRoundId": 0
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "status": "string",
- "statusId": 0
}
], - "stageId": 1,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
], - "status": "string",
- "statusId": 0,
- "files": {
- "count": 0
}, - "queries": [
- null
]
}
], - "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
Only journal managers and subeditors can make a request to this endpoint.
submissionId required | integer |
{- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "reviewAssignments": [
- {
- "id": 0,
- "isCurrentUserAssigned": 0,
- "status": 0,
- "statusLabel": 0,
- "dateDue": 0,
- "dateResponseDue": 0,
- "round": 0,
- "reviewRoundId": 0
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "status": "string",
- "statusId": 0
}
], - "stageId": 1,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
], - "status": "string",
- "statusId": 0,
- "files": {
- "count": 0
}, - "queries": [
- null
]
}
], - "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
submissionId required | integer |
[- {
- "_href": "string",
- "disabled": true,
- "email": "string",
- "fullName": "string",
- "groups": [
- {
- "id": 0,
- "permitSelfRegistration": true,
- "recommendOnly": true,
- "roleId": 0,
- "showTitle": true
}
], - "id": 0,
- "orcid": "string",
- "userName": "string"
}
]
stageId required | integer |
submissionId required | integer |
[- {
- "_href": "string",
- "disabled": true,
- "email": "string",
- "fullName": "string",
- "groups": [
- {
- "id": 0,
- "permitSelfRegistration": true,
- "recommendOnly": true,
- "roleId": 0,
- "showTitle": true
}
], - "id": 0,
- "orcid": "string",
- "userName": "string"
}
]
submissionId required | integer |
[- {
- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
]
publicationId required | integer |
submissionId required | integer |
Details about the publication that should be created.
abstract | object (LocaleObject) Key/value pairs containing data stored by locale key. |
accessStatus | integer Default: 0 |
categoryIds | Array of integers |
citationsRaw | string Optional metadata that contains references for works cited in this submission as raw text. |
copyrightHolder | object (LocaleObject) Key/value pairs containing data stored by locale key. |
copyrightYear | integer The copyright year for this publication. |
coverage | object (LocaleObject) Key/value pairs containing data stored by locale key. |
object | |
datePublished | string |
disciplines | Array of strings Optional metadata that describes the submission's types of study or branches of knowledge. |
fullTitle | object (LocaleObject) Key/value pairs containing data stored by locale key. |
hideAuthor | boolean Default: false Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship. |
issueId | integer |
keywords | Array of strings Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission. |
languages | Array of strings Optional metadata that identifies the submission's primary language. |
lastModified | string |
licenseUrl | string A URL to a webpage describing the license terms for this publication. |
locale | string The primary locale of this publication. |
pages | string The pages of the issue in which this article appears if it is published in a physical format. |
prefix | object (LocaleObject) Key/value pairs containing data stored by locale key. |
primaryContactId | integer Which |
pub-id::publisher-id | string A unique ID provided by the publisher. It will be used in the publication's URL path instead of the |
rights | object (LocaleObject) Key/value pairs containing data stored by locale key. |
sectionId | integer |
seq | integer Default: 0 |
source | object (LocaleObject) Key/value pairs containing data stored by locale key. |
status | integer Default: 1 Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the |
subjects | Array of strings Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics. |
submissionId | integer |
subtitle | object (LocaleObject) Key/value pairs containing data stored by locale key. |
supportingAgencies | Array of strings Optional metadata that indicates the source of research funding or other institutional support. |
title | object (LocaleObject) Key/value pairs containing data stored by locale key. |
type | object (LocaleObject) Key/value pairs containing data stored by locale key. |
version | integer The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number |
{- "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "accessStatus": 0,
- "categoryIds": [
- 0
], - "citationsRaw": "string",
- "copyrightHolder": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYear": 0,
- "coverImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "dateUploaded": "string",
- "uploadName": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "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"
}, - "hideAuthor": false,
- "issueId": 0,
- "keywords": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "version": 0
}
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
publicationId required | integer |
submissionId required | integer |
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
publicationId required | integer |
submissionId required | integer |
The details about the publication that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.
abstract | object (LocaleObject) Key/value pairs containing data stored by locale key. |
accessStatus | integer Default: 0 |
categoryIds | Array of integers |
citationsRaw | string Optional metadata that contains references for works cited in this submission as raw text. |
copyrightHolder | object (LocaleObject) Key/value pairs containing data stored by locale key. |
copyrightYear | integer The copyright year for this publication. |
coverage | object (LocaleObject) Key/value pairs containing data stored by locale key. |
object | |
datePublished | string |
disciplines | Array of strings Optional metadata that describes the submission's types of study or branches of knowledge. |
fullTitle | object (LocaleObject) Key/value pairs containing data stored by locale key. |
hideAuthor | boolean Default: false Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship. |
issueId | integer |
keywords | Array of strings Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission. |
languages | Array of strings Optional metadata that identifies the submission's primary language. |
lastModified | string |
licenseUrl | string A URL to a webpage describing the license terms for this publication. |
locale | string The primary locale of this publication. |
pages | string The pages of the issue in which this article appears if it is published in a physical format. |
prefix | object (LocaleObject) Key/value pairs containing data stored by locale key. |
primaryContactId | integer Which |
pub-id::publisher-id | string A unique ID provided by the publisher. It will be used in the publication's URL path instead of the |
rights | object (LocaleObject) Key/value pairs containing data stored by locale key. |
sectionId | integer |
seq | integer Default: 0 |
source | object (LocaleObject) Key/value pairs containing data stored by locale key. |
status | integer Default: 1 Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the |
subjects | Array of strings Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics. |
submissionId | integer |
subtitle | object (LocaleObject) Key/value pairs containing data stored by locale key. |
supportingAgencies | Array of strings Optional metadata that indicates the source of research funding or other institutional support. |
title | object (LocaleObject) Key/value pairs containing data stored by locale key. |
type | object (LocaleObject) Key/value pairs containing data stored by locale key. |
version | integer The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number |
{- "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "accessStatus": 0,
- "categoryIds": [
- 0
], - "citationsRaw": "string",
- "copyrightHolder": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYear": 0,
- "coverImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "dateUploaded": "string",
- "uploadName": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "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"
}, - "hideAuthor": false,
- "issueId": 0,
- "keywords": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "version": 0
}
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
Only journal managers and subeditors can make a request to this endpoint.
publicationId required | integer |
submissionId required | integer |
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
publicationId required | integer |
submissionId required | integer |
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
If the publication is assigned to an issue that is not yet published, it will be scheduled for publication and the status
will be set to STATUS_SCHEDULED
. If the issue is already published, it will be published immediately and the status
will be set to STATUS_PUBLISHED
.
The publication will be validated against any publishing requirements before it is published and a 400
response will be returned if it fails validation.
publicationId required | integer |
submissionId required | integer |
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
publicationId required | integer |
submissionId required | integer |
{- "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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
Results ar eeordered by datePublished
with the most recent first.
count | integer How many results to return in a single request. Default is |
isPublished | boolean Filter returned issues by those that have been published. Pass a |
numbers | string Filter returned issues by those assigned a specific number. |
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 |
volumes | string Filter returned issues by those in a specific volume. |
years | string Filter returned issues by those in a specific year. |
[- {
- "_href": "string",
- "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "datePublished": "string",
- "description": {
- "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"
}
], - "id": 0,
- "identification": "string",
- "number": "string",
- "publishedUrl": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "volume": 0,
- "year": 0
}
]
{- "_href": "string",
- "articles": [
- {
- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "stageId": 1,
- "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
], - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateNotified": "string",
- "datePublished": "string",
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "doi": "string",
- "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"
}
], - "id": 0,
- "identification": "string",
- "isCurrent": true,
- "lastModified": "string",
- "number": "string",
- "publishedUrl": "string",
- "sections": [
- {
- "id": 0,
- "seq": 0
}
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "volume": 0,
- "year": 0
}
If the issue has a custom section order, the seq
property of each SectionSummary
will reflect the sequence for that issue.
{- "_href": "string",
- "articles": [
- {
- "_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": [
- "string"
], - "languages": [
- "string"
], - "lastModified": "string",
- "licenseUrl": "string",
- "locale": "string",
- "pages": "string",
- "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "primaryContactId": 0,
- "pub-id::publisher-id": "string",
- "rights": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sectionId": 0,
- "seq": 0,
- "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "status": 1,
- "subjects": [
- "string"
], - "submissionId": 0,
- "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "supportingAgencies": [
- "string"
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "urlPublished": "string",
- "version": 0
}
], - "stageId": 1,
- "status": 1,
- "statusLabel": "string",
- "submissionProgress": 1,
- "urlAuthorWorkflow": "string",
- "urlEditorialWorkflow": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
], - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateNotified": "string",
- "datePublished": "string",
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "doi": "string",
- "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"
}
], - "id": 0,
- "identification": "string",
- "isCurrent": true,
- "lastModified": "string",
- "number": "string",
- "publishedUrl": "string",
- "sections": [
- {
- "id": 0,
- "seq": 0
}
], - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "volume": 0,
- "year": 0
}
assignedToSection | integer Filter the results by those assigned as section editors to this section ID. |
assignedToSubmission | integer Filter results by those assigned to this submission ID. |
assignedToSubmissionStage | integer Filter results by those assigned to this submission stage. Will be ignored if no |
count | integer How many results to return in a single request. Default is |
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 |
roleIds | string Filter the results by those who have one of these user role IDs. |
searchPhrase | string Filter the results by a search phrase matched against the |
status | string Filter results by active/disabled users. Must be one of |
{- "itemsMax": 0,
- "items": [
- {
- "_href": "string",
- "disabled": true,
- "email": "string",
- "fullName": "string",
- "groups": [
- {
- "id": 0,
- "permitSelfRegistration": true,
- "recommendOnly": true,
- "roleId": 0,
- "showTitle": true
}
], - "id": 0,
- "orcid": "string",
- "userName": "string"
}
]
}
{- "_href": "string",
- "authId": 0,
- "authString": "string",
- "billingAddress": "string",
- "country": "string",
- "dateLastRegistered": "string",
- "dateRegistered": "string",
- "dateValidated": "string",
- "disabled": true,
- "disabledReason": "string",
- "email": "string",
- "fullName": "string",
- "groups": [
- {
- "id": 0,
- "permitSelfRegistration": true,
- "recommendOnly": true,
- "roleId": 0,
- "showTitle": true
}
], - "id": 0,
- "interests": [
- {
- "id": 0,
- "interest": "string"
}
], - "mailingAddress": "string",
- "mustChangePassword": true,
- "orcid": "string",
- "phone": "string",
- "url": "string",
- "userName": "string"
}
averageCompletion | integer Filter results by those who complete a review assignment within |
count | integer How many results to return in a single request. Default is |
daysSinceLastAssignment | string Filter results by those who's last review was assigned at least |
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 |
reviewerRating | integer Filter results by those who have an average review assignment rating of at least |
reviewsActive | string Filter results by those who have |
reviewsCompleted | string Filter results by those who have completed at least |
reviewStage | integer Filter results by reviewers for one of the review stages in the workflow. Must be one of |
searchPhrase | string Filter the results by a search phrase matched against the |
status | string Filter results by active/disabled users. Must be one of |
{- "itemsMax": 0,
- "items": [
- {
- "_href": "string",
- "affiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "averageReviewCompletionDays": 0,
- "dateLastReviewAssignment": "string",
- "disabled": true,
- "fullName": "string",
- "gossip": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "groups": [
- {
- "id": 0,
- "permitSelfRegistration": true,
- "recommendOnly": true,
- "roleId": 0,
- "showTitle": true
}
], - "id": 0,
- "interests": [
- {
- "id": 0,
- "interest": "string"
}
], - "reviewsActive": 0,
- "reviewsCompleted": 0,
- "reviewsCancelled": 0,
- "reviewsDeclined": 0,
- "userName": "string"
}
]
}
count | type How many results to return in a single request. Default is |
isEnabled | string Filter results by enabled/disabled contexts. Any truthy or falsey value will get enabled/disabled contexts. Leave this parameter out to get all contexts. |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. |
searchPhrase | string Filter results by a search phrase matched against the |
{- "itemsMax": 0,
- "items": [
- {
- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "id": 0,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": { },
- "fr_CA": { }
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "url": "string",
- "urlPath": "string"
}
]
}
Details about the context that should be created. The path
field is required. The name
is required in the site's primary locale.
abbreviation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
about | object (LocaleObject) Key/value pairs containing data stored by locale key. |
acronym | object (LocaleObject) Key/value pairs containing data stored by locale key. |
additionalHomeContent | object (LocaleObject) Key/value pairs containing data stored by locale key. |
agencies | string Enable agencies metadata. |
announcementsIntroduction | object (LocaleObject) Key/value pairs containing data stored by locale key. |
authorGuidelines | object (LocaleObject) Key/value pairs containing data stored by locale key. |
authorInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
citations | string Enable citations metadata. |
clockssLicense | object (LocaleObject) Key/value pairs containing data stored by locale key. |
competingInterests | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactAffiliation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactEmail | string |
contactName | string |
contactPhone | string |
copyrightHolderOther | string |
copyrightHolderType | string |
copyrightNotice | object (LocaleObject) Key/value pairs containing data stored by locale key. |
copyrightYearBasis | string Default: "issue" |
coverage | string Enable coverage metadata. |
currency | string |
customHeaders | object (LocaleObject) Key/value pairs containing data stored by locale key. |
defaultMetricType | string |
defaultReviewMode | integer Default: 2 |
delayedOpenAccessDuration | integer |
delayedOpenAccessPolicy | object (LocaleObject) Key/value pairs containing data stored by locale key. |
description | object (LocaleObject) Key/value pairs containing data stored by locale key. |
disableUserReg | boolean |
disciplines | string Enable disciplines metadata. |
editorialTeam | object (LocaleObject) Key/value pairs containing data stored by locale key. |
emailSignature | string |
enableAnnouncements | boolean |
enableClockss | boolean |
enabled | boolean |
enableLockss | boolean |
enableOai | boolean Default: 1 |
enableOpenAccessNotification | boolean |
enableSubscriptionOnlinePaymentNotificationPurchaseIndividual | boolean |
enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional | boolean |
enableSubscriptionOnlinePaymentNotificationRenewIndividual | boolean |
enableSubscriptionOnlinePaymentNotificationRenewInstitutional | boolean |
envelopeSender | string |
object | |
object | |
itemsPerPage | integer Default: 25 |
object | |
keywords | string Default: "request" Enable keywords metadata. |
languages | string Enable languages metadata. |
librarianInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
licenseTerms | object (LocaleObject) Key/value pairs containing data stored by locale key. |
licenseUrl | string |
lockssLicense | object (LocaleObject) Key/value pairs containing data stored by locale key. |
mailingAddress | string |
membershipFee | number Default: 0 |
membershipFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
membershipFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
name | object (LocaleObject) Key/value pairs containing data stored by locale key. |
numAnnouncementsHomepage | integer |
numDaysBeforeInviteReminder | integer |
numDaysBeforeSubmitReminder | integer |
numMonthsAfterSubscriptionExpiryReminder | integer |
numMonthsBeforeSubscriptionExpiryReminder | integer |
numPageLinks | integer Default: 10 |
numWeeksAfterSubscriptionExpiryReminder | integer |
numWeeksBeforeSubscriptionExpiryReminder | integer |
numWeeksPerResponse | integer Default: 4 |
numWeeksPerReview | integer Default: 4 |
onlineIssn | string |
openAccessPolicy | object (LocaleObject) Key/value pairs containing data stored by locale key. |
pageFooter | object (LocaleObject) Key/value pairs containing data stored by locale key. |
object | |
paymentPluginName | string |
paymentsEnabled | boolean |
primaryLocale | string |
printIssn | string |
privacyStatement | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publicationFee | number Default: 0 |
publicationFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publicationFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publisherInstitution | string |
publishingMode | integer |
purchaseArticleFee | number Default: 0 |
purchaseArticleFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
purchaseArticleFeeEnabled | boolean |
purchaseArticleFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
purchaseIssueFee | number |
purchaseIssueFeeEnabled | boolean |
rateReviewerOnQuality | boolean |
readerInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
restrictArticleAccess | boolean |
restrictOnlyPdf | boolean |
restrictReviewerFileAccess | boolean |
restrictSiteAccess | boolean |
reviewerAccessKeysEnabled | boolean |
reviewGuidelines | object (LocaleObject) Key/value pairs containing data stored by locale key. |
rights | string Enable rights metadata. |
searchDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
seq | integer |
showEnsuringLink | boolean |
sidebar | Array of strings |
source | string Enable source metadata. |
object | |
subjects | string Enable subjects metadata. |
Array of objects Default: [{"order":1,"content":{"defaultLocaleKey":"default.contextSettings.checklist.notPreviouslyPublished"}},{"order":2,"content":{"defaultLocaleKey":"default.contextSettings.checklist.fileFormat"}},{"order":3,"content":{"defaultLocaleKey":"default.contextSettings.checklist.addressesLinked"}},{"order":4,"content":{"defaultLocaleKey":"default.contextSettings.checklist.submissionAppearance"}},{"order":5,"content":{"defaultLocaleKey":"default.contextSettings.checklist.bibliographicRequirements"}}] | |
submissionFee | number |
submissionFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
submissionFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
subscriptionAdditionalInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
subscriptionEmail | string |
subscriptionExpiryPartial | boolean |
subscriptionMailingAddress | string |
subscriptionName | string |
subscriptionPhone | string |
supportedFormLocales | Array of strings |
supportedLocales | Array of strings |
supportedSubmissionLocales | Array of strings |
supportEmail | string |
supportName | string |
supportPhone | string |
themePluginPath | string Default: "default" |
type | string Enable types metadata. |
urlPath | string |
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "urlPath": "string"
}
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "id": 0,
- "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "url": "string",
- "urlPath": "string"
}
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "id": 0,
- "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "url": "string",
- "urlPath": "string"
}
contextId required | integer Context ID |
The details about a context that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.
abbreviation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
about | object (LocaleObject) Key/value pairs containing data stored by locale key. |
acronym | object (LocaleObject) Key/value pairs containing data stored by locale key. |
additionalHomeContent | object (LocaleObject) Key/value pairs containing data stored by locale key. |
agencies | string Enable agencies metadata. |
announcementsIntroduction | object (LocaleObject) Key/value pairs containing data stored by locale key. |
authorGuidelines | object (LocaleObject) Key/value pairs containing data stored by locale key. |
authorInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
citations | string Enable citations metadata. |
clockssLicense | object (LocaleObject) Key/value pairs containing data stored by locale key. |
competingInterests | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactAffiliation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactEmail | string |
contactName | string |
contactPhone | string |
copyrightHolderOther | string |
copyrightHolderType | string |
copyrightNotice | object (LocaleObject) Key/value pairs containing data stored by locale key. |
copyrightYearBasis | string Default: "issue" |
coverage | string Enable coverage metadata. |
currency | string |
customHeaders | object (LocaleObject) Key/value pairs containing data stored by locale key. |
defaultMetricType | string |
defaultReviewMode | integer Default: 2 |
delayedOpenAccessDuration | integer |
delayedOpenAccessPolicy | object (LocaleObject) Key/value pairs containing data stored by locale key. |
description | object (LocaleObject) Key/value pairs containing data stored by locale key. |
disableUserReg | boolean |
disciplines | string Enable disciplines metadata. |
editorialTeam | object (LocaleObject) Key/value pairs containing data stored by locale key. |
emailSignature | string |
enableAnnouncements | boolean |
enableClockss | boolean |
enabled | boolean |
enableLockss | boolean |
enableOai | boolean Default: 1 |
enableOpenAccessNotification | boolean |
enableSubscriptionOnlinePaymentNotificationPurchaseIndividual | boolean |
enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional | boolean |
enableSubscriptionOnlinePaymentNotificationRenewIndividual | boolean |
enableSubscriptionOnlinePaymentNotificationRenewInstitutional | boolean |
envelopeSender | string |
object | |
object | |
itemsPerPage | integer Default: 25 |
object | |
keywords | string Default: "request" Enable keywords metadata. |
languages | string Enable languages metadata. |
librarianInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
licenseTerms | object (LocaleObject) Key/value pairs containing data stored by locale key. |
licenseUrl | string |
lockssLicense | object (LocaleObject) Key/value pairs containing data stored by locale key. |
mailingAddress | string |
membershipFee | number Default: 0 |
membershipFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
membershipFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
name | object (LocaleObject) Key/value pairs containing data stored by locale key. |
numAnnouncementsHomepage | integer |
numDaysBeforeInviteReminder | integer |
numDaysBeforeSubmitReminder | integer |
numMonthsAfterSubscriptionExpiryReminder | integer |
numMonthsBeforeSubscriptionExpiryReminder | integer |
numPageLinks | integer Default: 10 |
numWeeksAfterSubscriptionExpiryReminder | integer |
numWeeksBeforeSubscriptionExpiryReminder | integer |
numWeeksPerResponse | integer Default: 4 |
numWeeksPerReview | integer Default: 4 |
onlineIssn | string |
openAccessPolicy | object (LocaleObject) Key/value pairs containing data stored by locale key. |
pageFooter | object (LocaleObject) Key/value pairs containing data stored by locale key. |
object | |
paymentPluginName | string |
paymentsEnabled | boolean |
primaryLocale | string |
printIssn | string |
privacyStatement | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publicationFee | number Default: 0 |
publicationFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publicationFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
publisherInstitution | string |
publishingMode | integer |
purchaseArticleFee | number Default: 0 |
purchaseArticleFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
purchaseArticleFeeEnabled | boolean |
purchaseArticleFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
purchaseIssueFee | number |
purchaseIssueFeeEnabled | boolean |
rateReviewerOnQuality | boolean |
readerInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
restrictArticleAccess | boolean |
restrictOnlyPdf | boolean |
restrictReviewerFileAccess | boolean |
restrictSiteAccess | boolean |
reviewerAccessKeysEnabled | boolean |
reviewGuidelines | object (LocaleObject) Key/value pairs containing data stored by locale key. |
rights | string Enable rights metadata. |
searchDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
seq | integer |
showEnsuringLink | boolean |
sidebar | Array of strings |
source | string Enable source metadata. |
object | |
subjects | string Enable subjects metadata. |
Array of objects Default: [{"order":1,"content":{"defaultLocaleKey":"default.contextSettings.checklist.notPreviouslyPublished"}},{"order":2,"content":{"defaultLocaleKey":"default.contextSettings.checklist.fileFormat"}},{"order":3,"content":{"defaultLocaleKey":"default.contextSettings.checklist.addressesLinked"}},{"order":4,"content":{"defaultLocaleKey":"default.contextSettings.checklist.submissionAppearance"}},{"order":5,"content":{"defaultLocaleKey":"default.contextSettings.checklist.bibliographicRequirements"}}] | |
submissionFee | number |
submissionFeeDescription | object (LocaleObject) Key/value pairs containing data stored by locale key. |
submissionFeeName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
subscriptionAdditionalInformation | object (LocaleObject) Key/value pairs containing data stored by locale key. |
subscriptionEmail | string |
subscriptionExpiryPartial | boolean |
subscriptionMailingAddress | string |
subscriptionName | string |
subscriptionPhone | string |
supportedFormLocales | Array of strings |
supportedLocales | Array of strings |
supportedSubmissionLocales | Array of strings |
supportEmail | string |
supportName | string |
supportPhone | string |
themePluginPath | string Default: "default" |
type | string Enable types metadata. |
urlPath | string |
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "urlPath": "string"
}
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "id": 0,
- "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "url": "string",
- "urlPath": "string"
}
{- "abbreviation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "acronym": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "additionalHomeContent": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "agencies": "string",
- "announcementsIntroduction": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "citations": "string",
- "clockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "competingInterests": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactAffiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": "string",
- "contactName": "string",
- "contactPhone": "string",
- "copyrightHolderOther": "string",
- "copyrightHolderType": "string",
- "copyrightNotice": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYearBasis": "issue",
- "coverage": "string",
- "currency": "string",
- "customHeaders": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "defaultMetricType": "string",
- "defaultReviewMode": 2,
- "delayedOpenAccessDuration": 0,
- "delayedOpenAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disableUserReg": true,
- "disciplines": "string",
- "editorialTeam": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "emailSignature": "string",
- "enableAnnouncements": true,
- "enableClockss": true,
- "enableLockss": true,
- "enableOai": 1,
- "enableOpenAccessNotification": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
- "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
- "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
- "enabled": true,
- "envelopeSender": "string",
- "favicon": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "homepageImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "id": 0,
- "itemsPerPage": 25,
- "journalThumbnail": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "keywords": "request",
- "languages": "string",
- "librarianInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseTerms": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "licenseUrl": "string",
- "lockssLicense": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "mailingAddress": "string",
- "membershipFee": 0,
- "membershipFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "membershipFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "numAnnouncementsHomepage": 0,
- "numDaysBeforeInviteReminder": 0,
- "numDaysBeforeSubmitReminder": 0,
- "numMonthsAfterSubscriptionExpiryReminder": 0,
- "numMonthsBeforeSubscriptionExpiryReminder": 0,
- "numPageLinks": 10,
- "numWeeksAfterSubscriptionExpiryReminder": 0,
- "numWeeksBeforeSubscriptionExpiryReminder": 0,
- "numWeeksPerResponse": 4,
- "numWeeksPerReview": 4,
- "onlineIssn": "string",
- "openAccessPolicy": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderLogoImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "paymentPluginName": "string",
- "paymentsEnabled": true,
- "primaryLocale": "string",
- "printIssn": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFee": 0,
- "publicationFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publicationFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisherInstitution": "string",
- "publishingMode": 0,
- "purchaseArticleFee": 0,
- "purchaseArticleFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseArticleFeeEnabled": true,
- "purchaseArticleFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "purchaseIssueFee": 0,
- "purchaseIssueFeeEnabled": true,
- "rateReviewerOnQuality": true,
- "readerInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "restrictArticleAccess": true,
- "restrictOnlyPdf": true,
- "restrictReviewerFileAccess": true,
- "restrictSiteAccess": true,
- "reviewGuidelines": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewerAccessKeysEnabled": true,
- "rights": "string",
- "searchDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0,
- "showEnsuringLink": true,
- "sidebar": [
- "string"
], - "source": "string",
- "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "subjects": "string",
- "submissionChecklist": [
- {
- "order": 1,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished"
}
}, - {
- "order": 2,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.fileFormat"
}
}, - {
- "order": 3,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked"
}
}, - {
- "order": 4,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance"
}
}, - {
- "order": 5,
- "content": {
- "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements"
}
}
], - "submissionFee": 0,
- "submissionFeeDescription": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "submissionFeeName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionAdditionalInformation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subscriptionEmail": "string",
- "subscriptionExpiryPartial": true,
- "subscriptionMailingAddress": "string",
- "subscriptionName": "string",
- "subscriptionPhone": "string",
- "supportEmail": "string",
- "supportName": "string",
- "supportPhone": "string",
- "supportedFormLocales": [
- "string"
], - "supportedLocales": [
- "string"
], - "supportedSubmissionLocales": [
- "string"
], - "themePluginPath": "default",
- "type": "string",
- "url": "string",
- "urlPath": "string"
}
contextId required | integer Context ID |
The details you want to edit. The themePluginPath
is required to specify the active theme, even if the theme is not being changed. Any additional keys/values must match the options defined by that theme.
... | string |
themePluginPath | string |
{- "themePluginPath": "string",
- "...": "string"
}
{- "themePluginPath": "string",
- "...": "string"
}
Only admins can access these endpoints, which should be accessed using *
instead of the journal path.
{- "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "installedLocales": [
- "string"
], - "minPasswordLength": 0,
- "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderTitleImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "primaryLocale": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "redirect": 0,
- "sidebar": [
- "string"
], - "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "supportedLocales": [
- "string"
], - "themePluginPath": "default",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}
}
The details about the site that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.
about | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactEmail | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contactName | object (LocaleObject) Key/value pairs containing data stored by locale key. |
installedLocales | Array of strings |
minPasswordLength | integer |
pageFooter | object (LocaleObject) Key/value pairs containing data stored by locale key. |
object | |
primaryLocale | string |
privacyStatement | object (LocaleObject) Key/value pairs containing data stored by locale key. |
redirect | integer |
sidebar | Array of strings |
object | |
supportedLocales | Array of strings |
themePluginPath | string Default: "default" |
title | object (LocaleObject) Key/value pairs containing data stored by locale key. |
{- "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "installedLocales": [
- "string"
], - "minPasswordLength": 0,
- "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderTitleImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "primaryLocale": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "redirect": 0,
- "sidebar": [
- "string"
], - "styleSheet": {
- "temporaryFileId": 0,
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "supportedLocales": [
- "string"
], - "themePluginPath": "default",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}
}
{- "about": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactEmail": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contactName": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "installedLocales": [
- "string"
], - "minPasswordLength": 0,
- "pageFooter": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pageHeaderTitleImage": {
- "type": null,
- "properties": null,
- "en_US": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}, - "fr_CA": {
- "name": "string",
- "uploadName": "string",
- "width": 0,
- "height": 0,
- "dateUploaded": "string",
- "altText": "string"
}
}, - "primaryLocale": "string",
- "privacyStatement": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "redirect": 0,
- "sidebar": [
- "string"
], - "styleSheet": {
- "name": "string",
- "uploadName": "string",
- "dateUploaded": "string"
}, - "supportedLocales": [
- "string"
], - "themePluginPath": "default",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}
}
The details you want to edit. The themePluginPath
is required to specify the active theme, even if the theme is not being changed. Any additional keys/values must match the options defined by that theme.
... | string |
themePluginPath | string |
{- "themePluginPath": "string",
- "...": "string"
}
{- "themePluginPath": "string",
- "...": "string"
}
fromRoleIds | string Filter results by email templates sent by one or more role IDs. Separate role IDs with a comma. |
isCustom | string Filter results by those with or without a default template. A truthy value will return only templates with a key that does not match one of the default templates. A falsey value will return only templates with a key that matches one of the default templates. Note that a default template may be customized, but this does not qualify for |
isEnabled | string Filter results by enabled/disabled email templates. Any truthy or falsey value will get enabled/disabled email templates. |
searchPhrase | string Filter results by a search phrase matched against the |
toRoleIds | string Filter results by email templates received by one or more role IDs. Separate role IDs with a comma. |
{- "itemsMax": 0,
- "items": [
- {
- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "canDisable": true,
- "canEdit": true,
- "contextId": 0,
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "fromRoleId": 0,
- "id": 0,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "toRoleId": 0
}
]
}
Details about the email template that should be created.
body | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contextId | integer The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is |
enabled | boolean Is this email template enabled? Default is |
key | string A unique key for this email template. |
subject | object (LocaleObject) Key/value pairs containing data stored by locale key. |
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contextId": 0,
- "enabled": true,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}
}
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "canDisable": true,
- "canEdit": true,
- "contextId": 0,
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "fromRoleId": 0,
- "id": 0,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "toRoleId": 0
}
key required | integer Email template key |
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "canDisable": true,
- "canEdit": true,
- "contextId": 0,
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "fromRoleId": 0,
- "id": 0,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "toRoleId": 0
}
key required | integer Email template key |
The details about the email template that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.
body | object (LocaleObject) Key/value pairs containing data stored by locale key. |
contextId | integer The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is |
enabled | boolean Is this email template enabled? Default is |
key | string A unique key for this email template. |
subject | object (LocaleObject) Key/value pairs containing data stored by locale key. |
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "contextId": 0,
- "enabled": true,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}
}
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "canDisable": true,
- "canEdit": true,
- "contextId": 0,
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "fromRoleId": 0,
- "id": 0,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "toRoleId": 0
}
key required | integer Email template key |
{- "body": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "canDisable": true,
- "canEdit": true,
- "contextId": 0,
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "enabled": true,
- "fromRoleId": 0,
- "id": 0,
- "key": "string",
- "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "toRoleId": 0
}
Returns information about editorial activity such as the number of submissions accepted and declined, the number of days to reach editorial decisions, and the acceptance and rejection rates.
dateEnd | string Return stats before this date. |
dateStart | string Return stats after this date. |
sectionIds | string Filter results by submissions to these sections. Separate section IDs with a comma. |
[- {
- "key": "submissionsReceived",
- "name": "Submissions Received",
- "value": 64
}, - {
- "key": "submissionsAccepted",
- "name": "Submissions Accepted",
- "value": 54
}, - {
- "key": "submissionsDeclined",
- "name": "Submissions Declined",
- "value": 4
}, - {
- "key": "submissionsDeclinedDeskReject",
- "name": "Submissions Declined (Desk Reject)",
- "value": 0
}, - {
- "key": "submissionsDeclinedPostReview",
- "name": "Submissions Declined (After Review)",
- "value": 4
}, - {
- "key": "submissionsPublished",
- "name": "Submissions Published",
- "value": 53
}, - {
- "key": "daysToDecision",
- "name": "Days to First Editorial Decision",
- "value": 42
}, - {
- "key": "daysToAccept",
- "name": "Days to Accept",
- "value": 123
}, - {
- "key": "daysToReject",
- "name": "Days to Reject",
- "value": 322
}, - {
- "key": "acceptanceRate",
- "name": "Acceptance Rate",
- "value": 0.84
}, - {
- "key": "declineRate",
- "name": "Rejection Rate",
- "value": 0.06
}, - {
- "key": "declinedDeskRate",
- "name": "Desk Reject Rate",
- "value": 0
}, - {
- "key": "declinedReviewRate",
- "name": "After Review Reject Rate",
- "value": 0.06
}
]
Returns a list of publications ordered by their total abstract views. Includes total views by abstract, all galleys, PDF galleys, HTML galleys and other galleys.
count | type How many publications to return in a single request. Default is |
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
offset | integer Offset the publications returned. Use this to receive subsequent pages of requests. |
orderDirection | integer Order the results in |
searchPhrase | string Filter results by publications that match this search phrase. Searches the same submission properties as the |
sectionIds | string Filter results by publications in these sections. Separate section IDs with a comma. |
submissionIds | string Filter results by these publications. Separate submission IDs with a comma. |
[- {
- "abstractViews": 0,
- "galleyViews": 0,
- "pdfViews": 0,
- "htmlViews": 0,
- "otherViews": 0,
- "publication": {
- "_href": "string",
- "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "id": 0,
- "shortAuthorString": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
}
]
Returns a monthly or daily timeline of abstract views for the publications which match the request parameters.
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
searchPhrase | string Filter results by publications that match this search phrase. Searches the same submission properties as the |
sectionIds | string Filter results by publications in these sections. Separate section IDs with a comma. |
submissionIds | string Filter results by these publications. Separate submission IDs with a comma. |
timelineInterval | string Return a timeline by |
[- {
- "date": "string",
- "label": "string",
- "value": 0
}
]
Returns a monthly or daily timeline of galley views for the publications which match the request parameters.
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
searchPhrase | string Filter results by publications that match this search phrase. Searches the same submission properties as the |
sectionIds | string Filter results by publications in these sections. Separate section IDs with a comma. |
submissionIds | string Filter results by these publications. Separate submission IDs with a comma. |
timelineInterval | string Return a timeline by |
[- {
- "date": "string",
- "label": "string",
- "value": 0
}
]
Returns a publication's total views by abstract, all galleys, PDF galleys, HTML galleys and other galleys.
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
{- "abstractViews": 0,
- "galleyViews": 0,
- "pdfViews": 0,
- "htmlViews": 0,
- "otherViews": 0,
- "publication": {
- "_href": "string",
- "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "id": 0,
- "shortAuthorString": "string",
- "urlPublished": "string",
- "urlWorkflow": "string"
}
}
Returns a monthly or daily timeline of abstract views for the requested publication.
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
timelineInterval | string Return a timeline by |
[- {
- "date": "string",
- "label": "string",
- "value": 0
}
]
Returns a monthly or daily timeline of galley views for the requested publication.
dateEnd | string Return stats for publications before this date. |
dateStart | string Return stats for publications after this date. |
timelineInterval | string Return a timeline by |
[- {
- "date": "string",
- "label": "string",
- "value": 0
}
]
Returns a count of the number of user registrations broken down by roles.
Please note when using the registeredBefore
and registeredAfter
parameters that role counts reflect current user roles.
A user who registered as an author in January, 2019 but was later appointed to subeditor will be counted as a subeditor when the registration date range includes January, 2019.
registeredAfter | string Return counts reflecting users who registered after this date. |
registeredBefore | string Return counts reflecting users who registered before this date. |
status | string Count |
[- {
- "id": "total",
- "name": "Total",
- "value": 304
}, - {
- "id": 16,
- "name": "Journal Manager",
- "value": 4
}, - {
- "id": 17,
- "name": "Section Editor",
- "value": 14
}, - {
- "id": 4097,
- "name": "Assistant",
- "value": 1
}, - {
- "id": 65536,
- "name": "Author",
- "value": 220
}, - {
- "id": 4096,
- "name": "Reviewer",
- "value": 107
}, - {
- "id": 1048576,
- "name": "Reader",
- "value": 207
}, - {
- "id": 2097152,
- "name": "Subscription Manager",
- "value": 0
}
]
Handle controlled vocabularies like keywords and subjects. Only admins, journal managers, subeditors, assistants and authors can access these endpoints.
locale | string The locale key, such as |
vocab required | string The type of controlled vocab you want to retrieve entries for. One of |
[- "string"
]
A special endpoint to be used for handling file uploads. See the API Usage Guide for more information.
Use any parameter key to upload your file. The API endpoint will retrieve the first uploaded file.
null
{- "id": 0
}
Private endpoints for OJS's UI. These endpoints will be less stable between versions. We discourage their use in third-party plugins or applications.
This endpoint is used on the settings page to save payment plugin settings alongside the general journal settings for enabling payments and setting the currency.
None of these properties are required. In addition to paymentsEnabled
and currency
, you may pass any property that corresponds with a setting for an enabled paymethod
plugin.
... | string |
currency | string |
paymentsEnabled | boolean |
{- "paymentsEnabled": true,
- "currency": "string",
- "...": "string"
}
{- "name": [
- "You must provide a name to create a new user."
], - "roles": [
- "You must assign the user to one or more roles."
]
}
The user's public file directory supports files uploaded through the TinyMCE rich text editor. This is commonly used in context settings but is also available to all registered users through their profile biography.
Use the file
key to upload your file.
null
{- "url": "string"
}