Skip to content

Asana: Allocations schemas

8 Asana schemas with complete fields and constraints.

← Allocations operations · All schemas

Get an allocation — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of allocation resource.

Get an allocation — response body — data data effort, end date, gid, resource type, start date

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
start_datestringOptionalThe localized day on which the allocation starts.
Format: date
end_datestringOptionalThe localized day on which the allocation ends.
Format: date
effortJSONOptional
effort (anyOf 1)objectAlternativeThe amount of time associated with the allocation, represented as a percentage or number of hours.
effort (anyOf 1).typestringOptionalThe units used for tracking effort on an allocation, either "hours" or "percent".
Known values: hours, percent
effort (anyOf 1).valueJSONOptional
effort (anyOf 1).value (anyOf 1)numberAlternativeThe numeric effort value on the allocation.
effort (anyOf 1).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effort (anyOf 2)nullAlternative

Get an allocation — response body — data data — Allocation Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get an allocation — response body — data data effort, end date, gid, resource type, start date
$ (allOf 2)objectAll variants apply
$ (allOf 2).assigneeJSONOptional
$ (allOf 2).assignee (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).assignee (allOf 2)objectAll variants applyThe user or placeholder assigned to the allocation.
$ (allOf 2).assignee (allOf 2).namestringOptionalThe name of allocation resource.
$ (allOf 2).created_byModelOptionalExpand Get users in a team — response body — data data item
The user who created the allocation.
$ (allOf 2).parentModelOptionalExpand Search projects in a workspace — response body — data data item
The project the allocation is on.
$ (allOf 2).resource_subtypestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
start_datestringOptionalThe localized day on which the allocation starts.
Format: date
end_datestringOptionalThe localized day on which the allocation ends.
Format: date
effortJSONOptional
effort (anyOf 1)objectAlternativeThe amount of time associated with the allocation, represented as a percentage or number of hours.
effort (anyOf 1).typestringOptionalThe units used for tracking effort on an allocation, either "hours" or "percent".
Known values: hours, percent
effort (anyOf 1).valueJSONOptional
effort (anyOf 1).value (anyOf 1)numberAlternativeThe numeric effort value on the allocation.
effort (anyOf 1).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effort (anyOf 2)nullAlternative
assigneeModelOptionalExpand Get an allocation — response body — data data assignee
created_byModelOptionalExpand Get an OOO entry — response body — data data user
parentModelOptionalExpand Get a rate — response body — data data parent
resource_subtypestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get an allocation — response body — data data — sdk__Allocation Response
next_pageModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update an allocation — request body — body data effort, end date, gid, resource type, start date
$ (allOf 2)objectAll variants apply
$ (allOf 2).assigneestringOptionalGlobally unique identifier for the user or placeholder assigned to the allocation.
$ (allOf 2).parentstringOptionalGlobally 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

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
start_datestringOptionalThe localized day on which the allocation starts.
Format: date
end_datestringOptionalThe localized day on which the allocation ends.
Format: date
effortJSONOptional
effort (anyOf 1)objectAlternativeThe amount of time associated with the allocation, represented as a percentage or number of hours.
effort (anyOf 1).typestringOptionalThe units used for tracking effort on an allocation, either "hours" or "percent".
One of: hours, percent
effort (anyOf 1).valuenumberOptionalThe numeric effort value on the allocation.
effort (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.