Task Templates API
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
- category
- Required enum — The Category field is used to select the category that needs to be selected in the Category field of a new task when it is being created based on the template. Valid values are:
-
risk_and_impact
: Risk & Impactapproval
: Approvalimplementation
: Implementationfulfillment_placeholder
: Fulfillment Placeholderautomation
: Automation
- copy_notes_to_workflow
- Optional boolean, default:
false
— The Copy notes to workflow checkbox is called “Copy notes to workflow by default” when the task template is in Edit mode. This box is checked when the Copy note to workflow box of tasks that were created based on the template needs to be checked by default. - created_at
- Readonly datetime — The date and time at which the task template was created.
- disabled
- Optional boolean, default:
false
— The Disabled box is checked when the task template may not be used to help register new tasks. - effort_class
- Optional reference to Effort Class — The effort class that is selected by default, when someone registers time on a task created based on the template.
- id
- Readonly integer — The unique ID of the task template.
- impact
- Optional enum — The Impact field is used to select the impact level that needs to be selected in the Impact field of a new task when it is being created based on the template. Valid values are:
-
none
: None - Service Not Degradedlow
: Low - Service Degraded for One Usermedium
: Medium - Service Down for One Userhigh
: High - Service Degraded for Several Userstop
: Top - Service Down for Several Users
- instructions
- Optional text (max 64KB) — The Instructions field is used to enter the information that needs to be copied to the Instructions field of a new task when it is being created based on the template.
- instructions_attachments
- Writeonly attachments The attachments used in the Instructions field.
- member
- Optional reference to Person — The Member field is used to select the Person who should be selected in the Member field of a new task when it is being created based on the template.
- note
- Optional text (max 64KB) — The Note field is used to enter the information that needs to be copied to the Note field of a new task when it is being created based on the template.
- note_attachments
- Writeonly attachments The inline attachments used in the Note field.
- planned_duration
- Required integer (max 600000) — The Planned duration field is used to specify the number of minutes that should be entered in the Planned duration field of a new task when it is being created based on the template.
- planned_effort
- Optional integer (max 600000) — The Planned effort field is used to specify the number of minutes the member is expected to spend working on a task that was created based on the template.
- planned_effort_workflow_manager
- Optional integer (max 600000) — The Planned effort for workflow manager field is used to specify the number of minutes the workflow manager is expected to spend working on a task that was created based on the template.
- planned_effort_requester
- Optional integer (max 600000) — The Planned effort for requester field is used to specify the number of minutes the person, who is selected in the Requested for field of the first related request, is expected to spend working on a task that was created based on the template.
- planned_effort_requester_business_unit_manager
- Optional integer (max 600000) — The Planned effort for business unit manager of requester field is used to specify the number of minutes the business unit manager of the requester of the first related request is expected to spend working on a task that was created based on the template.
- planned_effort_requester_manager
- Optional integer (max 600000) — The Planned effort for manager of requester field is used to specify the number of minutes the manager of the requester of the first related request is expected to spend working on a task that was created based on the template.
- planned_effort_service_owner
- Optional integer (max 600000) — The Planned effort for service owner field is used to specify the number of minutes the owner of the service of the related to the workflow is expected to spend working on a task that was created based on the template.
- provider_not_accountable
- Optional boolean — The Provider not accountable field value is used to indicate whether the provider is not to be accountable for the affected SLAs linked to the requests that are linked to the workflow of a task that was created based on the template, as long as the task is active.
- request_template
- Optional reference to Request Template — The Request template field is used to select the Request template that must be used to generate a new request when a task based on the task template is started.
- request_service_instance
- Optional reference to Service Instance — The Service instance field is used to select the Service instance that must be applied to the new request that is generated when a task based on the task template is started.
- required_approvals
- Optional integer, default:
1
— The Required approvals field is used to enter the number that needs to be specified in the Required approvals field of a new approval task when it is being created based on the template. - skill_pool
- Optional reference to Skill Pool — The skill pool that should be selected in the Skill pool field of a new task when it is being created based on the template.
- source
- Optional string (max 30) - See source
- sourceID
- Optional string (max 128) - See source
- subject
- Required string (max 190) — The Subject field is used to enter a short description that needs to be copied to the Subject field of a new Task when it is being created based on the template.
- supplier
- Optional reference to Organization — The Supplier field is used to select the supplier Organization that should be selected in the Supplier field of a new task when it is being created based on the template.
- team
- Optional reference to Team — The Team field is used to select the Team that should be selected in the Team field of a new task when it is being created based on the template.
- times_applied
- Readonly integer — The number of times the task template is used to create a Task.
- ui_extension
- Optional reference to UI Extension — The UI extension field is used to select the UI extension that is to be added to a new task when it is being created based on the template.
- updated_at
- Readonly datetime — The date and time of the last update of the task template. If the task template has no updates it contains the
created_at
value. - urgent
- Optional boolean, default:
false
— The Mark as urgent box is checked when a new task that is created based on the template is to be marked as urgent. - work_hours_are_24x7
- Optional boolean, default:
false
— When set to true, the completion target of tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.