PKP Developer Docs
Documentation Powered by ReDoc

Open Journal Systems - API Reference (3.2)

Download OpenAPI specification:Download

URL: https://pkp.sfu.ca

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

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

Breaking changes

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

Submissions

Get a list of submissions.

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

query Parameters
assignedTo
integer

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

count
integer

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

daysInactive
integer

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

isIncomplete
boolean

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

isOverdue
boolean

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

issueIds
string

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

offset
integer

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

orderBy
string

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

orderDirection
string

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

searchPhrase
string

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

sectionIds
string

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

status
string

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

Responses

Response samples

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

Create a new submission.

Request Body schema: application/json

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 WORKFLOW_STAGE_ constants. Default is WORKFLOW_STAGE_SUBMISSION.

status
integer
Default: 1

Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_* constants. Default is STATUS_QUEUED.

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 0, indicating it is ready for an editor's consideration.

Responses

Request samples

Content type
application/json
{
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "stageId": 1,
  • "status": 1,
  • "submissionProgress": 1
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": 1,
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlWorkflow": "string"
}

Get a submission by ID.

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

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": 1,
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlWorkflow": "string"
}

Edit a submission.

path Parameters
submissionId
required
integer
Request Body schema: application/json

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 WORKFLOW_STAGE_ constants. Default is WORKFLOW_STAGE_SUBMISSION.

status
integer
Default: 1

Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_* constants. Default is STATUS_QUEUED.

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 0, indicating it is ready for an editor's consideration.

Responses

Request samples

Content type
application/json
{
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "stageId": 1,
  • "status": 1,
  • "submissionProgress": 1
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": 1,
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlWorkflow": "string"
}

Delete a submission.

Only journal managers and subeditors can make a request to this endpoint.

path Parameters
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": 1,
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlWorkflow": "string"
}

Get the participants assigned to a submisssion.

path Parameters
submissionId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the participants assigned to a stage of this submisssion's workflow.

path Parameters
stageId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of publications for this submission.

path Parameters
submissionId
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new publication for this submission.

path Parameters
publicationId
required
integer
submissionId
required
integer
Request Body schema: application/json

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 contributor is the primary contact for this publication.

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 id when present.

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 STATUS_* constants. Default is STATUS_QUEUED.

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 3. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.

Responses

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Get a publication.

path Parameters
publicationId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Edit a publication.

path Parameters
publicationId
required
integer
submissionId
required
integer
Request Body schema: application/json

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 contributor is the primary contact for this publication.

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 id when present.

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 STATUS_* constants. Default is STATUS_QUEUED.

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 3. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.

Responses

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Delete a publication.

Only journal managers and subeditors can make a request to this endpoint.

path Parameters
publicationId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Create a new version of an existing publication.

path Parameters
publicationId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Publish a publication.

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.

path Parameters
publicationId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Unpublish a publication.

path Parameters
publicationId
required
integer
submissionId
required
integer

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPublished": "string",
  • "version": 0
}

Issues

Get a list of issues.

Results ar eeordered by datePublished with the most recent first.

query Parameters
count
integer

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

isPublished
boolean

Filter returned issues by those that have been published. Pass a false value to return only unpublished issues. Only administrators and journal managers are allowed to access unpublished issues.

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 count of 10 and offset of 15 will return results 15 to 25.

orderBy
string

Order the results returned. Must be one of datePublished, lastModified or seq. Default is datePublished.

orderDirection
string

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

volumes
string

Filter returned issues by those in a specific volume.

years
string

Filter returned issues by those in a specific year.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the current issue.

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "articles": [
    ],
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doi": "string",
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "isCurrent": true,
  • "lastModified": "string",
  • "number": "string",
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "title": {
    },
  • "volume": 0,
  • "year": 0
}

Get an issue by ID.

If the issue has a custom section order, the seq property of each SectionSummary will reflect the sequence for that issue.

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "articles": [
    ],
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doi": "string",
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "isCurrent": true,
  • "lastModified": "string",
  • "number": "string",
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "title": {
    },
  • "volume": 0,
  • "year": 0
}

Users

Only admins, journal editors, and subeditors can access these endpoints.

Get a list of users.

query Parameters
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 assignedToSubmission parameter exists.

count
integer

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

offset
integer

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

orderBy
string

Order the results returned. Must be one of id, familyName or givenName. Default is id.

orderDirection
string

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

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 userName, givenName, familyName, email, affiliation, biography and orcid.

status
string

Filter results by active/disabled users. Must be one of active, disabled, all. Default is active.

Responses

Response samples

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

Get a user by ID.

path Parameters
userId
required
integer

User ID

Responses

Response samples

Content type
application/json
{
  • "_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,
  • "interests": [
    ],
  • "mailingAddress": "string",
  • "mustChangePassword": true,
  • "orcid": "string",
  • "phone": "string",
  • "url": "string",
  • "userName": "string"
}

<no summary>

query Parameters
averageCompletion
integer

