<content-service>/api/v1/items/transfer

URL structure

https://content-service.xy-company.com/api/v1/items/transfer

Supported methods and overview

• POST - used to transfer ownership of all Secure Objects and collections (i.e. items) from one Covata user to another Covata user.

Detailed description

Note: The content in this section of the page (and after Required Headers below) is incomplete and will be completed in due course.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• User administrator

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

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required parameters

The following required parameters must be sent in the body of the POST request, as individual members of a JSON object:

• from - The ID of a disabled Covata user (with the Originator role), whose items will be transferred to another user.

• to - The ID of another (enabled) Covata user (with the Originator role) to whom these items will be transferred.

  Example ():

Optional parameters

The following optional parameter can also be sent in the body of the POST request, as an individual member of the JSON object that includes the Required parameters above:

• folderName - .

  Example ():

Returns

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