Project Templates are sets of tasks and attributes that can be applied to new or existing projects. A single template can be used on any number of projects. A project template's tasks are all stored in an attribute located on the project template object called raw_json. It is a JSON hash of all the stories that has been turned into a string and is stored on the object.
A project template's tasks are all stored in an attribute located on the project template object called raw_json. It is a JSON hash of all the stories that has been turned into a string and is stored on the object.
Stories within the JSON have the following attributes:
title
- The title of the task.
billable
- The title of the project template.
relative_start_date
- An integer that represents the start day of the task relative to the start of the project.
relative_due_date
- An integer that represents the end day of the task relative to the start of the project.
duration
- The number of days the task will take to complete.
temp_id
- The unique reference ID for the task (used for dependencies).
description
- The task description.
budget_estimate_in_cents
- An integer (whole number) that represents the budget estimate, in cents, for the task.
time_estimate_in_minutes
- An integer (whole number) that represents the time estimate, in minutes, for the task.
sub_stories
- An nested array of sub-tasks that have the same structure as tasks.
checklist
- An array of strings, each being a checklist item on the task.
For example, "checklist":["item one", "item two"].
tag_list
- A string with tags that are comma separated.
For example, "design, engineering, this has spaces."
This creates three tags: "design", "engineering", and "this has spaces."
assignments
- An array of objects with key value pairs "assignee_id":id.
For example, [{"assignee_id":100},{"assignee_id":101}]
This task would have two resources assigned to it. These are the IDs of two associated project template assignments.
Project template assignments are associated objects.
dependencies
- An array of objects that represent a task's dependencies.
A dependency is an object that connects two tasks, and is used in Gantt charts. A dependency object lives
in the dependencies array on it's source task, not it's target.
Dependencies have the following attributes:
source_id
- The temporary ID of the first task (source task) in the dependency.target_id
- The temporary ID of the second task (target task) in the dependency.type
- There are four types of dependencies, numbered zero through three.lag
- An integer that represents the number of days delay that occurs between the two tasks in the dependency.raw_json example:
[ { "story_type":"task", "billable":true, "relative_start_date":1, "relative_due_date":2, "title":"Task One", "temp_id":1, "dependencies":[{"source_id":1, "target_id":2, "type":2, "lag":0}], "description":"this is a task", "assignments":[{"assignee_id":"26"}], "tag_list":"difficult,easy", "budget_estimate_in_cents":40000, "time_estimate_in_minutes":1200, "sub_stories": [ { "story_type":"task", "billable":true, "due_date":nil, "start_date":nil, "relative_start_date":1, "relative_due_date":3, "title":"Sub Task One", "description":"this is a sub task", "assignments":[{"assignee_id":"27"}], "budget_estimate_in_cents":20000, "time_estimate_in_minutes":300, "temp_id":3 } ] }, { "story_type":"deliverable", "billable":true, "endDay":4, "relative_start_date":1, "relative_due_date":4, "title":"Deliverable One", "temp_id":2, "description":"this is a deliverable", "sub_stories":[] }, { "story_type":"milestone", "billable":true, "title":"Milestone One", "description":"this is a milestone", "weight":100, "duration":0, "relative_start_date":5, "sub_stories":[], "checklist":["item one", "item two"], "temp_id":4 } ]
.
This endpoint returns structured Project Template objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the project_templates
top-level JSON key.
Please see our Response Format section for more information.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "project_templates": {
- "property1": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "project_template_assignments": {
- "property1": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}, - "property2": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}
}, - "project_template_additional_tabs": {
- "property1": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}, - "property2": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}
}
}
This endpoint returns structured Project Template objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the project_templates
top-level JSON key.
Please see our Response Format section for more information.
{- "project_template": {
- "title": "string",
- "sharing": "private_template",
- "is_budgeted": true,
- "budget": 0,
- "duration": 0,
- "currency": "string",
- "description": "string",
- "raw_json": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "project_templates": {
- "property1": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "project_template_assignments": {
- "property1": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}, - "property2": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}
}, - "project_template_additional_tabs": {
- "property1": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}, - "property2": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}
}
}
This endpoint returns structured Project Template objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the project_templates
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "project_templates": {
- "property1": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "project_template_assignments": {
- "property1": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}, - "property2": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}
}, - "project_template_additional_tabs": {
- "property1": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}, - "property2": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}
}
}
This endpoint returns structured Project Template objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the project_templates
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
object | |||||||||||||||||
|
{- "project_template": {
- "title": "string",
- "sharing": "private_template",
- "is_budgeted": true,
- "budget": 0,
- "duration": 0,
- "currency": "string",
- "description": "string",
- "raw_json": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "project_templates": {
- "property1": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "budget": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "duration": 0,
- "is_budgeted": true,
- "item_count": 0,
- "permissions": {
- "can_edit_project_template": true
}, - "project_template_additional_tab_ids": [
- "string"
], - "project_template_assignment_ids": [
- "string"
], - "raw_json": "string",
- "shared": true,
- "sharing": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "manager_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "project_template_assignments": {
- "property1": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}, - "property2": {
- "name": "string",
- "project_template_id": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "total_count": 0,
- "total_estimated_minutes": 0
}
}, - "project_template_additional_tabs": {
- "property1": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}, - "property2": {
- "associated_tab_id": 0,
- "project_template_id": 0,
- "tab_type": "string"
}
}
}
The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.
Project Template has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}