Task Planner
The Task Planner Web API is an interface to access information about existing tasks. It also provides possibility to perform operations on available tasks.
Requests have to be sent as HTTP requests with the scheme https://[HOST]:[PORT]/api/taskplanner/[Command]. To access the Task Planner Web API a user has to have the required permissions - which have to be set in the configuration manager. All clients have to be authenticated in order to use the API.
Note: All commands except the Definitions context require both the Web API and Task Planner permissions. The read-only Definitions context requires only the Web API permission. All clients must be authenticated.
Features
The Task Planner Web API exposes the following features:
-
Listing tasks created by a user
-
Listing all available tasks
-
Activating and deactivating tasks
-
Executing tasks
-
Deleting tasks
-
Returning detailed information about settings of a task and its execution history
-
Discovering available triggers, jobs, series, and result actions with example task definitions
Commands
The following commands are available for the Task Planner Web API:
| Command | Description |
|---|---|
| /list | Lists tasks created by a user |
| /list/all | Lists all available tasks |
| /export | Export tasks created by a user |
| /export/all | Export all available tasks |
| /import | Import tasks (single or multiple) |
| /execute | On-off execution of a single task definition using JSON |
| /definitions | Lists available Task Planner components and example definitions |
| /<TaskID> | Returns detailed information about settings of a task and its execution history |
| /<TaskID>/activate | Activates a task |
| /<TaskID>/deactivate | Deactivates a task |
| /<TaskID>/execute | Schedules immediate execution of a task |
| /<TaskID>/import | Import a single task |
| /<TaskID>/delete | Deletes a task |
© Copyright 1996 - 2026, i-net software GmbH; All rights Reserved. Imprint
