/yade/transfers
POST
Responds YADE transfers
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
jobschedulerId |
required, string | JobScheduler Master ID | scheduler | |
transferIds |
optional; array of integers | The ids of YADE transfers | [4711] | |
compact |
optional, boolean | Response has a compact version if this parameter is true | false | |
dateFrom |
optional, string | The value has multiple formats
|
1d | |
dateTo |
optional, string | The value has multiple formats like the dateFrom parameter
|
0 | |
timeZone |
optional, string |
|
Berlin/Europe | |
operations |
optional, array | Filtered all YADE history item with operations such as
|
["COPY"] | |
states |
optional, array | Filtered all YADE transfer items with states such as
|
["SUCCESS"] | |
mandator |
optional; string | Filtered all YADE history item with the mandator | ||
sources |
optional, array | Filtered response by source host and/or protocol | [{
"host": "localhost",
"protocol": "SFTP"
}] |
|
targets |
optional, array | Filtered response by target host and/or protocol | [{
"host": "localhost"
}] |
|
hasIntervention |
optional, boolean | Filters transfers which were intervened | ||
isIntervention |
optional, boolean | Filters transfers which are interventions | ||
profiles |
optional; array | Filters all transfers by a collection of specified configuration profiles. | [
"copy-per-SFTP-from-HostA-to-HostB",
"copy-per-SFTP-from-HostA-to-HostC"
] |
|
sourceFiles |
optional, array | Filtered response by source files | [
"/path/to/source"
] |
|
targetFiles |
optional, array | Filtered response by target files | [
"/path/to/target"
] |
|
limit |
optional, integer | Restricts the number of responsed records, -1=unlimited | 5000 | 10000 |
Request