changedInput schema / properties / limit / default
Previous value: -50New value: +25
changedInput schema / properties / limit / description
Previous value: -"Requested works (default 50, accepted maximum 10,000, effective maximum 1,000). Page locally with offset and nextOffset; the 64,000-byte response budget may return fewer."New value: +"Works per page. Default 25; a larger value returns at most 1,000 and says so."
changedInput schema / properties / offset / description
Previous value: -"Zero-based index of the first work to return (default 0). Combine with limit to page through the full works list."New value: +"Zero-based index of the first matching work to return (default 0). Continue with nextOffset."
addedInput schema / properties / work_types
Added value: +{
+ "description": "Keep only works of these types, matched against each workType (e.g. [\"journal-article\", \"preprint\"]; ORCID spells datasets data-set). Any listed type matches; an empty list keeps every type.",
+ "items": {
+ "description": "A work type in ORCID's vocabulary.",
+ "enum": [
+ "annotation",
+ "artistic-performance",
+ "blog-post",
+ "book-chapter",
+ "book-review",
+ "book",
+ "cartographic-material",
+ "clinical-study",
+ "conference-abstract",
+ "conference-output",
+ "conference-paper",
+ "conference-poster",
+ "conference-presentation",
+ "conference-proceedings",
+ "data-management-plan",
+ "data-set",
+ "design",
+ "dictionary-entry",
+ "disclosure",
+ "dissertation-thesis",
+ "edited-book",
+ "encyclopedia-entry",
+ "image",
+ "invention",
+ "journal-article",
+ "journal-issue",
+ "learning-object",
+ "lecture-speech",
+ "license",
+ "magazine-article",
+ "manual",
+ "moving-image",
+ "musical-composition",
+ "newsletter-article",
+ "newspaper-article",
+ "online-resource",
+ "other",
+ "patent",
+ "physical-object",
+ "preprint",
+ "registered-copyright",
+ "report",
+ "research-technique",
+ "research-tool",
+ "review",
+ "software",
+ "sound",
+ "spin-off-company",
+ "standards-and-policy",
+ "supervised-student-publication",
+ "technical-standard",
+ "test",
+ "trademark",
+ "transcription",
+ "translation",
+ "website",
+ "working-paper",
+ "undefined"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+}
addedInput schema / properties / year_from
Added value: +{
+ "description": "Keep only works published in or after this year, read from the first four digits of publicationDate. Under either year bound, works with no publication date are left out and counted in the notice.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedInput schema / properties / year_to
Added value: +{
+ "description": "Keep only works published in or before this year; not before year_from.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "orcidId",
- "orcidUri",
- "workCount",
- "returnedCount",
- "offset",
- "truncated",
- "works"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "orcidId",
+ "orcidUri",
+ "workCount",
+ "matchedCount",
+ "returnedCount",
+ "offset",
+ "truncated",
+ "works"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
addedOutput schema / properties / appliedFilters
Added value: +{
+ "additionalProperties": false,
+ "description": "The filters applied before paging, present only when one is set.",
+ "properties": {
+ "workTypes": {
+ "description": "Work types kept (work_types).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "yearFrom": {
+ "description": "Earliest publication year kept (year_from).",
+ "type": "number"
+ },
+ "yearTo": {
+ "description": "Latest publication year kept (year_to).",
+ "type": "number"
+ }
+ },
+ "type": "object"
+}
addedOutput schema / properties / matchedCount
Added value: +{
+ "description": "Works matching work_types and the year range, before offset and limit; equals workCount when no filter is set.",
+ "type": "number"
+}
changedOutput schema / properties / nextOffset / description
Previous value: -"Offset to pass on the next call to continue paging. Omitted when this response includes the final work."New value: +"Offset to pass on the next call, with the same filters, to continue paging. Omitted when this response includes the last matching work."
changedOutput schema / properties / notice / description
Previous value: -"Requested/effective limit disclosure or empty-list guidance: works may be private or not yet added."New value: +"Deprecated-iD disclosure naming the primary iD, requested/effective limit disclosure, the count of undated works a year filter left out, no-match or past-end guidance, or empty-record guidance: works may be private or not yet added."
changedOutput schema / properties / offset / description
Previous value: -"Zero-based offset applied to the full works list for this response."New value: +"Zero-based offset into the matching works applied for this response."
changedOutput schema / properties / returnedCount / description
Previous value: -"Number of works returned in this response, after applying offset, limit, and the 64,000-byte response budget."New value: +"Number of works returned in this response."
changedOutput schema / properties / truncated / description
Previous value: -"True when more works are available beyond this response, whether limit or the response budget ended the page — fetch them with nextOffset."New value: +"True when more matching works follow this page — fetch them with nextOffset."
changedOutput schema / properties / workCount / description
Previous value: -"Total works available for this ORCID iD, before offset and limit are applied."New value: +"Total works on this ORCID record, before filters, offset, and limit."
changedOutput schema / properties / works / description
Previous value: -"Works for this ORCID iD, sliced to the requested offset and limit and to the response budget."New value: +"Matching works in ORCID order, sliced to the requested offset and limit."
changedOutput schema / properties / works / items / properties / sources / items / properties / selfAsserted / description
Previous value: -"True when the asserting party (the assertion origin when recorded, otherwise the source) is the requested ORCID iD; false when a member organization or another ORCID user asserted the item."New value: +"True when the asserting party (the assertion origin when recorded, otherwise the source) is the record's ORCID iD (orcidId); false when a member organization or another ORCID user asserted the item."
changedOutput schema / properties / works / items / properties / workType / description
Previous value: -"Work type (e.g. journal-article, dataset, software, preprint)."New value: +"Work type in ORCID's vocabulary (e.g. journal-article, data-set, software, preprint), taken from the preferred version."