Marker descriptions

>>>

GET /api/v1/assets/:asset_id/marker_descriptions
Display all of the assets marker descriptions.

>>>

POST /api/v1/assets/:asset_id/marker_descriptions
Create a new marker description.

Params

Param name Description
marker_description
optional , nil allowed

Validations:

  • Must be a Hash
marker_description[text]
required

Marker’s description.

Validations:

  • Must be a String
marker_description[in]
required

Position of the in-point/marker in seconds

Validations:

  • Must be a String
marker_description[out]
optional , nil allowed

Position of the out-point in seconds

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:asset_id/marker_descriptions/:id
Update a marker description.

Params

Param name Description
id
required

ID of the marker description to be updated.

Validations:

  • Must be a String
marker_description
optional , nil allowed

Validations:

  • Must be a Hash
marker_description[text]
optional

Marker’s description.

Validations:

  • Must be a String
marker_description[in]
optional

Position of the in-point/marker in seconds

Validations:

  • Must be a String
marker_description[out]
optional , nil allowed

Position of the out-point in seconds

Validations:

  • Must be a String
>>>

DELETE /api/v1/assets/:asset_id/marker_descriptions/:id
Delete a marker description.

Params

Param name Description
id
required

ID of the marker description to be updated.

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:asset_id/marker_descriptions/bulk_update
Bulk update marker description GUIDs from Premiere.

Params

Param name Description
marker_descriptions
required

Validations:

  • Must be a Hash
marker_descriptions[marker_ids]
required

Array of marker ids that need updating.

Validations:

  • Must be an array of any type
marker_descriptions[project_guid]
required

Premiere Project file ID

Validations:

  • Must be a String
marker_descriptions[markers]
required

Hash mapping the database ID to Premiere GUID

Validations:

  • Must be a Hash
>>>

GET /api/v1/assets/:asset_id/marker_descriptions/:id/username
Attempts to guess the username of the marker descriptions creator

Params

Param name Description
marker_description
optional , nil allowed

Validations:

  • Must be a Hash
marker_description[text]
optional

Marker’s description.

Validations:

  • Must be a String
marker_description[in]
optional

Position of the in-point/marker in seconds

Validations:

  • Must be a String
marker_description[out]
optional , nil allowed

Position of the out-point in seconds

Validations:

  • Must be a String
>>>

PUT /api/v1/assets/:asset_id/marker_descriptions/:id/push_to_pam
Push marker description and replies back to the PAM asset.

Params

Param name Description
id
optional

ID of the marker description to push back.

Validations:

  • Must be a String