VIDA Backend API (1.0.0)

Download OpenAPI specification:

Welcome to the Vida API

The Vida API allows seamless integration with your media asset management process, from ingesting assets to handling complex delivery configurations. Every aspect of media management can be controlled through the Vida RESTful API, offering the flexibility and scalability to meet the needs of content creators, broadcasters, and media distributors. With automation, secure architecture, and AI-driven tools, Vida enhances every step of your media workflow.

Authentication

Vida uses OAuth-based authentication through Google or Microsoft, with multi-factor authentication (MFA) available for added security. Include your access token in the Authorization header for each request.

Assets

Create and manage Assets.

List Assets details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
uuids	Array of arrays UUIDs
Cache-Control	object Overrides default cache behaviour.

Responses

Assets update

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

filename

required

string

File name

Responses

Request samples

Payload

Content type

application/json

{"filename": "string"
}

Response samples

200

Content type

application/json

{"key": "string",
"policy": "string",
"url": "string",
"x_amz_algorithm": "string",
"x_amz_credential": "string",
"x_amz_date": "string",
"x_amz_security_token": "string",
"x_amz_signature": "string"
}

Delete Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

deleteReason required	string Reason for deletion
deletionBillable required	boolean Is deletion billable
assetUuids required	Array of strings List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"deleteReason": "string",
"deletionBillable": true,
"assetUuids": ["string"
]
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List all assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Get Archived Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Get Ingested Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

List latest Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Generate Mediapulse JSON for Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

{"message": "Accepted"
}

List All Assets on map

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

polyenc

required

string

Assets Poly

Responses

Request samples

Payload

Content type

application/json

{"polyenc": "string"
}

Request assets deletion

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

delete_reason required	string Delete reason for the asset
asset_uuids required	Array of strings List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"delete_reason": "string",
"asset_uuids": ["string"
]
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Set Assets as Cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets

required

Array of strings

List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
]
}

Response samples

200
401

Content type

application/json

true

Set Search Assets as cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

text	string Text input for searching assets
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
fields	Array of strings List of specific fields to include in the search results
advanced_mode	boolean Flag indicating whether advanced search mode is enabled

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
}

Response samples

200
401

Content type

application/json

true

Set assets as hot

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets

required

Array of strings

List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
]
}

Response samples

401

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get price for set as hot/cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

discount_code	string Optional discount code to apply to the search
assets required	Array of strings List of asset uuids
department_field_uuid	string Optional department field uuid

Responses

Request samples

Payload

Content type

application/json

{"discount_code": "string",
"assets": ["string"
],
"department_field_uuid": "string"
}

Response samples

200
401

Content type

application/json

{"currency": "string",
"discount_name": "string",
"discount_prices": {"price_per_gb": 0,
"total_price": 0
},
"discount_status": "active",
"price_per_gb": 0,
"total_assets": 0,
"total_bytes": 0,
"total_price": 0
}

Set Search Assets as hot

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

text	string Text input for searching assets
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
fields	Array of strings List of specific fields to include in the search results
advanced_mode	boolean Flag indicating whether advanced search mode is enabled

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
}

Response samples

400
401
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get price for set as hot/cold from search

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

discount_code	string Optional discount code to apply to the search
text	string Text input for searching assets
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
fields	Array of strings List of specific fields to include in the search results
advanced_mode	boolean Flag indicating whether advanced search mode is enabled
department_field_uuid	string Optional department field uuid

Responses

Request samples

Payload

Content type

application/json

{"discount_code": "string",
"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true,
"department_field_uuid": "string"
}

Response samples

200
400
401

Content type

application/json

{"currency": "string",
"discount_name": "string",
"discount_prices": {"price_per_gb": 0,
"total_price": 0
},
"discount_status": "active",
"price_per_gb": 0,
"total_assets": 0,
"total_bytes": 0,
"total_price": 0
}

Batch Assets update

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets required	Array of strings List of asset identifiers to be updated
required	object (PatchAssetToAssetType) Payload containing the update details for the assets

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
],
"payload": {"general": {"stage": 0,
"approval_status": 0,
"tags": [{"name": "string",
"value": "string",
"id": 0
}
],
"thumbnail_timecode": "string",
"client_asset_id": "string",
"external_key": "string",
"rating_uuids": ["string"
],
"embargoed_to": "string",
"is_quarantined": true
},
"core": {"episode_name": "string",
"episode_number": 0,
"series_name": "string",
"series_number": 0,
"client_ref": "string",
"programme_number": "string",
"facility_of_origin": "string",
"original_filename": "string"
},
"user_media_data": {"language": "string",
"aspect_ratio": "string",
"image_aspect": "string",
"framing": "string",
"elements": "string",
"bars": true,
"clock_slate": true,
"seamless_segmented": "string",
"retention": "string",
"player_offset": "string"
},
"audioTracks": [{"language": "string",
"audio_description": "string",
"loudness": "string",
"loudness_standard": "string",
"channels": [{"channelLabel": "U",
"description": "string",
"truePeak": "string",
"loudnessBs17704": "string",
"loudnessBs17701": "string",
"stereo": true,
"fullSpotCheck": "string"
}
],
"class": "string",
"qc_status": "string",
"bit_depth": "string",
"codec": "string",
"sample_rate": "string",
"track": 0
}
],
"additional": {"inventory_type": "string",
"production_company": "string",
"description": "string",
"synopsis": "string",
"synopsis_short": "string",
"genre": "string",
"note": "string",
"tape_no": "string",
"alt_no": "string",
"captions": true,
"subtitle": "string",
"part_no": "string",
"part_total": "string",
"production_no": "string",
"shooting_start_date": "string",
"shooting_end_date": "string",
"star_rating": 0,
"player_offset": "string",
"category": "string",
"content_class": "string",
"content_type": "string",
"client_content_class_id": "string",
"vida_number": "string",
"theme_code": "string",
"framerate": "string",
"theme": "string",
"type": "string",
"subtype": "string",
"variation": "string",
"version": "string",
"multiversion": ["string"
],
"is_preview_app_enabled": true,
"disposition": "string",
"legacy_ingest_date": "string"
},
"ext_title_info": {"season_title": "string",
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"eidr_number": "string",
"release_year": "string",
"tx_date": "string",
"library_sales_rights": true
},
"ext_asset_info": {"order_number": "string",
"barcode_field": "string",
"dynamic_range": "string",
"sequence_no": "string",
"artist": "string",
"origin": "string"
},
"mediaset": {"physical_version_title": "string",
"physical_version_description": "string",
"parent_media_id": "string",
"relationship": "string"
}
}
}

Request asset deletion

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

asset_uuids

required

Array of strings

List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"asset_uuids": ["string"
]
}

Response samples

200

Content type

application/json

true

Export a list of assets in landingpad

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Force ingest of landingpad assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

filekeys

required

Array of strings

List of s3 file keys

Responses

Request samples

Payload

Content type

application/json

{"filekeys": ["string"
]
}

Delete landingpad assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

filekeys

required

Array of strings

List of s3 file keys

Responses

Request samples

Payload

Content type

application/json

{"filekeys": ["string"
]
}

