URL structure

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

where {collectionId} is the ID of a collection.

Supported methods and overview

DELETE - used to explicitly delete the encrypted data (associated with all Secure Objects contained within a collection) from storage managed by the Covata Platform's Content Service.

Note: This method takes no parameters.

Detailed description

This API endpoint deletes the encrypted data (associated with all Secure Objects contained within a collection) from storage managed by the Covata Platform's Content Service.

The collection is specified by the {collectionId} value in the URL.

Note: If you intend to delete a collection and change the state of all Secure Objects contained within the collection to Deleted, then call this API endpoint on this collection first. This avoids problems where a Covata user's actual quota differs from the quota reported by the Covata Platform (until this data is automatically deleted by the Content Service). See <access-service>/api/v1/collections/{collectionId} for more information.

Supported roles and conditions

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide), conditions and permissions (where applicable):

Originator - a Covata user with this role can call this endpoint on a collection they own.
Originator, Collaborator and Ad hoc - a Covata user with any of these roles can call this endpoint for a collection they are a collaborator on (with the Remove (Folder) permission).

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

Required headers

The appropriate access token as the Bearer token:

Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

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