Project Task Templates API

List project task templates

List all project task templates for an account:

GET /project_task_templates

Response

Status: 200 OK
[
  {
    "id": 1034,
    "sourceID": null,
    "subject": "Finalize project implementation plan",
    "category": "activity",
    "created_at": "2016-12-23T05:09:04-06:00",
    "updated_at": "2016-12-23T05:09:04-06:00"
  },
  {
    "id": 805,
    "sourceID": null,
    "subject": "Approval from steering committee",
    "category": "approval",
    "created_at": "2016-12-23T05:09:04-06:00",
    "updated_at": "2016-12-23T05:09:04-06:00"
  },
  {
    "id": 371,
    "sourceID": null,
    "subject": "Project completed",
    "category": "milestone",
    "created_at": "2016-12-23T05:09:05-06:00",
    "updated_at": "2016-12-23T05:09:05-06:00"
  },
  "..."
]

The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of project task templates.

States

The following states are available:

Collection Fields

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

id sourceID subject impact category created_at updated_at

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

Sorting

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

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

id sourceID subject category created_at updated_at times_applied

Get a single project task template

GET /project_task_templates/:id

Response

Status: 200 OK
{
  "assign_to_project_manager": true,
  "assign_to_requester": false,
  "assign_to_requester_business_unit_manager": false,
  "assign_to_requester_manager": false,
  "assign_to_service_owner": false,
  "planned_effort_project_manager": 4,
  "planned_effort_requester": null,
  "planned_effort_requester_business_unit_manager": null,
  "planned_effort_requester_manager": null,
  "planned_effort_service_owner": null,
  "attachments": [

  ],
  "category": "activity",
  "copy_notes_to_project": false,
  "created_at": "2016-12-23T05:09:04-06:00",
  "disabled": false,
  "id": 1034,
  "instructions": "Be sure to include a communication plan that will keep everyone informed.",
  "note": null,
  "planned_duration": 24,
  "required_approvals": null,
  "source": null,
  "sourceID": null,
  "subject": "Finalize project implementation plan",
  "supplier": null,
  "times_applied": 28,
  "ui_extension": null,
  "updated_at": "2016-12-23T05:09:04-06:00"
}

The response contains these fields.

Create a project task template

POST /project_task_templates

When creating a new project task template these fields are available.

Response

Status: 201 Created
{
  "assign_to_project_manager": "...",
  "...": "..."
}

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

Update a project task template

PATCH /project_task_templates/:id

When updating a project task template these fields are available.

Response

Status: 200 OK
{
  "assign_to_project_manager": "...",
  "...": "..."
}

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

Fields

assign_to_project_manager
Optional boolean, default: false — The Project manager box is checked if the project manager is to be selected in the Assignees field of a new project task when it is being created based on the template.
assign_to_requester
Optional boolean, default: false — The Requester box is checked if a new project 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 project was registered.
assign_to_requester_business_unit_manager
Optional boolean, default: false — The Requester’s business unit manager box is checked if a new project 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 project was registered.
assign_to_requester_manager
Optional boolean, default: false — The Requester’s manager box is checked if a new project task that is being created based on the template is to be assigned to the manager of the project’s requester.
assign_to_service_owner
Optional boolean, default: false — The Service owner box is checked if a new project 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 project that the new project task is a part of.
category
Required enum — The Category field is used to select the category that needs to be selected in the Category field of a new project task when it is being created based on the template. Valid values are:
  • activity: Activity
  • approval: Approval
  • milestone: Milestone
copy_notes_to_project
Optional boolean, default: false — The Copy notes to project checkbox is called “Copy notes to project by default” when the project task template is in Edit mode. This box is checked when the Copy note to project box of project 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 project task template was created.
disabled
Optional boolean, default: false — The Disabled box is checked when the project task template may not be used to help register new project tasks.
id
Readonly integer — The unique ID of the project task template.
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 project 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 project task when it is being created based on the template.
planned_duration
Required integer — The Planned duration field is used to specify the number of hours that should be entered in the Planned duration field of a new project task when it is being created based on the template.
planned_effort_project_manager
Optional integer — The Planned effort field for the project manager is used to specify the number of hours that the project manager is expected to spend working on a project task that was created based on the template.
planned_effort_requester
Optional integer — The Planned effort field for the requester of the request for which the project was created is used to specify the number of hours that the requester is expected to spend working on a project task that was created based on the template.
planned_effort_requester_business_unit_manager
Optional integer — The Planned effort field for the business unit manager of the requester of the request for which the project was created is used to specify the number of hours that the requester’s business unit manager is expected to spend working on a project task that was created based on the template.
planned_effort_requester_manager
Optional integer — The Planned effort field for the manager of the requester of the request for which the project was created is used to specify the number of hours that the requester’s manager is expected to spend working on a project task that was created based on the template.
planned_effort_service_owner
Optional integer — The Planned effort field for the service owner is used to specify the number of hours that the service owner is expected to spend working on a project task that was created based on the template.
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 project 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 project 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 project task when it is being created based on the template.
times_applied
Readonly integer — The number of times the project task template is used to create a project 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 project task when it is being created based on the template.
updated_at
Readonly datetime — The date and time of the last update of the project task template. If the project task template has no updates it contains the created_at value.