List tasks

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property	Type	Description	Default
`configuration_id`	integer(int64)	configuration ID to list tasks for (optional) (non-negative)
`show_hidden`	boolean	show dismissed tasks	false

{
    "params": {
        "configuration_id": 1,
        "show_hidden": false
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`result`	object of type `task_list_response`	task/list response
`successful`	boolean	response with error or not

error_response

Property	Type	Description
`message`	string	error message

task_list_response

Property	Type	Description
`tasks`	array of task	list of tasks

task

Property	Type	Description
`configuration_id`	integer(int64)	ID of the configuration this task relates to, or 0 if the configuration has since been deleted (non-negative)
`configuration_name`	string	name of the configuration this task relates to
`task_id`	integer(int64)	task ID
`hidden_by`	string	name of the user that dismissed the task, or empty if not dismissed
`finished`	string(date-time)	UTC time if task finished, or empty if not finished
`messages`	array of message	messages associated with the task's execution
`performed_by`	string	name of the user that initiated the task
`started`	string(date-time)	UTC time of task start
`state`	string	task state (possible values: 'In Progress', 'End', 'Failed' and 'Dismissed')
`title`	string	task title
`updated`	string(date-time)	UTC time of the task last updated

message

Property	Type	Description
`message`	string	message text
`time`	string(date-time)	time of message

{
    "error": {
        "message": "string"
    },
    "result": {
        "tasks": [
            {
                "configuration_id": 1,
                "configuration_name": "string",
                "hidden_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
`error`	object of type `error_response`	error response
`successful`	boolean	always false

error_response

Property	Type	Description
`message`	string	error message

{
    "error": {
        "message": "string"
    },
    "successful": false
}

We're here to help!

/task/list

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments