Task: Start

Method

POST

Path

/qrs/task/{id}/start/synchronous

Description

Start a task (for example, a reload task), identified by {id}, 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.

Here is an example showing how to start a reload task using Postman.

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.

Body

-

Return value

GUID (Session ID)

Optional parameters

-