Get multiple purge configurations | NAGRAVISION Documentation Portal

Request

This API allows you to retrieve all the purge configurations, or a subset that is filtered by entity type and/or scope.

To get multiple purge configurations, send a GET request to:

http://<server>:<port>/cpm/operator/purgeConfigurations?entityName=<entity>&scope=<Live|Vod>

Headers

role – must be operator

Mandatory arguments

None

Other arguments

entityName=<entity> – specifies the entity to filter by (in query params), where entity is one of:
- events
- editorialContents
- technicalContents
- contentPublishingWindows
- transactionalProducts
scope=<Live|Vod> – filters by live or VOD

If you do not specify a filter, no filtering is done for the omitted filter.

For example, if you do not specify any filters in the query parameters, the request returns all configurations.

If you specify only a scope filter, the request returns all the configurations that match the specified scope, no matter which entity type they apply to.

Example

A GET request with the specified query parameters filters the results to show purge configurations for live events only:

http://<server>:<port>/cpm/operator/purgeConfigurations?entityName=events&scope=Live

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

If no configuration matches the specified filters, the request returns an HTTP 404 status.

Example

JSON

{
   "purgeConfigurationSet": [
      {
         "id": "pc01",
         "entityName": "events",
         "scope": "Live",
         "retentionPeriod": 10,
         "createDate": "2016-01-31T00:00:00Z",
         "lastUpdated": "2016-01-31T00:00:00Z"
      },
      {
         "id": "pc02",
         "entityName": "events",
         "scope": "Vod",
         "retentionPeriod": 20,
         "createDate": "2016-01-31T00:00:00Z",
         "lastUpdated": "2016-01-31T00:00:00Z"
      },
      {
         "id": "pc03",
         "entityName": "editorialContents",
         "scope": "Live",
         "retentionPeriod": 10,
         "createDate": "2016-01-31T00:00:00Z",
         "lastUpdated": "2016-01-31T00:00:00Z"
      }
   ],
   "totalRecords": 3
}