Folders

Restore a soft-deleted folder.

Changed on

This endpoint restores an existing folder, identified by its assetId, within the organization's ESM shared storage to an ACTIVE state. Descendants of the folder will have their states recomputed to their previous state. This operation is only permitted if the requester has appropriate write-level permissions on the folder.

NOTE:

  • Folders already in an ACTIVE state will remain ACTIVE and return 200 OK.
  • Restore operations can only be invoked on roots of DELETED trees. Restore calls made on assets in a DELETED_PARENT state will return a 409 Conflict error.
  • Descendants of this folder that were in a DELETED state prior its deletion will remain DELETED. Their respective descendants will also remain in a DELETED_PARENT or DELETED state as before.
  • Hard-deleted folders will return a 404 Not Found error.
  • If an asset with the same path already exists, the restored folder will be renamed automatically.
  • If the requester lacks the required permissions or the folder does not exist, an appropriate error response will be returned.
post/folders/{assetId}/restore

Request

  • Base URL: https://cloudstorage.adobe.io/v1
  • URL: https://cloudstorage.adobe.io/v1/folders/{assetId}/restore
  • Auth: HTTP bearer

Path parameters

assetIdstring required

A globally unique identifier for the asset

Example:urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174

The ID of the asset to get.

Headers

x-request-idstring
Example:1234567890

The X-Request-Id header is used to identify a request.
It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

Response

Success - Retrieved information about the folder

assetIdstring required

A globally unique identifier for the asset

namestring required

Human-readable name of the asset

createdDatestring date-time
modifiedDatestring date-time
createdBystring

The Unique ID for the principal in the system

modifiedBystring

The Unique ID for the principal in the system

pathstring

The path of the asset from the parent collection.

ancestorsAssetId[]

Ordered list of ancestor asset IDs (first is immediate parent).

state'active' | 'deleted' | 'deleted_parent'

Current state of the asset

assetTypestring required

Example response

{
  "assetId": "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174",
  "name": "My Asset",
  "createdDate": "2021-01-01T00:00:00Z",
  "modifiedDate": "2021-01-01T00:00:00Z",
  "createdBy": "08D81E3B665BE5640A495C2C@AdobeOrg",
  "modifiedBy": "08D81E3B665BE5640A495C2C@AdobeOrg",
  "path": "/My Project/My Folder/My Asset",
  "ancestors": [
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174",
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a175",
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a176"
  ]
}

Changes

  • 240b6278279cRevision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

  • 01600f5358e9Revision changes
    • info

      endpoint added