Skip to content

AssetInformationApi.md

Latest commit

 

History

History
362 lines (262 loc) · 14 KB

AssetInformationApi.md

File metadata and controls

362 lines (262 loc) · 14 KB

veritone_dmh.AssetInformationApi

All URIs are relative to https://localhost/assets-api

Method HTTP request Description
get_anonymous_asset_view GET /v1/assetInfo/anonymous/view/{assetId} Get the asset's quick view information.
get_anonymous_asset_view_with_type GET /v1/assetInfo/anonymous/view/{viewType}/{assetId} Get the asset's quick view information.
get_asset_view GET /v1/assetInfo/view/clip/{assetId}/{parent}/{parentId} Get asset quick view information for asset in parent object.
get_asset_view_get_v1_asset_info_view_by_asset_id GET /v1/assetInfo/view/{assetId} Get asset quick view information. This endpoint uses search to determine access to asset.
get_asset_view_with_type GET /v1/assetInfo/view/{viewType}/clip/{assetId}/{parent}/{parentId} Get asset quick view information for asset in parent object.
get_asset_view_with_type_get_v1_asset_info_view_by_view_type_by_asset_id GET /v1/assetInfo/view/{viewType}/{assetId} Get asset quick view information. This endpoint uses search to determine access to asset.

get_anonymous_asset_view

AssetQuickView get_anonymous_asset_view(asset_id, site_name=site_name, asset_fields_name=asset_fields_name)

Get the asset's quick view information.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
site_name = 'site_name_example' # str |  (optional)
asset_fields_name = 'asset_fields_name_example' # str |  (optional)

try:
    # Get the asset's quick view information.
    api_response = api_instance.get_anonymous_asset_view(asset_id, site_name=site_name, asset_fields_name=asset_fields_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_anonymous_asset_view: %s\n" % e)

Parameters

Name Type Description Notes
asset_id int
site_name str [optional]
asset_fields_name str [optional]

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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

get_anonymous_asset_view_with_type

AssetQuickView get_anonymous_asset_view_with_type(view_type, asset_id, site_name=site_name)

Get the asset's quick view information.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
view_type = 'view_type_example' # str | 
asset_id = 789 # int | 
site_name = 'site_name_example' # str |  (optional)

try:
    # Get the asset's quick view information.
    api_response = api_instance.get_anonymous_asset_view_with_type(view_type, asset_id, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_anonymous_asset_view_with_type: %s\n" % e)

Parameters

Name Type Description Notes
view_type str
asset_id int
site_name str [optional]

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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

get_asset_view

AssetQuickView get_asset_view(asset_id, parent, parent_id, asset_fields_name=asset_fields_name)

Get asset quick view information for asset in parent object.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
parent = "collection" # object | Parent entity through which access to asset is controlled.  One of collection, quote, order
parent_id = 789 # int | The id value for the parent entity
asset_fields_name = 'asset_fields_name_example' # str |  (optional)

try:
    # Get asset quick view information for asset in parent object.
    api_response = api_instance.get_asset_view(asset_id, parent, parent_id, asset_fields_name=asset_fields_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_asset_view: %s\n" % e)

Parameters

Name Type Description Notes
asset_id int
parent object Parent entity through which access to asset is controlled. One of collection, quote, order
parent_id int The id value for the parent entity
asset_fields_name str [optional]

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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

get_asset_view_get_v1_asset_info_view_by_asset_id

AssetQuickView get_asset_view_get_v1_asset_info_view_by_asset_id(asset_id, asset_fields_name=asset_fields_name)

Get asset quick view information. This endpoint uses search to determine access to asset.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
asset_fields_name = 'asset_fields_name_example' # str |  (optional)

try:
    # Get asset quick view information.  This endpoint uses search to determine access to asset.
    api_response = api_instance.get_asset_view_get_v1_asset_info_view_by_asset_id(asset_id, asset_fields_name=asset_fields_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_asset_view_get_v1_asset_info_view_by_asset_id: %s\n" % e)

Parameters

Name Type Description Notes
asset_id int
asset_fields_name str [optional]

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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

get_asset_view_with_type

AssetQuickView get_asset_view_with_type(view_type, asset_id, parent, parent_id)

Get asset quick view information for asset in parent object.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
view_type = 'view_type_example' # str | 
asset_id = 789 # int | 
parent = "collection" # object | Parent entity through which access to asset is controlled.  One of collection, quote, order
parent_id = 789 # int | The id value for the parent entity

try:
    # Get asset quick view information for asset in parent object.
    api_response = api_instance.get_asset_view_with_type(view_type, asset_id, parent, parent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_asset_view_with_type: %s\n" % e)

Parameters

Name Type Description Notes
view_type str
asset_id int
parent object Parent entity through which access to asset is controlled. One of collection, quote, order
parent_id int The id value for the parent entity

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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

get_asset_view_with_type_get_v1_asset_info_view_by_view_type_by_asset_id

AssetQuickView get_asset_view_with_type_get_v1_asset_info_view_by_view_type_by_asset_id(view_type, asset_id)

Get asset quick view information. This endpoint uses search to determine access to asset.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.AssetInformationApi(veritone_dmh.ApiClient(configuration))
view_type = 'view_type_example' # str | 
asset_id = 789 # int | 

try:
    # Get asset quick view information.  This endpoint uses search to determine access to asset.
    api_response = api_instance.get_asset_view_with_type_get_v1_asset_info_view_by_view_type_by_asset_id(view_type, asset_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetInformationApi->get_asset_view_with_type_get_v1_asset_info_view_by_view_type_by_asset_id: %s\n" % e)

Parameters

Name Type Description Notes
view_type str
asset_id int

Return type

AssetQuickView

Authorization

ApiKeyQuery

HTTP request headers

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

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