Asana · Schema

TimePeriodCompact

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.
end_on	string	The localized end date of the time period in `YYYY-MM-DD` format.
start_on	string	The localized start date of the time period in `YYYY-MM-DD` format.
period	string	The cadence and index of the time period. The value is one of: `FY`, `H1`, `H2`, `Q1`, `Q2`, `Q3`, or `Q4`.
display_name	string	A string representing the cadence code and the fiscal year.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TimePeriodCompact",
  "title": "TimePeriodCompact",
  "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": "time_period",
      "x-insert-after": "gid"
    },
    "end_on": {
      "type": "string",
      "description": "The localized end date of the time period in `YYYY-MM-DD` format.",
      "example": "2019-09-14"
    },
    "start_on": {
      "type": "string",
      "description": "The localized start date of the time period in `YYYY-MM-DD` format.",
      "example": "2019-09-13"
    },
    "period": {
      "type": "string",
      "description": "The cadence and index of the time period. The value is one of: `FY`, `H1`, `H2`, `Q1`, `Q2`, `Q3`, or `Q4`.",
      "enum": [
        "FY",
        "H1",
        "H2",
        "Q1",
        "Q2",
        "Q3",
        "Q4"
      ],
      "example": "Q1"
    },
    "display_name": {
      "type": "string",
      "description": "A string representing the cadence code and the fiscal year.",
      "example": "Q1 FY22"
    }
  }
}