Updating the airing time on multiple events | NAGRAVISION Documentation Portal

Request

To update the airing time of multiple events, send a PUT request to:

http://<server>:<port>/cpm/content/v1/events/

Headers

Content-Type: application/json

Mandatory fields

The mandatory fields depend on the parameter(s) being updated:

You must also specify airingStartTime, airingEndTime, or both.
To update just the airing start time, you must specify the event id.
To update just the airing end time, you must specify both the providerId and the providerResourceId.
To update both airing start and end times, you can use either
- The event id, or
- Both the providerId and providerResourceId

Example

A request with this payload updates the airing start and end times of the specified events:

JSON

{
    "eventSet": [
        {
               "airingStartTime": "2018-02-02T11:00:00Z",     // Airing start time alone can be updated using event id.
               "id": "GLOBAL_event1"
        },
        {
               "airingEndTime": "2036-02-01T11:10:00Z",       // Airing end time alone can be updated using providerId and providerResourceId.
               "providerId": "GLOBAL",
               "providerResourceId": "event2"
        },
        {
               "airingStartTime": "2036-02-01T11:00:00Z",     // Both airing start and end time can be updated using either id or providerId and providerResourceId.
               "airingEndTime": "2036-02-01T11:10:00Z",
               "id": "GLOBAL_event3",
               "providerId": "GLOBAL",
               "providerResourceId": "event3"
        }
    ]
}

Within eventSet, you can specify as many events as you need to.

Response

A successful request returns an HTTP 200 status and a link to the event(s).

A bad request returns an HTTP 400 status.

All PUT and POST calls to CPM are validated by the Validation Service. If there is a problem with the data you are submitting, you will receive one of the following:

Error – the data is invalid, so the request fails.
The error message will indicate which data is invalid and why.
Warning – there is an issue with the data that does not prevent it from being added/updated in CPM, but that you need to be aware of.
For example, if a mandatory field has no value for a non-primary locale (but the same field for the primary locale does have a value), you will get a warning rather than an error.
The warning message will indicate which data is invalid and why.

Note that there are still conditions where a request can pass validation, but fail when it reaches CPM, so you must handle such responses in an appropriate way too.

In addition, all such errors and warnings:

Are available as a report in Data Warehouse (errors only).
Generate alert emails that are sent to the email addresses that were configured when the system was deployed.

Note: this data only becomes available in the report 60–90 minutes after the error occurs (and the email is sent).

Example

A successful request returns a payload that looks like this:

JSON

{
    "selfSet": [
        "/content/v1/events/GLOBAL_event1",
        "/content/v1/events/GLOBAL_event2"
    ],
    "totalRecords": 2
}

Within selfSet, there is one line for each event that was updated.

Request

Headers

Mandatory fields

Example

Response

Example

See also