Transfers

A transfer is normally started while doing a Import using the request body.

Overview

Transfer state

A transfer can be in one of the following states.

TRANSFERRING
Data is currently being sent.
WAITING
The transfer is waiting to start.
FINISHED
All the data has been transferred.
ABORTED
The transfer has been aborted by the user.
FAILED
An error has occurred causing the transfer to fail.
FINISHED_PART
A piece of the data has been sent.

Priorities

Transfers are assigned bandwidth according to their priorities. A priority is an integer between 1 and 1000. Transfers with a higher priority value is prioritized over transfers with a lower priority value.

Managing transfers

Retrieve all transfers of a specific state

GET /transfer

Returns all transfers that are in a particular state.

Query Parameters:
 
  • state – Optional Transfer state of the transfers to retrieve. Default is “TRANSFERRING”.
Matrix Parameters:
 
  • number – Optional integer, the number of transfers to return. Default is all transfers.
  • first – Optional integer, the number of the first transfer to return. Default is 1.
Produces:
Role:

_transfer_read

Retrieve a specific transfer

GET /transfer/(transfer-id)

Retrieves a specific transfer.

Produces:
Role:

_transfer_read

Set the priority of a transfer

PUT /transfer/(transfer-id)

Sets a new priority for a specific transfer.

Query Parameters:
 
  • transferPriority – The desired priority.
Role:

_transfer_write