VIDA Backend API (1.0.0)

Download OpenAPI specification:Download

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.

Get details for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"attachments": [{"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
}
],
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "string",
"loudness": "string",
"loudness_standard": "string",
"number": "string",
"qc_status": "string",
"sample_rate": "string",
"tech": "string"
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"file_metadata": {"aspect_ratio": "string",
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"dropped_frames": true,
"duration": "string",
"duration_sec": 0,
"filesize": 0,
"format": "string",
"frame_rate_mode": "string",
"framerate": "string",
"interlace_mode": "string",
"pixel_aspect_ratio": 0,
"resolution": "string",
"source": "hybrik",
"timecode_start": "string",
"vida_resolution": "string",
"video": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"video_codec_mapping": "string"
},
"general": {"approval_status": 0,
"batch_id": "string",
"client_asset_id": "string",
"cold_only": true,
"collections": ["string"
],
"collections_details": [{"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"item_uuid": "string",
"name": "string",
"order": 0,
"uuid": "string"
}
],
"download_proxy_url": "string",
"download_url": "string",
"embargoed_to": "string",
"estimated_restore_at": "string",
"external_key": "string",
"file_ext": "string",
"file_url": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"hot_expires_at": "2019-08-24T14:15:22Z",
"is_proxy_only": true,
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"licensedPackageUuids": ["string"
],
"logs": [{"created_at": "string",
"message": "string"
}
],
"master_no": "string",
"md5": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"media_key": "string",
"original_filename": "string",
"parent": "string",
"preview_url": "string",
"processingStatus": "PLACEHOLDER",
"rating_uuids": ["string"
],
"s_object_id": "string",
"s_object_id_bk": "string",
"stage": 0,
"storage": "hot",
"storage_status": "active",
"subtitles": [{"language": "string",
"path": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_processing": true,
"thumbnail_tape_interval": "string",
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"type": "string",
"upload_source": "string",
"uploaded_at": "string",
"uuid": "string"
},
"locks": [{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
],
"logginginfo": [{"duration": "string",
"logging_type": "string",
"note": "string",
"offset": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
],
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"transactions": [{"ai_model_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"email": "string",
"name": "string",
"uuid": "string"
},
"id": 0,
"order_id": 0,
"type": "ingest"
}
],
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Update an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (PatchAssetAdditionalType)
	Array of objects (PatchAssetAudioTrackType)
	object (PatchAssetCoreType)
	object (PatchAssetExtAssetInfoType)
	object (PatchAssetExtTitleInfoType)
	object (PatchAssetGeneralType)
	object (PatchAssetMediaSetType)
	object (PatchAssetUserMediaDataType)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"attachments": [{"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
}
],
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "string",
"loudness": "string",
"loudness_standard": "string",
"number": "string",
"qc_status": "string",
"sample_rate": "string",
"tech": "string"
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"file_metadata": {"aspect_ratio": "string",
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"dropped_frames": true,
"duration": "string",
"duration_sec": 0,
"filesize": 0,
"format": "string",
"frame_rate_mode": "string",
"framerate": "string",
"interlace_mode": "string",
"pixel_aspect_ratio": 0,
"resolution": "string",
"source": "hybrik",
"timecode_start": "string",
"vida_resolution": "string",
"video": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"video_codec_mapping": "string"
},
"general": {"approval_status": 0,
"batch_id": "string",
"client_asset_id": "string",
"cold_only": true,
"collections": ["string"
],
"collections_details": [{"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"item_uuid": "string",
"name": "string",
"order": 0,
"uuid": "string"
}
],
"download_proxy_url": "string",
"download_url": "string",
"embargoed_to": "string",
"estimated_restore_at": "string",
"external_key": "string",
"file_ext": "string",
"file_url": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"hot_expires_at": "2019-08-24T14:15:22Z",
"is_proxy_only": true,
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"licensedPackageUuids": ["string"
],
"logs": [{"created_at": "string",
"message": "string"
}
],
"master_no": "string",
"md5": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"media_key": "string",
"original_filename": "string",
"parent": "string",
"preview_url": "string",
"processingStatus": "PLACEHOLDER",
"rating_uuids": ["string"
],
"s_object_id": "string",
"s_object_id_bk": "string",
"stage": 0,
"storage": "hot",
"storage_status": "active",
"subtitles": [{"language": "string",
"path": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_processing": true,
"thumbnail_tape_interval": "string",
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"type": "string",
"upload_source": "string",
"uploaded_at": "string",
"uuid": "string"
},
"locks": [{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
],
"logginginfo": [{"duration": "string",
"logging_type": "string",
"note": "string",
"offset": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
],
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"transactions": [{"ai_model_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"email": "string",
"name": "string",
"uuid": "string"
},
"id": 0,
"order_id": 0,
"type": "ingest"
}
],
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Delete an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assetUuids required	Array of strings
deleteReason required	string
deletionBillable required	boolean

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Get subtitles for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"subs": [{"language": "string",
"path": "string"
}
]
}

Get a Hybrik Analyze for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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
},
"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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

"string"

Get a Hybrik QA for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Get pdf with an Asset details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"url": "string"
}

List Asset Storage Logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page

Responses

Response samples

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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

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

Get transcriptions for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

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

Upload to Vimeo

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"after": [{"confidence": 0,
"data": {"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": {"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

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
type required	string `Type of data to be locked for edits`
confirm	boolean `Confirm take over of existing lock by another user`
action required	string Action to perform with lock. Can be `create` or `refresh` or `unlock`

Responses

Response samples

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

string

Unique Client identifier in the system

Responses

Add a File to an Asset from Aspera

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Get download proxy for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"url": "string"
}

Register to Rasp

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

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

Delete from a Rasp register

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Create an Asset Trailer

Trailer is created from asset clips.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

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

Create an Asset Trailer

Trailer is created from images.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

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

Create transcription for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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 Optional job options, including tone settings
trackNumber	string Optional track number associated with the job

Responses

Request samples

Payload

Content type

application/json

{"modelUuid": "string",
"options": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null,
"description": null
},
"trackNumber": "string"
}

Response samples

Content type

application/json

{"jobUuid": "string"
}

Abort an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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"
}

Complete an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Create an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

"string"

Create a Virtual Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

{"uuid": "string"
}

Create an Asset from Aspera

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PostAsperaAssetToAssetTypeFiles)

List of files for aspera

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Update an Asset embargo date

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (PatchAssetAdditionalType)
	Array of objects (PatchAssetAudioTrackType)
	object (PatchAssetCoreType)
	object (PatchAssetExtAssetInfoType)
	object (PatchAssetExtTitleInfoType)
	object (PatchAssetGeneralType)
	object (PatchAssetMediaSetType)
	object (PatchAssetUserMediaDataType)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

true

Regenerate an Asset Proxy

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

true

Finish an Aspera Upload

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

Content type

application/json

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

List Assets details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Assets update

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

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

string

Unique Client identifier in the system

Request Body schema: application/json
required

assetUuids required	Array of strings
deleteReason required	string
deletionBillable required	boolean

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

List All Assets

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Get Archived Assets

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Get Ingest Assets List

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

List latest Assets

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Generate Mediapulse JSON for Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"message": "Accepted"
}

List All Assets on map

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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"
}

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Set Assets as Cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

Content type

application/json

true

Set Search Assets as cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

true

Set assets as hot

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

Content type

application/json

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

Get price for set as hot/cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

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

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Get price for set as hot/cold from search

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

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

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

Export a list of assets in landingpad

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Carts

Create and manage Carts.

List Assets in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
embargoed	boolean Filters Assets by `is embargoed`
quarantined	boolean Filters Assets by `is quarantined`

Responses

Response samples

Content type

application/json

[{"asset": {"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
},
"note": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
]

Count Items in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

0

List Cart extra

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

List prices for a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"cold": 0,
"discount_name": "string",
"discount_prices": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"discount_status": "active",
"price": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"settings": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"total": 0
}

Validate Items in a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[ ]

Add search to a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Add to a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

Array

entity_uuid required	string
	object (PostOrderItemExtraInterface)
type required	string (ItemTypeEnum) Enum: "asset" "collection" "order"

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Delete Item from a Cart

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

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

Collections

Create and manage Collections

List Collections details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters

Responses

Response samples

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}
]

