Asana: Task templates schemas
10 Asana schemas with complete fields and constraints.
← Task templates operations · All schemas
Get a task template — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a task template — response body — data data — sdk__Task Template Response |
Referenced models: Get a task template — response body — data data — sdk__Task Template Response
Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).description | string | Optional | Description of the task that will be created from this template. |
$ (allOf 2).html_description | string | Optional | HTML description of the task that will be created from this template. See [rich text](/docs/rich-text#reading-rich-text). |
$ (allOf 2).memberships | array | Optional | Array of projects that the task created from this template will be added to |
$ (allOf 2).memberships[] | Model | Each item | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).relative_start_on | JSON | Optional | |
$ (allOf 2).relative_start_on (anyOf 1) | JSON | Alternative | |
$ (allOf 2).relative_start_on (anyOf 1) (anyOf 1) | integer | Alternative | The number of days after the task has been instantiated on which that the task will start |
$ (allOf 2).relative_start_on (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).relative_start_on (anyOf 2) | null | Alternative | |
$ (allOf 2).relative_due_on | JSON | Optional | |
$ (allOf 2).relative_due_on (anyOf 1) | JSON | Alternative | |
$ (allOf 2).relative_due_on (anyOf 1) (anyOf 1) | integer | Alternative | The number of days after the task has been instantiated on which that the task will be due |
$ (allOf 2).relative_due_on (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).relative_due_on (anyOf 2) | null | Alternative | |
$ (allOf 2).due_time | JSON | Optional | |
$ (allOf 2).due_time (anyOf 1) | string | Alternative | The time of day that the task will be due |
$ (allOf 2).due_time (anyOf 2) | null | Alternative | |
$ (allOf 2).dependencies | array | Optional | Array of task templates that the task created from this template will depend on |
$ (allOf 2).dependencies[] | Model | Each item | Expand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task |
$ (allOf 2).dependents | array | Optional | Array of task templates that will depend on the task created from this template |
$ (allOf 2).dependents[] | Model | Each item | Expand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task |
$ (allOf 2).followers | array | Optional | Array of users that will be added as followers to the task created from this template |
$ (allOf 2).followers[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).attachments | array | Optional | Array of attachments that will be added to the task created from this template |
$ (allOf 2).attachments[] | Model | Each item | Expand Get attachments from an object — response body — data, next page data item |
$ (allOf 2).subtasks | array | Optional | Array of subtasks that will be added to the task created from this template |
$ (allOf 2).subtasks[] | Model | Each item | Expand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task |
$ (allOf 2).custom_fields | array | Optional | Array of custom fields that will be added to the task created from this template |
$ (allOf 2).custom_fields[] | Model | Each item | Expand Get a membership — response body — data / data / access_level: admin, editor, user parent |
Referenced models: Get attachments from an object — response body — data, next page data item, Get a membership — response body — data / data / access_level: admin, editor, user parent, Search projects in a workspace — response body — data data item, Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task, Get users in a team — response body — data data item
Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Name of the task that will be created from this template. |
task_resource_subtype | string | Optional | The subtype of the task that will be created from this template. Known values: default_task, milestone_task, approval_task |
Get a task template — response body — data / data / template / task_resource_subtype: default task, milestone task, approval task attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. An *attachment* object represents any file attached to a task in Asana, whether it's an uploaded file or one associated via a third-party service such as Dropbox or Google Drive. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the file. Read only: true |
resource_subtype | string | Optional | The service hosting the attachment. Valid values are `asana`, `dropbox`, `gdrive`, `onedrive`, `box`, `vimeo`, and `external`. |
Get a task template — response body — data data gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get multiple task templates — response body — data, next page data item |
Referenced models: Get multiple task templates — response body — data, next page data item
Get a task template — response body — data data — Task Template Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task template — response body — data data gid, name, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).name | string | Optional | Name of the task template. |
$ (allOf 2).project | JSON | Optional | |
$ (allOf 2).project (anyOf 1) | JSON | Alternative | The project that this task template belongs to. |
$ (allOf 2).project (anyOf 1) (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).project (anyOf 2) | null | Alternative | |
$ (allOf 2).template | JSON | Optional | The configuration for the task that will be created from this template. |
$ (allOf 2).template (allOf 1) | Model | All variants apply | Expand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task |
$ (allOf 2).created_by | JSON | Optional | The user who created this task template. |
$ (allOf 2).created_by (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).created_at | string | Optional | The time at which this task template was created. Format: date-time |
Referenced models: Search projects in a workspace — response body — data data item, Get a task template — response body — data data gid, name, resource type, Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task, Get users in a team — response body — data data item
Get a task template — response body — data data — sdk__Task Template Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *task template* is an object that allows new tasks to be created with a predefined setup. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name of the task template. |
project | JSON | Optional | |
project (anyOf 1) | JSON | Alternative | The project that this task template belongs to. |
project (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a rate — response body — data data parent |
project (anyOf 2) | null | Alternative | |
template | JSON | Optional | The configuration for the task that will be created from this template. |
template (allOf 1) | object | All variants apply | |
template (allOf 1).name | string | Optional | Name of the task that will be created from this template. |
template (allOf 1).task_resource_subtype | string | Optional | The subtype of the task that will be created from this template. Known values: default_task, milestone_task, approval_task |
template (allOf 1).description | string | Optional | Description of the task that will be created from this template. |
template (allOf 1).html_description | string | Optional | HTML description of the task that will be created from this template. See [rich text](/docs/rich-text#reading-rich-text). |
template (allOf 1).memberships | array | Optional | Array of projects that the task created from this template will be added to |
template (allOf 1).memberships[] | Model | Each item | Expand Get a rate — response body — data data parent |
template (allOf 1).relative_start_on | JSON | Optional | |
template (allOf 1).relative_start_on (anyOf 1) | JSON | Alternative | |
template (allOf 1).relative_start_on (anyOf 1) (anyOf 1) | integer | Alternative | The number of days after the task has been instantiated on which that the task will start |
template (allOf 1).relative_start_on (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
template (allOf 1).relative_start_on (anyOf 2) | null | Alternative | |
template (allOf 1).relative_due_on | JSON | Optional | |
template (allOf 1).relative_due_on (anyOf 1) | JSON | Alternative | |
template (allOf 1).relative_due_on (anyOf 1) (anyOf 1) | integer | Alternative | The number of days after the task has been instantiated on which that the task will be due |
template (allOf 1).relative_due_on (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
template (allOf 1).relative_due_on (anyOf 2) | null | Alternative | |
template (allOf 1).due_time | JSON | Optional | |
template (allOf 1).due_time (anyOf 1) | string | Alternative | The time of day that the task will be due |
template (allOf 1).due_time (anyOf 2) | null | Alternative | |
template (allOf 1).dependencies | array | Optional | Array of task templates that the task created from this template will depend on |
template (allOf 1).dependencies[] | object | Each item | |
template (allOf 1).dependencies[].name | string | Optional | Name of the task that will be created from this template. |
template (allOf 1).dependencies[].task_resource_subtype | string | Optional | The subtype of the task that will be created from this template. Known values: default_task, milestone_task, approval_task |
template (allOf 1).dependents | array | Optional | Array of task templates that will depend on the task created from this template |
template (allOf 1).dependents[] | object | Each item | |
template (allOf 1).dependents[].name | string | Optional | Name of the task that will be created from this template. |
template (allOf 1).dependents[].task_resource_subtype | string | Optional | The subtype of the task that will be created from this template. Known values: default_task, milestone_task, approval_task |
template (allOf 1).followers | array | Optional | Array of users that will be added as followers to the task created from this template |
template (allOf 1).followers[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
template (allOf 1).attachments | array | Optional | Array of attachments that will be added to the task created from this template |
template (allOf 1).attachments[] | Model | Each item | Expand Get a task template — response body — data / data / template / task_resource_subtype: default task, milestone task, approval task attachments item |
template (allOf 1).subtasks | array | Optional | Array of subtasks that will be added to the task created from this template |
template (allOf 1).subtasks[] | object | Each item | |
template (allOf 1).subtasks[].name | string | Optional | Name of the task that will be created from this template. |
template (allOf 1).subtasks[].task_resource_subtype | string | Optional | The subtype of the task that will be created from this template. Known values: default_task, milestone_task, approval_task |
template (allOf 1).custom_fields | array | Optional | Array of custom fields that will be added to the task created from this template |
template (allOf 1).custom_fields[] | Model | Each item | Expand Get a goal — response body — data data custom fields item |
created_by | JSON | Optional | The user who created this task template. |
created_by (allOf 1) | Model | All variants apply | Expand Get an OOO entry — response body — data data user |
created_at | string | Optional | The time at which this task template was created. Format: date-time |
Referenced models: Get a task template — response body — data / data / template / task_resource_subtype: default task, milestone task, approval task attachments item, Get an OOO entry — response body — data data user, Get a goal — response body — data data custom fields item, Get a rate — response body — data data parent
Get multiple task templates — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a task template — response body — data data — sdk__Task Template Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a task template — response body — data data — sdk__Task Template Response
Get multiple task templates — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *task template* is an object that allows new tasks to be created with a predefined setup. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name of the task template. |
Instantiate a task from a task template — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the new task. If not provided, the name of the task template will be used. |