Filter results by those who complete a review assignment within X days on average.

count
integer

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

daysSinceLastAssignment
string

Filter results by those who's last review was assigned at least X days ago. You can also pass a range as a string formatted as X-X.

offset
integer

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

orderBy
string

Order the results returned. Must be one of id, familyName or givenName. Default is id.

orderDirection
string

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

reviewerRating
integer

Filter results by those who have an average review assignment rating of at least X (valid ratings are between 1 and 5).

reviewsActive
string

Filter results by those who have X review assignments currently in progress. You can also pass a range as a string formatted as X-X.

reviewsCompleted
string

Filter results by those who have completed at least X reviews. You can also pass a range as a string formatted as X-X.

reviewStage
integer

Filter results by reviewers for one of the review stages in the workflow. Must be one of WORKFLOW_STAGE_ID_INTERNAL_REVIEW or WORKFLOW_STAGE_ID_EXTERNAL_REVIEW. In OJS, the review stage is WORKFLOW_STAGE_ID_EXTERNAL_REVIEW.

searchPhrase
string

Filter the results by a search phrase matched against the userName, givenName, familyName, email, affiliation, biography, orcid, interests, and gossip.

status
string

Filter results by active/disabled users. Must be one of active, disabled, all. Default is active.

Responses

Response samples

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

Contexts

Only admins and journal managers can access these endpoints.

Get a list of journals.

query Parameters
count
type

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

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 name, description, acronym, or abbreviation.

Responses

Response samples

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

Create a new context (journal/press).

Request Body schema: application/json

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

languages
string

Enable languages metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

object
subjects
string

Enable subjects metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

urlPath
string

Responses

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "url": "string",
  • "urlPath": "string"
}

Get a context by ID.

path Parameters
contextId
required
integer

Context ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "url": "string",
  • "urlPath": "string"
}

Edit a context (journal/press).

path Parameters
contextId
required
integer

Context ID

Request Body schema: application/json

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

languages
string

Enable languages metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

object
subjects
string

Enable subjects metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

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. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

urlPath
string

Responses

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "url": "string",
  • "urlPath": "string"
}

Delete a context (journal/press).

path Parameters
contextId
required
integer

Context ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "string",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "citations": "string",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "copyrightHolderOther": "string",
  • "copyrightHolderType": "string",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "coverage": "string",
  • "currency": "string",
  • "customHeaders": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 2,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "disableUserReg": true,
  • "disciplines": "string",
  • "editorialTeam": {
    },
  • "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": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "request",
  • "languages": "string",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "string",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "string",
  • "styleSheet": {
    },
  • "subjects": "string",
  • "submissionChecklist": [
    ],
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "type": "string",
  • "url": "string",
  • "urlPath": "string"
}

Get a context's active theme and any theme options defined by it.

path Parameters
contextId
required
integer

Context ID

Responses

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Edit a context's (journal/press) active theme and options defined by that theme.

path Parameters
contextId
required
integer

Context ID

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Site

Only admins can access these endpoints, which should be accessed using * instead of the journal path.

Get the overall site object.

Responses

Response samples

Content type
application/json
{
  • "about": {
    },
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "installedLocales": [
    ],
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "themePluginPath": "default",
  • "title": {
    }
}

Edit a site.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "about": {
    },
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "installedLocales": [
    ],
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "themePluginPath": "default",
  • "title": {
    }
}

Response samples

Content type
application/json
{
  • "about": {
    },
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "installedLocales": [
    ],
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "themePluginPath": "default",
  • "title": {
    }
}

Get the site's active theme and any theme options defined by it.

Responses

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Edit the site's active theme and options defined by that theme.

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Email Templates

Only admins and journal managers can access these endpoints.

Get a list of email templates.

query Parameters
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 isCustom. Only completely custom templates, not a customization of a default template, will be returned when isCustom is true.

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 key, subject, body, or description.

toRoleIds
string

Filter results by email templates received by one or more role IDs. Separate role IDs with a comma.

Responses

Response samples

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

Create a new email template.

Request Body schema: application/json

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 null.

enabled
boolean

Is this email template enabled? Default is true.

key
string

A unique key for this email template.

subject
object (LocaleObject)

Key/value pairs containing data stored by locale key.

Responses

Request samples

Content type
application/json
{
  • "body": {
    },
  • "contextId": 0,
  • "enabled": true,
  • "key": "string",
  • "subject": {
    }
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "body": {
    },
  • "canDisable": true,
  • "canEdit": true,
  • "contextId": 0,
  • "description": {
    },
  • "enabled": true,
  • "fromRoleId": 0,
  • "id": 0,
  • "key": "string",
  • "subject": {
    },
  • "toRoleId": 0
}

Get an email template by its email key.

path Parameters
key
required
integer

Email template key

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "body": {
    },
  • "canDisable": true,
  • "canEdit": true,
  • "contextId": 0,
  • "description": {
    },
  • "enabled": true,
  • "fromRoleId": 0,
  • "id": 0,
  • "key": "string",
  • "subject": {
    },
  • "toRoleId": 0
}