List own collections details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters

Responses

List Shared Collections details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters

Responses

Response samples

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}
]

Get a Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}

Update a Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

	Array of objects (PatchCollectionItemType) New collection collection items
custom_cover	boolean An updated collection cover
delete_items	Array of strings Collection items to delete
description	string An updated collection description
filename	string An updated collection filename
name	string An updated collection name
owner	string An updated collection owner
	Array of objects (ParentCollectionInterface) An updated collection parent
shared_to_team_uuids	Array of strings An updated collection shared to team uuids
users	Array of strings An updated collection users

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"access_type": "shared",
"children": [{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"name": "string",
"number_of_assets": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"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",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"users": [{"name": "string",
"picture": "string",
"uuid": "string"
}
],
"uuid": "string"
}

Delete Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

List collection items details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters
tx-date-from	string Filters results by newer than given date
tx-date-to	string Filters results by older than given date
facility-of-origin	string Filters results by facility of origin

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
]

Create a Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

description required	string A description of a new collection
name required	string A name for a new collection
uuid required	string An unique identifier for a new collection

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"uuid": "string"
}

Response samples

Content type

application/json

{"access_type": "shared",
"children": [{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"name": "string",
"number_of_assets": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"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",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"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

Unique item identifier in the system

header Parameters

order-by	string Set order by
order-dir	string Set order dir
vida-client-id	string Unique Client identifier in the system

Request Body schema: application/json
required

fields

required

Array of strings

Field names to export

Responses

Request samples

Payload

Content type

application/json

{"fields": ["string"
]
}

Get Access Type

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

Content type

application/json

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

Upload a Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"access_type": "shared",
"children": [{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"name": "string",
"number_of_assets": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"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",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed": 0,
"owner": "string",
"owner_name": "string",
"parent_uuids": ["string"
],
"shared_to_teams": [{"name": "string",
"uuid": "string"
}
],
"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

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

"string"

Add order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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 items to Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PatchCollectionItemType)

New collection items data

Responses

Request samples

Payload

Content type

application/json

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

Add Cart Items to Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Add Collection to Cart

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Add search results to Collection

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Remove items from Collection

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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"
]
}

Licensed Packages

Create and manage Licensed Packages.

List Licensed Packages

Authorizations:

customAuthorizer

query Parameters

contract_uuids	string Filters Licensed Packages, List of contract unique identifiers
partner_uuids	string Filters Licensed Packages, List of partners unique identifiers
expires_before	number Filters Licensed Packages, Expires before that date

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters
status	string Filters Licensed Packages, status can be `draft` or `active`
view-state	string Filters Licensed Packages, view state can be `none` or `promo` or `hero`

Responses

Response samples

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "2019-08-24T14:15:22Z",
"min_start_at": "2019-08-24T14:15:22Z",
"name": "string",
"number_of_assets": 0,
"number_of_contracts": 0,
"number_of_embargoed": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "none"
}
]

