veritone-dmh

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0-SNAPSHOT
• Package version: 0.1.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import veritone_dmh 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import veritone_dmh

Getting Started

Please follow the installation procedure and then run the following:

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)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AssetInformationApi	get_anonymous_asset_view	GET /v1/assetInfo/anonymous/view/{assetId}	Get the asset's quick view information.
AssetInformationApi	get_anonymous_asset_view_with_type	GET /v1/assetInfo/anonymous/view/{viewType}/{assetId}	Get the asset's quick view information.
AssetInformationApi	get_asset_view	GET /v1/assetInfo/view/clip/{assetId}/{parent}/{parentId}	Get asset quick view information for asset in parent object.
AssetInformationApi	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.
AssetInformationApi	get_asset_view_with_type	GET /v1/assetInfo/view/{viewType}/clip/{assetId}/{parent}/{parentId}	Get asset quick view information for asset in parent object.
AssetInformationApi	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.
ClipApi	asset_indexing	PUT /v1/clip/index/clipIds	Request manual indexing of assets by asset Ids
ClipApi	asset_share	POST /v1/clip/share	Share assets with other users.
ClipApi	clip_collection_edit	GET /v1/clip/{id}/collectionEdit	Retrieve editable clip fields for a collection based on configuration.
ClipApi	clip_create	POST /v1/clip	Create a clip.
ClipApi	clip_delivery_metadata_get	GET /v1/clip/{id}/deliveryMetadata/{deliveryMetadataId}	Retrieve a clip delivery metadata.
ClipApi	clip_get	GET /v1/clip/cacheStats	Retrieve clip metadata and renditions.
ClipApi	clip_get_delivery_options	GET /v1/clip/{id}/share/deliveryOptions	Retrieve clip delivery options.
ClipApi	clip_get_detail	GET /v1/clip/{id}/clipDetail	Retrieve clip metadata based on configuration.
ClipApi	clip_get_edit	GET /v1/clip/{id}/clipEdit	Retrieve editable clip fields based on configuration.
ClipApi	clip_get_get_v1_clip_by_id	GET /v1/clip/{id}	Retrieve clip metadata and renditions.
ClipApi	clip_in_collection_detail	GET /v1/clip/{id}/{parent}/{parentId}/clipDetail	Retrieve clip metadata based on access privilege of parent entity of asset.
ClipApi	clip_list	GET /v1/clip/byIds	Get a list of clips.
ClipApi	clip_update	PUT /v1/clip/{id}	Update an existing clip.
ClipApi	collection_update	PUT /v1/clip/{id}/collectionEdit	Update existing clips in a collection
ClipApi	create_child_clip	POST /v1/clip/child	Create a child clip from an existing clip.
ClipApi	create_rendition_for_clip	PUT /v1/clip/{id}/rendition	Create a rendition for a clip
ClipApi	create_rendition_for_clip_by_core	POST /v1/clip/{id}/renditionInstall	Create a rendition for a clip
ClipApi	delete_rendition_for_clip	DELETE /v1/clip/{id}/rendition/{renditionId}	Delete a rendition for a clip
ClipApi	get_asset_edit_detail	GET /v1/clip/fieldDefinition	Retrieve the field definition for the specified field.
ClipApi	invalidate_cache	PUT /v1/clip/invalidateCache	Invalidate caches in the app.
ClipApi	remove_clips_from_content_owners_inventory	PUT /v1/clip/remove/clipIds	Remove clips from content owner's inventory
ClipApi	watermark	PUT /v1/clip/watermark/image/{id}	Retrieve watermarked rendition of specified clip.
ClipMetadataTransformApi	get_transformation_script	GET /v1/transform/{definitionId}	Retrieve asset metadata transformation script by script ID
CollectionSummaryApi	asset_solr_cloud_search_collection	GET /v1/collectionSummary/assets/{id}	Retrieve asset summaries for a collection.
CollectionSummaryApi	collection_summary_by_access_level	GET /v1/collectionSummary/fetchBy	Retrieve collection summaries for a user by access level.
CollectionSummaryApi	collection_summary_search	GET /v1/collectionSummary/search	Retrieve collection summaries for a user by access level.
CollectionSummaryApi	create_collection_summary	POST /v1/collectionSummary	Create a collection summary.
CollectionSummaryApi	get_collection_metadata_summary	GET /v1/collectionSummary/metadata/{id}	Retrieve a collection metadata summary.
CollectionSummaryApi	get_collection_summary	GET /v1/collectionSummary/{id}	Retrieve a collection summary.
CollectionSummaryApi	set_focused_collection	PUT /v1/collectionSummary/setFocused/{id}	Set the focused collection and receive the corresponding collection summary.
CollectionSummaryApi	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.
FilterApi	get_filter_tree	GET /v1/filter/anonymous/filterTree	Retrieve the filter tree for the site.
FilterApi	get_filter_tree_for_related_assets	GET /v1/filter/anonymous/filterTree/{assetId}/{configId}	Retrieve the filter tree values for related assets search.
FilterApi	get_user_filter_tree	GET /v1/filter/filterTree	Retrieve the filter tree values.
FilterApi	get_user_filter_tree_by_id	GET /v1/filter/filterTree/{id}	Retrieve the filter tree values for a specified root filter.
FilterApi	get_user_filter_tree_for_related_assets	GET /v1/filter/filterTree/{assetId}/{configId}	Retrieve the filter tree values for related assets search.
GallerySearchResultApi	gallery_result_get	GET /v1/galleryResult	Retrieve a GalleryResult.
RenditionTypesApi	available_renditions	GET /v1/renditionType/availableRenditions/{assetId}	Retrieve a map of available renditions for a clip.
RenditionTypesApi	clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id	GET /v1/renditionType/clipDetail/{assetId}/{parent}/{parentId}	Retrieve clip metadata based on access privilege of parent entity of asset.
RenditionTypesApi	find_rendition	GET /v1/renditionType/{assetId}	Retrieve a single rendition URL for a particular use type.
RenditionTypesApi	find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id	GET /v1/renditionType/{assetId}/quote/{quoteId}	Retrieve a single rendition URL for a particular use type.
RenditionTypesApi	get_asset_delivery_options	GET /v1/renditionType/deliveryOptions/{assetId}	Retrieve the url to download comp.
RenditionTypesApi	get_asset_delivery_options_by_parent	GET /v1/renditionType/deliveryOptions/{assetId}/{parent}/{parentId}	Retrieve the url to download comp based on access to specified parent entity.
RenditionTypesApi	get_cart_asset_delivery_options	GET /v1/renditionType/cartDeliveryOptions	Retrieve the url to download comp.
RenditionTypesApi	get_clip_detail	GET /v1/renditionType/clipDetail/{assetId}	Retrieve the URL used to render a rendition. The siteName query parameter is optional and only required for anonymous users.
RenditionTypesApi	get_comp_aspera_spec	GET /v1/renditionType/asperaSpec/{assetId}	Retrieve the asperaSpec for a rendition type.
RenditionTypesApi	get_comp_download_url	GET /v1/renditionType/downloadUrl/{assetId}	Retrieve a download URL for a rendition type.
RenditionTypesApi	get_delivery_options_for_current_user	GET /v1/renditionType/myDeliveryOptions	Retrieve delivery options for the current user
RenditionTypesApi	get_eligible_assets_for_delivery_option	GET /v1/renditionType/deliveryOptions/eligibleAssets	return asset ids that are valid for the specified delivery option
RenditionTypesApi	get_line_item_spec_list_for_order	GET /v1/renditionType/order/specs/{orderId}	Retrieve the url to download the lineItem transcodes for order.
RenditionTypesApi	get_line_item_url	GET /v1/renditionType/order/{orderId}/lineItem/{lineItemId}	Retrieve the url to download the lineItem transcode.
RenditionTypesApi	get_line_item_urls_for_order	GET /v1/renditionType/order/{orderId}	Retrieve the url to download the lineItem transcodes for order.
RenditionURLApi	get_rendition	GET /v1/renditionUrl/select/{assetId}	Get a rendition with the converted external urls for an asset that matches the selection criteria specified by query parameters.
RenditionURLApi	get_renditions	GET /v1/renditionUrl/{assetId}	Get all renditions including the converted external urls for an asset.
SearchApi	advanced_search_request	POST /v1/search/advancedSearch	Advanced Search Request. Please see the structure of the request. The following operations are supported: [In, Contains, Is, GreaterThan, LessThan, IsNot, NotIn, NotContains].
SearchApi	aiware_type_ahead_terms	GET /v1/search/aiwareTypeAheadTerms	Get the list of the aiware terms with document count that match the prefix text.
SearchApi	anonymous_asset_access_check	GET /v1/search/anonymous/accessCheck	Check anonymous access to assets by id for a site.
SearchApi	asset_access_check	GET /v1/search/accessCheck	Check access to assets by id for a logged in user.
SearchApi	asset_access_check_for_user	GET /v1/search/accessCheckForUser	Check access to assets by id for a supplied userName.
SearchApi	asset_access_check_for_user_get_v1_search_access_check_for_user_by_id	GET /v1/search/accessCheckForUser/{id}	Check access to assets by id for a supplied userName.
SearchApi	asset_access_pricing_check	GET /v1/search/accessPricingCheck	Check access to assets for pricing by id for a logged in user.
SearchApi	asset_aiware_search	GET /v1/search/aiware	Asset search.
SearchApi	asset_solr_cloud_anon_search	GET /v1/search/anonymous	Anonymous asset search.
SearchApi	asset_solr_cloud_anon_search_term	GET /v1/search/anonymous/searchTerms	Get the list of the search terms with document count that match the prefix text.
SearchApi	asset_solr_cloud_search	GET /v1/search	Asset search.
SearchApi	asset_vector_search	GET /v1/search/vector	Asset search.
SearchApi	find_entities	GET /v1/search/aiware/entities	Retrieve entities from aiware for the logged in user.
SearchApi	related_asset_search	GET /v1/search/anonymous/relatedAssets/{assetId}/{configId}	Anonymous asset search.
SearchApi	related_asset_search_get_v1_search_related_assets_by_asset_id_by_config_id	GET /v1/search/relatedAssets/{assetId}/{configId}	Anonymous asset search.
SearchApi	search_for_user	GET /v1/search/assetSearchForUser
SearchApi	search_terms	GET /v1/search/searchTerms	Get the list of the search terms with document count that match the prefix text.
SearchApi	thesaurus_terms	GET /v1/search/thesaurusTerms	Get the list of the thesaurus terms with document count that match the prefix text.
SearchApi	thesaurus_terms_get_v1_search_type_ahead_terms	GET /v1/search/typeAheadTerms	Get the list of the thesaurus terms with document count that match the prefix text.