Get details for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
origin	string Asset origin
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Update an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (GeneralProperty) General property
	object (CoreProperty) Core asset information
	object (PatchAssetUserMediaData) User media data associated with the asset
	Array of objects (PatchAssetAudioTrack) Audio tracks associated with the asset
	object (PatchAssetAdditional) Additional asset details
	object (PatchAssetExtTitleInfo) Extended title information related to the asset
	object (PatchAssetExtAssetInfo) Extended asset information such as licensing and metadata
	object (PatchAssetMediaSet) Mediaset details

Responses

Request samples

Payload

Content type

application/json

{"general": {"stage": 0,
"approval_status": 0,
"tags": [{"name": "string",
"value": "string",
"id": 0
}
],
"thumbnail_timecode": "string",
"client_asset_id": "string",
"external_key": "string",
"rating_uuids": ["string"
],
"embargoed_to": "string",
"is_quarantined": true
},
"core": {"episode_name": "string",
"episode_number": 0,
"series_name": "string",
"series_number": 0,
"client_ref": "string",
"programme_number": "string",
"facility_of_origin": "string",
"original_filename": "string"
},
"user_media_data": {"language": "string",
"aspect_ratio": "string",
"image_aspect": "string",
"framing": "string",
"elements": "string",
"bars": true,
"clock_slate": true,
"seamless_segmented": "string",
"retention": "string",
"player_offset": "string"
},
"audioTracks": [{"language": "string",
"audio_description": "string",
"loudness": "string",
"loudness_standard": "string",
"channels": [{"channelLabel": "U",
"description": "string",
"truePeak": "string",
"loudnessBs17704": "string",
"loudnessBs17701": "string",
"stereo": true,
"fullSpotCheck": "string"
}
],
"class": "string",
"qc_status": "string",
"bit_depth": "string",
"codec": "string",
"sample_rate": "string",
"track": 0
}
],
"additional": {"inventory_type": "string",
"production_company": "string",
"description": "string",
"synopsis": "string",
"synopsis_short": "string",
"genre": "string",
"note": "string",
"tape_no": "string",
"alt_no": "string",
"captions": true,
"subtitle": "string",
"part_no": "string",
"part_total": "string",
"production_no": "string",
"shooting_start_date": "string",
"shooting_end_date": "string",
"star_rating": 0,
"player_offset": "string",
"category": "string",
"content_class": "string",
"content_type": "string",
"client_content_class_id": "string",
"vida_number": "string",
"theme_code": "string",
"framerate": "string",
"theme": "string",
"type": "string",
"subtype": "string",
"variation": "string",
"version": "string",
"multiversion": ["string"
],
"is_preview_app_enabled": true,
"disposition": "string",
"legacy_ingest_date": "string"
},
"ext_title_info": {"season_title": "string",
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"eidr_number": "string",
"release_year": "string",
"tx_date": "string",
"library_sales_rights": true
},
"ext_asset_info": {"order_number": "string",
"barcode_field": "string",
"dynamic_range": "string",
"sequence_no": "string",
"artist": "string",
"origin": "string"
},
"mediaset": {"physical_version_title": "string",
"physical_version_description": "string",
"parent_media_id": "string",
"relationship": "string"
}
}

Response samples

401

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Delete an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

deleteReason required	string Reason for deletion
deletionBillable required	boolean Is deletion billable
assetUuids required	Array of strings List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"deleteReason": "string",
"deletionBillable": true,
"assetUuids": ["string"
]
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get download proxy for Timed Texts

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
401

Content type

application/json

[{"original_filename": "string",
"type": "vtt",
"url": "string"
}
]

Get a Hybrik Analyze for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
404

Content type

application/json

{"deep_properties": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"general_properties": {"asset": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"audio": [{"bitrate_kb": 0,
"bitrate_mode": "string",
"channel_designators": ["string"
],
"channel_order": "string",
"channels": 0,
"codec": "string",
"duration_sec": 0,
"language": "string",
"pid": 0,
"sample_format": "string",
"sample_rate": 0,
"sample_size": 0
}
],
"container": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"subtitle": [{"duration_sec": 0,
"format": "string",
"language": "string"
}
],
"timecode": [{"format": "string",
"source": "string",
"start_value": "string"
}
],
"video": {"bit_resolution": 0,
"bitrate_kb": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"clean_aperture_height": 0,
"clean_aperture_width": 0,
"codec": "string",
"color_matrix": "string",
"color_primaries": "string",
"color_space": "string",
"color_trc": "string",
"dar": 0,
"duration_sec": 0,
"frame_rate": 0,
"frame_rate_mode": "string",
"height": 0,
"interlace_mode": "string",
"par": 0,
"pid": 0,
"profile": "string",
"width": 0
}
},
"hybrik_profile": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
}
}

Get a playlist for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
origin	string Asset origin
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200

Content type

application/json

"string"

Get a list of related Assets

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Patch related assets

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

attach required	Array of strings List of array relations to attach
detach required	Array of strings List of array relations to detach

Responses

Request samples

Payload

Content type

application/json

{"attach": ["string"
],
"detach": ["string"
]
}

Get a list of possibly related Assets

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Patch related assets

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuid required	string Unique identifier for the dependant asset
relationPlayerOffset required	string player offset for the dependant asset
isOffsetBackward required	boolean is offset backward for the dependant asset

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"relationPlayerOffset": "string",
"isOffsetBackward": true
}

Get a Hybrik QA for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Get a PDF with an Asset details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
origin	string Asset origin
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200
401
404

Content type

application/json

{"url": "string"
}

Get a QC Report with an requested data

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required	object (QCReportHeader) Data for headers
required	object (QCReportOverview) Data for overview worksheet
	object (QCReportVideoErrors) Data for video errors worksheet
	object (QCReportAudioErrors) Data for audio errors worksheet
	object (QCReportInSceneTextLog) Data for in-scene text log worksheet
	object (QCReportRecommendations) Data for recommendations worksheet
gradeRegion required	string Enum: "us" "eu" Grade region for the report

Responses

Request samples

Payload

Content type

application/json

{"header": {"isPassed": true,
"leftColumn": {"name": "string",
"value": "string"
},
"rightColumn": {"name": "string",
"value": "string"
}
},
"overviewSheet": {"technicalInformation": {"leftColumn": {"name": "string",
"value": "string"
},
"rightColumn": {"name": "string",
"value": "string"
}
},
"programmeLayoutTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
},
"audioSpecificationsTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
},
"logosTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
},
"commentsList": {"minRows": 0,
"minEmptyRows": 0,
"values": ["string"
]
}
},
"videoErrorsSheet": {"videoErrorLogTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
}
},
"audioErrorsSheet": {"audioErrorLogTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
}
},
"inSceneTextLogSheet": {"textLogTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
}
},
"recommendationsSheet": {"recommendationsTable": {"minRows": 0,
"minEmptyRows": 0,
"headers": ["string"
]
}
},
"gradeRegion": "us"
}

Response samples

200
401
404

Content type

application/json

{"url": "string"
}

List Asset Storage Logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"id": 0,
"message": "string",
"storageChangeDirection": "hotToCold"
}
]

List an Asset Storage Statuses

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
401

Content type

application/json

{"s3Status": "string",
"wasabiStatus": "string"
}

Get transcriptions for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

[{"assetUuid": "string",
"default": true,
"source": "Whisper",
"status": "pending",
"uuid": "string"
}
]

Upload to Vimeo

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
401

Content type

application/json

{"link": "string",
"uri": "string"
}

