UserTransfersResource
The following resources are part of this group:
- /transfers
- /transfers/folder-monitor
- /transfers/pull
- /transfers/push
- /transfers/{transferId}
- /transfers/{transferId}/mdn
- /transfers/{transferId}/transferData
- /transfers/{transferId}/mdn/verify
/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 |
| file | The transfered file. | 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. | 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
| element: | transferEntries |
transfer The transfer log entries matching the search criteria.
/transfers/folder-monitor
POST
Initiate a folder monitor transfer.
Parameters
| name | description | type | default |
|---|---|---|---|
| version | (no documentation provided) | path |
Request Body
| element: | monitoredFolder |
the folder monitor request entity
Response Body
| element: | transferResult |
the transfer result.
/transfers/pull
POST
Pull files from a given site.
Parameters
| name | description | type | default |
|---|---|---|---|
| version | (no documentation provided) | path |
Request Body
| element: | transferPull |
server pull entity.
Response Body
| element: | (custom) |
If synchronous, the status of the transfer operation. Otherwise the operation index of the transfer.
/transfers/push
POST
Push a file to a given site.
Parameters
| name | description | type | default |
|---|---|---|---|
| version | (no documentation provided) | path |
Request Body
| element: | transferPush |
server push entity.
Response Body
| element: | (custom) |
If synchronous, the status of the transfer operation. Otherwise the operation index of the transfer.
/transfers/{transferId}
GET
Return a specific transfer log entry.
Parameters
| name | description | type | default |
|---|---|---|---|
| transferId | the transfer log id | path | |
| version | (no documentation provided) | path |
Response Body
| element: | transferLogDetails |
transfer log entry
/transfers/{transferId}/mdn
GET
Get the transfer receipt for a transfer id.
Parameters
| name | description | type | default |
|---|---|---|---|
| transferId | the transfer id | path | |
| version | (no documentation provided) | path |
Response Body
| element: | transferData |
the transfer receipt
/transfers/{transferId}/transferData
GET
Get all transfer data for a given transfer.
Parameters
| name | description | type | default |
|---|---|---|---|
| transferId | the id of the transfer | path | |
| version | (no documentation provided) | path |
Response Body
| element: | transferDataEntries |
all transfer data for a transfer
/transfers/{transferId}/mdn/verify
GET
Verify transfer receipt for a given transfer id.
Parameters
| name | description | type | default |
|---|---|---|---|
| transferId | the id of the transfer to verify | path | |
| version | (no documentation provided) | path |
Response Body
| element: | receiptVerificationResult |
the receipt verification result