Asana · Schema

AllocationBase

A generic Asana Resource, containing a globally unique identifier.

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name Type Description
gid string Globally unique identifier of the resource, as a string.
resource_type string The base type of this resource.
start_date string The localized day on which the allocation starts.
end_date string The localized day on which the allocation ends.
effort object The amount of time associated with the allocation, represented as a percentage or number of hours
View JSON Schema on GitHub

JSON Schema

asana-allocationbase-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AllocationBase",
  "title": "AllocationBase",
  "description": "A generic Asana Resource, containing a globally unique identifier.",
  "type": "object",
  "properties": {
    "gid": {
      "description": "Globally unique identifier of the resource, as a string.",
      "type": "string",
      "readOnly": true,
      "example": "12345",
      "x-insert-after": false
    },
    "resource_type": {
      "description": "The base type of this resource.",
      "type": "string",
      "readOnly": true,
      "example": "allocation",
      "x-insert-after": "gid"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "The localized day on which the allocation starts.",
      "example": "2024-02-28"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "The localized day on which the allocation ends.",
      "example": "2024-02-28"
    },
    "effort": {
      "type": "object",
      "nullable": true,
      "description": "The amount of time associated with the allocation, represented as a percentage or number of hours",
      "properties": {
        "type": {
          "type": "string",
          "description": "The units used for tracking effort on an allocation, either \"hours\" or \"percent\".",
          "enum": [
            "hours",
            "percent"
          ]
        },
        "value": {
          "type": "number",
          "description": "The numeric effort value on the allocation.",
          "example": 50
        }
      }
    }
  }
}