App directoryDocsForumMy apps

Allocations

📘

Accessing allocation endpoints

Allocations are available to all Enterprise and above customers

An allocation object represents how much of a resource (e.g. person, team) is dedicated to a specific work object (e.g. project, portfolio) over a specific period of time. The effort value of an allocation object can be a percentage or number of hours.

Allocation

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
assigneeobjectThe user who is assigned to the allocation.
assignee.gidstringGlobally unique identifier of the resource, as a string.
assignee.namestringRead-only except when same user as requester. The user’s name.
assignee.resource_typestringThe base type of this resource.
created_byobjectThe user who created the allocation.
created_by.gidstringGlobally unique identifier of the resource, as a string.
created_by.namestringRead-only except when same user as requester. The user’s name.
created_by.resource_typestringThe base type of this resource.
effortobject¦nullThe amount of time associated with the allocation, represented as a percentage or number of hours
effort.typestringThe units used for tracking effort on an allocation, either "hours" or "percent".
effort.valuenumberThe numeric effort value on the allocation.
end_datedateThe localized day on which the allocation ends.
parentobjectThe project the allocation is on.
parent.gidstringGlobally unique identifier of the resource, as a string.
parent.namestringName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
parent.resource_typestringThe base type of this resource.
resource_subtypestringThe subtype of the allocation.
start_datedateThe localized day on which the allocation starts.
{
  "data": [
    {
      "gid": "12345",
      "resource_type": "allocation",
      "resource_subtype": "project_allocation",
      "assignee": {
        "gid": "12345",
        "name": "Greg Sanchez",
        "resource_type": "user"
      },
      "parent": {
        "gid": "12345",
        "name": "Test Project",
        "resource_type": "project"
      },
      "start_date": "2019-09-14",
      "end_date": "2019-09-14",
      "created_by": {
        "gid": "12345",
        "name": "Greg Sanchez",
        "resource_type": "user"
      },
      "effort": {
        "type": "percent",
        "value": 50
      }
    }
  ]
}