CHIEFSOFT\ameye
349 lines
8.9 KiB
JSON
349 lines
8.9 KiB
JSON
{
|
|
"title": "Publication",
|
|
"description": "A published version of a submission.",
|
|
"type": "object",
|
|
"required": [
|
|
"submissionId",
|
|
"version"
|
|
],
|
|
"properties": {
|
|
"_href": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"readOnly": true,
|
|
"apiSummary": true
|
|
},
|
|
"abstract": {
|
|
"type": "string",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"authors": {
|
|
"type": "array",
|
|
"description": "A list of the authors for this publication.",
|
|
"readOnly": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Author"
|
|
}
|
|
},
|
|
"authorsString": {
|
|
"type": "string",
|
|
"description": "All of the authors rendered with the appropriate separators according to the locale.",
|
|
"apiSummary": true,
|
|
"readOnly": true
|
|
},
|
|
"authorsStringIncludeInBrowse": {
|
|
"type": "string",
|
|
"description": "A list of authors that are included in publication lists, like tables of content and search results, rendered with the appropriate separators according to the locale.",
|
|
"apiSummary": true,
|
|
"readOnly": true
|
|
},
|
|
"authorsStringShort": {
|
|
"type": "string",
|
|
"description": "A shortened version of the authors rendered with the appropriate separators according to the locale.",
|
|
"apiSummary": true,
|
|
"readOnly": true
|
|
},
|
|
"categoryIds": {
|
|
"type": "array",
|
|
"apiSummary": true,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"citations": {
|
|
"type": "array",
|
|
"description": "Optional metadata that contains an array of references for works cited in this submission. References have been split and parsed from the raw text.",
|
|
"readOnly": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"citationsRaw": {
|
|
"type": "string",
|
|
"description": "Optional metadata that contains references for works cited in this submission as raw text.",
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"copyrightHolder": {
|
|
"type": "string",
|
|
"description": "The copyright statement for this publication.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"copyrightYear": {
|
|
"type": "integer",
|
|
"description": "The copyright year for this publication.",
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"coverage": {
|
|
"type": "string",
|
|
"description": "Optional metadata that usually indicates a work's location, time period or jurisdiction.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"coverImage": {
|
|
"type": "object",
|
|
"multilingual": true,
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"properties": {
|
|
"temporaryFileId": {
|
|
"type": "integer",
|
|
"writeOnly": true
|
|
},
|
|
"dateUploaded": {
|
|
"type": "string"
|
|
},
|
|
"uploadName": {
|
|
"type": "string"
|
|
},
|
|
"altText": {
|
|
"type": "string",
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"dataAvailability": {
|
|
"type": "string",
|
|
"description": "Optional metadata that describes whether the author(s) have made their data available and, if so, where readers may access it.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"datePublished": {
|
|
"type": "string",
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable",
|
|
"date_format:Y-m-d"
|
|
]
|
|
},
|
|
"disciplines": {
|
|
"type": "array",
|
|
"description": "Optional metadata that describes the submission's types of study or branches of knowledge.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"doiObject": {
|
|
"type": "object",
|
|
"description": "An object representing the DOI for this publication.",
|
|
"apiSummary": true,
|
|
"readOnly": true,
|
|
"$ref": "#/definitions/Doi"
|
|
},
|
|
"doiId": {
|
|
"type": "integer",
|
|
"description": "The ID of the DOI to assign to this publication.",
|
|
"writeOnly": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"fullTitle": {
|
|
"type": "string",
|
|
"description": "The combined prefix, title and subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
|
"multilingual": true,
|
|
"readOnly": true,
|
|
"apiSummary": true
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"readOnly": true,
|
|
"apiSummary": true
|
|
},
|
|
"keywords": {
|
|
"type": "array",
|
|
"description": "Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"description": "Optional metadata that identifies the submission's primary language.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"lastModified": {
|
|
"type": "string",
|
|
"validation": [
|
|
"date_format:Y-m-d H:i:s"
|
|
]
|
|
},
|
|
"licenseUrl": {
|
|
"type": "string",
|
|
"description": "A URL to a webpage describing the license terms for this publication.",
|
|
"validation": [
|
|
"nullable",
|
|
"url"
|
|
]
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"description": "The primary locale of the submission this publication is attached to. This locale is used as the fallback when a language is missing from a multilingual property.",
|
|
"apiSummary": true,
|
|
"readOnly": true
|
|
},
|
|
"prefix": {
|
|
"type": "string",
|
|
"description": "A prefix to be prepended to the title. In English, words such as \"The\" and \"A\" are commonly entered in the prefix instead of the title.",
|
|
"multilingual": true,
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"primaryContactId": {
|
|
"type": "integer",
|
|
"description": "Which `contributor` is the primary contact for this publication.",
|
|
"apiSummary": true
|
|
},
|
|
"pub-id::publisher-id": {
|
|
"type": "string",
|
|
"description": "A unique ID provided by the publisher. It will be used in the publication's URL path instead of the `id` when present.",
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"rights": {
|
|
"type": "string",
|
|
"description": "Optional metadata that describes any rights held over the submission.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"seq": {
|
|
"type": "integer",
|
|
"default": 0,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"description": "Optional metadata that may be an ID, such as a DOI, of another work from which the submission is derived.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"subjects": {
|
|
"type": "array",
|
|
"description": "Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"submissionId": {
|
|
"type": "integer",
|
|
"apiSummary": true
|
|
},
|
|
"subtitle": {
|
|
"type": "string",
|
|
"description": "The subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
|
"multilingual": true,
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable",
|
|
"allowable_title_html_tags",
|
|
"no_new_line"
|
|
]
|
|
},
|
|
"supportingAgencies": {
|
|
"type": "array",
|
|
"description": "Optional metadata that indicates the source of research funding or other institutional support.",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "integer",
|
|
"description": "Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the `PKPSubmission::STATUS_*` constants. Default is `PKPSubmission::STATUS_QUEUED`.",
|
|
"apiSummary": true,
|
|
"default": 1,
|
|
"validation": [
|
|
"in:1,3,4,5"
|
|
]
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"description": "The title without a prefix or subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
|
"multilingual": true,
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"nullable",
|
|
"allowable_title_html_tags",
|
|
"no_new_line"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Optional metadata that describes the type of the submission and usually matches on of the [Dublin Core Types](http://dublincore.org/documents/dcmi-type-vocabulary/#section-7-dcmi-type-vocabulary).",
|
|
"multilingual": true,
|
|
"validation": [
|
|
"nullable"
|
|
]
|
|
},
|
|
"urlPath": {
|
|
"type": "string",
|
|
"description": "An optional path to use in the URL instead of the ID.",
|
|
"validation": [
|
|
"nullable",
|
|
"regex:/^[a-zA-Z0-9]+([\\.\\-_][a-zA-Z0-9]+)*$/"
|
|
]
|
|
},
|
|
"urlPublished": {
|
|
"type": "string",
|
|
"description": "The public URL for this publication or where it will be available if it has not yet been published.",
|
|
"apiSummary": true,
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"description": "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.",
|
|
"apiSummary": true,
|
|
"validation": [
|
|
"min:1"
|
|
]
|
|
}
|
|
}
|
|
} |