Job Definition

Returns detailed information about one available job component. The example object has the JSON structure expected for this component by the Import command.

The component ID must first be obtained from the /jobs list. If no available component has the specified ID, the server returns 404 Not Found.

GET /api/taskplanner/definitions/jobs/<JobID>

REQUEST Parameter	Value Type	Description
JobID	string	Extension name of the job component, as returned by the /jobs list

RESPONSE Fields	Value Type	Description
id	string	Extension name of the component
name	string	Localized display name of the component
description	string	Localized description of the component
example	object	Example component definition for the Task Planner import/export JSON format
fields	object array	Configurable properties, including their types, keys, localized labels, defaults, choices, and conditions

For jobs, the example object can additionally contain conditionproperties. See the JSON representation of a job for its use in task definitions. The fields array describes the component's configurable properties. Every field can contain the following common values. Field types can add further values, such as selectable entries, file protocols, filters, or numeric constraints.

Field object value	Value Type	Description
conditions	object array or null	Conditions that control whether the field is visible or disabled
type	string	Input type, for example `TEXTFIELD`, `SELECT`, `BOOLEAN`, `DATE`, `TIME`, `FILE`, or `FOLDER`
key	string	Property key used in the task definition
label	string	Localized label of the field
placeholder	string or null	Placeholder shown when no value is configured
value	string or null	Default value; non-null defaults are also copied into the returned `example.properties` object
updateValuesOnChange	boolean	Whether changing this field requires the other field values to be refreshed

Example Request

# Request
GET /api/taskplanner/definitions/jobs/job.http HTTP/1.1
Authorization: Bearer <access_token>
 
# Response
HTTP/1.1 200 OK
Content-Type: application/json
 
{
  "id": "job.http",
  "name": "HTTP",
  "description": "Pings a URL or sends a PUT/POST request with result data",
  "example": {
    "id": "job.http",
    "properties": {
      "url": "https://example.com/"
    },
    "conditionproperties": null
  },
  "fields": [
    {
      "type": "TEXTFIELD",
      "key": "url",
      "label": "URL"
    }
  ]
}

Application Example

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

Job Definition

GET /api/taskplanner/definitions/jobs/<JobID>

Example Request

Application Example

{{welcome.getConfig().welcomeTitle}}

Help