Get historical asset locks which represent successful edits by users

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

[{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
]

Get details of before / after state of the asset lock

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

{"after": [{"confidence": 0,
"data": {"audioTrackNumber": 0,
"content": "string",
"instances": [{"Height": 0,
"Left": 0,
"Top": 0,
"Width": 0,
"instance_type": "BoundingBox",
"start": "string"
}
],
"note": "string",
"parent": "string",
"translations": [{"content": "string",
"language": "string"
}
]
},
"end": 0,
"id": 0,
"start": 0,
"type": "label-detection"
}
],
"before": [{"confidence": 0,
"data": {"audioTrackNumber": 0,
"content": "string",
"instances": [{"Height": 0,
"Left": 0,
"Top": 0,
"Width": 0,
"instance_type": "BoundingBox",
"start": "string"
}
],
"note": "string",
"parent": "string",
"translations": [{"content": "string",
"language": "string"
}
]
},
"end": 0,
"id": 0,
"start": 0,
"type": "label-detection"
}
]
}

Lock an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
type required	enum Type of data to be locked for edits
confirm	string Confirm take over of existing lock by another user
action required	enum Action type to perform with lock

Responses

Response samples

200
400
404

Content type

application/json

{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}

Create an Asset

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuid required	string Unique identifier for the asset
batchId required	string Identifier for the batch to which this asset belongs
originalFilename required	string Original name of the file uploaded by the user
internalFilename required	string Internal filename used within the system
series_title	string Series title of the asset
	Array of objects (AssetTagType) Tags associated with the asset
star_rating	number Star rating of the asset
	object (AssetCoords) Coordinates of the asset
contentType	string Content type of the asset
tapeNumber	string Tape number of the asset
coldOnly	boolean Flag indicating if the asset can be stored only in cold storage
processingStatus	string Enum: "PLACEHOLDER" "CREATED" "INITIALIZING" "REUPLOADED" "ANALYSE_REUPLOADED" "PRORES_REUPLOADED" "AWAITING_ANALYSE" "CREATING_PRORES" "ASPERA_LANDINGPAD_COPY" "ANALYSE" "CREATING_PROXY" "CREATING_STREAM" "DONE" "ERROR" "QA_FAILED" "DELETED" Processing status of the asset
type	string Enum: "video" "audio" "image" "subtitle" "archive" "document" "other" "font" Type of the asset
externalKey	string External key associated with the asset
sObjectID	string Salesforce object ID associated with the asset
uploadSource	string Enum: "Launchpad" "VIDA UI" "Landingpad" Upload source of the asset
theme	string Theme of the asset
contentClass	string Content class of the asset

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"batchId": "string",
"originalFilename": "string",
"internalFilename": "string",
"series_title": "string",
"tags": [{"name": "string",
"value": "string",
"id": 0
}
],
"star_rating": 0,
"coords": {"x": 0,
"y": 0
},
"contentType": "string",
"tapeNumber": "string",
"coldOnly": true,
"processingStatus": "PLACEHOLDER",
"type": "video",
"externalKey": "string",
"sObjectID": "string",
"uploadSource": "Launchpad",
"theme": "string",
"contentClass": "string"
}

Response samples

200

Content type

application/json

{"AbortDate": "2019-08-24T14:15:22Z",
"AbortRuleId": "string",
"Bucket": "string",
"BucketKeyEnabled": true,
"ChecksumAlgorithm": "CRC32",
"Key": "string",
"RequestCharged": "requester",
"SSECustomerAlgorithm": "string",
"SSECustomerKeyMD5": "string",
"SSEKMSEncryptionContext": "string",
"SSEKMSKeyId": "string",
"ServerSideEncryption": "AES256",
"UploadId": "string"
}

Add a File to an Asset from Aspera

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

batchId required	string Batch identifier
originalFilename required	string Original filename of the asset
internalFilename required	string Internal filename used within the system for the asset
sourcePath required	string Source path where the asset is stored

Responses

Request samples

Payload

Content type

application/json

{"batchId": "string",
"originalFilename": "string",
"internalFilename": "string",
"sourcePath": "string"
}

Response samples

200
400

Content type

application/json

{"cookie": "string",
"destinationRoot": "string",
"token": "string"
}

Get download proxy for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
origin	string Asset origin

Request Body schema: application/json
required

contact_uuid	string UUID of the contact associated with the download proxy
opportunity_uuid	string UUID of the opportunity associated with the download proxy
contact_name	string Name of the contact associated with the download proxy
opportunity_name	string Name of the opportunity associated with the download proxy

Responses

Request samples

Payload

Content type

application/json

{"contact_uuid": "string",
"opportunity_uuid": "string",
"contact_name": "string",
"opportunity_name": "string"
}

Response samples

200
401

Content type

application/json

{"url": "string"
}

Register to Rasp

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
404

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"expired_at": "2019-08-24T14:15:22Z",
"ruid": "string"
}

Delete from Rasp register

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Request asset deletion

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

delete_reason

required

string

Delete reason for the asset

Responses

Request samples

Payload

Content type

application/json

