/task/list
- Vijayganesh Sivaprakasam
List tasks
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description | Default |
|---|---|---|---|
| integer(int64) | configuration ID to list tasks for (optional) (non-negative) |
|
| boolean | show dismissed tasks | false |
{
"params": {
"configuration_id": 1,
"show_dismissed": false
}
}Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | task/list response |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
task_list_response
Property | Type | Description |
|---|---|---|
| array of task | list of tasks |
task
Property | Type | Description |
|---|---|---|
| integer(int64) | ID of the configuration this task relates to, or 0 if the configuration has since been deleted (non-negative) |
| string | name of the configuration this task relates to |
| integer(int64) | task ID |
| string | name of the user that dismissed the task, or empty if not dismissed |
| string(date-time) | UTC time if task finished, or empty if not finished |
| array of message | messages associated with the task's execution |
| string | name of the user that initiated the task |
| string(date-time) | UTC time of task start |
| string | task state (possible values: 'In Progress', 'End', 'Failed' and 'Dismissed') |
| string | task title |
| string(date-time) | UTC time of the task last updated |
message
Property | Type | Description |
|---|---|---|
| string | message text |
| string(date-time) | time of message |
{
"error": {
"message": "string"
},
"result": {
"tasks": [
{
"configuration_id": 1,
"configuration_name": "string",
"dismissed_by": "string",
"finished": "2024-07-31T13:57:42.000123456Z",
"messages": [
{
"message": "string",
"time": "2024-07-31T13:57:42.000123456Z"
}
],
"performed_by": "string",
"started": "2024-07-31T13:57:42.000123456Z",
"state": "In Progress",
"task_id": 1,
"title": "string",
"updated": "2024-07-31T13:57:42.000123456Z"
}
]
},
"successful": true
}HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}