Documentation For Models

• AdvancedSearchRequest
• AiwareTypeAheadTerm
• ApiList
• ApiListAiwareTypeAheadTerm
• ApiListAssetDeliveryOption
• ApiListClip
• ApiListDeliveryOption
• ApiListLong
• ApiListString
• AsperaSpec
• AssetDeliveryOption
• AssetDetail
• AssetEditDetail
• AssetEditField
• AssetQuickView
• AssetShareInfo
• AssetShareResponse
• AssetSummary
• Background
• CacheInvalidateParams
• ChildClipRequest
• Clip
• ClipData
• ClipIdsRequest
• ClipIdsResponse
• Collection
• CollectionAssetSummary
• CollectionMetadataSummary
• CollectionMetadataUpdateResponse
• CollectionSummary
• Concept
• Configuration
• CountedSearchTerms
• CreateRenditionByCore
• CreateRenditionRequest
• DeliveryOption
• DeliveryOptionTarget
• EntityTag
• FieldExpression
• FilterTree
• Font
• GalleryResult
• Link
• Locale
• MediaType
• NameValue
• NewClipRequest
• NewCookie
• OrderAsperaSpecList
• Page
• PageAssetSummary
• PageCollectionAssetSummary
• PageCollectionSummary
• Rendition
• RenditionInfo
• RenditionInfoList
• RenditionUrl
• Response
• SearchExpression
• SearchTerm
• SmallPreviewSummary
• StatusType
• Supplier
• SupplierData
• ThumbnailSummary
• TranscodeTarget
• Transform
• UpdateMetadataObj
• UriBuilder
• UserSummary

Documentation For Authorization

ApiKeyQuery

• Type: API key
• API key parameter name: api_key
• Location: URL query string

Author