HOME

{
	"title": "Editorial Decision",
	"description": "An editorial decision such as accept, decline or request revisions.",
	"required": [
		"dateDecided",
		"decision",
		"editorId",
		"stageId",
		"submissionId"
	],
	"properties": {
		"_href": {
			"type": "string",
			"description": "The URL to this decision in the REST API.",
			"format": "uri",
			"readOnly": true,
			"apiSummary": true
		},
		"actions": {
			"type": "array",
			"description": "Optional. A list of actions to be taken with this decision, such as sending an email. Each decision supports different actions. See the request body examples for supported decision actions.",
			"writeOnly": true,
			"items": {
				"type": "object"
			}
		},
		"dateDecided": {
			"type": "string",
			"description": "The date the decision was taken.",
			"writeDisabledInApi": true,
			"apiSummary": true,
			"validation": [
				"date_format:Y-m-d H:i:s"
			]
		},
		"decision": {
			"type": "integer",
			"description": "The decision that was made. One of the `Decision::*` constants.",
			"apiSummary": true
		},
		"description": {
			"type": "string",
			"description": "A user-facing description of this decision type.",
			"apiSummary": true,
			"readOnly": true
		},
		"editorId": {
			"type": "integer",
			"description": "The user id of the editor who took the decision.",
			"writeDisabledInApi": true,
			"apiSummary": true
		},
		"id": {
			"type": "integer",
			"apiSummary": true,
            "readOnly": true
		},
		"label": {
			"type": "string",
			"description": "A short label or name for this decision type.",
			"apiSummary": true,
			"readOnly": true
		},
		"reviewRoundId": {
			"type": "integer",
			"description": "The unique id of the review round when this decision was taken. Do not include this if the decision is not recorded in a review stage. This is a globally unique id. It does not represent whether the decision was taken in the first or second round of reviews for a submission. See `round` below.",
			"apiSummary": true,
			"validation": [
				"nullable"
			]
		},
		"round": {
			"type": "integer",
			"description": "The sequential review round when this decision was taken. For example, the first, second or third round of review for this submission. Do not include this unless using `reviewRoundId`.",
			"apiSummary": true
		},
		"stageId": {
			"type": "integer",
			"description": "The workflow stage when this decision was taken. One of the `WORKFLOW_STAGE_ID_` constants.",
			"writeDisabledInApi": true,
			"apiSummary": true,
			"validation": [
				"min:1",
				"max:5"
			]
		},
		"submissionId": {
			"type": "integer",
			"description": "The decision applies to this submission.",
			"writeDisabledInApi": true,
			"apiSummary": true
		}
	}
}