Task definitions

Jobs are made up of a number of tasks that execute in a specific order.

Task definitions

Retrieve task definitions

GET /task-definition

Retrieves all tasks that have been defined in the system.

Query Parameters:
 
  • type – Optional Job types to retrieve task definitions for.
Produces:
Role:

_taskdefinition_read

Define new task

POST /task-definition

Defines one or more new task.

Accepts:
Produces:
  • application/xml, application/json
    schema:URIListType
Role:

_taskdefinition_write

Retrieve a task

GET /task-definition/{task-id}

Retrieves the definition document for a task with a specific id.

Produces:
Role:

_taskdefinition_read

Delete a task

DELETE /task-definition/{task-id}

Deletes the task.

Role:_taskdefinition_write

Update an existing task

New in version 4.0.

PUT /task-definition/{task-id}

Updates the task.

Accepts:
Produces:
Role:

_taskdefinition_write

Job graphs

In order to easily see the dependencies between steps for a particular job type, there is functionality to render the job definition as a graph. In order to render the graph, the Graphviz package is required.

Get job graph

GET /task-definition/jobtype/(jobtype)/graph

Shows the dependencies of the tasks of a specified Job types.

Produces:
  • image/png
Role:

_administrator

Get job graph as DOT file

GET /task-definition/jobtype/(jobtype)/graph/dot

Shows the dependencies of the tasks of a specified job type in DOT format, for further processing.

Produces:
  • text/plain
Role:

_administrator