Asana: Allocations schemas
8 Asana schemas with complete fields and constraints.
← Allocations operations · All schemas
Get an allocation — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get an allocation — response body — data data — sdk__Allocation Response |
Referenced models: Get an allocation — response body — data data — sdk__Allocation Response
Get an allocation — response body — data data assignee
| 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 *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user or placeholder assigned to the allocation. |
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 allocation resource. |
Get an allocation — response body — data data effort, end date, gid, resource type, start date
| 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 |
start_date | string | Optional | The localized day on which the allocation starts. Format: date |
end_date | string | Optional | The localized day on which the allocation ends. Format: date |
effort | JSON | Optional | |
effort (anyOf 1) | object | Alternative | The amount of time associated with the allocation, represented as a percentage or number of hours. |
effort (anyOf 1).type | string | Optional | The units used for tracking effort on an allocation, either "hours" or "percent". Known values: hours, percent |
effort (anyOf 1).value | JSON | Optional | |
effort (anyOf 1).value (anyOf 1) | number | Alternative | The numeric effort value on the allocation. |
effort (anyOf 1).value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
effort (anyOf 2) | null | Alternative |
Get an allocation — response body — data data — Allocation Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get an allocation — response body — data data effort, end date, gid, resource type, start date |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).assignee | JSON | Optional | |
$ (allOf 2).assignee (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).assignee (allOf 2) | object | All variants apply | The user or placeholder assigned to the allocation. |
$ (allOf 2).assignee (allOf 2).name | string | Optional | The name of allocation resource. |
$ (allOf 2).created_by | Model | Optional | Expand Get users in a team — response body — data data item The user who created the allocation. |
$ (allOf 2).parent | Model | Optional | Expand Search projects in a workspace — response body — data data item The project the allocation is on. |
$ (allOf 2).resource_subtype | string | Optional | The subtype of the allocation. |
Referenced models: Get an allocation — response body — data data effort, end date, gid, resource type, start date, Search projects in a workspace — response body — data data item, Get users in a team — response body — data data item
Get an allocation — response body — data data — sdk__Allocation Response
| 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 |
start_date | string | Optional | The localized day on which the allocation starts. Format: date |
end_date | string | Optional | The localized day on which the allocation ends. Format: date |
effort | JSON | Optional | |
effort (anyOf 1) | object | Alternative | The amount of time associated with the allocation, represented as a percentage or number of hours. |
effort (anyOf 1).type | string | Optional | The units used for tracking effort on an allocation, either "hours" or "percent". Known values: hours, percent |
effort (anyOf 1).value | JSON | Optional | |
effort (anyOf 1).value (anyOf 1) | number | Alternative | The numeric effort value on the allocation. |
effort (anyOf 1).value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
effort (anyOf 2) | null | Alternative | |
assignee | Model | Optional | Expand Get an allocation — response body — data data assignee |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
parent | Model | Optional | Expand Get a rate — response body — data data parent |
resource_subtype | string | Optional | The subtype of the allocation. |
Referenced models: Get an allocation — response body — data data assignee, Get an OOO entry — response body — data data user, Get a rate — response body — data data parent
Get multiple allocations — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get an allocation — response body — data data — sdk__Allocation 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 an allocation — response body — data data — sdk__Allocation Response
Update an allocation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update an allocation — request body — body data effort, end date, gid, resource type, start date |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).assignee | string | Optional | Globally unique identifier for the user or placeholder assigned to the allocation. |
$ (allOf 2).parent | string | Optional | Globally unique identifier for the project the allocation is on. |
Referenced models: Update an allocation — request body — body data effort, end date, gid, resource type, start date
Update an allocation — request body — body data effort, end date, gid, resource type, start date
| 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 |
start_date | string | Optional | The localized day on which the allocation starts. Format: date |
end_date | string | Optional | The localized day on which the allocation ends. Format: date |
effort | JSON | Optional | |
effort (anyOf 1) | object | Alternative | The amount of time associated with the allocation, represented as a percentage or number of hours. |
effort (anyOf 1).type | string | Optional | The units used for tracking effort on an allocation, either "hours" or "percent". One of: hours, percent |
effort (anyOf 1).value | number | Optional | The numeric effort value on the allocation. |
effort (anyOf 2) | null | Alternative |