hlconnect_client.AssetsApi

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_list	GET /assets/list	Retrieve a paginated list of digital assets
assets_search	POST /assets/search	Search assets

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.AssetsApi(api_client)

    try:
        # Retrieve the list of available asset categories
        api_response = api_instance.assets_categories()
        print("The response of AssetsApi->assets_categories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AssetsApi->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]

assets_list

AssetsListResponse assets_list(page_size=page_size, last_id=last_id, exclude_parts=exclude_parts)

Retrieve a paginated list of digital assets

Returns a list of digital assets with their complete metadata. Assets include information about formats, pricing, contributors, categories, instruments, and related media.

Example

Bearer Authentication (access_token):

import hlconnect_client
from hlconnect_client.models.assets_list_response import AssetsListResponse
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.AssetsApi(api_client)
    page_size = 20 # int | Number of assets to return per page (optional) (default to 20)
    last_id = 56 # int | The ID of the last asset from the previous page. Used for pagination to retrieve the next page of results. (optional)
    exclude_parts = False # bool | Exclude individual ensemble parts (asset_type \"PART\") (optional) (default to False)

    try:
        # Retrieve a paginated list of digital assets
        api_response = api_instance.assets_list(page_size=page_size, last_id=last_id, exclude_parts=exclude_parts)
        print("The response of AssetsApi->assets_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AssetsApi->assets_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_size	int	Number of assets to return per page	[optional] [default to 20]
last_id	int	The ID of the last asset from the previous page. Used for pagination to retrieve the next page of results.	[optional]
exclude_parts	bool	Exclude individual ensemble parts (asset_type "PART")	[optional] [default to False]

Return type

AssetsListResponse

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved list of assets with pagination information	* 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	-
403	Forbidden - Vendor access check failed	-
500	Internal server error - Something went wrong processing the request	-

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

assets_search

AssetsSearchResponse assets_search(assets_search_request)

Search assets

Returns full metadata for the assets that match the filters. Results are sorted by asset_id and paged with page_size and last_id.

Example

Bearer Authentication (access_token):

import hlconnect_client
from hlconnect_client.models.assets_search_request import AssetsSearchRequest
from hlconnect_client.models.assets_search_response import AssetsSearchResponse
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.AssetsApi(api_client)
    assets_search_request = {"hl_skus":["04001191"]} # AssetsSearchRequest | 

    try:
        # Search assets
        api_response = api_instance.assets_search(assets_search_request)
        print("The response of AssetsApi->assets_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AssetsApi->assets_search: %s\n" % e)

Parameters

Name	Type	Description	Notes
assets_search_request	AssetsSearchRequest

Return type

AssetsSearchResponse

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Assets matched by the search filters (only those the vendor has access to).	* X-Environment - * X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request - payload failed validation	-
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	-
403	Forbidden - Vendor access check failed	-
500	Internal server error	-

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

FilesExpand file tree

AssetsApi.md

Latest commit

History

AssetsApi.md

File metadata and controls

hlconnect_client.AssetsApi

assets_categories

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assets_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assets_search

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details