Version 2.7 has not been released yet, and its documentation is a work in progress.

Download digital object endpoint

GET /api/informationobjects/<slug>/digitalobject

This endpoint will stream the content of the master digital object associated with the archival description whose slug is provided.

Note

This endpoint supports streaming locally stored online digital objects, as well as external digital objects linked via a public URI. It is not possible to stream offline digital objects with this endpoint.

To be able to query the endpoint, you will need to know the slug of the information object (aka archival description) whose digital object you wish to download. Note that the slug is included in the Browse information objects endpoint response, so you could use it to determine the slug of a particular description if needed.

Example request

curl -v -H "REST-API-Key: api-key" "https://www.example.com/api/informationobjects/test-description/digitalobject" --output sample_file.pdf

Example response

Example response is truncated and edited for readability.

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Length: 339503
Content-Description: File Transfer
Content-Transfer-Encoding: binary
Content-Disposition: attachment; filename=sample_file.pdf
Cache-Control: public, must-revalidate
Pragma: public

(file bitstream)

Back to top