URL structure

1 https://content-service.xy-company.com/api/v1/collections/{collectionId}/contents

where {collectionId} is the ID of a folder/collection.

Supported methods and overview

DELETE ( Deprecated ) - returns an HTTP response status 200 OK only. In earlier Cocoon Data Platform versions, this endpoint used to delete the encrypted data associated with all file objects/Secure Objects contained within a folder/collection (specified by collectionId) from storage managed by the Cocoon Data Platform's Content Service.

Note: This endpoint is deprecated and should no longer be used. Instead, the deletion of all file object data within a folder (including all file object version data) from storage is now automatically handled through DELETE method requests to the following endpoints:

<access-service>/api/v1/recycle-bin/items/{itemId}

<access-service>/api/v1/organisations/{orgId}/recycle-bin/items

Detailed description

This API endpoint deletes the encrypted data associated with all file objects contained within a folder (specified by collectionId) from storage managed by the Cocoon Data Platform's Content Service.

Supported roles and conditions

This API endpoint supports requests utilizing Cocoon Data user accounts with the following roles (as described in the Organisation Administrator's Guide) and conditions:

Originator - when this user owns the folder whose ID is specified by {collectionId} in the request's URL.
Originator, Collaborator and Ad hoc - when this user is a collaborator with the Remove (Folder) permission on the file object whose ID is specified by {collectionId} in the URL.

The Cocoon Data Platform's resources available to one of these Cocoon Data users (above) is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.