{"delete_reason": "string"
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Request asset deletion

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

true

Create an Asset Trailer

Trailer is created from asset clips.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

imgCount

required

number

The number of images or clips to be used for the trailer

Responses

Request samples

Payload

Content type

application/json

{"imgCount": 0
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create an Asset Trailer

Trailer is created from images.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

imgCount

required

number

The number of images or clips to be used for the trailer

Responses

Request samples

Payload

Content type

application/json

{"imgCount": 0
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create transcription for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

modelUuid required	string Unique identifier for the model associated with the job
	object (PostJobOptions) Optional job options, including tone settings
trackNumber	string Optional track number associated with the job
speed	string Transcription Whisper Speed
sourceLanguage	string Transcription Whisper Source Language of asset
trackId	number Audio track id for the job

Responses

Request samples

Payload

Content type

application/json

{"modelUuid": "string",
"options": {"tone": "string"
},
"trackNumber": "string",
"speed": "string",
"sourceLanguage": "string",
"trackId": 0
}

Response samples

400
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Abort an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uploadId

required

string

Unique identifier for the upload session to be aborted

Responses

Request samples

Payload

Content type

application/json

{"uploadId": "string"
}

Response samples

200

Content type

application/json

{"RequestCharged": "requester"
}

Complete an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uploadId required	string The ID of the upload session
required	Array of objects (UploadAssetCompletePart) List of uploaded parts

Responses

Request samples

Payload

Content type

application/json

{"uploadId": "string",
"parts": [{"ETag": "string",
"PartNumber": 0
}
]
}

Response samples

200

Content type

application/json

{"Bucket": "string",
"BucketKeyEnabled": true,
"ChecksumCRC32": "string",
"ChecksumCRC32C": "string",
"ChecksumSHA1": "string",
"ChecksumSHA256": "string",
"ETag": "string",
"Expiration": "string",
"Key": "string",
"Location": "string",
"RequestCharged": "requester",
"SSEKMSKeyId": "string",
"ServerSideEncryption": "AES256",
"VersionId": "string"
}

Create an upload part

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uploadId required	string Unique identifier for the upload
partNumber required	number The part number of the uploaded

Responses

Request samples

Payload

Content type

application/json

{"uploadId": "string",
"partNumber": 0
}

Response samples

200

Content type

application/json

"string"

Create a Virtual Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

timecodeIn required	string Starting timecode for the virtual asset
timecodeOut required	string Ending timecode for the virtual asset

Responses

Request samples

Payload

Content type

application/json

{"timecodeIn": "string",
"timecodeOut": "string"
}

Response samples

200
400

Content type

application/json

{"uuid": "string"
}

Create an Asset from Aspera

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PostAsperaAssetToAsset)

List of files for aspera

Responses

Request samples

Payload

Content type

application/json

{"files": [{"uuid": "string",
"batchId": "string",
"originalFilename": "string",
"internalFilename": "string",
"sourcePath": "string",
"uploadSource": "Launchpad"
}
]
}

Response samples

200
419

Content type

application/json

{"cookie": "string",
"destinationRoot": "string",
"token": "string"
}

Detect audio language

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Update an Asset embargo date

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (GeneralProperty) General property
	object (CoreProperty) Core asset information
	object (PatchAssetUserMediaData) User media data associated with the asset
	Array of objects (PatchAssetAudioTrack) Audio tracks associated with the asset
	object (PatchAssetAdditional) Additional asset details
	object (PatchAssetExtTitleInfo) Extended title information related to the asset
	object (PatchAssetExtAssetInfo) Extended asset information such as licensing and metadata
	object (PatchAssetMediaSet) Mediaset details

Responses

Request samples

Payload

Content type

application/json

{"general": {"stage": 0,
"approval_status": 0,
"tags": [{"name": "string",
"value": "string",
"id": 0
}
],
"thumbnail_timecode": "string",
"client_asset_id": "string",
"external_key": "string",
"rating_uuids": ["string"
],
"embargoed_to": "string",
"is_quarantined": true
},
"core": {"episode_name": "string",
"episode_number": 0,
"series_name": "string",
"series_number": 0,
"client_ref": "string",
"programme_number": "string",
"facility_of_origin": "string",
"original_filename": "string"
},
"user_media_data": {"language": "string",
"aspect_ratio": "string",
"image_aspect": "string",
"framing": "string",
"elements": "string",
"bars": true,
"clock_slate": true,
"seamless_segmented": "string",
"retention": "string",
"player_offset": "string"
},
"audioTracks": [{"language": "string",
"audio_description": "string",
"loudness": "string",
"loudness_standard": "string",
"channels": [{"channelLabel": "U",
"description": "string",
"truePeak": "string",
"loudnessBs17704": "string",
"loudnessBs17701": "string",
"stereo": true,
"fullSpotCheck": "string"
}
],
"class": "string",
"qc_status": "string",
"bit_depth": "string",
"codec": "string",
"sample_rate": "string",
"track": 0
}
],
"additional": {"inventory_type": "string",
"production_company": "string",
"description": "string",
"synopsis": "string",
"synopsis_short": "string",
"genre": "string",
"note": "string",
"tape_no": "string",
"alt_no": "string",
"captions": true,
"subtitle": "string",
"part_no": "string",
"part_total": "string",
"production_no": "string",
"shooting_start_date": "string",
"shooting_end_date": "string",
"star_rating": 0,
"player_offset": "string",
"category": "string",
"content_class": "string",
"content_type": "string",
"client_content_class_id": "string",
"vida_number": "string",
"theme_code": "string",
"framerate": "string",
"theme": "string",
"type": "string",
"subtype": "string",
"variation": "string",
"version": "string",
"multiversion": ["string"
],
"is_preview_app_enabled": true,
"disposition": "string",
"legacy_ingest_date": "string"
},
"ext_title_info": {"season_title": "string",
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"eidr_number": "string",
"release_year": "string",
"tx_date": "string",
"library_sales_rights": true
},
"ext_asset_info": {"order_number": "string",
"barcode_field": "string",
"dynamic_range": "string",
"sequence_no": "string",
"artist": "string",
"origin": "string"
},
"mediaset": {"physical_version_title": "string",
"physical_version_description": "string",
"parent_media_id": "string",
"relationship": "string"
}
}

Response samples

200

Content type

application/json

true

Regenerate an Asset Proxy

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List archive contents from an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get asset archive contents

Authorizations:

customAuthorizer

path Parameters

type required	string Export type
uuid required	string UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Finish an Aspera Upload

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

batch_id required	string Batch identifier
is_reuploaded required	boolean Flag indicating whether the asset has been re-uploaded

Responses

Request samples

Payload

Content type

application/json

{"batch_id": "string",
"is_reuploaded": true
}

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get asset comments

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create an asset comment

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuid required	string Unique identifier for the comment
body required	string Comment body text

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"body": "string"
}

Response samples

200
400
404

Content type

application/json

"string"

Cart

Create and manage Carts.

List Assets in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
embargoed required	string Filter by embargoed
quarantined required	string Filter by quarantined
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Count Items in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

0

0

List Cart extra

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

List prices for a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

	Array of objects (PostCartSummaryDestinations) List of destination configurations, each with a unique identifier
	Array of objects (JobTypePayloadInterface) List of jobs associated with the cart
discount_code	string Optional discount code applied to the cart
order_type	string Enum: "delivery_destination" "email_delivery" "workflow" "warm_up" "external_workflow" Type of order being placed
delivery_emails	Array of strings List of email addresses for delivery notifications
download_limit	number Maximum number of downloads allowed for this order
department_field_uuid	string Department field UUID

Responses

Request samples

Payload

Content type

application/json

{"destinations": [{"config_uuid": "string"
}
],
"jobs": [{"uuid": "string",
"context": "label-detection",
"service": "Whisper"
}
],
"discount_code": "string",
"order_type": "delivery_destination",
"delivery_emails": ["string"
],
"download_limit": 0,
"department_field_uuid": "string"
}

Response samples

200

Content type

application/json

{"cold": 0,
"discount_name": "string",
"discount_prices": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"discount_status": "active",
"formulas": {"property1": [{"config_uuid": "string",
"description": "string",
"formula": "string"
}
],
"property2": [{"config_uuid": "string",
"description": "string",
"formula": "string"
}
]
},
"price": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"settings": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"structuredFormulas": [{"config_uuid": "string",
"discount": 0,
"download_limit": 0,
"gigabytes": 0,
"minutes": 0,
"price_per_asset": 0,
"price_per_gb": 0,
"price_per_min": 0,
"price_per_quality": 0,
"quantity": 0,
"total": 0,
"type": "string"
}
],
"total": 0
}

List items with filename conventions

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_package_title required	string Title of the package
order_no required	string Order number
required	object (ConventionDataFilenamesForCartPayloadType) List of filenames for the cart

Responses

Request samples

Payload

Content type

application/json

{"order_package_title": "string",
"order_no": "string",
"overridden_conventions_data": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
}
}

Response samples

200

Content type

application/json

[{"cart_item_uuid": "string",
"original_filename": "string",
"result": "string",
"type": "video"
}
]

Validate Items in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_type

required

string

Enum: "delivery_destination" "email_delivery" "workflow" "warm_up" "external_workflow"

Type of order

Responses

Request samples

Payload

Content type

application/json

{"order_type": "delivery_destination"
}

Response samples

204
400

Content type

application/json

[ ]

Add search to a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

text	string Text input for searching assets
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
fields	Array of strings List of specific fields to include in the search results
advanced_mode	boolean Flag indicating whether advanced search mode is enabled

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
}

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Add Items to a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

