veritone_dmh.CollectionSummaryApi

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

Method	HTTP request	Description
asset_solr_cloud_search_collection	GET /v1/collectionSummary/assets/{id}	Retrieve asset summaries for a collection.
collection_summary_by_access_level	GET /v1/collectionSummary/fetchBy	Retrieve collection summaries for a user by access level.
collection_summary_search	GET /v1/collectionSummary/search	Retrieve collection summaries for a user by access level.
create_collection_summary	POST /v1/collectionSummary	Create a collection summary.
get_collection_metadata_summary	GET /v1/collectionSummary/metadata/{id}	Retrieve a collection metadata summary.
get_collection_summary	GET /v1/collectionSummary/{id}	Retrieve a collection summary.
set_focused_collection	PUT /v1/collectionSummary/setFocused/{id}	Set the focused collection and receive the corresponding collection summary.
update_collection_summary	PUT /v1/collectionSummary/{id}	Update a collection and return its summary. The request should include the full collection object. The response will be a collection summary based on the modified collection.

asset_solr_cloud_search_collection

Page asset_solr_cloud_search_collection(id, sort_id=sort_id, i=i, n=n, afn=afn, time_format=time_format)

Retrieve asset summaries for a collection.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
id = 'id_example' # str | 
sort_id = 789 # int | Sort id (optional)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)
afn = 'afn_example' # str | Optional. Asset Fields Name config string. (optional)
time_format = 'milliseconds' # str | Optional. Time Format for timeStart and timeEnd. Support streamTimecode, sourceTimecode, milliseconds and sourceMilliseconds (optional) (default to milliseconds)

try:
    # Retrieve asset summaries for a collection.
    api_response = api_instance.asset_solr_cloud_search_collection(id, sort_id=sort_id, i=i, n=n, afn=afn, time_format=time_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->asset_solr_cloud_search_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
sort_id	int	Sort id	[optional]
i	int	Page index	[optional] [default to 0]
n	int	Number of results per page	[optional] [default to 20]
afn	str	Optional. Asset Fields Name config string.	[optional]
time_format	str	Optional. Time Format for timeStart and timeEnd. Support streamTimecode, sourceTimecode, milliseconds and sourceMilliseconds	[optional] [default to milliseconds]

Return type

Page

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]

collection_summary_by_access_level

Page collection_summary_by_access_level(access_level, include_public=include_public, s=s, d=d, i=i, n=n)

Retrieve collection summaries for a user by access level.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
access_level = 'access_level_example' # str | Access level
include_public = true # bool | Include public shares (optional)
s = 'lastUpdated' # str | Sort by (optional) (default to lastUpdated)
d = true # bool | Sort descending (optional) (default to true)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)

try:
    # Retrieve collection summaries for a user by access level.
    api_response = api_instance.collection_summary_by_access_level(access_level, include_public=include_public, s=s, d=d, i=i, n=n)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->collection_summary_by_access_level: %s\n" % e)

Parameters

Name	Type	Description	Notes
access_level	str	Access level
include_public	bool	Include public shares	[optional]
s	str	Sort by	[optional] [default to lastUpdated]
d	bool	Sort descending	[optional] [default to true]
i	int	Page index	[optional] [default to 0]
n	int	Number of results per page	[optional] [default to 20]

Return type

Page

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]

collection_summary_search

Page collection_summary_search(access_level, q=q, include_public=include_public, s=s, d=d, i=i, n=n)

Retrieve collection summaries for a user by access level.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
access_level = 'access_level_example' # str | Access level
q = 'q_example' # str | Query string (optional)
include_public = true # bool | Include public shares (optional)
s = 'lastUpdated' # str | Sort by (optional) (default to lastUpdated)
d = true # bool | Sort descending (optional) (default to true)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)

try:
    # Retrieve collection summaries for a user by access level.
    api_response = api_instance.collection_summary_search(access_level, q=q, include_public=include_public, s=s, d=d, i=i, n=n)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->collection_summary_search: %s\n" % e)

Parameters

Name	Type	Description	Notes
access_level	str	Access level
q	str	Query string	[optional]
include_public	bool	Include public shares	[optional]
s	str	Sort by	[optional] [default to lastUpdated]
d	bool	Sort descending	[optional] [default to true]
i	int	Page index	[optional] [default to 0]
n	int	Number of results per page	[optional] [default to 20]

Return type

Page

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]

create_collection_summary

CollectionSummary create_collection_summary(body=body)

Create a collection summary.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.Collection() # Collection |  (optional)

try:
    # Create a collection summary.
    api_response = api_instance.create_collection_summary(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->create_collection_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Collection		[optional]

Return type

CollectionSummary

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_collection_metadata_summary

CollectionMetadataSummary get_collection_metadata_summary(id)

Retrieve a collection metadata summary.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Retrieve a collection metadata summary.
    api_response = api_instance.get_collection_metadata_summary(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->get_collection_metadata_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

CollectionMetadataSummary

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_collection_summary

CollectionSummary get_collection_summary(id)

Retrieve a collection summary.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Retrieve a collection summary.
    api_response = api_instance.get_collection_summary(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->get_collection_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

CollectionSummary

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]

set_focused_collection

CollectionSummary set_focused_collection(id)

Set the focused collection and receive the corresponding collection summary.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | 

try:
    # Set the focused collection and receive the corresponding collection summary.
    api_response = api_instance.set_focused_collection(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->set_focused_collection: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

CollectionSummary

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]

update_collection_summary

CollectionSummary update_collection_summary(id, body=body)

Update a collection and return its summary. The request should include the full collection object. The response will be a collection summary based on the modified collection.

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.CollectionSummaryApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | 
body = veritone_dmh.Collection() # Collection | The full collection that is to be updated. Note that this is not the collection summary object. (optional)

try:
    # Update a collection and return its summary. The request should include the full collection object. The response will be a collection summary based on the modified collection.
    api_response = api_instance.update_collection_summary(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionSummaryApi->update_collection_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	Collection	The full collection that is to be updated. Note that this is not the collection summary object.	[optional]

Return type

CollectionSummary

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]

FilesExpand file tree

CollectionSummaryApi.md

Latest commit

History

CollectionSummaryApi.md

File metadata and controls

veritone_dmh.CollectionSummaryApi

asset_solr_cloud_search_collection

Example

Parameters

Return type

Authorization

HTTP request headers

collection_summary_by_access_level

Example

Parameters

Return type

Authorization

HTTP request headers

collection_summary_search

Example

Parameters

Return type

Authorization

HTTP request headers

create_collection_summary

Example

Parameters

Return type

Authorization

HTTP request headers

get_collection_metadata_summary

Example

Parameters

Return type

Authorization

HTTP request headers

get_collection_summary

Example

Parameters

Return type

Authorization

HTTP request headers

set_focused_collection

Example

Parameters

Return type

Authorization

HTTP request headers

update_collection_summary

Example

Parameters

Return type

Authorization

HTTP request headers