MetaPub

Get an EPG batch operation.

Changed on

Gets the batch information which can be used to check the status of the operation or retrieve more details if the batch fails.

get/api/v2/metapub/program-information/batch/{batch-id}

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

Response

The batch information.

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

    • 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