URL structure

1 https://content-service.xy-company.com/api/v1/objects/{objectId}/view

where {objectId} is the ID of a file object/Secure Object.

Supported methods and overview

GET - downloads the encrypted read-only view data of a file object/Secure Object (specified by objectId) from storage via the Cocoon Data Platform's Content Service.
PUT - regenerates the read-only view of a file object (specified by objectId) based on the file object's actual data, which is also stored and managed by the Content Service.

Notes:

The PUT method take no parameters.

All methods above work with the active version of the file object (specified by objectId).

Detailed description

This API endpoint serves a number of purposes, all of which are managed by the Cocoon Data Platform's Content Service:

Downloads the encrypted read-only view data of a file object (specified by objectId) from storage.
Note: The key required to decrypt this read-only view can be obtained by calling the <access-service>/api/v1/objects/{objectId}/keys/view API endpoint.
Regenerates the read-only view of a file object (specified by objectId) based on the file object's actual data in storage.

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 - using the GET and PUT methods when this user owns the file object whose ID is specified by {objectId} in the request's URL.
Originator, Collaborator and Ad hoc - using the GET method when this user is a collaborator with the View permission on the file object whose ID is specified by {objectId} in the URL.

The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria 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...

Optional parameters

The following optional parameter can be sent in the URL of the GET request:

encoding - Specify the value base64 to download the encrypted view as Base64-encoded data. Otherwise, omit this parameter to download the encrypted view as raw/binary data. In both cases, the Content-Type in the response is application/octet-stream.

Example:
1 https://content-service.xy-company.com/api/v1/objects/987654321098765432/view?encoding=base64

Returns

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