TrackingCategoriesApi.md

codat_python_sdk.TrackingCategoriesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
companies_company_id_data_tracking_categories_get	GET /companies/{companyId}/data/trackingCategories	Gets the latest tracking categories for a given company.
companies_company_id_data_tracking_categories_tracking_category_id_get	GET /companies/{companyId}/data/trackingCategories/{trackingCategoryId}	Gets the specified tracking categories for a given company.

companies_company_id_data_tracking_categories_get

CodatPublicApiModelsDataTrackingCategoryPagedResponseModel companies_company_id_data_tracking_categories_get(company_id, )

Gets the latest tracking categories for a given company.

Example

• Api Key Authentication (API Key Auth):
• OAuth Authentication (Codat Login):

import time
import codat_python_sdk
from codat_python_sdk.api import tracking_categories_api
from codat_python_sdk.model.codat_public_api_models_data_tracking_category_paged_response_model import CodatPublicApiModelsDataTrackingCategoryPagedResponseModel
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codat_python_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API Key Auth
configuration.api_key['API Key Auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API Key Auth'] = 'Bearer'

# Configure OAuth2 access token for authorization: Codat Login
configuration = codat_python_sdk.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with codat_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tracking_categories_api.TrackingCategoriesApi(api_client)
    company_id = "companyId_example" # str | 
    page_size = 100 # int |  (optional) if omitted the server will use the default value of 100
    query = "query_example" # str |  (optional)
    order_by = "orderBy_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Gets the latest tracking categories for a given company.
        api_response = api_instance.companies_company_id_data_tracking_categories_get(company_id, )
        pprint(api_response)
    except codat_python_sdk.ApiException as e:
        print("Exception when calling TrackingCategoriesApi->companies_company_id_data_tracking_categories_get: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Gets the latest tracking categories for a given company.
        api_response = api_instance.companies_company_id_data_tracking_categories_get(company_id, page_size=page_size, query=query, order_by=order_by)
        pprint(api_response)
    except codat_python_sdk.ApiException as e:
        print("Exception when calling TrackingCategoriesApi->companies_company_id_data_tracking_categories_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	str
page	int		defaults to 1
page_size	int		[optional] if omitted the server will use the default value of 100
query	str		[optional]
order_by	str		[optional]

Return type

CodatPublicApiModelsDataTrackingCategoryPagedResponseModel

Authorization

[API Key Auth](../README.md#API Key Auth), [Codat Login](../README.md#Codat Login)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-

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

companies_company_id_data_tracking_categories_tracking_category_id_get

CodatPublicApiModelsDataTrackingCategoryTree companies_company_id_data_tracking_categories_tracking_category_id_get(company_id, tracking_category_id)

Gets the specified tracking categories for a given company.

Example

• Api Key Authentication (API Key Auth):
• OAuth Authentication (Codat Login):

import time
import codat_python_sdk
from codat_python_sdk.api import tracking_categories_api
from codat_python_sdk.model.codat_public_api_models_data_tracking_category_tree import CodatPublicApiModelsDataTrackingCategoryTree
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codat_python_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API Key Auth
configuration.api_key['API Key Auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API Key Auth'] = 'Bearer'

# Configure OAuth2 access token for authorization: Codat Login
configuration = codat_python_sdk.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with codat_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tracking_categories_api.TrackingCategoriesApi(api_client)
    company_id = "companyId_example" # str | 
    tracking_category_id = "trackingCategoryId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Gets the specified tracking categories for a given company.
        api_response = api_instance.companies_company_id_data_tracking_categories_tracking_category_id_get(company_id, tracking_category_id)
        pprint(api_response)
    except codat_python_sdk.ApiException as e:
        print("Exception when calling TrackingCategoriesApi->companies_company_id_data_tracking_categories_tracking_category_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	str
tracking_category_id	str

Return type

CodatPublicApiModelsDataTrackingCategoryTree

Authorization

[API Key Auth](../README.md#API Key Auth), [Codat Login](../README.md#Codat Login)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-

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