BRbrightcovelearning
OTT Stored Jobs

Update an OTT stored job.

Changed on

Updates the configuration data for a stored job. An OTTStoredJob object specifying non-null values for writable fields to be updated should be passed as the request body.

patch/accounts/{{account_id}}/mrss/ott-stored-jobs/{job_id}

Request

  • Base URL
    https://social.api.brightcove.com/v1
  • URL
    https://social.api.brightcove.com/v1/accounts/{{account_id}}/mrss/ott-stored-jobs/{job_id}
  • 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

job_idstring required

ID of the job

Request body

idstring

Id of this job

namestring required

Name of this job

syndicationsstring[] required

A list of OTT syndication ids to be processed.

auto_run_interval_hoursinteger

Frequency in hours at which to automatically regenerate the job results. If not set or if set to zero, no auto-regeneration will occur but the job can still be run on demand via the /run REST API method. If a non-zero value is specified, the minimum interval is 6 hours. Newly generated results will overwrite results generated by any earlier job runs.

state'READY' | 'PENDING' | 'PROCESSING'

State of this job. READY indicates the job is not currently in the process of being run. PENDING indicates the an API request to run the job on demand has been made but processing of the job has not yet begun. PROCESSING indicates the job is currently being run.

last_run_status'SUCCESS' | 'ERROR'

Status of the last run attempt for this stored job.

resultsstring[]

A list of URLs pointing to the latest set of results files. Currently this will contain just a single URL pointing to a zipped results file if the job was processed successfully. The signed URLs will expire after 3 hours, refetching the job will generate fresh URLs.

public_resultsstring[]

If this job contained syndications that were configured with publish_results set to true, a list of URLs pointing to the latest set of public results files.

errorsstring[]

A list of errors that occurred if a job failed to complete successfully during its latest run.

created_atstring

Job creation timestamp, in UTC format.

updated_atstring

Last job update timestamp, in UTC format.

last_run_atstring

Last job run timestamp, in UTC format.

last_successful_run_atstring

Last successful job run timestamp, in UTC format.

Response

The updated stored job.

idstring

Id of this job

namestring required

Name of this job

syndicationsstring[] required

A list of OTT syndication ids to be processed.

auto_run_interval_hoursinteger

Frequency in hours at which to automatically regenerate the job results. If not set or if set to zero, no auto-regeneration will occur but the job can still be run on demand via the /run REST API method. If a non-zero value is specified, the minimum interval is 6 hours. Newly generated results will overwrite results generated by any earlier job runs.

state'READY' | 'PENDING' | 'PROCESSING'

State of this job. READY indicates the job is not currently in the process of being run. PENDING indicates the an API request to run the job on demand has been made but processing of the job has not yet begun. PROCESSING indicates the job is currently being run.

last_run_status'SUCCESS' | 'ERROR'

Status of the last run attempt for this stored job.

resultsstring[]

A list of URLs pointing to the latest set of results files. Currently this will contain just a single URL pointing to a zipped results file if the job was processed successfully. The signed URLs will expire after 3 hours, refetching the job will generate fresh URLs.

public_resultsstring[]

If this job contained syndications that were configured with publish_results set to true, a list of URLs pointing to the latest set of public results files.

errorsstring[]

A list of errors that occurred if a job failed to complete successfully during its latest run.

created_atstring

Job creation timestamp, in UTC format.

updated_atstring

Last job update timestamp, in UTC format.

last_run_atstring

Last job run timestamp, in UTC format.

last_successful_run_atstring

Last successful job run timestamp, in UTC format.

Changes