Array

type required	string Enum: "asset" "collection" "order" The type of the item
entity_uuid required	string The UUID of the entity
required	object (PostOrderItemExtra) Additional information for the order item (optional)

Responses

Request samples

Payload

Content type

application/json

[{"type": "asset",
"entity_uuid": "string",
"extra": {"offset": "string",
"timecode_in": "string",
"timecode_out": "string",
"note": "string",
"voiceover_required": "string",
"override_asset_filename": "string",
"is_bbc_talent_voice_branding": "string"
}
}
]

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Delete Items from a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Collections

Create and manage Collections

List Collections details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter	string Filter
views-date-from required	string Views date from
views-date-to required	string Views date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

List my collections details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter	string Filter
views-date-from required	string Views date from
views-date-to required	string Views date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

List shared collections details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter	string Filter
views-date-from required	string Views date from
views-date-to required	string Views date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Get a Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

403
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Update a Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name	string An updated collection name
description	string An updated collection description
custom_cover	boolean An updated collection cover
filename	string An updated collection filename
	Array of objects (PatchCollectionItem) New collection collection items
delete_items	Array of strings Collection items to delete
owner	string An updated collection owner
users	Array of strings An updated collection users
	Array of objects (ParentCollection) An updated collection parent
shared_to_team_uuids	Array of strings An updated collection shared to team uuids
inherit_access required	boolean Inherit access from parent collection
is_public required	boolean Anyone can browse this collection

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"custom_cover": true,
"filename": "string",
"add_items": [{"item_uuid": "string",
"asset_uuid": "string",
"logging_type": "string",
"timecode_in": "string",
"timecode_out": "string",
"note": "string"
}
],
"delete_items": ["string"
],
"owner": "string",
"users": ["string"
],
"parentIds": [{"uuid": "string",
"attached": true
}
],
"shared_to_team_uuids": ["string"
],
"inherit_access": true,
"is_public": true
}

Response samples

200

Content type

application/json

{"access_type": "owned",
"children": [{"access_type": "owned",
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}

/collection/{uuid}

Authorizations:

customAuthorizer

Responses

List collection items details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter required	string Filter
tx-date-from required	string Date from
tx-date-to required	string Date to
facility-of-origin required	string Facility of origin
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Create a Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuid required	string An unique identifier for a new collection
name required	string A name for a new collection
description required	string A description of a new collection
inherit_access required	boolean Inherit access from parent collection
is_public required	boolean Anyone can browse this collection

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"description": "string",
"inherit_access": true,
"is_public": true
}

Response samples

201

Content type

application/json

{"access_type": "owned",
"children": [{"access_type": "owned",
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}

Export collection details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction

Request Body schema: application/json
required

fields required	Array of strings Field names to export
selected_asset_uuids	Array of strings Filter assets to export

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"selected_asset_uuids": ["string"
]
}

Get Access Type

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

collection_uuids

required

Array of strings

Collection unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"collection_uuids": ["string"
]
}

Response samples

200

Content type

application/json

[{"access_type": "owned",
"uuid": "string"
}
]

Upload a Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

filename required	string A filename for a new collection
file_uuid required	string An unique identifier for a new collection
file_type required	string A filename for a new collection

Responses

Request samples

Payload

Content type

application/json

{"filename": "string",
"file_uuid": "string",
"file_type": "string"
}

Response samples

201

Content type

application/json

{"access_type": "owned",
"children": [{"access_type": "owned",
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"inherit_access": true,
"is_public": true,
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"number_of_quarantined": 0,
"number_of_virtual": 0,
"owner": "string",
"owner_name": "string",
"parents": [{"name": "string",
"uuid": "string"
}
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"totalViews": 0,
"totalViewsRanking": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}

Create a Collection with confirmation

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

filename required	string A filename of a new collection
file_key required	string A file key of a new collection

Responses

Request samples

Payload

Content type

application/json

{"filename": "string",
"file_key": "string"
}

Response samples

200

Content type

application/json

"string"

Add order to collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_uuid

required

string

An order uuid

Responses

Request samples

Payload

Content type

application/json

{"order_uuid": "string"
}

Add order to collections

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_uuid required	string An order uuid
collection_uuids required	Array of strings Collection unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"order_uuid": "string",
"collection_uuids": ["string"
]
}

Add items to Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PatchCollectionItem)

New collection items data

Responses

Request samples

Payload

Content type

application/json

{"items": [{"item_uuid": "string",
"asset_uuid": "string",
"logging_type": "string",
"timecode_in": "string",
"timecode_out": "string",
"note": "string"
}
]
}

Add items to Collections

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required	Array of objects (PatchCollectionItem) New collection items data
collection_uuids required	Array of strings Collection unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"items": [{"item_uuid": "string",
"asset_uuid": "string",
"logging_type": "string",
"timecode_in": "string",
"timecode_out": "string",
"note": "string"
}
],
"collection_uuids": ["string"
]
}

Add Cart Items to Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Add Cart Items to Collections

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

collection_uuids

required

Array of strings

Collection unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"collection_uuids": ["string"
]
}

Remove subcollection from Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

collection_uuids

required

Array of strings

Collection unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"collection_uuids": ["string"
]
}

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Creates collection small thumbnail

Creates small thumbnail for collection if it has custom cover

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Add Collection to Cart

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Add search results to Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required	object (PostSearchV2) A search query
collections required	Array of strings Collection list
collection_name	string Collection name
users	Array of strings Users unique identifier

Responses

Request samples

Payload

Content type

application/json

{"query": {"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
},
"collections": ["string"
],
"collection_name": "string",
"users": ["string"
]
}

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Remove items from Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

items

required

Array of strings

Item unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"items": ["string"
]
}

Get a Collection analytics

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get a Collection analytics log

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
views-date-from required	string Views date from
views-date-to required	string Views date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200
404

Content type

application/json

[{"id": 0,
"logAction": "create",
"logDate": "2019-08-24T14:15:22Z",
"user": {"email": "string",
"name": "string",
"uuid": "string"
}
}
]

Export collection analytics logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
views-date-from required	string Views date from
views-date-to required	string Views date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction

Request Body schema: application/json
required

fields required	Array of strings Field names to export
selected_asset_uuids	Array of strings Filter assets to export

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
],
"selected_asset_uuids": ["string"
]
}

Delivery Destinations

Create and manage Delivery Destinations.

Get Paginated Delivery Destinations

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter	string Filter by name
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200
403

Content type

application/json

[{"uuid": "string",
"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file"
}
]

Get one Delivery Destination

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
403

Content type

application/json

{"uuid": "string",
"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file"
}

Edit a Delivery Destination

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of Delivery Destination
status required	string Enum: "draft" "active" Status of delivery
required	object (DeliveryDestinationEmailInput) Mailing lists to send notifications and links
required	Array of objects (DeliveryDestinationConfigInput) Delivery Destination configurations
	object (PublishForDeliveryDestinationInput) Publish option for all configs
	object (DeliveryDestinationFilenameConventionsInput) Filename Conventions configuration
type required	string Enum: "file" "title" Type of delivery

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file"
}

Response samples

200
403

Content type

application/json

{"uuid": "string",
"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file"
}

