Task: Start by name

LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

/qrs/task/start/synchronous?name={name}

Description

Start a task (for example, a reload task), identified by {name}, so that it runs on a Qlik Sense Scheduler Service (QSS). The call returns when the slave QSS starts to execute the task.

The returned session ID can be used to:

  • Poll the task while it is running. Call GET /qrs/executionsession/{id} where {id} is the session ID. If the poll does not return anything, the task did not start or has already finished (and removed the session).
  • Get the result of the task. Call GET /qrs/executionresult?filter=ExecutionId eq {id} where {id} is the session ID. The ExecutionResult entity provides information on the task (for example, the status of the task, when it started and finished, and the node on which it was running). If task retries are configured, there can be more than one execution result entity for a single session as each task retry renders a new execution result.

Information that is returned from an API request may contain references to properties and values where the meaning of the value may not be self-evident, for example, status: 2 or architecture: 0. These values typically belong to an enumeration that is associated with the entity type specified in the API request; in these cases, it may be helpful to call the /qrs/about/api/enums API to get a complete list of the enumerations, which can give you insight into the meaning of these values. See About API: Get enums.

Body

-

Return value

GUID (Session ID)

Optional parameters

-

See also: 

Did this information help you?

Can you tell us why it did not help you and how we can improve it?

Thanks for helping us improve!