AssetsCategoriesApi.md

hlconnect_client.AssetsCategoriesApi

All URIs are relative to https://hlconnect-api.mu.se

Method	HTTP request	Description
assets_categories	GET /assets/categories	Retrieve the list of available asset categories

assets_categories

CategoriesListResponse assets_categories()

Retrieve the list of available asset categories

Returns the full list of available asset categories (classifications). Categories are linked to assets.

Example

• Bearer Authentication (access_token):

import hlconnect_client
from hlconnect_client.models.categories_list_response import CategoriesListResponse
from hlconnect_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://hlconnect-api.mu.se
# See configuration.py for a list of all supported configuration parameters.
configuration = hlconnect_client.Configuration(
    host = "https://hlconnect-api.mu.se"
)

# 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 Bearer authorization: access_token
configuration = hlconnect_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hlconnect_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hlconnect_client.AssetsCategoriesApi(api_client)

    try:
        # Retrieve the list of available asset categories
        api_response = api_instance.assets_categories()
        print("The response of AssetsCategoriesApi->assets_categories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AssetsCategoriesApi->assets_categories: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CategoriesListResponse

Authorization

access_token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved the list of categories	* X-Environment - * X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Too many requests: the client exceeded its rate limit	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
401	Unauthorized - Missing or invalid access token	-
500	Internal server error	-

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