Delete chosen Delivery Destination

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create new Delivery Destination

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of Delivery Destination
status required	string Enum: "draft" "active" Status of delivery
required	object (DeliveryDestinationEmailInput) Mailing lists to send notifications and links
required	Array of objects (DeliveryDestinationConfigInput) Delivery Destination configurations
	object (PublishForDeliveryDestinationInput) Publish option for all configs
	object (DeliveryDestinationFilenameConventionsInput) Filename Conventions configuration
type required	string Enum: "file" "title" Type of delivery
uuid required	string UUID of Delivery Destination

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file",
"uuid": "string"
}

Response samples

201
403

Content type

application/json

{"uuid": "string",
"name": "string",
"status": "draft",
"email": {"delivery": ["string"
],
"notification": ["string"
]
},
"configs": [{"uuid": "string",
"rules": ["string"
]
}
],
"publish": {"type": "INGEST_IN_VIDA",
"credentialUuid": "string"
},
"filenameConventions": {"video": "string",
"audio": "string",
"image": "string",
"subtitle": "string",
"archive": "string",
"document": "string",
"other": "string",
"font": "string"
},
"type": "file"
}

Licensed Packages

Create and manage Licensed Packages.

List Licensed Packages

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter required	Array of arrays Filters Licensed Packages, Keyword for filter in name and description
status	enum Filters Licensed Packages, status can be `draft` or `active`
view-state	enum Filters Licensed Packages, view-state can be `none`, `promo` or `hero`
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
contract_in	string Contract in
contract_out	string Contract out
expires_before	string Expires before
contract_uuids	Array of arrays Filters Licensed Packages, List of contract unique identifiers
partner_uuids	Array of arrays Filters Licensed Packages, List of partners unique identifiers
Cache-Control	object Overrides default cache behaviour.

Responses

List Licensed Packages for Content Corner

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
filter required	Array of arrays Filters Licensed Packages, Keyword for filter in name and description
status	enum Filters Licensed Packages, status can be `draft` or `active`
view-state	enum Filters Licensed Packages, view-state can be `none`, `promo` or `hero`
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
expires_before	string Expires before
Cache-Control	object Overrides default cache behaviour.

Responses

Get a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

400
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Update a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

status required	string Enum: "draft" "active" Status of the licensed package
custom_cover	boolean Indicates whether a custom cover is used
custom_cover_path	string Path to the custom cover image
contract_uuids required	Array of strings List of contract UUIDs associated with the licensed package

Responses

Request samples

Payload

Content type

application/json

{"status": "draft",
"custom_cover": true,
"custom_cover_path": "string",
"contract_uuids": ["string"
]
}

Delete a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Get a Licensed Package for Content Corner

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

List Licensed Package Items

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
downloaded	string Is downloaded
tx-date-from	string Date from
tx-date-to	string Date to
facility-of-origin	string Facility of origin
type	string Type
text	string Text to filter
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List Licensed Package Items for Content Corner

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
downloaded	string Is downloaded
tx-date-from	string Date from
tx-date-to	string Date to
facility-of-origin	string Facility of origin
type	string Type
text	string Text to filter
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List Licensed Package Users from Rights Contracts with accessible content

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
text	string Text to filter
mail	string User email
partner-id	string Partner id
supplier-uuid	string Supplier uuid
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200
404

Content type

application/json

[{"email": "string",
"name": "string",
"uuid": "string"
}
]

Create a Licensed Package

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of the licensed package
description required	string Description of the licensed package
view_state required	string Enum: "none" "promo" "hero" Current view state of the licensed package
required	object (LicensedPackageOptions) Options and settings for the licensed package

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"view_state": "none",
"options": {"custom_cover_position": "string"
}
}

Download Setup for a Licensed Package

Creates a download setup for a Licensed Package or a download setup for Licensed Package Items if Asset uuids or Licensed Package Item uuids are given.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

download_uuids	Array of strings List of licensed packages UUIDs for the download
download_asset_uuids	Array of strings List of asset UUIDs for the downloaded
keep_folders_structure	boolean Indicates whether to preserve the folder structure during download
required	object (PostSearchV2) Search criteria for selecting licensed packages to download
partner_uuid required	string UUID of the partner initiating the download
download_type required	string Enum: "ASPERA" "HTTPS" Type of download

Responses

Request samples

Payload

Content type

application/json

{"download_uuids": ["string"
],
"download_asset_uuids": ["string"
],
"keep_folders_structure": true,
"search": {"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
},
"partner_uuid": "string",
"download_type": "ASPERA"
}

Response samples

400
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List Licensed Package Items download availability

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

asset_uuids

required

Array of strings

List of asset UUIDs that will be checked, if empty array, will return for all items

Responses

Request samples

Payload

Content type

application/json

{"asset_uuids": ["string"
]
}

Response samples

200
404

Content type

application/json

{"property1": true,
"property2": true
}

List Licensed Package Partners

Returns list of a valid Partners for a Licensed Package with the information if the Partner can still download this LicensedPackage. Download availability is based on Download Limit. If anything can be downloaded from Licensed Package canBeDownloaded will be return as true.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

asset_uuids

Array of strings

List of asset UUIDs that will be downloaded

Responses

Request samples

Payload

Content type

application/json

{"asset_uuids": ["string"
]
}

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Trigger Notification for a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

asset_uuids required	Array of strings List of asset UUIDs associated with the licensed package notification
emails required	Array of strings List of email addresses to send the notification to
rights_contract_uuids required	Array of strings List of rights contract UUIDs associated with the licensed package notification

Responses

Request samples

Payload

Content type

application/json

{"asset_uuids": ["string"
],
"emails": ["string"
],
"rights_contract_uuids": ["string"
]
}

Add items to Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PatchLicensedPackageItem)

List of asset uuids and notes

Responses

Request samples

Payload

Content type

application/json

{"items": [{"asset_uuid": "string",
"note": "string"
}
]
}

Add items to Licensed Packages

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required	Array of objects (PatchLicensedPackageItem) List of asset uuids and notes
licensed_package_uuids required	Array of strings Licensed Package unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"items": [{"asset_uuid": "string",
"note": "string"
}
],
"licensed_package_uuids": ["string"
]
}

Add search to Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

text	string Text input for searching assets
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
fields	Array of strings List of specific fields to include in the search results
advanced_mode	boolean Flag indicating whether advanced search mode is enabled

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"filters": {"inventory_type": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"player_offset": {"from": 0,
"to": 0
},
"container_duration": {"from": 0,
"to": 0
},
"video_duration": {"from": 0,
"to": 0
},
"encoded_pixels": ["string"
],
"clean_aperture": ["string"
],
"aspect_ratio": ["string"
],
"bitrate": {"from": 0,
"to": 0
},
"category": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"collection_uuid": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"framerate": ["string"
],
"ingest_date": { },
"legacy_ingest_date": { },
"updated_at": { },
"is_dirty": true,
"is_preview_app_enabled": true,
"is_deleted": true,
"is_purged": true,
"is_virtual": true,
"language": ["string"
],
"library_sales_rights": true,
"multiversion": ["string"
],
"image_aspect": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"orphan_filter": "string",
"physical_version_title": ["string"
],
"physical_version_description": ["string"
],
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"metadata_sub_type": ["string"
],
"synopsis": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"tx_date": { },
"type": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"genre": ["string"
],
"origin": ["string"
],
"vida_resolution": ["string"
],
"alt_no": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"audio_tracks_class": ["string"
],
"cold_only": true,
"storage": ["hot"
],
"transcriptions": ["string"
],
"profile": ["string"
],
"bitrate_mode": ["string"
],
"bit_depth": [0
],
"interlace_mode": ["string"
],
"video_interlacing_analysis_result": ["string"
],
"pixel_aspect_ratio": [0
],
"chroma_format": ["string"
],
"color_space": ["string"
],
"color_primaries": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_format": ["string"
],
"format": ["string"
],
"licensed_package_uuids": ["string"
],
"tagsValue": ["string"
],
"width": [0
],
"height": [0
],
"upload_source": ["string"
],
"is_quarantined": true,
"is_embargoed": true,
"delivery_pack_name": ["string"
],
"revision": [0
]
},
"fields": ["string"
],
"advanced_mode": true
}

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Delete items from Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

