Change Templates - Task Templates API

List all task templates of a change template

List all task templates of a change template with a specific ID.

GET /change_templates/:id/task_templates

Response

Status: 200 OK

[
  {
    "created_at": "2016-03-14T03:13:46-06:00",
    "category": "implementation",
    "sourceID": null,
    "updated_at": "2016-03-14T03:13:46-06:00",
    "subject": "Inform Operations that events can be ignored",
    "id": 40,
    "impact": "none",
    "disabled": false
  },
  {
    "created_at": "2016-03-14T03:13:46-06:00",
    "category": "approval",
    "sourceID": null,
    "updated_at": "2016-03-14T03:13:46-06:00",
    "subject": "Windows Server service owner approval",
    "id": 39,
    "impact": null,
    "disabled": false
  },
  "..."
]

The response contains these fields by default.

Predefined Filters

The following predefined filters are available:

/change_templates/:id/task_templates/disabled: List all disabled task templates of a change template with a specific ID
/change_templates/:id/task_templates/enabled: List all enabled task templates of a change template with a specific ID

Add a task template to a change template

Add a link between a change template with a specific ID and a task template with a specific ID.

POST /change_templates/:id/task_templates?task_template_id=:id&phase_name=:name

Response

Status: 200 OK

{
}

Update a task template linked to a change template

Update a link between a change template with a specific ID and a task template with a specific ID.

PATCH /change_templates/:id/task_templates/:task_template_aggregate_id?phase_name=:name

Response

Status: 200 OK

{
  "id": 127,
  "phase_name": "Approval",
  "task_template": {
    "id": 823,
    "subject": "CFO Approval"
  }
}

Remove a task template from a change template

Remove the link between a change template with a specific ID and a task template with a specific ID.

DELETE /change_templates/:id/task_templates/:task_template_id

Response

Status: 204 No Content

Remove all task templates from a change template

Remove all links between a change template with a specific ID and its task templates.

DELETE /change_templates/:id/task_templates

Response

Status: 204 No Content

Fields

id: Required integer — The unique ID of the relation between the change template and the task template.
phase_name: Optional string (max 50) — The Phase Name field indicates the phase of the change template that the task template is a part of.
task_template: Required reference to Task Template — The Task Template field indicates the task template that is related to the change template.