Edit an email template.

path Parameters
key
required
integer

Email template key

Request Body schema: application/json

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 null.

enabled
boolean

Is this email template enabled? Default is true.

key
string

A unique key for this email template.

subject
object (LocaleObject)

Key/value pairs containing data stored by locale key.

Responses

Request samples

Content type
application/json
{
  • "body": {
    },
  • "contextId": 0,
  • "enabled": true,
  • "key": "string",
  • "subject": {
    }
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "body": {
    },
  • "canDisable": true,
  • "canEdit": true,
  • "contextId": 0,
  • "description": {
    },
  • "enabled": true,
  • "fromRoleId": 0,
  • "id": 0,
  • "key": "string",
  • "subject": {
    },
  • "toRoleId": 0
}

Delete an email template. Default templates that have not been modified can not be deleted.

path Parameters
key
required
integer

Email template key

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "body": {
    },
  • "canDisable": true,
  • "canEdit": true,
  • "contextId": 0,
  • "description": {
    },
  • "enabled": true,
  • "fromRoleId": 0,
  • "id": 0,
  • "key": "string",
  • "subject": {
    },
  • "toRoleId": 0
}

Delete custom templates and reset all templates to their default settings.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Statistics

Only admins and journal managers can access these endpoints.

Get statistics about editorial activity.

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.

query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get total views for a set of publications.

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.

query Parameters
count
type

How many publications to return in a single request. Default is 30. Max is 100.

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 ASC or DESC order. Default is DESC.

searchPhrase
string

Filter results by publications that match this search phrase. Searches the same submission properties as the searchPhrase parameter in the /submissions endpoint.

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total abstract views in a timeline.

Returns a monthly or daily timeline of abstract views for the publications which match the request parameters.

query 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 searchPhrase parameter in the /submissions endpoint.

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 month or day. Default is month.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total galleys views in a timeline.

Returns a monthly or daily timeline of galley views for the publications which match the request parameters.

query 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 searchPhrase parameter in the /submissions endpoint.

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 month or day. Default is month.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the total views of one publication.

Returns a publication's total views by abstract, all galleys, PDF galleys, HTML galleys and other galleys.

query Parameters
dateEnd
string

Return stats for publications before this date.

dateStart
string

Return stats for publications after this date.

Responses

Response samples

Content type
application/json
{
  • "abstractViews": 0,
  • "galleyViews": 0,
  • "pdfViews": 0,
  • "htmlViews": 0,
  • "otherViews": 0,
  • "publication": {
    }
}

Get the abstract views of one publication in a timeline.

Returns a monthly or daily timeline of abstract views for the requested publication.

query Parameters
dateEnd
string

Return stats for publications before this date.

dateStart
string

Return stats for publications after this date.

timelineInterval
string

Return a timeline by month or day. Default is month.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the galleys views of one publication in a timeline.

Returns a monthly or daily timeline of galley views for the requested publication.

query Parameters
dateEnd
string

Return stats for publications before this date.

dateStart
string

Return stats for publications after this date.

timelineInterval
string

Return a timeline by month or day. Default is month.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get statistics about users.

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.

query Parameters
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 active or disabled users. Default: active.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Vocabs

Handle controlled vocabularies like keywords and subjects. Only admins, journal managers, subeditors, assistants and authors can access these endpoints.

Get the controlled vocab entries available in this journal.

query Parameters
locale
string

The locale key, such as en_US, you want to retrieve entries for. If no locale is provided, entries will be provided in the user's current locale or fall back to the journal's primary locale.

vocab
required
string

The type of controlled vocab you want to retrieve entries for. One of CONTROLLED_VOCAB_*.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Temporary Files

A special endpoint to be used for handling file uploads. See the API Usage Guide for more information.

Responds with the appopriate headers to indicate file uploads maybe be sent, required by some file upload utilities which send a preflight request.

Responses

Upload a file to the temporary file storage area and receive a temporary file ID.

Request Body schema: application/json

Use any parameter key to upload your file. The API endpoint will retrieve the first uploaded file.

any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "id": 0
}

Backend

Private endpoints for OJS's UI. These endpoints will be less stable between versions. We discourage their use in third-party plugins or applications.

Used to save payment settings.

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.

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "paymentsEnabled": true,
  • "currency": "string",
  • "...": "string"
}

Response samples

Content type
application/json
{
  • "name": [
    ],
  • "roles": [
    ]
}

Responds with the appopriate headers to indicate file uploads maybe be sent, required by some file upload utilities which send a preflight request.

Responses

Upload a file to the user's public file directory.

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.

Request Body schema: application/json

Use the file key to upload your file.

any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "url": "string"
}

Used in submission lists.

This endpoint delivers a little bit of extra information about each submission that is used in the submissions list. This private endpoint saves a few extra HTTP requests, but it is more database-intensive for each query.

Responses