Task Templates API

List task templates
Get a single task template
Create a task template
Update a task template
Fields

List task templates

List all task templates for an account:

GET /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. Filtering and pagination are available to reduce/limit the collection of task templates.

Predefined Filters

The following predefined filters are available:

/task_templates/disabled : List all disabled task templates
/task_templates/enabled : List all enabled task templates

Collection Fields

By default the following fields will appear in collections of task templates:

id sourceID subject impact category created_at updated_at

Obtain a different set of fields using the ?fields= parameter .

Filtering

Filtering is available for the following fields :

id source sourceID subject impact category created_at updated_at disabled

Sorting

By default a collection of task templates is sorted descending by id .

The following fields are accepted by the ?sort= parameter :

id sourceID subject impact category created_at updated_at times_applied

Get a single task template

GET /task_templates/:id

Response

Status: 200 OK

{
  "created_at": "2017-10-21T04:13:52-06:00",
  "category": "implementation",
  "sourceID": null,
  "updated_at": "22017-11-08T02:49:28-06:00",
  "supplier": null,
  "member": null,
  "subject": "Move desktop PC",
  "id": 329,
  "times_applied": 3,
  "planned_duration": 960,
  "planned_effort": 120,
  "required_approvals": null,
  "instructions": "Pick up the desktop PC and take it to its new location.",
  "note": null,
  "attachments": [],
  "pdf_design": null,
  "effort_class": null,
  "copy_notes_to_workflow": false,
  "assign_to_workflow_manager": false,
  "assign_to_service_owner": false,
  "assign_to_requester": false,
  "assign_to_requester_manager": false,
  "assign_to_requester_business_unit_manager": false,
  "planned_effort_workflow_manager": null,
  "planned_effort_requester": null,
  "planned_effort_requester_business_unit_manager": null,
  "planned_effort_requester_manager": null,
  "planned_effort_service_owner": null,
  "impact": null,
  "disabled": false,
  "team": {
    "id": 10,
    "name": "End-User Support, Houston"
  },
  "source": null,
  "ui_extension": null,
  "urgent": false
}

The response contains these fields .

Create a task template

POST /task_templates

When creating a new task template these fields are available.

Response

Status: 201 Created

{
  "assign_to_workflow_manager": "...",
  "...": "..."
}

The response contains all fields of the created task template and is similar to the response in Get a single task template

Update a task template

PATCH /task_templates/:id

When updating a task template these fields are available.

Response

Status: 200 OK

{
  "assign_to_workflow_manager": "...",
  "...": "..."
}

The response contains all fields of the updated task template and is similar to the response in Get a single task template

Fields

assign_to_workflow_manager

Optional boolean , default: false — The Workflow manager box is checked if a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the workflow to which the task belongs.

assign_to_requester

Optional boolean , default: false — The Requester box is checked if a new task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the workflow is being generated.

assign_to_requester_business_unit_manager

Optional boolean , default: false — The Requester’s business unit manager box is checked if a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the workflow is being generated.

assign_to_requester_manager

Optional boolean , default: false — The Requester’s manager box is checked if the manager of the requester of the first related request is to be selected in the Approver field of a new task when it is being created based on the template.

assign_to_service_owner

Optional boolean , default: false — The Service owner box is checked if a new task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the workflow that the new task is a part of.

attachments

Readonly aggregated Attachments