Object Retrieval By ID API
The object retrieval by ID API provides a machine interface for downloading single object metadata using and identifier.
The API endpoint is available at https://v2.sherpa.ac.uk/cgi/retrieve_by_id
Examples
- /cgi/retrieve_by_id?item-type=publication&api-key=YOUR-API-KEY&format=Json&identifier=1097-0142
- /cgi/retrieve_by_id?item-type=publication&api-key=YOUR-API-KEY&format=Json&identifier=6835
- /cgi/retrieve_by_id?item-type=publication&api-key=YOUR-API-KEY&format=Json&identifier=cancer
Parameters
| Parameter Name | Required | Description | Type |
|---|---|---|---|
| item-type | Yes | The type of object to retrieve | set('funder', 'funder_group', 'repository', 'publisher', 'publisher_policy', 'publication') |
| api-key | Yes | Your API Key, part of your Sherpa user account | API Key |
| format | Yes | The format of the output | set('Json','Ids') |
| identifier | yes | The identifier of an object. | The numeric system ID of an object, or for publications, an issn or a case-insensitive title. |
Returned Data
Note that usually the API will only return a single object, but it's possible to get more than one for certain non-unique identifiers (e.g. publication titles).
Two formats are currently supported; Ids and Json. Ids will return plain text with an object ID on each line. As JSON, an object is containing the name-value pair of 'items' and an array of objects.
{
"items" : [
{ ... },
{ ... },
{ ... },
{ ... },
{ ... }
]
}
The objects contained within the items array will be the results of your API query, and will depend on the object type requested. Please see our Metadata Schema for a full description of the fields and value types of each object.