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: - application/xml, application/json – TaskDefinitionListDocument
Role: _taskdefinition_read
Define new task¶
- POST /task-definition¶
Defines one or more new task.
Accepts: - application/xml, application/json – TaskDefinitionListDocument
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: - application/xml, application/json – TaskDefinitionListDocument
Role: _taskdefinition_read
Update an existing task¶
New in version 4.0.
- PUT /task-definition/{task-id}¶
Updates the task.
Accepts: - application/xml, application/json – TaskDefinitionDocument
Produces: - application/xml, application/json – TaskDefinitionDocument
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.