Getting all properties from a certain Task

Format

Method	GET
URL	/tasks/$TASK_ID
Request contents	Empty
Successful answer	Object related to this Task type
Non-successful answer	ErrorMessage Object
Unexpected answer	HTTP 500

Common fields for all Task types

Schema

task_id	String	Task's unique identifier
execution	String	Date and time when the task finished running
when	String	Date and time when the task was created
state	String	Current state. Either "running" or "completed"
result	String	Task result. Either "error", "success" or "pending"
result_msg	String	Message related to Task result
task_type	int	Integer code meaning the type of the task, with meaning 0: "unknown", 1: "guest_action", ...
task_type_str	String	Human readable code with the type of the task like "guest_create". Since 3.1.

JSON example

{
    "when": "2016-02-03 16:57:42",
    "execution": "2016-02-03 16:58:03",
    "state": "completed",
    "result": "success",
    "task_id": "86725e2d-6277-434e-84ad-4d5d174f405f",
    "result_msg": "Guest started successfuly on host flexdev01"
}

flexVDI Documentation 3.1

Getting all properties from a certain Task

Analytics

Format

Common fields for all Task types

Schema

JSON example

Related content