Library Service - Public

Retrieve a public library's element

get/api/v1/public/libraries/{libraryId}/elements/{elementId}

Request

  • Base URL: https://cc-libraries.adobe.io
  • URL: https://cc-libraries.adobe.io/api/v1/public/libraries/{libraryId}/elements/{elementId}
  • Auth: none declared. Required headers: x-api-key

Path parameters

libraryIdstring required

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

elementIdstring required

The ID of the requested element.

Query parameters

selectorstring

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • representations: Flattened list of assets associated with the library element.
linkIdstring

The ID associating the request with the public library landing page URL.

Headers

authorizationstring

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-keystring required

The API key assigned to your API client account when you signed up.

x-request-idstring

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

if-none-matchstring

The etag value, returns content only if the asset's etag is EXACTLY the same.

if-matchstring

The etag value, returns content only if the asset's etag is NOT the same.

x-use-cdnboolean

Set to true if the API is called from a CDN.

x-cdn-origin'melville'

Indicate which backend service should be used for a call from a CDN. Required for calls from a CDN.

Response

OK

idstring
namestring
storage_usedinteger

Storage used

created_dateinteger
modified_dateinteger
typestring
sourcestring
element_typestring[]
assetSubTypestring
_fcboolean
sourceRefstring
parent_idstring
manifest_etagstring

Changes

No recorded changes to this operation across all 6 revisions of this API.