List Licensed Packages for Content Corner

Authorizations:

customAuthorizer

query Parameters

expires_before

number

Filters Licensed Packages, Expires before that date

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
filter	string JSON encoded value of the filters
view-state	string Filters Licensed Packages, view state can be `none` or `promo` or `hero`

Responses

Response samples

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "2019-08-24T14:15:22Z",
"min_start_at": "2019-08-24T14:15:22Z",
"name": "string",
"number_of_assets": 0,
"number_of_contracts": 0,
"number_of_embargoed": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "none"
}
]

Get a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"contracts": [{"name": "string",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "string",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed_assets": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "string"
}

Update a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"contracts": [{"name": "string",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "string",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed_assets": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "string"
}

Delete a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Get a Licensed Package For Content Corner

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"contracts": [{"name": "string",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "string",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed_assets": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "string"
}

List Licensed Package Items

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
downloaded	boolean Filters Results by `is downloaded`
text	string Filters results by included text
tx-date-from	string Filters results by newer than given date
tx-date-to	string Filters results by older than given date
type	string Filters results by asset type Available asset types: `video, audio, image, subtitle, archive, document, other, font`
facility-of-origin	string Filters results by facility of origin

Responses

Response samples

Content type

application/json

[{"approval_status": 0,
"asset": {"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
},
"clip_sales_force_name": "string",
"clipping_status": "string",
"delivery_destinations": [{"configs": [{"jobs": [{"extra": {"publishSize": 0
},
"progress": 0,
"status": "submitted",
"type": "transcode"
}
],
"name": "string",
"path": "string",
"uuid": "string"
}
],
"name": "string",
"uuid": "string"
}
],
"download_uuid": "string",
"downloaded": true,
"expires_at": "string",
"external_id": "string",
"note": "string",
"remaining_downloads": 0,
"sales_force_uri": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
]

List Licensed Package Items for Content Corner

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
downloaded	boolean Filters Results by `is downloaded`
text	string Filters results by included text
tx-date-from	string Filters results by newer than given date
tx-date-to	string Filters results by older than given date
type	string Filters results by asset type Available asset types: `video, audio, image, subtitle, archive, document, other, font`
facility-of-origin	string Filters results by facility of origin

Responses

Response samples

Content type

application/json

[{"approval_status": 0,
"asset": {"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
},
"clip_sales_force_name": "string",
"clipping_status": "string",
"delivery_destinations": [{"configs": [{"jobs": [{"extra": {"publishSize": 0
},
"progress": 0,
"status": "submitted",
"type": "transcode"
}
],
"name": "string",
"path": "string",
"uuid": "string"
}
],
"name": "string",
"uuid": "string"
}
],
"download_uuid": "string",
"downloaded": true,
"expires_at": "string",
"external_id": "string",
"note": "string",
"remaining_downloads": 0,
"sales_force_uri": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
]

Create a Licensed Package

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"contracts": [{"name": "string",
"uuid": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"items": [{"alt_no": "string",
"aspect_ratio": "string",
"asset_uuid": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"item_uuid": "string",
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"width": 0
}
],
"max_expires_at": "string",
"name": "string",
"number_of_assets": 0,
"number_of_embargoed_assets": 0,
"options": {"custom_cover_position": "string"
},
"owner": "string",
"owner_name": "string",
"status": "string",
"total": 0,
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"view_state": "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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

download_asset_uuids	Array of strings List of asset UUIDs for the downloaded
download_uuids	Array of strings List of licensed packages UUIDs for the download
keep_folders_structure	boolean Indicates whether to preserve the folder structure during download
partner_uuid required	string UUID of the partner initiating the download
required	object (PostSearchTypeV2) Search criteria for selecting licensed packages to download

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"cookie": "string",
"faspPort": 0,
"paths": [{"destination": "string",
"source": "string"
}
],
"remoteHost": "string",
"remoteUser": "string",
"sshPort": 0,
"token": "string",
"transferUuid": "string"
}

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

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

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

Trigger Notification for a Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Add items to Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PatchLicensedPackageItemType)

List of asset uuids and notes

Responses

Request samples

Payload

Content type

application/json

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

Add Search Licensed Packages

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Delete items form Licensed Package

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

items

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"items": ["string"
]
}

Orders

Create and manage Orders.

List Orders

Authorizations:

customAuthorizer

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
status	string Filters by order status, can be `submitted` or `approved`
delivery-status	string Filters orders by delivery-status Available delivery statuses: `created` `scheduled` `collecting_assets` `delivery` `delivered` `failed` `submitted_to_sf` `gettyimages_api_failed` `retrieving_from_cold`
orders-type	string Filters orders by its typeAvailable order types: `shared-packs` `all` `shared` `own`
name-subject	string
download-status	string Filters orders by download-status, can be `new` or `downloaded` or `expired`
date-from	string Filters results by newer than given date
date-to	string Filters results by older than given date

Responses

Response samples

Content type

application/json

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

Get an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Edit an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

comment	string Optional comment for the order
expires_at	number The expiration date of the order
send_as_shared_pack required	boolean Indicates whether the order should be sent as a shared pack
sf_unlock	boolean
status required	string Enum: "approved" "submitted" Status of the order

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

List items for an Order

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
downloaded	boolean Filters Results by `is downloaded`
text	string Filters results by included text
tx-date-from	string Filters results by newer than given date
tx-date-to	string Filters results by older than given date
type	string Filters results by asset type Available asset types: `video, audio, image, subtitle, archive, document, other, font`
facility-of-origin	string Filters results by facility of origin

Responses

Response samples

Content type

application/json

[{"approval_status": 0,
"asset": {"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
},
"clip_sales_force_name": "string",
"clipping_status": "string",
"delivery_destinations": [{"configs": [{"jobs": [{"extra": {"publishSize": 0
},
"progress": 0,
"status": "submitted",
"type": "transcode"
}
],
"name": "string",
"path": "string",
"uuid": "string"
}
],
"name": "string",
"uuid": "string"
}
],
"download_uuid": "string",
"downloaded": true,
"expires_at": "string",
"external_id": "string",
"note": "string",
"remaining_downloads": 0,
"sales_force_uri": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
]

Edit Order Items

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects

A list of assets with their unique identifiers and status

Responses

Request samples

Payload

Content type

application/json

{"assets": [{"status": "approved",
"uuid": "string"
}
]
}

Response samples

Content type

application/json

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

Get an Order confirmation pdf

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"url": "string"
}

List Redelivery Emails

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

["string"
]

List an Order related emails

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

["string"
]

List orders from a Mediapulse

Authorizations:

customAuthorizer

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
text	string Filters results by included text
po	string Filters mediapulse orders by `purchase number`
wo_no	string Filters mediapulse orders by identifier
tx-date-from	string Filters results by newer than given date
tx-date-to	string Filters results by older than given date

Responses

Response samples

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

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

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

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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"cookie": "string",
"faspPort": 0,
"paths": [{"destination": "string",
"source": "string"
}
],
"remoteHost": "string",
"remoteUser": "string",
"sshPort": 0,
"token": "string",
"transferUuid": "string"
}

Retry Clipping

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

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

Retry Delivery Destinations Failed Jobs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (OrderRetryDDJobInterface)

A list of jobs to retry

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Retry delivery for Clips

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

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

Content type

application/json

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

Get an Order delivery confirmation pdf

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Get Order delivery confirmation pdfs

Pdfs are being send by an email to an User

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

string

Unique Client identifier in the system

Request Body schema: application/json
required

status required	string Enum: "completed" "error" "success" The aspera finished status of the download.
transferUuid required	string The unique identifier for the aspera transfer

Responses

Request samples

Payload

Content type

application/json

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

Export an Order details

Authorizations:

customAuthorizer

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
status	string
delivery-status	string Filters orders by delivery-status Available delivery statuses: `created` `scheduled` `collecting_assets` `delivery` `delivered` `failed` `submitted_to_sf` `gettyimages_api_failed` `retrieving_from_cold`
orders-type	string Filters orders by its typeAvailable order types: `shared-packs` `all` `shared` `own`
name-subject	string
download-status	string Filters orders by download-status, can be `new` or `downloaded` or `expired`
date-from	string Filters results by newer than given date
date-to	string Filters results by older than given date

Request Body schema: application/json
required

required

Array of objects (DataSelector)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Convert pathe to uuid

Authorizations:

customAuthorizer

header Parameters

vida-client-id

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

Content type

application/json

{ }

Order again

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

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

Rights Contracts

Create and manage Rights Contracts.

List Rights Contracts

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
partner-id	string Filter results by Partner identifier
filter	string JSON encoded value of the filters

Responses

Response samples

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_package_uuids": ["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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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_package_uuids": ["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

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

contract_id required	string Contract identifier
created_at required	string Timestamp when the rights contract was created
download_limit required	number A number of times an item can be downloaded per contract
end_date required	string End date of the rights contract
licensed_package_count required	number Count of 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_uuids required	Array of strings List of UUIDs for licensed packages 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
name required	string Name of the rights contract
notifications_enabled required	boolean Flag indicating if notifications are enabled for the contract
required	object Partner details including UUID, name, and users count
partner_uuid required	string UUID of the partner associated with the rights contract
start_date required	string Start date of the rights contract
status required	string Current status of the rights contract
updated_at required	string Timestamp when the rights contract was last updated

Responses

Request samples

Payload

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_package_uuids": ["string"
],
"licensed_packages_to_attach": ["string"
],
"licensed_packages_to_detach": ["string"
],
"name": "string",
"notifications_enabled": true,
"partner": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null,
"description": null
},
"partner_uuid": "string",
"start_date": "string",
"status": "string",
"updated_at": "string"
}

Response samples

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_package_uuids": ["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"
}

Delete a Rights Contract

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Get Rights Contract Logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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

string

Unique Client identifier in the system

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

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_package_uuids": ["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"
}

Export a Rights Contract details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system
partner-id	string Partner identifier
filter	string JSON encoded value of the filters

Request Body schema: application/json
required

required

Array of objects (DataSelector)

Responses

Request samples

Payload

Content type

application/json

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

Set a Rights Contract to release

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

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_package_uuids": ["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"
}

VIDA Backend API (1.0.0)

Welcome to the Vida API

Authentication

Assets

Get details for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an Asset

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an Asset

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get subtitles for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a Hybrik Analyze for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a playlist for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a Hybrik QA for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Get pdf with an Asset details

Authorizations:

path Parameters

header Parameters

Responses

Response samples

List Asset Storage Logs

Authorizations:

path Parameters

header Parameters

Responses

Response samples

List an Asset Storage Statuses

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get transcriptions for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Upload to Vimeo

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get historical asset locks which represent successful edits by users

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