Returns read-only information about the Task Planner components that are currently available on the server. The returned component IDs and example definitions can be used to assemble task definitions for the Import command.

The Definitions context does not require the Task Planner permission. The client must still be authenticated and have the Web API permission.

The following definition contexts are available:

Lists the available definition contexts.

# Request
GET /api/taskplanner/definitions HTTP/1.1
Authorization: Bearer <access_token>
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
[
  {
    "name": "triggers",
    "description": "Available trigger types and their example definitions."
  },
  {
    "name": "jobs",
    "description": "Available job types and their example definitions."
  },
  {
    "name": "series",
    "description": "Available series types and their example definitions."
  },
  {
    "name": "actions",
    "description": "Available result action types and their example definitions."
  }
]

curl -LsH "Authorization: Bearer <access_token>"          "http://127.0.0.1:9000/api/taskplanner/definitions"