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

​

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgId}/items/transfer

​

Supported methods and overview

• POST - transfers the ownership of all file objects and folders from one Covata user to another Covata user.

​

Detailed description

​

Supported roles and conditions

• Organisation administrator - when this user is a member of the organisation specified by the {orgId} of the request’s URL.

​

Required headers

• Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

• Content-Type: application/json

​

Required parameters

• from - The ID of a Covata user (with the Originator role), whose items will be transferred to another Covata user.
• to - The ID of another Covata user (with the Originator role) to whom these items will be transferred.
  Example (request):
  {
    "from": "749419842687528960",
    "to": "750613175405441024"
  }
  

​

Optional parameters

• folderName - The name of a new folder that will be created at the root location of the Covata user (represented by to above) to whom the complete hierarchy of items (belonging to the user represented by from above) will be transferred.
  Note: If this parameter is omitted, then a new folder (like this) will automatically be created with a default name consisting of the email address of the Covata user (represented by from) followed by an underscore, followed by the current date.
• deleteUser - A boolean value that indicates whether (true) or not (false) the Covata user specified in the from field above, whose items are being transfered to another user, will be removed from the organisation.
  Example (request):
  {
    "from": "749419842687528960",
    "to": "750613175405441024",
    "folderName": "Alex's items",
    "deleteUser": true
  }
  

​

Returns