Library Service

Restore Archived Elements

Changed on
post/api/v1/libraries/{libraryId}/archive

Request

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

OK

status'OK' | 'CREATED' | 'ACCEPTED' | 'NO_CONTENT' | 'MOVED_PERMANENTLY' | 'SEE_OTHER' | 'NOT_MODIFIED' | 'TEMPORARY_REDIRECT' | 'BAD_REQUEST' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'NOT_ACCEPTABLE' | 'CONFLICT' | 'GONE' | 'PRECONDITION_FAILED' | 'UNSUPPORTED_MEDIA_TYPE' | 'INTERNAL_SERVER_ERROR' | 'SERVICE_UNAVAILABLE'
messagestring

Changes