v2

latestOpenAPI 3.0.0raw.githubusercontent.com2022-03-2110019.3 KB
Resource Identifiers

return a view of a file or subcollection component of a resource

This returns a JSON list of NERDm Component objects of type DataFile and Subcollection. This will be an empty list if there are no such components with the idenfied resource.

get/id/{dsid}/pdr:f/{filepath}

Path parameters

dsidstring required

the ARK (or reduced) identifier for the resource of interest. Note that an EDI-ID will not be resolved through this endpoint.

filepathstring required

the path to a file or subcollection within the resource

Query parameters

formatstring

the desired format of the view to return. The value is can be one of the example format names below or a MIME-type name. If not provided, the format is determined by the Accept request header and content-negotiation rules. When an Accept is not specified, the default is nerdm.

Response

the identifier and version were found and a view was returned.

string required

a description of the resource in NERDm JSON format; the object will be a NERDm Resourse type.