Metadata Store Application
Provides an application for handling Data Object Identifier at CNES
This application provides 3 API:
- dois : DOI minting
- metadata : Registration of the associated metadata
- media : Possbility to obtain metadata in various formats and/or get automatic, direct access to an object rather than via the "landing page"
Resources
/dois
Methods
GET
Retrieves the DOI collection
available response status and representations:
STATUS 200 : Operation successful
STATUS 204 : the DOI is known to DataCite Metadata Store (MDS), but no metadata have been registered
STATUS 500 : Interface problem between Datacite and DOI-Server
POST
POST will mint new DOI if specified DOI doesn't exist. This method will attempt to update URL if you specify existing DOI. Standard domains and quota restrictions check will be performed. A Datacentre's doiQuotaUsed will be increased by 1. A new record in Datasets will be created.
request header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
acceptable request representations:
available response status and representations:
STATUS 201 : Operation successful
STATUS 400 : Validation error when defining the DOI and its landing page
STATUS 412 : metadata must be uploaded first
STATUS 500 : Interface problem between Datacite and DOI-Server
STATUS 401 : Fail to authorize the user
STATUS 403 : Forbidden to use this role
STATUS 403 : User is not allowed to make this operation
STATUS 409 : Error when an user is associated to more than one role without setting selectedRole parameter
/dois/{doiName}
Methods
GET
Get the landing page related to a given DOI
request template parameters
| parameter |
value |
description |
|
doiName
|
string
(required)
|
DOI name
|
available response status and representations:
STATUS 200 : Operation successful
STATUS 204 : the DOI is known to DataCite Metadata Store (MDS), but no metadata have been registered
STATUS 400 : Character or prefix not allowed in the DOI
STATUS 404 : DOI does not exist in our database
STATUS 500 : Interface problem between Datacite and DOI-Server
/metadata
Methods
POST
This request stores new version of metadata. The request body must contain a valid XML.
request header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
acceptable request representations:
available response status and representations:
STATUS 201 : Operation successful
STATUS 400 : Failed to validate the user inputs parameters
STATUS 500 : Interface problem between Datacite and DOI-Server
STATUS 1001 : Cannot access to Datacite
STATUS 401 : Fail to authorize the user
STATUS 403 : Forbidden to use this role
STATUS 403 : User is not allowed to make this operation
STATUS 409 : Error when an user is associated to more than one role without setting selectedRole parameter
/metadata/{doiName}
Methods
DELETE
Delete a specific metadata
request template parameters
| parameter |
value |
description |
|
doiName
|
string
(required)
|
DOI name
|
request header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
available response status and representations:
STATUS 200 : Operation successful
STATUS 404 : DOI does not exist in our database
STATUS 500 : Interface problem between Datacite and DOI-Server
STATUS 401 : Fail to authorize the user
STATUS 403 : Forbidden to use this role
STATUS 403 : User is not allowed to make this operation
STATUS 409 : Error when an user is associated to more than one role without setting selectedRole parameter
GET
Get a specific metadata
request template parameters
| parameter |
value |
description |
|
doiName
|
string
(required)
|
DOI name
|
available response status and representations:
STATUS 200 : Operation successful
STATUS 404 : DOI does not exist in our database
STATUS 410 : the requested dataset was marked inactive (using DELETE method)
STATUS 500 : Interface problem between Datacite and DOI-Server
/media/{doiName}
Methods
GET
Get a specific media for a given DOI
request template parameters
| parameter |
value |
description |
|
doiName
|
string
(required)
|
DOI name
|
available response status and representations:
STATUS 200 : Operation successful
STATUS 404 : DOI does not exist in our database
STATUS 500 : Interface problem between Datacite and DOI-Server
POST
POST will add/update media type/urls pairs to a DOI. Standard domain restrictions check will be performed.
request header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
acceptable request representations:
available response status and representations:
STATUS 200 : Operation successful
STATUS 400 : DOI not provided or one or more of the specified mime-types or urls are invalid (e.g. non supported mime-type, not allowed url domain, etc.)
STATUS 500 : Interface problem between Datacite and DOI-Server
STATUS 401 : Fail to authorize the user
STATUS 403 : Forbidden to use this role
STATUS 403 : User is not allowed to make this operation
STATUS 409 : Error when an user is associated to more than one role without setting selectedRole parameter
Representations
DOI collection representation (text/uri-list)
This request returns a list of all DOIs for the requesting datacentre. There is no guaranteed order.
Empty representation (text/plain)
No contain
application/x-www-form-urlencoded
plain parameters
| parameter |
value |
description |
|
doi
|
string
(required)
|
DOI name
|
|
url
|
string
(required)
|
URL of the landing page
|
header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
Explain representation (text/plain)
short explanation of status code e.g. CREATED, HANDLE_ALREADY_EXISTS etc
Body representation (text/plain - )
short explanation of status code
short explanation of status code
short explanation of status code
DOI Representation (text/plain)
This request returns an URL associated with a given DOI.
DataCite metadata
XML Schema
Source:
header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|
Media representation (text/plain)
This request returns a key-value list of media types/urls for a given DOI name
application/x-www-form-urlencoded
plain parameters
| parameter |
value |
description |
|
{mediaType}
|
string
(repeating)
Fixed: {url}
|
(key/value) = (mediaType/url)
|
header parameters
| parameter |
value |
description |
|
selectedRole
|
string
|
A user can select one role when he is associated to several roles
|