Information noteLOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.
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 an executionsession ID when the task has successfully started. If the call returns an empty GUID ( 00000000-0000-0000-0000-000000000000 ), the task did not start, for example, it is disabled or there is no scheduler to perform the reload or the app is not available.
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. The current state of execution is returned. If the poll returns 404 Not Found, execution of the task has finished and the executionsession entity has been automatically deleted from the database.
- 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 noteInformation 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
-