items

required

Array of strings

List of asset UUIDs to remove from the licensed package

Responses

Request samples

Payload

Content type

application/json

{"items": ["string"
]
}

Delete items from Licensed Packages

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

items required	Array of strings List of asset UUIDs to remove from the licensed package
licensed_package_uuids required	Array of strings Licensed Package unique identifiers

Responses

Request samples

Payload

Content type

application/json

{"items": ["string"
],
"licensed_package_uuids": ["string"
]
}

Export licensed package details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (LicensedPackageFieldsData)

List of fields to select

Responses

Request samples

Payload

Content type

application/json

{"fields": [{"value": "string",
"label": "string"
}
]
}

Orders

Create and manage Orders.

List Orders

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
name-subject	string Name of subject
delivery-status	string Delivery status
download-status	string Download status
status	string Status
combined-status	string Combined status
orders-type required	enum Filter
date-from	string Date from
date-to	string Date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List orders in approval flow

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
name-subject	string Name of subject
delivery-status	string Delivery status
download-status	string Download status
status	string Status
combined-status	string Combined status
orders-type required	enum Filter
date-from	string Date from
date-to	string Date to
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Edit an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

send_as_shared_pack required	boolean Indicates whether the order should be sent as a shared pack
status required	string Status of the order
comment	string Optional comment for the order
expires_at	number The expiration date of the order
sf_unlock	boolean Indicates whether the order should be unlocked for sf

Responses

Request samples

Payload

Content type

application/json

{"send_as_shared_pack": true,
"status": "string",
"comment": "string",
"expires_at": 0,
"sf_unlock": true
}

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

List items for an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
downloaded	string Is downloaded
tx-date-from	string Date from
tx-date-to	string Date to
facility-of-origin	string Facility of origin
type	string Type
text	string Text to filter
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Approve Order Items

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

all required	boolean Indicates whether to apply the status to all order items
status required	string Status of the order items
	Array of objects (PatchOrderAssetProperty) A list of order items with their unique identifiers and status

Responses

Request samples

Payload

Content type

application/json

{"all": true,
"status": "string",
"assets": [{"uuid": "string"
}
]
}

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get signed clearance notes link

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
403

Content type

application/json

{"clearance_notes_uri": "string"
}

Get an Order confirmation pdf

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
403

Content type

application/json

{"url": "string"
}

List Redelivery Emails

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
403

Content type

application/json

["string"
]

Lists order status changes

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

List an Order related emails

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

["string"
]

List orders from a Mediapulse

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
tx-date-from	string Date from
tx-date-to	string Date to
text	string Text
po	string Filters mediapulse orders by `purchase number`
wo_no	string Filters mediapulse orders by identifier
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200
400

Content type

application/json

[{"account_rep_desc": "string",
"contact": "string",
"date_changed": "string",
"phase_code": "string",
"po": "string",
"status_no": "string",
"wo_desc": "string",
"wo_end_dt": "string",
"wo_no": 0
}
]

Create an Order

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Responses

Response samples

200

Content type

application/json

{"coldStorageRetrieval": true,
"id": 0,
"uuid": "string"
}

Create an Order for fast download

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Responses

Create an Order for assets undeletion

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Responses

Download setup for an Order

Creates a download setup for an Order or a download setup for Order Items if Order Items uuids are given.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

download_uuids required	Array of strings A list of UUIDs for the files to be downloaded
keep_folders_structure required	boolean Flag indicating whether to keep the folder structure during the download
config_uuid required	string The configuration UUID for the download request
download_type required	string Enum: "ASPERA" "HTTPS" The type of the download request

Responses

Request samples

Payload

Content type

application/json

{"download_uuids": ["string"
],
"keep_folders_structure": true,
"config_uuid": "string",
"download_type": "ASPERA"
}

Response samples

401
403
404
422

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Retry Clipping

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

items

required

Array of strings

A list of item UUIDs to re-trigger clipping

Responses

Request samples

Payload

Content type

application/json

{"items": ["string"
]
}

Response samples

400
403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Retry Delivery Destinations Failed Jobs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (OrderRetryDDJob)

A list of jobs to retry

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"item_uuid": "string",
"config_uuid": "string"
}
]
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Retry failed clippings in order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_item_uuids

Array of strings

A list of exact order item uuids to retry

Responses

Request samples

Payload

Content type

application/json

{"order_item_uuids": ["string"
]
}

Response samples

400

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Retry delivery for Clips

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

emails

required

Array of strings

List of email addresses for redelivering the clips

Responses

Request samples

Payload

Content type

application/json

{"emails": ["string"
]
}

Response samples

403
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Get an Order delivery confirmation pdf

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Get Order delivery confirmation pdfs

Pdfs are being send by an email to an User

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuids

required

Array of strings

A list of UUIDs to get order delivery confirmation pdfs

Responses

Request samples

Payload

Content type

application/json

{"uuids": ["string"
]
}

Set Aspera Download Success Status

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

transferUuid required	string The unique identifier for the aspera transfer
status required	string The aspera finished status of the download.

Responses

Request samples

Payload

Content type

application/json

{"transferUuid": "string",
"status": "string"
}

Export an Order details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
name-subject	string Name of subject
delivery-status	string Delivery status
download-status	string Download status
status	string Status
combined-status	string Combined status
orders-type required	enum Filter
date-from	string Date from
date-to	string Date to

Request Body schema: application/json
required

required

Array of objects (DataSelector)

Selector

Responses

Request samples

Payload

Content type

application/json

{"fields": [{"value": "string",
"label": "string"
}
]
}

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Convert Pathe Ids to Uuids

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

ids

required

Array of strings

A list of path IDs

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200

Content type

application/json

{ }

/order/{uuid}/approve

Authorizations:

customAuthorizer

Request Body schema: application/json
required

comment	string
expires_at	number
send_as_shared_pack required	boolean
sf_unlock	boolean
status required	string Enum: "approved" "submitted"

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"expires_at": 0,
"send_as_shared_pack": true,
"sf_unlock": true,
"status": "approved"
}

Manage Assigned Order Discounts

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

order_uuids required	Array of strings Uuids of orders to change discount
new_discount_uuid	string Uuid of new discount

Responses

Request samples

Payload

Content type

application/json

{"order_uuids": ["string"
],
"new_discount_uuid": "string"
}

Response samples

403
404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Order again

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Rights Contracts

Create and manage Rights Contracts.

