Assets

>>>

PUT /api/v1/assets/:id/update_metadata
Update metadata of a assets.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset metadata of which will be updated.

Validations:

  • Must be a String
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:

  • Must be a Hash
>>>

GET /api/v1/assets/:id/custom_metadata
Display metadata of a assets.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset metadata of which will be displayed.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id
Display an asset.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be displayed.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id
Update an asset.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be updated.

Validations:

  • Must be a String
asset
optional , nil allowed

Validations:

  • Must be a Hash
asset[name]
optional

Name of the asset.

Validations:

  • Must be a String
asset[description]
optional , nil allowed

Asset’s description.

Validations:

  • Must be a String
asset[size]
optional , nil allowed

The size of the asset.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id/prepare_download_highres
Initiate asset download, pass the given state id to download_highres after the AssetState finished successfully.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/download_highres
Download an asset in original resolution as a zip file. Must be given a state_id returned from prepare_download_highres.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
state_id
optional

ID of the AssetState job returned by call to prepare_download_highres

Validations:

  • Must be a String
generic_file_id
optional

When provided the download will return only one file of a multi-file asset.

Validations:

  • Must be a Integer
>>>

PUT /api/v1/assets/:id/prepare_download_editing_proxy
Initiate editing proxy download, pass the given state id to download_editing_proxy after the AssetState finished successfully.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/download_editing_proxy
Download the editing proxy of an asset. Must be given a state_id returned from prepare_download_editing_proxy.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
state_id
optional

ID of the AssetState job returned by call to prepare_download_highres

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id/prepare_download_lowres
Initiate proxy download, pass the given state id to download_lowres after the AssetState finished successfully.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/download_lowres
Download an asset in low resolution as an mp4 file.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
state_id
optional

ID of the AssetState job returned by call to prepare_download_lowres

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/download_xls
Download an XLS as a summary of all marker descriptions.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/download_avid_xml
Download marker descriptions in the Avid Marker XML format.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be downloaded.

Validations:

  • Must be a String
>>>

POST /api/v1/assets/:id/reencode
Reencode (create a new proxy) an asset.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be reencoded.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/annotations_to_pdf
Create a PDF file with assets annotations

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
asset_ids
optional

IDs of the source assets.

Validations:

  • Must be an array of any type
folder
optional

Validations:

  • Must be a Hash
folder[container_id]
required

Container’s ID of the folder

Validations:

  • Must be a String
folder[dirname]
required

Container’s relative path to the folder

Validations:

  • Must be a String
folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
recursive
optional

include subfolders when providing a folder.

Validations:

  • Must be one of: true, false.
>>>

GET /api/v1/assets/links
Get assets sharing a file (by inode) with the given assets.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
asset_ids
required

IDs of the source assets.

Validations:

  • Must be an array of any type
>>>

DELETE /api/v1/assets/:id/delete_description
Delete a description from the history.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset.

Validations:

  • Must be a String
description_id
required

ID of the description which should be delete.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/by_path
Return asset ids matching the given path

Params

Param name Description
path
optional

Relative path the asset to search for

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id/share_via_email
Share the asset with a user via an email address

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be shared.

Validations:

  • Must be a String
email
required

email to share the asset with

Validations:

  • Must be a String
expires
required

the expiration date of the shared asset

Validations:

  • Must be a String
password
optional

password required to access the asset.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id/copy_to
Copy an asset using a copying strategy to a desired storage. Returns the current state of the copying process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the asset to be copied.

Validations:

  • Must be a String
strategy
required

ID of the copying strategy to be applied.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/copy_folder_to
Copy a folder using a copying strategy to a desired storage. Returns the current state of the copying process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
folder
optional

Validations:

  • Must be a Hash
folder[container_id]
required

Container’s ID of the folder

Validations:

  • Must be a String
folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
strategy
required

ID of the copying strategy to be applied.

Validations:

  • Must be a String
>>>

DELETE /api/v1/assets/destroy
Remove assets or folders from the storage and the database.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
data
required

Validations:

  • Must be a Hash
data[project_id]
required

Project’s ID of the folder or asset to delete

Validations:

  • Must be a Hash
data[project_id][asset_ids]
optional

IDs of assets to be deleted.

Validations:

  • Must be an array of Integer
data[project_id][folders]
optional

Validations:

  • Must be an Array of nested elements
data[project_id][folders][dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
data[project_id][folders][storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
>>>

POST /api/v1/assets/:id/generate_sequence_report
Triggers the generation of a HKG or GEMA report.

Params

Param name Description
id
required

ID of the asset.

Validations:

  • Must be a String
sequence_name
required

Premiere sequence name that is used for the report

Validations:

  • Must be a String
type
required

Type of the report

Validations:

  • Must be one of: gema, hkn.
>>>

POST /api/v1/assets/bulk_update_custom_metadata
Bulk update custom metadata of assets.

Params

Param name Description
asset_ids
optional

IDs of the assets to update.

Validations:

  • Must be an array of any type
folder
optional

Validations:

  • Must be a Hash
folder[container_id]
required

Container’s ID of the folder

Validations:

  • Must be a String
folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
recursive
optional

Include subfolders when providing a folder.

Validations:

  • Must be one of: true, false.
override
optional

Override existing metadata.

Validations:

  • Must be one of: true, false.
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:

  • Must be a Hash
>>>

PUT /api/v1/assets/:id/premiere_project_sequence_names
Get the sequences names present in the given Premiere project.

Params

Param name Description
id
required

ID of the Asset.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:id/premiere_project_download_summary
Get information about supported assets and their sizes for the download of a Premiere project

Params

Param name Description
id
required

ID of the Asset.

Validations:

  • Must be a String
sequence_names
optional

Array of sequence names

Validations:

  • Must be an array of any type
>>>

GET /api/v1/assets/:id/access_right_type
Get information of the access right the current user has for the asset.

Params

Param name Description
id
required

ID of the Asset.

Validations:

  • Must be a String
>>>

GET /api/v1/assets/:id/proxy_key
Get the binary form of the proxy encryption key.

Params

Param name Description
id
required

ID of the Asset.

Validations:

  • Must be a String