- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset metadata of which will be updated. Validations:
|
|
custom_metadata
required |
A Hash of Hashes. First level keys are indices of the elements. Second level keys are ‘value’ and ‘custom_metadata_field’. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset metadata of which will be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be updated. Validations:
|
|
asset
optional , nil allowed |
Validations:
|
|
asset[name]
optional |
Name of the asset. Validations:
|
|
asset[description]
optional , nil allowed |
Asset’s description. Validations:
|
|
asset[size]
optional , nil allowed |
The size of the asset. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
|
state_id
optional |
ID of the AssetState job returned by call to prepare_download_highres Validations:
|
|
generic_file_id
optional |
When provided the download will return only one file of a multi-file asset. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
|
state_id
optional |
ID of the AssetState job returned by call to prepare_download_highres Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
|
state_id
optional |
ID of the AssetState job returned by call to prepare_download_lowres Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to download transcripts from. Validations:
|
|
asset_ids
optional |
List of IDs of assets to bulk download transcripts from Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to download transcripts from. Validations:
|
|
state_id
optional |
ID of the AssetState job returned by call to prepare_download_transcripts Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be downloaded. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be reencoded. Validations:
|
|
transcription_action
optional |
What to do with an existing Transcription. Defaults to recreate. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
asset_ids
optional |
IDs of the source assets. Validations:
|
|
folder
optional |
Validations:
|
|
folder[container_id]
required |
Container’s ID of the folder Validations:
|
|
folder[dirname]
required |
Container’s relative path to the folder Validations:
|
|
folder[storage]
optional |
Storage/media name of the folder Validations:
|
|
recursive
optional |
include subfolders when providing a folder. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
asset_ids
required |
IDs of the source assets. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset. Validations:
|
|
description_id
required |
ID of the description which should be delete. Validations:
|
| Param name | Description |
|---|---|
|
path
optional |
Relative path the asset to search for Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be transcribed. Validations:
|
|
tags
optional |
Array of language tags to be transcribed selectively. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be analyzed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to use as a base for a reverse image search. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the asset to be copied. Validations:
|
|
strategy
required |
ID of the copying strategy to be applied. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
folder
optional |
Validations:
|
|
folder[container_id]
required |
Container’s ID of the folder Validations:
|
|
folder[dirname]
required |
Container relative path to the folder Validations:
|
|
folder[storage]
optional |
Storage/media name of the folder Validations:
|
|
strategy
required |
ID of the copying strategy to be applied. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
data
required |
Validations:
|
|
data[project_id]
required |
Project’s ID of the folder or asset to delete Validations:
|
|
data[project_id][asset_ids]
optional |
IDs of assets to be deleted. Validations:
|
|
data[project_id][folders]
optional |
Validations:
|
|
data[project_id][folders][dirname]
required |
Container relative path to the folder Validations:
|
|
data[project_id][folders][storage]
optional |
Storage/media name of the folder Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the asset. Validations:
|
|
sequence_name
required |
Premiere sequence name that is used for the report Validations:
|
|
type
required |
Type of the report Validations:
|
| Param name | Description |
|---|---|
|
asset_ids
optional |
IDs of the assets to update. Validations:
|
|
folder
optional |
Validations:
|
|
folder[container_id]
required |
Container’s ID of the folder Validations:
|
|
folder[dirname]
required |
Container relative path to the folder Validations:
|
|
folder[storage]
optional |
Storage/media name of the folder Validations:
|
|
recursive
optional |
Include subfolders when providing a folder. Validations:
|
|
override
optional |
Override existing metadata. Validations:
|
|
custom_metadata
required |
A Hash of Hashes. First level keys are indices of the elements. Second level keys are ‘value’ and ‘custom_metadata_field’. Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Asset. Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Asset. Validations:
|
|
sequence_names
optional |
Array of sequence names Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Asset. Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Asset. Validations:
|