Back to AsanaGet A Time Period
Returns the full record for a single time period.
Input
type: object
properties:
parameters:
type: object
properties:
time_period_gid:
type: string
description: Globally unique identifier for the time period.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- time_period_gid
title: Parameters
Output
type: object
properties:
data:
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: task
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-14T00:00:00.000Z'
start_on:
type: string
description: The localized start date of the time period in `YYYY-MM-DD` format.
example: '2019-09-13T00:00:00.000Z'
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
parent:
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: task
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-14T00:00:00.000Z'
start_on:
type: string
description: >-
The localized start date of the time period in `YYYY-MM-DD`
format.
example: '2019-09-13T00:00:00.000Z'
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