List Rights Contracts

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
text	string Text to filter
licensed-package-uuid	string UUID of licensed package
start-before	string Start before
end-after	string End after
partner-id	string Partner id
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction
Cache-Control	object Overrides default cache behaviour.

Responses

Response samples

200

Content type

application/json

[{"contract_id": "string",
"created_at": "string",
"download_limit": 0,
"end_date": "string",
"licensed_package_count": 0,
"licensed_package_names": "string",
"licensed_packages": [{"name": "string",
"uuid": "string"
}
],
"name": "string",
"notifications_enabled": true,
"partner": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"start_date": "string",
"status": "string",
"updated_at": "string",
"uuid": "string"
}
]

Get a Rights Contract

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
404

Content type

application/json

{"contract_id": "string",
"created_at": "string",
"download_limit": 0,
"end_date": "string",
"licensed_package_count": 0,
"licensed_package_names": "string",
"licensed_packages": [{"name": "string",
"uuid": "string"
}
],
"name": "string",
"notifications_enabled": true,
"partner": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"start_date": "string",
"status": "string",
"updated_at": "string",
"uuid": "string"
}

Update a Rights Contract

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of the rights contract
contract_id required	string Contract identifier
notifications_enabled required	boolean Flag indicating if notifications are enabled for the contract
download_limit required	number A number of times an item can be downloaded per contract
required	object (RightsContractPartner) Partner details including UUID, name, and users count
licensed_package_uuids required	Array of strings List of UUIDs for licensed packages associated with the rights contract
licensed_package_names required	Array of strings List of names for licensed packages associated with the rights contract
licensed_package_count required	number Count of licensed packages associated with the rights contract
status required	string Current status of the rights contract
partner_uuid required	string UUID of the partner associated with the rights contract
licensed_packages_to_attach required	Array of strings List of licensed package UUIDs to attach to the rights contract
licensed_packages_to_detach required	Array of strings List of licensed package UUIDs to detach from the rights contract

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"contract_id": "string",
"notifications_enabled": true,
"download_limit": 0,
"partner": {"uuid": "string",
"name": "string",
"partner_users_count": 0
},
"licensed_package_uuids": ["string"
],
"licensed_package_names": ["string"
],
"licensed_package_count": 0,
"status": "string",
"partner_uuid": "string",
"licensed_packages_to_attach": ["string"
],
"licensed_packages_to_detach": ["string"
]
}

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Delete a Rights Contract

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Get a Rights Contract Logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

[{"base_object": "string",
"changeset": "string",
"date": "string",
"message": "string",
"user": "string"
}
]

Create a Rights Contract

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

uuid required	string Unique identifier for the rights contract
name required	string Name of the rights contract
contract_id required	string Contract identifier
notifications_enabled required	boolean Flag indicating if notifications are enabled for the contract
download_limit required	number A number of times an item can be downloaded per contract
partner_uuid required	string UUID of the partner associated with the rights contract
licensed_package_uuids required	Array of strings List of UUIDs for licensed packages associated with the rights contract

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"contract_id": "string",
"notifications_enabled": true,
"download_limit": 0,
"partner_uuid": "string",
"licensed_package_uuids": ["string"
]
}

Response samples

403

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Export a Rights Contract details

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
partner-id	string Partner id
filter	string Filter
page	string Page number
per-page	string Items per page
order-by	string Order by field
order-dir	enum Order direction

Request Body schema: application/json
required

required

Array of objects (RightsContractFieldsData)

List of fields to select

Responses

Request samples

Payload

Content type

application/json

{"fields": [{"value": "string",
"label": "string"
}
]
}

Set a Rights Contract to release

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Transcode Containers

Create and manage transcode container configurations.

Get all transcode containers

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

[{"kind": "string",
"label": "string",
"uuid": "string"
}
]

Get details for a transcode container

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
404

Content type

application/json

{"kind": "string",
"label": "string",
"uuid": "string"
}

Update existing transcode container

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

kind required	string Container kind (format)
label required	string Display label

Responses

Request samples

Payload

Content type

application/json

{"kind": "string",
"label": "string"
}

Response samples

200
400
404

Content type

application/json

{"kind": "string",
"label": "string",
"uuid": "string"
}

Delete a transcode container

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create new transcode container

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

kind required	string Container kind (format)
label required	string Display label

Responses

Request samples

Payload

Content type

application/json

{"kind": "string",
"label": "string"
}

Response samples

201
400

Content type

application/json

{"kind": "string",
"label": "string",
"uuid": "string"
}

Transcode Types

Create and manage transcode type configurations.

Get all transcode types

Authorizations:

customAuthorizer

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

[{"name": "string",
"transcode_containers": [{"kind": "string",
"label": "string",
"uuid": "string"
}
],
"uuid": "string",
"video_codec_mappings": [{"display_name": "string",
"profile": "string",
"uuid": "string",
"video_codec": "string"
}
]
}
]

Get details for a transcode type

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id required	string Unique Client identifier in the system
Cache-Control	object Overrides default cache behaviour.

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
404

Content type

application/json

{"name": "string",
"transcode_containers": [{"kind": "string",
"label": "string",
"uuid": "string"
}
],
"uuid": "string",
"video_codec_mappings": [{"display_name": "string",
"profile": "string",
"uuid": "string",
"video_codec": "string"
}
]
}

Update existing transcode type

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of the transcode type
container_uuids required	Array of strings Container UUIDs
codec_mapping_uuids required	Array of strings Codec mapping UUIDs

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"container_uuids": ["string"
],
"codec_mapping_uuids": ["string"
]
}

Response samples

200
400
404

Content type

application/json

{"name": "string",
"transcode_containers": [{"kind": "string",
"label": "string",
"uuid": "string"
}
],
"uuid": "string",
"video_codec_mappings": [{"display_name": "string",
"profile": "string",
"uuid": "string",
"video_codec": "string"
}
]
}

Delete a transcode type

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

UUID of entity

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

any (undefined)

Responses

Request samples

Payload

Content type

application/json

null

Response samples

404

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string",
"type": "EntityNotFoundError"
}

Create new transcode type

Authorizations:

customAuthorizer

header Parameters

vida-client-id

required

string

Unique Client identifier in the system

Request Body schema: application/json
required

name required	string Name of the transcode type
container_uuids required	Array of strings Container UUIDs
codec_mapping_uuids required	Array of strings Codec mapping UUIDs

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"container_uuids": ["string"
],
"codec_mapping_uuids": ["string"
]
}

Response samples

201
400

Content type

application/json

{"name": "string",
"transcode_containers": [{"kind": "string",
"label": "string",
"uuid": "string"
}
],
"uuid": "string",
"video_codec_mappings": [{"display_name": "string",
"profile": "string",
"uuid": "string",
"video_codec": "string"
}
]
}

VIDA Backend API (1.0.0)

Welcome to the Vida API

Authentication

Assets

List Assets details

Authorizations:

header Parameters

Responses

Assets update

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Assets

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List all assets

Authorizations:

header Parameters

Responses

Get Archived Assets

Authorizations:

header Parameters

Responses

Get Ingested Assets

Authorizations:

header Parameters

Responses

List latest Assets

Authorizations:

header Parameters

Responses

Generate Mediapulse JSON for Assets

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List All Assets on map

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request assets deletion

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Set Assets as Cold

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Set Search Assets as cold

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Set assets as hot

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get price for set as hot/cold

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required