TransfersResource
The following resources are part of this group:
/transfers
GET
Retrieve transfer log entries.
Parameters
name |
description |
type |
default |
limit |
Number of items to retrieve.
|
query |
|
offset |
The offset from the first returned result.
|
query |
0 |
accountOrLogin |
The account or login name.
|
query |
|
file |
The transfered file.
|
query |
|
userClass |
The user class.
|
query |
|
site |
The transfer site name.
|
query |
|
status |
The transfer status. More than one parameter is allowed.
|
query |
|
transferId |
the id of the transfer status entry It is evaluated if at least one of startTimeBefore, startTimeAfter, endTimeBefore, endTimeAfter is set.
|
query |
|
startTimeBefore |
The time before which the transfer started as RFC2822 string.
|
query |
|
startTimeAfter |
The time after which the transfer started as RFC2822 string.
|
query |
|
endTimeBefore |
The time before which the transfer ended as RFC2822 string.
|
query |
|
endTimeAfter |
The time after which the transfer ended as RFC2822 string.
|
query |
|
actionBy |
Transfer initiated by Server or Client.
|
query |
|
protocol |
The transfer protocol. More than one parameter is allowed.
|
query |
|
application |
The application name. More than one parameter is allowed.
|
query |
|
direction |
The transfer direction. More than one parameter is allowed.
|
query |
|
secure |
Secure or non-secure transfer.
|
query |
|
resubmitted |
(no documentation provided)
|
query |
|
operationIndex |
The operation index. More than one parameter is allowed.
|
query |
|
version |
(no documentation provided)
|
path |
|
Response Body
transfer The transfer log entries matching the search criteria.
/transfers/export
GET
Retrieve transfer log entries.
Parameters
name |
description |
type |
default |
accountOrLogin |
The account or login name.
|
query |
|
file |
The transfered file.
|
query |
|
userClass |
The user class.
|
query |
|
site |
The transfer site name.
|
query |
|
status |
The transfer status. More than one parameter is allowed.
|
query |
|
startTimeBefore |
The time before which the transfer started.
|
query |
|
startTimeAfter |
The time after which the transfer started.
|
query |
|
endTimeBefore |
The time before which the transfer ended.
|
query |
|
endTimeAfter |
The time after which the transfer ended.
|
query |
|
actionBy |
Transfer initiated by Server or Client.
|
query |
|
protocol |
The transfer protocol. More than one parameter is allowed.
|
query |
|
application |
The application name. More than one parameter is allowed.
|
query |
|
direction |
The transfer direction. More than one parameter is allowed.
|
query |
|
secure |
Secure or non-secure transfer.
|
query |
|
resubmitted |
(no documentation provided)
|
query |
|
operationIndex |
The operation index. More than one parameter is allowed.
|
query |
|
version |
(no documentation provided)
|
path |
|
Response Body
transfer The transfer log entries matching the search criteria.
/transfers/{transferId}
GET
Parameters
name |
description |
type |
default |
transferId |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
/transfers/{transferId}/cancel
POST
Cancel a transfer.
Parameters
name |
description |
type |
default |
transferId |
the transfer id. Base64 encoded composite id.
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
the resubmission status.
/transfers/{transferId}/mdn
GET
Parameters
name |
description |
type |
default |
transferId |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
/transfers/{transferId}/resubmit
POST
Parameters
name |
description |
type |
default |
transferId |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
/transfers/{transferId}/transferData
GET
Parameters
name |
description |
type |
default |
transferId |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
/transfers/{transferId}/mdn/verify
GET
Parameters
name |
description |
type |
default |
transferId |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)