This tutorial goes over editing information in the works section of an ORCID record. The work activity type is intended to link to the research outputs of the ORCID record holder.

This workflow can be used with Member API credentials on sandbox or the production servers.

Scopes: /activities/update and /read-limited

Method: 3 step OAuth

Endpoints: /work and /works

Sample XML files:

• reading the works section summary 2.1
• reading a basic work 2.1
• reading a detailed work item 2.1
• writing a work item with the minimal information 2.1
• writing a work with the detailed information 2.1
• writing multiple works 2.1
• writing multiple works in json 2.1
• reading the works section summary 3.0
• reading a basic work 3.0
• reading a detailed work item 3.0
• writing a work item with the minimal information 3.0
• writing a work with the detailed information 3.0
• writing multiple works 3.0
• writing multiple works in json 3.0

Editing the work section of a record requires a 3 step OAuth token with the /activities/update scope, the /read-limited scope should also be requested for reading works. See Authenticating using OAuth for steps to obtain a token.

• title (required) The title of the work

• subtitle (optional) A subtitle to the work

• translated-title (optional) The title the work appears under in another language, the language of the translated title is recorded as an attribute

• journal-title (optional) The name of a larger collection the work belongs to, such as a journal for journal articles or a book for book chapters

• short-description (optional) A brief description or abstract of the work

• citation-type (optional) The format the citation is provided in. This field is selected from the following list: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER

• citation-value (optional) The contents of the citation

• work-type (required) The type of object the work is. This field must be selected from the supported work types

• publication-date (optional) The date the work was completed

• external-id-type (required) The type of identifier. This field must be selected from the supported work identifiers

• external-id-value (required) The identifier itself

• external-id-url (optional) A url the identifier resolves to

• external-id-relationship (required) Identifiers that apply only to the work being added should be marked as self. Identifiers that apply to a larger collection this work belongs to should be set to part-of. Identifiers that apply to alternate versions of the work should be set to version-of. Identifiers that apply to the funding for the work should be set to funded-by.

• work-url (optional) A url linking to the work

• work-contributors (optional) Information about the individuals who created the work

• language-code (optional) The language used to describe the work in the previous fields

• country (optional) A country the work was published in or otherwise associated with

Example request in curl

Example request in curl

Example request in curl

Example request in curl

Example request in curl

Example request in curl

Example request in curl