Library Service

Create, copy, or move elements

Changed on

Create a new element, or copy/move existing elements.

Create Element Create a single element. All elements require at least one asset-based or literal representation. When creating a new asset-based element (ex: images, thumbnails, video), upload the asset(s) BEFORE creating the element. Use the response(s) from the Upload Asset API call(s) as objects in the representations array when using this API to create a new element.

Move Elements Move one or more elements, which means delete it from its current location and create it in the target library (indicated by this API's libraryId path param). To move an element, use the self object in the request body of this API call.

  • elements: Array of element(s) to move, specified by Element ID ex. `{"id":"<elementId>"}.
  • id: The library where the element(s) currently exist, specified by Library URN.

Copy Elements Copy one or more elements, which means leave the original element untouched and create a copy of it in the target library (indicated by this API's libraryId path param). To copy an element, use the source object in the request body of this API call.

  • elements: Array of element(s) to move, specified by Element ID ex. `{"id":"<elementId>"}.
    • optionally provide a new name for the new element ex. `{"id":"<elementId>", "name":"<new name>", "description":"description"}.
  • id: The library where the element(s) currently exist, specified by Library URN. If the source Library ID is the same as the target library, the element(s) will be duplicated.
post/api/v1/libraries/{libraryId}/elements

Request

  • Base URL: https://cc-libraries.adobe.io
  • URL: https://cc-libraries.adobe.io/api/v1/libraries/{libraryId}/elements
  • 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)

invocation_modestring required

Specifies the processing mode to invoke this request process with.

Possible Values

  • sync: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout.
  • async: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion.
  • sync,async: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete.

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.

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.

Request body

idstring

Ignored if submitted. The result will have a different ID.

descriptionstring

Description of new element

namestring required

Display name for new element

typestring required

Element type

sourceRefstring

Reference other content as inspiration for this element

Example request

{
  "source": {
    "elements": [
      {
        "id": "b8038ad3-c41e-4f9e-a7c3-96bb475ff8ef",
        "name": "new element",
        "description": "This is my favorite element."
      }
    ]
  },
  "self": {
    "elements": [
      {
        "id": "b8038ad3-c41e-4f9e-a7c3-96bb475ff8ef",
        "name": "new element",
        "description": "This is my favorite element."
      }
    ]
  }
}

Response

successful operation

total_countinteger

Total results for query

Changes