Live2VOD for Organization

Collapse Vod

A vod can be collapsed to a specific filter config

post/v2/{org}/channels/{channel-id}/vods/{vod_id}/collapse

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}/vods/{vod_id}/collapse
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

channel-idstring required

Unique channel identifier

vod_idstring required

ID for a VOD

Request body

$schemastring uri

A URL to the JSON Schema for this object.

clip_prefixstring

Prefix for clip

clip_suffixstring

Suffix for clip

disable_auto_prefixboolean

Disable any autoprefix

end_timestring date-time

EndTime of VOD

new_clip_descriptionstring required

Description for new collapsed clip

new_clip_idinteger required

New Clip ID for collapsed clip

publish_vodboolean

Publish newly created VOD

start_timestring date-time

StartTime of VOD

upidstring

UPID for VOD

Example request

{
  "$schema": "https://api.istreamplanet.com/schemas/CollapseVODRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

clip_idinteger required

New Clip ID for collapsed vod

task_idstring required

Identifies collapse task id

Example response

{
  "$schema": "https://api.istreamplanet.com/schemas/CollapseVODResponseBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.