PRprss
MetaPub

Create a batch operation on EPG information.

Changed on

Create a batch to process the metadata of one or more electronic program guide (EPG) programs using metadata that has been uploaded to the customer's CD Drive. If multiple EPG programs are present in the metadata, they will all be updated, however updates across programs are not atomic. Note that an EPG program maps to the ContentDepot concept of an episode which is also known as a "program instance".

A batch operation must be explicitly created rather than the server attempting to detect new metadata in order to allow for all the content to be uploaded including any supporting content like images. A batch operation is accepted and queued for asynchronous processing at a later time. A client can poll the batch periodically to determine when it completes and the resulting state.

post/api/v2/metapub/program-information/batch

Request

  • Base URL
    https://contentdepot.prss.org (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Authorization code: /api/oauth2/authorize
    Token URL: /api/oauth2/token scopes: cd:full

Request body

uristring uri required

The URI to the metadata file. Currently only the cddrive scheme is supported.

format'radiodns' required

The format of the metadata file defining the create or update actions to be performed on one or more EPG programs. For more information on how RadioDNS EPG maps to ContentDepot <a href="/api/epg-cd-mapping.html">click here </a>

namestring

An optional human readable name for the batch.

Response

The accepted batch information that is queued for processing.

idinteger required

The ID of the batch.

namestring

The optional name of the batch for human reference.

messagestring

The human readable success or failure message.

status'queued' | 'processing' | 'failed' | 'successful' required

The current processing status.

uristring uri

The URI to the metadata file defining the batch creates/updates.

format'radiodns' required

The format of the metadata file defining the create or update actions to be performed on one or more EPG programs.

createdDatestring date-time required

The date and time the batch was created in ISO 8601 format.

finishedDatestring date-time

The date and time the batch finished (either successful or failed) in ISO 8601 format.

Changes

  • 0cf3125218c1Revision changes
    • breaking

      the / request property format changed from dateTime:yyyy-MM-dd'T'HH:mm:ss'Z' to date-time

    • breaking

      the response's property format changed from dateTime to date-time for status

    • breaking

      the response's property format changed from dateTime to date-time for status

    • breaking

      the / response's property format changed from dateTime to date-time for status