Request
To update a single event's airing time, send a PUT request to:
http://<server>:<port>/cpm/content/v1/events/{eventId}
Headers
-
Content-Type: application/json
Mandatory fields
The mandatory fields depend on the parameter(s) being updated:
-
eventId– the ID of the event to be updated -
You must also specify
airingStartTime,airingEndTime, or both.
Example
A request with this payload updates the airing start and end times of the event with the ID specified in the URL:
{
"airingStartTime": "2036-02-01T11:00:00Z",
"airingEndTime": "2036-02-01T11:10:00Z"
}
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:
{
"self": "/content/v1/events/GLOBAL_event1"
}
See also
For full details of this API, see Content and Product Manager (CPM) API documentation: content v1 .