Get Tasks
Get tasks as a list. The list can be ordered and filtered, if needed. The result is paginated, returning up to 20 tasks by default.
Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/task
COPY
Query Parameters
integer
pageSize
Optional
Number of tasks to be returned. Default: 20
integer
page
Optional
The page index. Default: 1
string of array
filterKey
Optional
If filterValue is also specified, list of task keys to use for filtering
array
filterValue
Optional
If filterKey is also specified, list of task values to use for filtering
string
sortKey
Optional
The key of the task to sort by
boolean
asc
Optional
Sort the result ascending. If not defined, resulting tasks will be in chronological order, otherwise alphabetically sorted ascending (true) or descending (false).
boolean
includeAutomaticTasks
Optional
If true, the result set will include tasks which are created and run automatically.
Responses
200
List of tasks.
[
{
"id": 0,
"taskType": "string",
"subTasks": {
"subTasks": {
"canBeRestarted": false,
"name": "string",
"status": "string",
"message": {},
"nextSubTasks": {
"nextSubTasks": "string"
},
"ignoreStatus": false,
"checkpointId": 0,
"checkpointFK": 0,
"snapshots": {
"snapshots": "string"
}
}
},
"totalSnapshots": [
"string"
],
"uid": "string",
"metaProps": {
"metaProps": {}
},
"taskRef": 0,
"message": {},
"automatic": false,
"status": "string",
"environmentId": "string",
"nextTaskId": 0,
"taskName": "string",
"next_tasks": [
0
]
}
]
401
Unauthorized access
[
{
"id": 0,
"taskType": "string",
"subTasks": {
"subTasks": {
"canBeRestarted": false,
"name": "string",
"status": "string",
"message": {},
"nextSubTasks": {
"nextSubTasks": "string"
},
"ignoreStatus": false,
"checkpointId": 0,
"checkpointFK": 0,
"snapshots": {
"snapshots": "string"
}
}
},
"totalSnapshots": [
"string"
],
"uid": "string",
"metaProps": {
"metaProps": {}
},
"taskRef": 0,
"message": {},
"automatic": false,
"status": "string",
"environmentId": "string",
"nextTaskId": 0,
"taskName": "string",
"next_tasks": [
0
]
}
]