/tasks/history
POST
Task history
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
controllerId |
optional, string | Controller ID | myController | |
jobs |
optional, array[object] | Filtered response by a collection of jobs specified by its workflow path and an optional job name. If "job" is undefined then the answer contains all jobs of the specified workflow. If this parameter is specified then the parameters folders , excludeJobs , jobName and workflowPath are ignored. |
[{
"workflowPath":"/path/to/workflow",
"job":"myJob"
}] |
|
excludeJobs |
optional, array[object] | Response contains all jobs except the jobs that are specified in this collection. A job is specified by its workflow path and an optional job name. If "job" is undefined then all jobs of the specified workflow are excluded in the response. This parameter will be ignored if jobs parameter is set. |
[{
"workflowPath":"/path/to/workflow",
"job":"myJob"
}] |
|
dateFrom |
optional, string | The value has multiple formats
|
1d | |
dateTo |
optional, string | The value has multiple formats similiar to the dateFrom parameter
|
0 | |
timeZone |
optional, string |
|
Europe/Berlin | |
jobName |
optional, string | Limits result to a specified glob pattern of a Job name that supports '*' and '?' as wildcards where
|
"*test*" | |
workflowPath |
optional, string | Limits result to a specified glob pattern of a Workflow path that supports '*' and '?' as wildcards where
|
"my*Workflow" | |
folders |
optional, array[object] | Limits the result to a collection of folders | [{
"folder": "/sos",
"recursive": true
}] |
|
limit |
optional, integer | Limits the number of resulting items, -1=unlimited | 5000 | 10000 |
historyStates |
optional, array[string] contains SUCCESSFUL, FAILED and/or INCOMPLETE |
Limits result to specified states | ["SUCCESSFUL"] | |
criticalities |
optional, array[string] | Possible values are NORMAL and MINOR Only records with these criticalities are responsed |
["NORMAL"] | |
taskIds |
optional; array[integer] | The history ids of tasks If "taskIds" is specified then all other optional parameters except controllerId are ignored. |
[4711] |
Request