Asana: Custom types schemas
7 Asana schemas with complete fields and constraints.
← Custom types operations · All schemas
Get a custom type — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a custom type — response body — data data — sdk__Custom Type Response |
Referenced models: Get a custom type — response body — data data — sdk__Custom Type Response
Get a custom type — response body — data data asana created type identifier, gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p> Custom Types extend the types of Asana Objects. |
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 custom type. |
asana_created_type_identifier | JSON | Optional | |
asana_created_type_identifier (anyOf 1) | string | Alternative | *Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values. Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE Read only: true |
asana_created_type_identifier (anyOf 2) | null | Alternative |
Get a custom type — response body — data data status options The available options for the custom type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
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 custom type status option. |
completion_state | JSON | Optional | |
completion_state (anyOf 1) | string | Alternative | The completion state the custom type status option corresponds to, all custom types must have one ‘Incomplete’ and ‘Complete’ status option. |
completion_state (anyOf 2) | null | Alternative | |
enabled | JSON | Optional | |
enabled (anyOf 1) | boolean | Alternative | Whether or not the custom type status option is a selectable value for the custom type. |
enabled (anyOf 2) | null | Alternative | |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | The color associated with the custom type status option. Defaults to ‘none’. |
color (anyOf 2) | null | Alternative |
Get a custom type — response body — data data status options status options The available options for the custom type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).completion_state | JSON | Optional | |
$ (allOf 2).completion_state (anyOf 1) | string | Alternative | The completion state the custom type status option corresponds to, all custom types must have one ‘Incomplete’ and ‘Complete’ status option. |
$ (allOf 2).completion_state (anyOf 2) | null | Alternative | |
$ (allOf 2).enabled | JSON | Optional | |
$ (allOf 2).enabled (anyOf 1) | boolean | Alternative | Whether or not the custom type status option is a selectable value for the custom type. |
$ (allOf 2).enabled (anyOf 2) | null | Alternative | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | The color associated with the custom type status option. Defaults to ‘none’. |
$ (allOf 2).color (anyOf 2) | null | Alternative |
Get a custom type — response body — data data — Custom Type Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a custom type — response body — data data asana created type identifier, gid, name, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).status_options | JSON | Optional | |
$ (allOf 2).status_options (anyOf 1) | array | Alternative | The available options for the custom type. |
$ (allOf 2).status_options (anyOf 1)[] | Model | Each item | Expand Get a custom type — response body — data data status options status options The available options for the custom type item |
$ (allOf 2).status_options (anyOf 2) | null | Alternative |
Referenced models: Get a custom type — response body — data data status options status options The available options for the custom type item, Get a custom type — response body — data data asana created type identifier, gid, name, resource type
Get a custom type — response body — data data — sdk__Custom Type 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. Custom Types extend the types of Asana Objects. |
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 custom type. |
asana_created_type_identifier | JSON | Optional | |
asana_created_type_identifier (anyOf 1) | string | Alternative | *Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values. Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE Read only: true |
asana_created_type_identifier (anyOf 2) | null | Alternative | |
status_options | JSON | Optional | |
status_options (anyOf 1) | array | Alternative | The available options for the custom type. |
status_options (anyOf 1)[] | Model | Each item | Expand Get a custom type — response body — data data status options The available options for the custom type item |
status_options (anyOf 2) | null | Alternative |
Referenced models: Get a custom type — response body — data data status options The available options for the custom type item
Get all custom types associated with an object — 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 custom type — response body — data data — sdk__Custom Type 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 custom type — response body — data data — sdk__Custom Type Response