URL
POST /api/v1/task/{TaskID}/run
It is also possible to start the reports with report parameters and overwrite the default values.
Example:
POST http://localhost/rs29/api/v1/tasks/1249E640-BB94-4449-88B4/run$Year=2019
Important: Normally, users (without administrator rights) can only display and execute tasks which they have created themselves (to protect sensitive files in the task actions). API user accounts are not affected by this; they can start any task as soon as the Task ID is known. However, the access rights for report templates and data sources that are required to carry out a task will still be checked.
Result
The request will run until the task is complete (Code 200) or an error has occurred.
Error codes (in addition to general error codes)
|
Status code |
Status text |
Explanation |
|
500 |
- |
Error during export. The request body consists of two lines: [TASK_PHASE] [Localized error message] TASK_PHASE is "PrepareTask", "GenerateReport", "ExecuteActions" or "Unknown" |
|
404 |
ERR_INVALID_TASK |
task not found |