BRbrightcovelearning
OTT Async Jobs

Create a new OTT async job request.

Changed on

Create a new job request for the asynchronous generation of feeds for one or more OTT Syndications.

post/accounts/{{account_id}}/mrss/ott-async-jobs

Request

  • Base URL
    https://social.api.brightcove.com/v1
  • URL
    https://social.api.brightcove.com/v1/accounts/{{account_id}}/mrss/ott-async-jobs
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://oauth.brightcove.com/v4/access_token scopes: video-cloud/social/mrss/write

Path parameters

account_idstring required

ID of the account

Request body

idstring

Id of this job

namestring

Name of this job

state'PENDING' | 'PROCESSING' | 'COMPLETED' | 'ERROR'

State of this job. Job state starts out as PENDING when the job is submitted, moves to PROCESSING when the processing of the job begins, and move to either COMPLETED or ERROR state when job processing finishes.

syndicationsstring[] required

A list of OTT syndications to be processed. The resulting feeds will be generated and packaged into a single zipped results file.

resultsstring[]

A list of URLs pointing to results files. Currently this will always contain just a single URL pointing to a zipped results file if the job was processed successfully. The URLs expire after 3 hours.

errorsstring[]

A list of errors that occurred if a job failed to complete successfully.

created_atstring

Job creation timestamp, in UTC format.

updated_atstring

Last job update timestamp, in UTC format.

Response

The newly created job.

idstring

Id of this job

namestring

Name of this job

state'PENDING' | 'PROCESSING' | 'COMPLETED' | 'ERROR'

State of this job. Job state starts out as PENDING when the job is submitted, moves to PROCESSING when the processing of the job begins, and move to either COMPLETED or ERROR state when job processing finishes.

syndicationsstring[] required

A list of OTT syndications to be processed. The resulting feeds will be generated and packaged into a single zipped results file.

resultsstring[]

A list of URLs pointing to results files. Currently this will always contain just a single URL pointing to a zipped results file if the job was processed successfully. The URLs expire after 3 hours.

errorsstring[]

A list of errors that occurred if a job failed to complete successfully.

created_atstring

Job creation timestamp, in UTC format.

updated_atstring

Last job update timestamp, in UTC format.

Changes