Skip to content

Latest commit

 

History

History
120 lines (87 loc) · 5.37 KB

TimePeriodsApi.md

File metadata and controls

120 lines (87 loc) · 5.37 KB
Raw

asana.TimePeriodsApi

All URIs are relative to https://app.asana.com/api/1.0

Method HTTP request Description
get_time_period GET /time_periods/{time_period_gid} Get a time period
get_time_periods GET /time_periods Get time periods

get_time_period

Get a time period

Returns the full record for a single time period.

(more information)

Example

import asana
from asana.rest import ApiException
from pprint import pprint

configuration = asana.Configuration()
configuration.access_token = '<YOUR_ACCESS_TOKEN>'
api_client = asana.ApiClient(configuration)

# create an instance of the API class
time_periods_api_instance = asana.TimePeriodsApi(api_client)
time_period_gid = "917392" # str | Globally unique identifier for the time period.
opts = {
    'opt_fields': "display_name,end_on,parent,parent.display_name,parent.end_on,parent.period,parent.start_on,period,start_on", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
}

try:
    # Get a time period
    api_response = time_periods_api_instance.get_time_period(time_period_gid, opts)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimePeriodsApi->get_time_period: %s\n" % e)

Parameters

Name Type Description Notes
time_period_gid str Globally unique identifier for the time period.
opt_fields Dict This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. [optional]

Return type

dict

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8

[Back to top] [Back to API list] [Back to README]

get_time_periods

Get time periods

Returns compact time period records.

(more information)

Example

import asana
from asana.rest import ApiException
from pprint import pprint

configuration = asana.Configuration()
configuration.access_token = '<YOUR_ACCESS_TOKEN>'
api_client = asana.ApiClient(configuration)

# create an instance of the API class
time_periods_api_instance = asana.TimePeriodsApi(api_client)
workspace = "31326" # str | Globally unique identifier for the workspace.
opts = {
    'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100.
    'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
    'start_on': '2019-09-15', # date | ISO 8601 date string
    'end_on': '2019-09-15', # date | ISO 8601 date string
    'opt_fields': "display_name,end_on,offset,parent,parent.display_name,parent.end_on,parent.period,parent.start_on,path,period,start_on,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
}

try:
    # Get time periods
    api_response = time_periods_api_instance.get_time_periods(workspace, opts)
    for data in api_response:
        pprint(data)
except ApiException as e:
    print("Exception when calling TimePeriodsApi->get_time_periods: %s\n" % e)

Parameters

Name Type Description Notes
workspace str Globally unique identifier for the workspace.
limit int Results per page. The number of objects to return per page. The value must be between 1 and 100. [optional]
offset str Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' [optional]
start_on date ISO 8601 date string [optional]
end_on date ISO 8601 date string [optional]
opt_fields Dict This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. [optional]

Return type

generator

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8

[Back to top] [Back to API list] [Back to README]