File: /var/www/ojs/lib/pkp/schemas/submission.json
{
"title": "Submission",
"description": "A submission to the journal or press.",
"required": [
"contextId"
],
"properties": {
"_href": {
"type": "string",
"readOnly": true,
"apiSummary": true
},
"contextId": {
"type": "integer",
"apiSummary": true
},
"currentPublicationId": {
"type": "integer",
"description": "Which publication is the latest published version.",
"apiSummary": true
},
"dateLastActivity": {
"type": "string",
"description": "The last time activity was recorded related to this submission.",
"apiSummary": true,
"validation": [
"date:Y-m-d H:i:s"
]
},
"dateSubmitted": {
"type": "string",
"apiSummary": true,
"validation": [
"date:Y-m-d H:i:s"
]
},
"id": {
"type": "integer",
"apiSummary": true
},
"lastModified": {
"type": "string",
"description": "The last time a modification was made to this submission or any of its associated objects.",
"apiSummary": true,
"validation": [
"date:Y-m-d H:i:s"
]
},
"locale": {
"type": "string",
"description": "The primary language of this submission.",
"apiSummary": true,
"validation": [
"regex:/^[a-z]{2}_[A-Z]{2}(@[a-z]{0,})?$/"
]
},
"publications": {
"type": "array",
"description": "A list of publications that have been created for this submission.",
"apiSummary": true,
"readOnly": true,
"items": {
"$ref": "#/definitions/Publication"
}
},
"reviewRounds": {
"type": "array",
"description": "A list of review rounds that have been opened for this submission.",
"readOnly": true,
"items": {
"$ref": "#/definitions/ReviewRound"
}
},
"reviewAssignments": {
"type": "array",
"description": "Information about pending and completed review assignments.",
"readOnly": "true",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"isCurrentUserAssigned": {
"type": "integer",
"readOnly": true
},
"status": {
"type": "integer",
"readOnly": true
},
"statusLabel": {
"type": "integer",
"readOnly": true
},
"dateDue": {
"type": "integer",
"validation": [
"date|Y-m-d H:i:s"
]
},
"dateResponseDue": {
"type": "integer",
"validation": [
"date|Y-m-d H:i:s"
]
},
"round": {
"type": "integer"
},
"reviewRoundId": {
"type": "integer"
}
}
}
},
"stageId": {
"type": "integer",
"description": "The stage of the editorial workflow that this submission is currently in. One of the `WORKFLOW_STAGE_` constants. Default is `WORKFLOW_STAGE_SUBMISSION`.",
"apiSummary": true,
"default": 1,
"validation": [
"min:1",
"max:5"
]
},
"stages": {
"type": "array",
"description": "Key data about the status, files and discussions of each stage.",
"readOnly": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": "string"
},
"isActiveStage": {
"type": "boolean"
},
"currentUserAssignedRoles": {
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"type": "string"
},
"statusId": {
"type": "integer"
},
"files": {
"type": "object",
"properties": {
"count": {
"type": "integer"
}
}
},
"queries": {
"type": "array",
"items": {
"id": {
"type": "integer"
},
"assocType": {
"type": "integer"
},
"assocId": {
"type": "integer"
},
"stageId": {
"type": "integer"
},
"seq": {
"type": "integer"
},
"closed": {
"type": "boolean"
}
}
}
}
}
},
"status": {
"type": "integer",
"description": "Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the `STATUS_*` constants. Default is `STATUS_QUEUED`.",
"apiSummary": true,
"default": 1,
"validation": [
"in:1,2,3,4,5"
]
},
"statusLabel": {
"type": "string",
"description": "A human-readable version of the submission's status. It will be Published, Declined, Queued (still in the workflow) or Scheduled.",
"readOnly": true,
"apiSummary": true
},
"submissionProgress": {
"type": "integer",
"description": "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.",
"apiSummary": true,
"default": 1,
"validation": [
"in:0,1,2,3,4"
]
},
"urlAuthorWorkflow": {
"type": "string",
"description": "A URL to the author's editorial workflow.",
"apiSummary": true,
"readOnly": true
},
"urlEditorialWorkflow": {
"type": "string",
"description": "A URL to the editors' and assistants' editorial workflow.",
"apiSummary": true,
"readOnly": true
},
"urlWorkflow": {
"type": "string",
"description": "A URL to the workflow most appropriate for the current user. It will match the `urlAuthorWorkflow` or `urlEditorialWorkflow.",
"apiSummary": true,
"readOnly": true
},
"urlPublished": {
"type": "string",
"description": "A URL to the current publication or where it will be published.",
"apiSummary": true,
"readOnly": true
}
}
}