Library Service

Retrieve a specific library

Changed on
get/api/v1/libraries/{libraryId}

Request

  • Base URL: https://cc-libraries.adobe.io
  • URL: https://cc-libraries.adobe.io/api/v1/libraries/{libraryId}
  • Auth: none declared. Required headers: authorization, 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)

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.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
libraryVersionstring

Retrieve a cached library response (if available) for the specified version. To ensure the most recent cached version, use the version, which is provided when retrieving the library list. If the cached version is unavailable for some reason, the live result will be returned. Using this parameter is optional, but is likely to provide substantially faster performance.

Headers

authorizationstring required

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.

if-none-matchstring

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

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.

Response

OK

idstring

Library Id

toolkit_idstring

Library toolkit id

namestring

Library name

storage_usedinteger

Storage used

document_idstring

Document ID

document_typestring

Document Type

creatorstring

Library creator

ownership'PRIVATE' | 'INCOMING' | 'OUTGOING' | 'DISCOVERY' | 'PUBLIC'

Library ownership type

created_dateinteger

Library created date

modified_dateinteger

Library modified date

versionstring

Library version

regionstring

Library region

library_urnstring

Library resource_urn

manifest_urnstring

Library manifest_urn

storage_pathstring
elements_countinteger
removed_elements_countinteger
searchableboolean
rawNamestring
renditionGridMissingboolean
assetSubTypestring
_fcboolean
is_searchableboolean

Library is searchable

manifest_etagstring

Changes