Return available artifact descriptors
GET {{baseUrl}}/publications/:id/artifacts?embed=page_links&startPage=84531674&maxPages=84531674
Returns a collection of ArtifactDescriptor objects, each of which describes one kind of artifact associated with this publication. Each ArtifactDescriptor provides the artifact name, its mime type(s), whether it is currently available, whether the artifact is paginated (and if it is, what the last available page index is), a 'variant path' for uniquely identifying artifacts of the same kind but with different properties (e.g. thumbnails with different dimensions) in url paths, and an object with the variant properties suitable for querying.
Note:
Be aware that artifacts with variants share common names (for example, svg
or thumbnails
) and so are only uniquely identifiable in a query with a combination of the name and variant property values. The HAL links will always uniquely identify both the ArtifactDescriptor to learn publishing status, the /artifacts/pageLinks url path for paginated artifacts, and the url path to acquire the actual published artifact itself.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
embed | string | For paginated artifacts, embed links to the content for individual pages in the corresponding descriptors. The only value for embed supported by the service is 'pageLinks' | |
startPage | number | Sets the starting page index to provide with embedded page links when the embed=pageLinks query parameter is provided. Page indexes start at 0. If not specified, the default is '0'. | |
maxPages | number | Sets the maximum number of embedded page links to provide when the embed=pageLinks query parameter is used. If not specified, all page links will be embedded. | |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":-93154958.51294933,"total":-30268410.696701407,"_embedded":{"artifacts":[{"name":"eu dolor aliqua aute","types":["laboris proident nisi ex deserunt","dolor eiu"],"available":false,"paged":false,"lastIndex":-30768884.91012992,"properties":{},"_links":{"self":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"templated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"deprecation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hreflang":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"curies":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},{"name":"sit dolore","types":["mollit laboris amet occaecat adipisicing","voluptate sit"],"available":false,"paged":false,"lastIndex":-96795477.23726451,"properties":{},"_links":{"self":{"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"templated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"deprecation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hreflang":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"curies":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}}]}}