Service endpoint categories

Tenants (only used in SSP deployments)

GET

/adm/v1/admin/tenants

ADMIN

Gets tenants

POST

/adm/v1/admin/tenants

ADMIN

Adds a tenant

GET

/adm/v1/admin/tenants/{uid}

ADMIN

Gets a tenant

PUT

/adm/v1/admin/tenants/{uid}

OPERATOR

Updates a tenant

Account profiles

GET

/adm/v1/accountProfiles

OPERATOR

Retrieves multiple account profiles.

PUT

/adm/v1/accountProfiles

OPERATOR

Updates multiple account profiles.

POST

/adm/v1/accountProfiles

OPERATOR

Adds an account profile.

GET

/adm/v1/accountProfiles/{uid}

OPERATOR

Retrieves an account profile by UID.

PUT

/adm/v1/accountProfiles/{uid}

OPERATOR

Updates a single account profile.

DELETE

/adm/v1/accountProfiles/{uid}

OPERATOR

Deletes a single account profile.

Accounts

GET

/adm/v1/accounts

OPERATOR

Retrieves multiple accounts.

PUT

/adm/v1/accounts

OPERATOR

Updates multiple accounts.

POST

/adm/v1/accounts

OPERATOR

Adds an account.

PUT

/adm/v1/accounts/preHashedPassword/{uid}

OPERATOR

Updates an account with a pre-hashed password and salt.

POST

/adm/v1/accounts/preHashedPassword

OPERATOR

Adds an account with a pre-hashed password.

GET

/adm/v1/accounts/{uid}

OPERATOR

Retrieves an account by ID.

PUT

/adm/v1/accounts/{uid}

OPERATOR

Updates an account.

Accounts service (OPF specific)

DELETE

/adm/v1/accounts/actions/purgeAccount/{accountId}

OPERATOR

Removes all data associated with the account ID passed in.

PUT

/adm/v1/accounts/actions/{uid}/pin

OPERATOR

Adds or updates a PIN against an account.

GET

/adm/v1/accounts/lastLoginDates

OPERATOR

Finds inactive accounts.

POST

/adm/v1/accounts/actions/signonEnsureDevice

OPERATOR

Sign-on using signon ID, password, client ID, and device information.

Operator accounts PIN status

GET

/adm/v1/accounts/{accountId}/pins/status

OPERATOR

Read the PIN status for an account.

Bundled accounts

GET

/adm/v1/bundled/devices

OPERATOR

Retrieves a bundle account based on device filter.

GET

/adm/v1/bundled/devices/{uid}

OPERATOR

Retrieves account, users, and devices by device UID.

GET

/adm/v1/bundled/devices/casn/{caSN}

OPERATOR

Retrieves account, users, and devices by device caSN.

POST

/adm/v1/bundled/accounts

OPERATOR

Adds a bundled account.

GET

/adm/v1/bundled/accounts/{uid}

OPERATOR

Retrieves account, users, and devices by account UID.

Device classifiers

GET

/adm/v1/deviceClassifiers

OPERATOR

Retrieve device classifiers.

PUT

/adm/v1/deviceClassifiers

OPERATOR

Updates multiple device classifiers.

POST

/adm/v1/deviceClassifiers

OPERATOR

Adds a device classifier.

GET

/adm/v1/deviceClassifiers/{uid}

OPERATOR

Retrieves a device classifier by UID.

PUT

/adm/v1/deviceClassifiers/{uid}

OPERATOR

Update a device classifier.

DELETE

/adm/v1/deviceClassifiers/{uid}

OPERATOR

Deletes a device classifier.

Device profiles

GET

/adm/v1/deviceProfiles

OPERATOR

Retrieves multiple device profiles.

PUT

/adm/v1/deviceProfiles

OPERATOR

Updates multiple device profiles.

POST

/adm/v1/deviceProfiles

OPERATOR

Adds a device profile.

GET

/adm/v1/deviceProfiles/{uid}

OPERATOR

Retrieves a device profile by UID.

PUT

/adm/v1/deviceProfiles/{uid}

OPERATOR

Updates a device profile.

DELETE

/adm/v1/deviceProfiles/{uid}

OPERATOR

Deletes a device profile.

Devices

GET

/adm/v1/devices

OPERATOR

Retrieves multiple devices.

POST

/adm/v1/devices

OPERATOR

Adds a device.

DELETE

/adm/v1/devices

OPERATOR

Deletes devices using account UID.

GET

/adm/v1/devices/{uid}

OPERATOR

Retrieves a single device by UID.

PUT

/adm/v1/devices/{uid}

OPERATOR

Updates a device.

DELETE

/adm/v1/devices/{uid}

OPERATOR

Deletes a device.

GET

/adm/v1/devices/canAccountApproveADevice/{accountId}

OPERATOR

Get account device approval details.

Devices (OPF specific)

POST

/adm/v1/devices/actions/authorise

OPERATOR

Checks the device is authorised. Creates the device if it does not already exist, and re-assigns the device if it belongs to a different account.

This API will always return the ID of the device that is authorised.

Archived accounts

POST

/adm/v1/operator/ArchiveAccounts

OPERATOR

Archives accounts that were cancelled over a configured number of days.

PIN types

GET

/adm/v1/pinTypes/{type}

OPERATOR

Retrieves a PIN type.

DELETE

/adm/v1/pinTypes/{type}

OPERATOR

Deletes a PIN type.

GET

/adm/v1/pinTypes

OPERATOR

Gets all PIN types

PUT

/adm/v1/pinTypes

OPERATOR

Add/update a PIN type

Users

GET

/adm/v1/users

OPERATOR

Retrieves multiple users.

POST

/adm/v1/users

OPERATOR

Adds a user.

DELETE

/adm/v1/users

OPERATOR

Deletes users using account UID.

GET

/adm/v1/users/{uid}

OPERATOR

Retrieves a user by UID.

PUT

/adm/v1/users/{uid}

OPERATOR

Updates a user.

DELETE

/adm/v1/users/{uid}

OPERATOR

Deletes a user.

User accounts (OPF specific)

GET

/adm/v1/user/accounts/pins

CLIENT

Retrieves PINs for an account.

POST

/adm/v1/user/accounts/actions/validatePin

CLIENT

Validates a PIN for an account.

PUT

/adm/v1/user/accounts/actions/changePassword

OPERATOR

Changes the password for an account.

PUT

/adm/v1/user/accounts/actions/changePin

CLIENT

Changes a PIN for an account.

GET

/adm/v1/user/accounts

CLIENT

Retrieves an account by account UID in token header.

POST

/adm/v1/user/accounts/actions/pin

CLIENT

Creates a PIN for an account.

GET

/adm/v1/user/accounts/pins/status

CLIENT

Read the status of all PINs for an account.

GET

/adm/v1/user/accounts/parentalControl/ratingsThresholds

CLIENT

Retrieves the set of parental control ratings threshold(s) for an account.

POST

/adm/v1/user/accounts/parentalControl/ratingsThresholds

OPERATOR

Updates one or more parental control ratings threshold(s), on an account, for a specified ratings body.

POST

/adm/v1/user/accounts/parentalControl/actions/updateRatingsThresholds

CLIENT

Updates one or more parental control ratings threshold(s), on an account, for a specified ratings body.

POST

/adm/v1/user/accounts/parentalControl/actions/deleteRatingsThresholds

CLIENT

Deletes one or more parental control ratings bodies and corresponding threshold(s) from an account.

User bundled accounts

GET

/adm/v1/user/bundled/accounts

OPERATOR

Retrieves a bundled account.

User devices

GET

/adm/v1/devices/canAccountApproveADevice/{accountId }

OPERATOR

Used to get the details of how many devices a user has approved and when they can approve a new one.

PUT

/adm/v1/user/devices/{uid}/activate

OPERATOR

Updates a device activate.

POST

/adm/v1/user/devices/actions/authorise

OPERATOR

Checks the device is authorised. Re-assigns the device if it belongs to a different account.

PUT

/adm/v1/user/devices/{uid}/name

OPERATOR

Updates a device name.

PUT

/adm/v1/user/devices/{uid}/deactivate

OPERATOR

Updates a device deactivate.

GET

/adm/v1/user/devices/amiapproved

CLIENT

Used to confirm a device approval.

POST

/adm/v1/user/devices/amendapprovals

CLIENT

Used to approve and/or unapprove a device.

POST

/adm/v1/user/devices/amendapprovals/{accountId}

OPERATOR

Used to approve and/or unapprove a device.

GET

/adm/v1/user/devices/{uid}

OPERATOR

Retrieves a device by UID and token header.

GET

/adm/v1/user/devices

OPERATOR

Retrieves all devices by token header.

GET

/adm/v1/user/devices/canIApproveADevice

CLIENT

Used to find out next available approval time.

User users

GET

/adm/v1/user/users

OPERATOR

Retrieves all users by token header.

GET

/adm/v1/user/users/{uid}

OPERATOR

Retrieves a user by UID.

PUT

/adm/v1/user/users/{uid}/status

OPERATOR

Updates a user.

User v2 accounts (OPF specific)

POST

/adm/v2/user/tigo/accounts/actions/signon

OPERATOR

Tigo-based sign on using signOnId, clientId, countryCode, and deviceInformation.

POST

/adm/v2/user/accounts/actions/refresh

OPERATOR

Refreshes authorisation which will return a signon entity JSON object.

PUT

/adm/v2/user/accounts/actions/resetPin

OPERATOR

Resets the PIN for an account.

POST

/adm/v2/user/accounts/actions/signon

OPERATOR

Sign-on using the signon ID, password, client ID, and device information. Either client ID or device information must be used; user and password are mandatory.

If no client ID is passed a new device will be created.

POST

/adm/v2/user/accounts/actions/selfservicesignon

OPERATOR

Sign-on using username and password only which will return just an account id in the JSON object.

POST

/adm/v2/user/accounts/actions/managedsignon

OPERATOR

Sign-on for managed devices using the client ID and device information. Either client ID or device information must be used; user and password are mandatory.

If no client ID is passed a new device will be created.

POST

/adm/v2/user/accounts/actions/anonymoussignon

OPERATOR

Sign-on using anonymous account ID.

POST

/adm/v2/user/accounts/actions/generateResetPasswordSecret

OPERATOR

Generates a reset password secret which will return a ResetSecret entity JSON object.

POST

/adm/v2/user/accounts/actions/generateResetPinSecret

OPERATOR

Generates a reset pin secret which will return a ResetSetPin JSON object.

User v3 Accounts (OPF specific)

PUT

/adm/v2/user/accounts/actions/resetPassword

OPERATOR

Resets the password for an account.

Devices additional properties

POST

/adm/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Creates additional properties on a device.

GET

/adm/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Get a device's additional properties.

DELETE

/adm/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Delete all additional properties on a device.

PUT

/adm/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Updates the additional properties on a device.

User activity

POST

/activitygateway/v1/useractivity/rating

CLIENT

Log a new rating request. (This is just a specialisation of the raw useractivity API.)

POST

/activitygateway/v1/useractivity/{activityName}

CLIENT

Log a new activity

Bookmarks

PUT

/activitygateway/v1/clientdata/account/{account}/bookmarks/{contentId}

CLIENT

Creates or updates an existing bookmark for account

DELETE

/activitygateway/v1/clientdata/account/{account}/bookmarks/{contentId}

CLIENT

Deletes an existing bookmark for a given account.

DELETE

/activitygateway/v1/clientdata/account/{account}/bookmarks

CLIENT

Deletes all existing bookmarks for a given account.

DELETE

/activitygateway/v1/clientdata/account/{account}/bookmarks/action/deleteByTag/{tagId}

CLIENT

Deletes an existing bookmark for a given account based on tag ID.

PUT

/activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

CLIENT

Creates or updates an existing bookmark for user

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

CLIENT

Deletes an existing bookmark for a given user.

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/action/deleteByTag/{tagId}

CLIENT

Deletes an existing bookmark for a given user based on tag ID.

Favourites lists

POST

/activitygateway/v1/clientdata/account/{account}/favouriteslists

CLIENT

Creates a new favourites list for account.

PUT

/activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}

CLIENT

Updates an existing account's favourites list.

DELETE

/activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}

CLIENT

Deletes an existing account's favouriteslist and all entries

PUT

/activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

CLIENT

Adds a favourite to an account favourites list.

DELETE

/activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

CLIENT

Removes a favourite from an account favourites list.

POST

/activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists

CLIENT

Creates a new favouriteslist for a user.

PUT

/activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

CLIENT

Updates an existing user's favourites list.

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

CLIENT

Deletes an existing user's favouriteslist and all entries.

PUT

/activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

CLIENT

Adds a favourite to a favourites list.

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

CLIENT

Removes a favourite from a favourites list.

Histories

POST

/activitygateway/v1/clientdata/account/{account}/history

CLIENT

Creates the history for an account.

DELETE

/activitygateway/v1/clientdata/account/{account}/history/{id}

CLIENT

Deletes an existing history entry

POST

/activitygateway/v1/clientdata/account/{account}/user/{userId}/history

CLIENT

Creates history for user

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/history/{id}

CLIENT

Deletes an existing history entry.

Playlists

PUT

/activitygateway/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

CLIENT

Adds a playlist entry to an account's playlist

DELETE

/activitygateway/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

CLIENT

Removes a playlist entry from an account's playlist

PUT

/activitygateway/v1/clientdata/account/{account}/playlists/{id}

CLIENT

Updates an existing account's playlist

DELETE

/activitygateway/v1/clientdata/account/{account}/playlists/{id}

CLIENT

Deletes an existing account's playlist and all entries

POST

/activitygateway/v1/clientdata/account/{account}/playlists

CLIENT

Creates a new playlists for account

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}/content/{contentId}

CLIENT

Removes a playlist entry from a playlist

PUT

/activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

CLIENT

Updates an existing user's playlist

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

CLIENT

Deletes an existing user's playlist and all entries

POST

/activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists

CLIENT

Creates a new playlists for a user

Reminders

POST

/activitygateway/v1/clientdata/account/{account}/reminders

CLIENT

Creates a new reminder for an account

DELETE

/activitygateway/v1/clientdata/account/{account}/reminders/{id}

CLIENT

Deletes an existing reminder for a given user

POST

/activitygateway/v1/clientdata/account/{account}/user/{userId}/reminders

CLIENT

Creates a new reminder

DELETE

/activitygateway/v1/clientdata/account/{account}/user/{userId}/reminders/{id}

CLIENT

Deletes an existing reminder for a given user

Authentication service discovery service

GET

/ags/servicediscovery

CLIENT

Discover the services available and the parameters each endpoint may accept.

Authentication services

POST

/ags/signOn

CLIENT

Retrieve sign on token using provided credentials.

POST

/ags/subsequentSignOn

CLIENT

Subsequent sign on to be used when the initial sign on endpoint returns a 300 to indicate there are multiple accounts associated with the user.

POST

/ags/refresh

CLIENT

Refreshes a sign on token.

POST

/ags/signOut

CLIENT

Signs out from an account.

Registration services

POST

/ags/register/{type}

CLIENT

Register using provided credentials.

POST

/ags/subsequentRegister

CLIENT

Subsequent registration to be used when the initial register endpoint returns a 300 to indicate there are multiple accounts associated with the user.

Business rule groups

GET

/businessConfig/admin/v1/businessRuleGroups

OPERATOR

Retrieves all business rule groups according to the provided query parameters. A default limit of 100 protecting the system is defined.

POST

/businessConfig/admin/v1/businessRuleGroups

OPERATOR

Creates a new business rule group.

GET

/businessConfig/admin/v1/businessRuleGroups/{id}

OPERATOR

Retrieves one business rule group specified by its identifier.

PUT

/businessConfig/admin/v1/businessRuleGroups/{id}

OPERATOR

Updates one business rule group specified by its identifier. All the attributes must be specified otherwise they will be nullified.

DELETE

/businessConfig/admin/v1/businessRuleGroups/{id}

OPERATOR

Deletes one business rule group specified by its identifier.

Business rule instances

GET

/businessConfig/admin/v1/businessRuleInstances/{moduleName}/
{businessRulePackageName}/{businessRuleName}

OPERATOR

Retrieves a business rule instance according to the provided module name, business rule package name and business rule name.

PUT

/businessConfig/admin/v1/businessRuleInstances/{moduleName}/{businessRulePackageName}/{businessRuleName}

OPERATOR

Configure a business rule instance according to the provided module name, business rule package name and business rule name.

DELETE

/businessConfig/admin/v1/businessRuleInstances/{moduleName}/{businessRulePackageName}/{businessRuleName}

OPERATOR

Delete a business rule instance according to the provided module name, business rule package name and business rule name.

GET

/businessConfig/admin/v1/businessRuleInstances/{moduleName}

OPERATOR

Retrieves all business rule instances according to the provided module name. A default limit of 100 protecting the system is defined.

Business rules

GET

/businessConfig/admin/v1/businessRules

OPERATOR

Retrieves all business rules according to the provided query parameters. A default limit of 100 protecting the system is defined.

POST

/businessConfig/admin/v1/businessRules/load

OPERATOR

Loads a pseudo rule content into a BCM rule and commit it.

GET

/businessConfig/admin/v1/businessRules/{packageName}/{name}

OPERATOR

Retrieves one business rule specified by its package name and its name.

POST

/businessConfig/admin/v1/businessRules/{packageName}/{name}

OPERATOR

Creates a new business rule with the given name and package name.

PUT

/businessConfig/admin/v1/businessRules/{packageName}/{name}

OPERATOR

Updates one business rule specifying name and package name. All the attributes must be specified otherwise they will be nullified.

DELETE

/businessConfig/admin/v1/businessRules/{packageName}/{name}

OPERATOR

Deletes one business rule specified by its name and package name.

POST

/businessConfig/admin/v1/businessRules/{packageName}/{name}/commit

OPERATOR

Commits the business rule and stores the content of the contentUnderConstruction property against the incremented latest version.

Devices

GET

/businessConfig/admin/v1/devices

OPERATOR

Retrieves all devices. A default limit of 100 protecting the system is defined.

POST

/businessConfig/admin/v1/businessConfig/admin/v1/devices

OPERATOR

Creates a new device.

GET

/businessConfig/admin/v1/devices/{deviceId}

OPERATOR

Retrieves one device specifying its identifier.

PUT

/businessConfig/admin/v1/devices/{deviceId}

OPERATOR

Updates one device specifying its identifier. All the attributes must be specified otherwise they will be nullified.

DELETE

/businessConfig/admin/v1/devices/{deviceId}

OPERATOR

Deletes one device specifying its identifier.

POST

/businessConfig/admin/v1/devices/{deviceId}/lockAndGetDevice

OPERATOR

Lock device which is used by workflow instance and get particular device object.

POST

/businessConfig/admin/v1/devices/{deviceId}/lockAndDecrementAndUnlock

OPERATOR

Lock device then decrement pending jobs count with one lock device and unlock device.

POST

/businessConfig/admin/v1/devices/{deviceId}/decrementPendingJobs

OPERATOR

Decrement pending jobs count by one.

POST

/businessConfig/admin/v1/devices/{deviceId}/fetchExecutableJobCount

OPERATOR

Receives the job count from CWM and responds with executable job count for the device ID.

POST

/businessConfig/admin/v1/devices/{deviceId}/resetPendingJobs

OPERATOR

Inputs the pending job count that needs to be reset on the device post initial job processing in CWM.

POST

/businessConfig/admin/v1/devices/{deviceId}/actions

OPERATOR

Executes a device action. The list of supported actions are lock and unlock. It is used for pessimistic locking when the same device is used by n workflow instances.

Fields

GET

/businessConfig/admin/v1/fields

OPERATOR

Retrieve all configured  custom fields

Used as a metadata field while creating CPM entities (editorial/technical contents/channels, events etc...)

POST

/businessConfig/admin/v1/fields

OPERATOR

Create a new custom field

Used as a metadata field while creating CPM entities (editorial/technical contents/channels, events etc...)

GET

/businessConfig/admin/v1/fields/{fieldId}

OPERATOR

Retrieve a specific custom field

Used as a metadata field while creating CPM entities (editorial/technical contents/channels, events etc...)

PUT

/businessConfig/admin/v1/fields/{fieldId}

OPERATOR

Update an existing custom field

Used as a metadata field while creating CPM entities (editorial/technical contents/channels, events etc...)

DELETE

/businessConfig/admin/v1/fields/{fieldId}

OPERATOR

Delete an existing custom field

Used as a metadata field while creating CPM entities (editorial/technical contents/channels, events etc...)

Ping

GET

/businessConfig/admin/v1/ping

OPERATOR

Pings API to verify that the BCM is ready to accept REST calls.

Profiles

GET

/businessConfig/admin/v1/profiles/{profileId}

OPERATOR

Retrieves one profile specifying its identifier.

PUT

/businessConfig/admin/v1/profiles/{profileId}

OPERATOR

Updates one profile specifying its identifier. All the attributes must be specified otherwise they will be nullified.

DELETE

/businessConfig/admin/v1/profiles/{profileId}

OPERATOR

Deletes one profile specifying its identifier.

GET

/businessConfig/admin/v1/profiles

OPERATOR

Retrieves all profiles. A default max limit of 100 is defined in order to protect the system.

POST

/businessConfig/admin/v1/profiles

OPERATOR

Creates a new profile.

Usage rules

GET

/businessConfig/admin/v1/usageRules

OPERATOR

Retrieve all usage rules used by URL builder

POST

/businessConfig/admin/v1/usageRules

OPERATOR

Create new usage rules used by URL builder

GET

/businessConfig/admin/v1/usageRules/{name}

OPERATOR

Retrieve a specific usage rule used by URL builder

PUT

/businessConfig/admin/v1/usageRules/{name}

OPERATOR

Update an existing usage rule

DELETE

/businessConfig/admin/v1/usageRules/{name}

OPERATOR

Delete an existing usage rule

Authentication

GET

/bcm/v1/config/authentication

OPERATOR

Retrieve authentication configured on system.

PUT

/bcm/v1/config/authentication

OPERATOR

Create or update the authentication configured on the system.

CDN configuration

GET

/bcm/v1/config/cdnConfiguration

OPERATOR

Retrieve all CDN configuration mappings configured on the config map

PUT

/bcm/v1/config/cdnConfiguration

OPERATOR

Create or update the available CDN configuration on the system

GET

/bcm/v1/config/cdnConfiguration/{cdnId}

OPERATOR

Get available configuration for CDN ID mappings from the config map

PUT

/bcm/v1/config/cdnConfiguration/{cdnId}

OPERATOR

Create or update the available CDN configuration on the system

DELETE

/bcm/v1/config/cdnConfiguration/{cdnId}

OPERATOR

Delete available configuration for CDN ID mapping from the config map

Channel session account group policy

GET

/bcm/v1/channelSessionGroups/{channelGroupId}

OPERATOR

Get available configuration for channel session account group maxSessions for specified channelGroupId from the config map.

PUT

/bcm/v1/channelSessionGroups/{channelGroupId}

OPERATOR

Create/update available configuration for channelGroupId and maxSessions list mappings from the config map.

DELETE

/bcm/v1/channelSessionGroups/{channelGroupId}

OPERATOR

Delete available configuration for channel session account group maxSession from the config map.

GET

/bcm/v1/channelSessionAccountGroupPolicyConfig

OPERATOR

Retrieve all available channel session account group policy configuration from the system.

PUT

/bcm/v1/channelSessionAccountGroupPolicyConfig

OPERATOR

Create or update all available channel session account group policy configuration from the system.

GET

/bcm/v1/channelSessionGroups

OPERATOR

Retrieve all channel session groups configured on the config map.

PUT

/bcm/v1/channelSessionGroups

OPERATOR

Create or update the available channel session groups from the system.

Content categories

GET

/bcm/v1/config/contentCategories

OPERATOR

Retrieve all available content categories configured on the system.

PUT

/bcm/v1/config/contentCategories

OPERATOR

Create or update the available content categories configured on the system.

Content type mappings

GET

/bcm/v1/config/contentTypeMappings

OPERATOR

Retrieve all configured mappings between Nagra specific content types and content providers' types

PUT

/bcm/v1/config/contentTypeMappings

OPERATOR

Configure/Modify (bulk) a list of mappings between Nagra specific content types and content providers' types

GET

/bcm/v1/config/contentTypeMappings/{contentType}

OPERATOR

Retrieve mapping between specified Nagra specific content types and content providers' types

PUT

/bcm/v1/config/contentTypeMappings/{contentType}

OPERATOR

Configure/Modify specified mappings between Nagra specific content types and content providers' types

DELETE

/bcm/v1/config/contentTypeMappings/{contentType}

OPERATOR

Delete specified mappings between Nagra specific content types and content providers' types

Default image sequence number

GET

/bcm/v1/config/defaultImageSequenceNumber

OPERATOR

Retrieve Default Image Sequence Number configured on the config map

PUT

/bcm/v1/config/defaultImageSequenceNumber

OPERATOR

Create or update all available configuration for defaultImageSequenceNumber from the system

Entity management

GET

/bcm/v1/config/entityManagement

OPERATOR

Retrieve all entity management configured on the system.

PUT

/bcm/v1/config/entityManagement

OPERATOR

Create or update all available configuration for entity managemnet from the system.

External content provider

GET

/bcm/v1/config/externalContentProvider

OPERATOR

Retrieve all external content providers configured on the config map.

POST

/bcm/v1/config/externalContentProvider

OPERATOR

Create available configuration for external content provider from the config map.

GET

/bcm/v1/config/externalContentProvider/externalContentProvider/{id}

OPERATOR

Get available configuration for external content provider from the config map for ID.

PUT

/bcm/v1/config/externalContentProvider/externalContentProvider/{id}

OPERATOR

Update available configuration for external content provider from the config map for ID.

DELETE

/bcm/v1/config/externalContentProvider/externalContentProvider/{id}

OPERATOR

Delete available configuration for external content provider from the config map for ID.

FIPS codes

GET

/bcm/v1/config/fipscodes

OPERATOR

Retrieve the configured list of FIPS codes 

PUT

/bcm/v1/config/fipscodes

OPERATOR

Configure a list of FIPS codes that are allowed to be used during account configuration

Generic recommendations configuration

GET

/bcm/v1/config/recoconfig

OPERATOR

Retrieve available generic recommendation configuration on the system.

PUT

/bcm/v1/config/recoconfig

OPERATOR

Create or update the generic recommendation configuration on the system.

Geo-filtering

GET

/bcm/v1/config/geofiltering

OPERATOR

Retrieve geo-filtering configured on system.

PUT

/bcm/v1/config/geofiltering

OPERATOR

Create or update the geo-filtering configured on the system.

GET

/bcm/v1/config/geofiltering/templates

OPERATOR

Retrieve countryCodeListTemplates configured on system.

PUT

/bcm/v1/config/geofiltering/templates

OPERATOR

Create or update the countryCodeListTemplates configured on the system.

Geo-blocking (countries)

GET

/bcm/v1/config/geoblocking/allowedcountries

OPERATOR

Retrieves all allowed countries configured on the system.

PUT

/bcm/v1/config/geoblocking/allowedcountries

OPERATOR

Creates or updates the allowed countries configured on the system.

GET

/bcm/v1/config/geoblocking/countries

OPERATOR

Retrieves all country lists configured on the system.

PUT

/bcm/v1/config/geoblocking/countries

OPERATOR

Creates or updates the country list configured on the system.

Geo-blocking (regions)

GET

/bcm/v2/config/geoblocking/allowedregions

OPERATOR

Retrieves all allowed regions configured on the system.

PUT

/bcm/v2/config/geoblocking/allowedregions

OPERATOR

Creates or updates the allowed Regions configured on the system.

GET

/bcm/v2/config/geoblocking/country/{code}/regions

OPERATOR

Retrieves all Region list configured on the system.

PUT

/bcm/v2/config/geoblocking/country/{code}/regions

OPERATOR

Creates or updates the Region list configured on the system.

Geo-blocking (VPN)

GET

/bcm/v1/config/geoblocking/blockvpn

OPERATOR

Retrieves blockVPN configured on the system.

PUT

/bcm/v1/config/geoblocking/blockvpn

OPERATOR

Creates or updates the blockVPN configured on the system.

Image type mappings

GET

/bcm/v1/config/imageTypeMappings/{imageType}

OPERATOR

Retrieve mapping between Nagra image type and content providers' image types for specified image type

PUT

/bcm/v1/config/imageTypeMappings/{imageType}

OPERATOR

Configure/Modify (bulk) mappings between Nagra image type and content providers' image types

DELETE

/bcm/v1/config/imageTypeMappings/{imageType}

OPERATOR

Delete specified mapping between Nagra image type and content providers' image types

GET

/bcm/v1/config/imageTypeMappings

OPERATOR

Retrieve all mappings between Nagra image type and content providers' image types

PUT

/bcm/v1/config/imageTypeMappings

OPERATOR

Configure/Modify mapping between Nagra image type and content providers' image types

Metadata locale

GET

/bcm/v1/config/metadata/locales

OPERATOR

Retrieves all available metadata locales configured on the system.

PUT

/bcm/v1/config/metadata/locales

OPERATOR

Creates or updates the available metadata locales configured on the system.

Node links

GET

/bcm/v1/config/nodeLinks

OPERATOR

Retrieve all node links configured on the system.

PUT

/bcm/v1/config/nodeLinks

OPERATOR

Create or update all available configuration for node links from the system.

Parental ratings

GET

/bcm/v1/config/parentalRatings

OPERATOR

Retrieves all available parental rating configured on the system.

PUT

/bcm/v1/config/parentalRatings

OPERATOR

Creates or updates the available parental rating configured on the system.

Playback URL configuration

GET

/bcm/v1/config/playbackUrl

OPERATOR

Retrieve all playback URLs configured on the system.

PUT

/bcm/v1/config/playbackUrl

OPERATOR

Create or update all available configuration for playback URLs from the system.

Playout device class configuration

GET

/bcm/v1/config/playoutDeviceClassConfig

OPERATOR

Retrieve the configured list of device classifiers

PUT

/bcm/v1/config/playoutDeviceClassConfig

OPERATOR

Configure list of device classifiers that are allowed in platform (mobile, managed etc...)

Product capabilities

GET

/bcm/v1/config/productcapabilities

OPERATOR

Retrieve the configured list of product features/capabilities

PUT

/bcm/v1/config/productcapabilities

OPERATOR

Configure list of product features/capabilities supported in platform (SD, HD etc...)

Rails custom templates

GET

/bcm/v1/config/railsCustomTemplates

OPERATOR

Retrieve all Rails Custom Templates configured on the config map

POST

/bcm/v1/config/railsCustomTemplates

OPERATOR

Create available configuration for Rails Custom Templates from the config map

GET

/bcm/v1/config/railsCustomTemplates/{id}

OPERATOR

Get available configuration for Rails Custom Templates from the config map for ID

PUT

/bcm/v1/config/railsCustomTemplates/{id}

OPERATOR

Update available configuration for Rails Custom Templates from the config map for ID

DELETE

/bcm/v1/config/railsCustomTemplates/{id}

OPERATOR

Delete available configuration for Rails Custom Templates from the config map for ID

Technical types

GET

/bcm/v1/config/products/technicaltypes

OPERATOR

Retrieve all available technical types for products configured on the system.

PUT

/bcm/v1/config/products/technicaltypes

OPERATOR

Create or update the available technical types for products configured on the system.

Technical usage rule profile config

GET

/bcm/v1/technicalUsageRuleProfileConfig

OPERATOR

Retrieve all available technical usage rule profile configuration from the system.

PUT

/bcm/v1/technicalUsageRuleProfileConfig

OPERATOR

Create or update all available technical usage rule profile configuration from the system,

GET

/bcm/v1/technicalUsageRuleProfiles

OPERATOR

Retrieve all technical usage rule profiles mappings configured on the config map.

PUT

/bcm/v1/technicalUsageRuleProfiles

OPERATOR

Create or update the available technical usage rule profiles mappings configured on the system. Profile names should be subset of allowed technical usage rule profiles.

GET

/bcm/v1/technicalUsageRuleProfiles/{profileName}

OPERATOR

Get available configuration for technical usage rule profiles for the specified profile name from the config map.

PUT

/bcm/v1/technicalUsageRuleProfiles/{profileName}

OPERATOR

Create/update available configuration for profile and channel list mappings from the config map. Profile name should be subset of allowed technical usage rule profiles.

DELETE

/bcm/v1/technicalUsageRuleProfiles/{profileName}

OPERATOR

Delete available configuration for technical usage rule profiles from the config map.

Validation rules mappings

GET

/bcm/v1/config/validationRules

OPERATOR

Retrieve all available validation rules configured on the system.

GET

/bcm/v1/config/validationRules/{ruleType}

OPERATOR

Retrieve validation rules of type configured on the system.

PUT

/bcm/v1/config/validationRules/{ruleType}

OPERATOR

Creating/updating validation rules of type schemaRules in config map.

DELETE

/bcm/v1/config/validationRules/{ruleType}

OPERATOR

Delete available configuration for validation rule from the config map.

Watermarking configuration

GET

/bcm/v1/config/watermarking

OPERATOR

Retrieve all available configuration for watermarking from the system

.

PUT

/bcm/v1/config/watermarking

OPERATOR

Create or update all available configuration for watermarking from the system.

POST

/cag/v1/{casInstanceName}/v1/entitlements

OPERATOR

Adds an entitlement to CAS.

POST

/cag/v1/{casInstanceName}/devices/{deviceId}/entitlements

OPERATOR

Creates a product subscriptions for a device.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/entitlements

OPERATOR

Updates a product subscriptions for a device.

DELETE

/cag/v1/{casInstanceName}/devices/{deviceId}/entitlements

OPERATOR

Removes product subscriptions for device.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/chipsets/{chipsetNum}/pair

OPERATOR

Pairs the ChipSet serial number.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/chipsets/{chipsetNum}/unpair

OPERATOR

Unpairs the ChipSet serial number.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/pin

OPERATOR

Resets the parental PIN code for a device.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/pin/{pinNum}

OPERATOR

Creates a parental PIN code for a device.

POST

/cag/v1/{casInstanceName}/devices/{deviceId}/message

OPERATOR

Posts the message.

POST

/cag/v1/{casInstanceName}/devices/{deviceId}/mail

OPERATOR

Send mail.

PUT

/cag/v1/{casInstanceName}/devices/{deviceId}/recovery

OPERATOR

The number of years to recover.

Cast crew personas

GET

/persons/v1/operator/castCrewPersonas

OPERATOR

Returns one or more cast/persona entries based on filter and limit. If no filter/limit is specified, the total number of results are limited to the maximum set limit on that resource. This will always return a totalRecords element, whose value is irrespective of the limit or page being set.

PUT

/persons/v1/operator/castCrewPersonas

OPERATOR

Updates the details of one or more cast/persona entries based on id(s).

DELETE

/persons/v1/operator/castCrewPersonas

OPERATOR

Deletes the one or more cast/persona entries based the given id(s).

GET

/persons/v1/operator/castCrewPersonas/{id}

OPERATOR

Returns the details of the cast/persona for the given identifier.

PUT

/persons/v1/operator/castCrewPersonas/{id}

OPERATOR

Updates the details of the cast/persona for the given id.

DELETE

/persons/v1/operator/castCrewPersonas/{id}

OPERATOR

Deletes the cast/persona entry for the given identifier.

DELETE

/persons/v1/operator/castCrewPersonas/playlists?ids={id}

OPERATOR

Deletes playlist entries for each person based on the identifiers specified in the query parameter.

Users

GET

/persons/v1/operator/users

OPERATOR

Returns one or more users based on filter and limit. If no filter/limit is specified, the total number of results are limited to the maximum set limit on that resource. This will always return a totalRecords element, whose value is irrespective of the limit or page being set.

PUT

/persons/v1/operator/users

OPERATOR

Updates the details of one or more user entries based on id(s).

DELETE

/persons/v1/operator/users

OPERATOR

Deletes the one or more user entries based the given id(s).

GET

/persons/v1/operator/users/{id}

OPERATOR

Returns the details of the user for the given identifier.

PUT

/persons/v1/operator/users/{id}

OPERATOR

Updates the details of the user for the given id.

DELETE

/persons/v1/operator/users/{id}

OPERATOR

Deletes the user entry for the given identifier. Returns the identifier of the deleted cast/persona. Also applies to resource that did not match the request.

Cast crew personas

GET

/client/castCrewPersonas

CLIENT

Returns one or more cast/persona entries based on filter and limit. If no filter/limit is specified, the total number of results are limited to the maximum set limit on that resource. This will always return a totalRecords element, whose value is irrespective of the limit or page being set.

Users

GET

/client/users

CLIENT

Returns one or more users based on filter and limit. If no filter/limit is specified, the total number of results are limited to the maximum set limit on that resource. This will always return a totalRecords element, whose value is irrespective of the limit or page being set.

GET

/client/users/{accountId}/{userId}

CLIENT

Returns the details of the user for the given account and user ID.

PUT

/client/users/{accountId}/{userId}

CLIENT

Updates the details of the user for the given account and user ID.

DELETE

/client/users/{accountId}/{userId}

CLIENT

Removes the entry of the user for the given account and user ID.

GET

/contentdelivery/v1/presentationTemplate

CLIENT

Retrieve the presentation template that is currently enabled for the requesting device.

GET

/contentdelivery/v1/genericContent

CLIENT

Retrieve generic content.

GET

/contentdelivery/v1/personalizedContent

CLIENT

Retrieve personalised content.

GET

/contentdelivery/v2/genericContent

CLIENT

Retrieve generic content.

GET

/contentdelivery/v2/personalizedContent

CLIENT

Retrieve personalised content.

EPG

GET

/metadata/v1/epg

CLIENT

Get programmes for a given time period across all channels, or for a specific channel.

GET

/metadata/v1/epg/now

CLIENT

Get current programmes available across all channels.

Catchup

GET

/metadata/v1/catchup

CLIENT

Get catchup content.

GET

/metadata/v1/catchup/{event-id }

CLIENT

Get catchup content.

Subscribed

GET

/metadata/v1/subscribed/products

CLIENT

Get products to which the account (known from the authentication details) is subscribed.

Bookmarks

POST

/contentdiscovery/v2/bookmarks/account/{accountId}/action/{action}

CLIENT

Adds an entry to an accounts bookmark list.

Contexts

GET

/v2/contexts

CLIENT

Gets recommendation contexts.

Operator

GET

/operator/v2/contexts/presentationproperties

OPERATOR

Gets the presentation properties of all contexts.

Ratings

POST

/contentdiscovery/v2/ratings/account/{accountId}

CLIENT

Rates content for an account.

Recommendations

POST

/contentdiscovery/v2/recommendations/account/{accountId}

CLIENT

Get account recommendations.

User activity

POST

/contentdiscovery/v2/useractivity/{userActivity}/account/{accountId}

CLIENT

Records user activity.

Devices

GET

/devices/profiles

OPERATOR

Retrieves list of device profiles assignment.

PUT

/devices/profiles

OPERATOR

Assigns profile templates to a device.

DELETE

/devices/profiles

OPERATOR

Unlinks device from profiles.

Discover view

GET

/discover/accounts/{accountID}

CLIENT

Retrieves strip contents for the account.

GET

/discover/accounts/{accountId}/users/{userId}

CLIENT

Retrieve strip contents for the given user of the account

Magazine view

GET

/magazine/accounts/{accountID}

CLIENT

Retrieves magazine contents for the given account.

GET

/magazine/accounts/{accountId}/users/{userId}

CLIENT

Retrieves magazine contents for the given user of the account.

Profiles

GET

/cds/v1/profiles

OPERATOR

Retrieves list of profiles based on query fields.

PUT

/cds/v1/profiles

OPERATOR

Adds or updates profile template.

DELETE

/cds/v1/profiles

OPERATOR

Deletes profiles based on filter.

Content providers

GET

/exportcex/admin/v1/contentProviders/

OPERATOR

Get all content providers

GET

/exportcex/admin/v1/contentProviders/{contentProvider}

OPERATOR

Get content provider by ID

POST

/exportcex/admin/v1/contentProviders/{contentProvider}

OPERATOR

Create content provider

DELETE

/exportcex/admin/v1/contentProviders/{contentProvider}

OPERATOR

Delete content provider

Algorithm parameter set

GET

/exportcex/admin/v1/contentProviders/{contentProvider}/algorithmParameterSets/{algorithmParameterSetId}

OPERATOR

Get Algorithm ParameterSet By Id

PUT

/exportcex/admin/v1/contentProviders/{contentProvider}/algorithmParameterSets/{algorithmParameterSetId}

OPERATOR

Update Algorithm ParameterSet

POST

/exportcex/admin/v1/contentProviders/{contentProvider}/algorithmParameterSets/{algorithmParameterSetId}

OPERATOR

Create Algorithm ParameterSet

DELETE

/exportcex/admin/v1/contentProviders/{contentProvider}/algorithmParameterSets/{algorithmParameterSetId}

OPERATOR

Delete Algorithm ParameterSet

DELETE

/exportcex/admin/v1/contentProviders/{contentProvider}/algorithmParameterSets/{algorithmParameterSetId}/{keyName}

OPERATOR

Delete Property Key Value

Health check

GET

/healthCheck/cpm 

ADMIN

Healthcheck API validating the health of CPM

GET

/healthCheck/bcm 

ADMIN

Healthcheck API validating the health of BCM

GET

/healthCheck 

ADMIN

Healthcheck API validating the health of services used by CEX (CPM and BCM)

Ping

GET

/ping 

ADMIN

Ping API to check if CEX is up and running

GET

/cim-dplus/v1/ingest

OPERATOR

Gets the ingestion status

POST

/cim-dplus/v1/ingest

OPERATOR

Starts the manual/on-demand ingestion.

DELETE

/cim-dplus/v1/ingest

OPERATOR

Stops the ongoing ingestion (full/incremental/manual).

Content authorisations

GET

/metadata/commercial/v1/contentAuthorizations

OPERATOR

Fetch content authorisations by contentSecurityId and contentAvailabilityOffset.

Products

GET

/metadata/commercial/v1/products/{productId}

OPERATOR

Get product by productId.

PUT

/metadata/commercial/v1/products/{productId}

OPERATOR

Update product by productId.

DELETE

/metadata/commercial/v1/products/{productId}

OPERATOR

Delete product by productId.

GET

/metadata/commercial/v1/products

OPERATOR

Find products by query.

PUT

/metadata/commercial/v1/products

OPERATOR

Update products.

POST

/metadata/commercial/v1/products

OPERATOR

Create a product.

DELETE

/metadata/commercial/v1/products

OPERATOR

Delete Products by providerId  and providerResourceId.

PATCH

/metadata/commercial/v1/products

OPERATOR

Patch product by filter.

GET

/metadata/commercial/v1/products/relatedProds

OPERATOR

Find products with business products by query.

PUT

/metadata/commercial/v1/products/command

OPERATOR

Update product set based on action.

GET

/metadata/commercial/v1/products/{marketableType}/export

OPERATOR

Find products for export.

DELETE

/metadata/commercial/v1/products/{productId}/deviceClass

OPERATOR

Delete device class by product ID.

Content groups

GET

/metadata/commercial/v2/contentGroups/{contentGroupId}

OPERATOR

Get contentGroup by ID.

Nodes

GET

/metadata/commercial/v2/nodes/{nodeId}

OPERATOR

Get a node by ID.

Channel events

PUT

/metadata/content/v1/channelEvents

OPERATOR

Update channel events.

Channel lineup links

GET

/metadata/content/v1/channelLineUpLinks

OPERATOR

Get channel lineup links by lineup ID or name.

POST

/metadata/content/v1/channelLineUpLinks

OPERATOR

Create channel lineup links.

DELETE

/metadata/content/v1/channelLineUpLinks

OPERATOR

Delete channel lineup links.

GET

/metadata/content/v1/channelLineUpLinks/channelLineUp/{channelLineUpId}/editorialChannel/{editorialChannelId}

OPERATOR

Get channel lineup links for a given channel lineup ID and editorial channel ID.

Channel lineups

GET

/metadata/content/v1/channelLineUps

OPERATOR

Get channel lineups by query.

PUT

/metadata/content/v1/channelLineUps

OPERATOR

Create/update channel lineup set.

POST

/metadata/content/v1/channelLineUps

OPERATOR

Create channel lineup.

GET

/metadata/content/v1/channelLineUps/{channelLineUpId}

OPERATOR

Get channel lineup by ID.

PUT

/metadata/content/v1/channelLineUps/{channelLineUpId}

OPERATOR

Update a channel lineup by ID.

DELETE

/metadata/content/v1/channelLineUps/{channelLineUpId}

OPERATOR

Delete channel lineup by ID.

Channel set events

PUT

/metadata/content/v1/channelSetEvents

OPERATOR

Update channel set events.

Content groups links

PUT

/metadata/content/v1/contentGroupsLinks/{groupedResourceType}/{groupedResourceId}/contentGroup/{contentGroupId}

OPERATOR

Create or update content groups link by groupedResourceId  and contentGroupId.

DELETE

/metadata/content/v1/contentGroupsLinks/{groupedResourceType}/{groupedResourceId}/contentGroup/{contentGroupId}

OPERATOR

Delete content groups link by groupedResourceId  and contentGroupId.

GET

/metadata/content/v1/contentGroupsLinks/{groupedResourceType}

OPERATOR

Get content groups links.

DELETE

/metadata/content/v1/contentGroupsLinks/{groupedResourceType}

OPERATOR

Delete content groups links.

PUT

/metadata/content/v1/contentGroupsLinks

OPERATOR

Update content groups link.

Content groups

GET

/metadata/content/v1/contentGroups/{contentGroupId}

OPERATOR

Get content group by ContentGroupId.

PUT

/metadata/content/v1/contentGroups/{contentGroupId}

OPERATOR

Update content group by contentGroupId.

DELETE

/metadata/content/v1/contentGroups/{contentGroupId}

OPERATOR

Delete content group by contentGroupId.

DELETE

/metadata/content/v1/contentGroups/{contentGroupId}/deleteRelations

OPERATOR

Delink of contents from content group.

GET

/metadata/content/v1/contentGroups

OPERATOR

Get content groups by query.

PUT

/metadata/content/v1/contentGroups

OPERATOR

Update content groups.

POST

/metadata/content/v1/contentGroups

OPERATOR

Create content group.

DELETE

/metadata/content/v1/contentGroups

OPERATOR

Delete content groups by providerId and providerResourceId.

PUT

/metadata/content/v1/contentGroups/command

OPERATOR

Update content group set based on action.

GET

/metadata/content/v1/contentGroups/export

OPERATOR

Find content groups for export.

Content publishing windows

GET

/metadata/content/v1/contentPublishingWindows

OPERATOR

Find content publishing windows by query.

PUT

/metadata/content/v1/contentPublishingWindows

OPERATOR

Update content publishing windows.

POST

/metadata/content/v1/contentPublishingWindows

OPERATOR

Create content publishing window.

DELETE

/metadata/content/v1/contentPublishingWindows

OPERATOR

Delete content publishing windows by providerId and providerResourceId.

GET

/metadata/content/v1/contentPublishingWindows/{contentPublishingWindowId}

OPERATOR

Get content publishing window by CPW ID.

PUT

/metadata/content/v1/contentPublishingWindows/{contentPublishingWindowId}

OPERATOR

Update content publishing window by CPW ID.

DELETE

/metadata/content/v1/contentPublishingWindows/{contentPublishingWindowId}

OPERATOR

Delete content publishing window by CPW ID.

PUT

/metadata/content/v1/contentPublishingWindows/command

OPERATOR

Update content publishing window based on action.

GET

/metadata/content/v1/contentPublishingWindows/export

OPERATOR

Find content publishing windows for export.

Deep links

GET

/metadata/content/v1/deepLinks

OPERATOR

Find deep links by query.

PUT

/metadata/content/v1/deepLinks

OPERATOR

Update deep links.

POST

/metadata/content/v1/deepLinks

OPERATOR

Create deep link.

DELETE

/metadata/content/v1/deepLinks

OPERATOR

Delete deep link based on criteria.

GET

/metadata/content/v1/deepLinks/{deepLinkId}

OPERATOR

Get a deep link by ID.

PUT

/metadata/content/v1/deepLinks/{deepLinkId}

OPERATOR

Update a deep link by ID.

DELETE

/metadata/content/v1/deepLinks/{deepLinkId}

OPERATOR

Delete a deep link by ID.

Dynamic content groups

GET

/metadata/content/v1/dynamicContentGroups

OPERATOR

Find dynamic content groups by query.

PUT

/metadata/content/v1/dynamicContentGroups

OPERATOR

Update dynamic content groups.

POST

/metadata/content/v1/dynamicContentGroups

OPERATOR

Create dynamic content group.

DELETE

/metadata/content/v1/dynamicContentGroups

OPERATOR

Delete dynamic content group based on criteria.

GET

/metadata/content/v1/dynamicContentGroups/dynamicContentGroups/{dynamicContentGroupId}

OPERATOR

Get a dynamic content group by ID.

PUT

/metadata/content/v1/dynamicContentGroups/dynamicContentGroups/{dynamicContentGroupId}

OPERATOR

Update dynamic content group by ID.

DELETE

/metadata/content/v1/dynamicContentGroups/dynamicContentGroups/{dynamicContentGroupId}

OPERATOR

Delete a dynamic content group by ID.

POST

/metadata/content/v1/dynamicContentGroups/dynamicContentGroups/{dynamicContentGroupId}/sources

OPERATOR

Add sources for dynamic content group by ID.

DELETE

/metadata/content/v1/dynamicContentGroups/dynamicContentGroups/{dynamicContentGroupId}/sources

OPERATOR

Delete all sources for a dynamic content group.

POST

/metadata/content/v1/dynamicContentGroups/{dynamicContentGroupId}/sources/{sourceType}/{sourceId}

OPERATOR

Add source for dynamic content group.

DELETE

/metadata/content/v1/dynamicContentGroups/{dynamicContentGroupId}/sources/{sourceType}/{sourceId}

OPERATOR

Delete source for a dynamic content group.

Editorial channels

GET

/metadata/content/v1/editorialChannels/{editorialChannelId}

OPERATOR

Get editorial channel by ID.

PUT

/metadata/content/v1/editorialChannels/{editorialChannelId}

OPERATOR

Update an editorial channel by ID.

DELETE

/metadata/content/v1/editorialChannels/{editorialChannelId}

OPERATOR

Delete an editorial channel by ID.

GET

/metadata/content/v1/editorialChannels

OPERATOR

Find editorial channels by query.

PUT

/metadata/content/v1/editorialChannels

OPERATOR

Update editorial channel set.

POST

/metadata/content/v1/editorialChannels

OPERATOR

Create an editorial channel.

DELETE

/metadata/content/v1/editorialChannels

OPERATOR

Delete editorial channels by providerId and providerResourceId.

DELETE

/metadata/content/v1/editorialChannels/{providerId}/{providerResourceId}/parentalRatings/{parentalRatingBodyName}

OPERATOR

Delete parental rating by name.

POST

/metadata/content/v1/editorialChannels/{editorialChannelId}/regionalization

OPERATOR

Create regional to editorial channel set.

DELETE

/metadata/content/v1/editorialChannels/{editorialChannelId}/regionalization

OPERATOR

Delete regionalisation set from editorial channel.

PUT

/metadata/content/v1/editorialChannels/command

OPERATOR

Update editorial channel by action. Used for export scenarios. The possible values are ["updateExportStatus"] .

POST

/metadata/content/v1/editorialChannels/{editorialChannelId}/removeDvbinfo

OPERATOR

Remove dvbinfo items or clear dvbinfo from editorial channel.

POST

/metadata/content/v1/editorialChannels/{editorialChannelId}/clientControls

OPERATOR

Create client controls on editorial channel set.

DELETE

/metadata/content/v1/editorialChannels/{editorialChannelId}/clientControls

OPERATOR

Delete client controls from editorial channel set.

DELETE

/metadata/content/v1/editorialChannels/{editorialChannelId}/sourcePreference

OPERATOR

Delete source preference from editorial channel set.

DELETE

/metadata/content/v1/editorialChannels/{editorialChannelId}/regionalSettings/{location}/sourcePreference

OPERATOR

Delete regional source preference.

Nodes

GET

/metadata/content/v1/nodes/hierarchy/{nodeId}

OPERATOR

Fetch node hierarchy by node ID.

GET

/metadata/content/v1/nodes/export

OPERATOR

Find nodes for export.

DELETE

/metadata/content/v1/nodes/{nodeId}/preferenceSet

OPERATOR

Delete preference set from node.

GET

/metadata/content/v1/nodes/{nodeId}

OPERATOR

Get a node by ID.

PUT

/metadata/content/v1/nodes/{nodeId}

OPERATOR

Update a node by ID.

POST

/metadata/content/v1/nodes/{nodeId}

OPERATOR

Delete child preference set from node.

DELETE

/metadata/content/v1/nodes/{nodeId}

OPERATOR

Delete a node by ID.

GET

/metadata/content/v1/nodes

OPERATOR

Find nodes by query.

PUT

/metadata/content/v1/nodes

OPERATOR

Update a node set.

POST

/metadata/content/v1/nodes

OPERATOR

Create a node.

DELETE

/metadata/content/v1/nodes

OPERATOR

Delete node by providerId and providerResourceId.

PUT

/metadata/content/v1/nodes/command

OPERATOR

Update node based on action.

PUT

/metadata/content/v1/nodes/reorder/{nodeId}

OPERATOR

Reorder the node based on the action. Either move or copy under the new parent.

DELETE

/metadata/content/v1/nodes/{nodeId}/orderingFields

OPERATOR

Delete ordering fields from node.

POST

/metadata/content/v1/nodes/move

OPERATOR

Reorder the node. Move node/nodes under the new parent.

POST

/metadata/content/v1/nodes/copy

OPERATOR

Reorder the node. Node copy.

Editorial contents

DELETE

/metadata/content/v1/editorialContents/{providerId}/{providerResourceId}/parentalRatings/{parentalRatingBodyName

OPERATOR

Delete parental rating by name.

POST

/metadata/content/v1/editorialContents/{editorialContentId}/clientControls

OPERATOR

Create client controls on editorial content.

DELETE

/metadata/content/v1/editorialContents/{editorialContentId}/clientControls

OPERATOR

Delete client controls from editorial content set.

GET

/metadata/content/v1/editorialContents/{editorialContentId}

OPERATOR

Get editorial content by ID.

PUT

/metadata/content/v1/editorialContents/{editorialContentId}

OPERATOR

Update editorial content by ID.

DELETE

/metadata/content/v1/editorialContents/{editorialContentId}

OPERATOR

Delete editorial content by ID.

GET

/metadata/content/v1/editorialContents

OPERATOR

Find editorial contents by query.

PUT

/metadata/content/v1/editorialContents

OPERATOR

Update editorial content set.

POST

/metadata/content/v1/editorialContents

OPERATOR

Create an editorial content.

DELETE

/metadata/content/v1/editorialContents

OPERATOR

Delete editorial contents by providerId and providerResourceId.

DELETE

/metadata/content/v1/editorialContents/{providerId}/{providerResourceId}/referenceAsset/{referenceAssetType}

OPERATOR

Delete reference asset by type.

DELETE

/metadata/content/v1/editorialContents/{providerId}/{providerResourceId}/referenceAsset/{referenceAssetType}/
assetDeviceLocation/{assetDeviceLocationType}

OPERATOR

Delete reference asset ADL for a given reference asset type.

DELETE

/metadata/content/v1/editorialContents/{editorialContentId}/contentGroupRef

OPERATOR

Delete BELONGS_TO  link from editorial content to content group.

PUT

/metadata/content/v1/editorialContents/command

OPERATOR

Update editorial content set based on action.

GET

/metadata/content/v1/editorialContents/node

OPERATOR

Get editorial contents by passing node ID.

GET

/metadata/content/v1/editorialContents/export

OPERATOR

Find editorial contents for export.

Events

DELETE

/metadata/content/v1/events/{providerId}/{providerResourceId}/parentalRatings/{parentalRatingBodyName}

OPERATOR

Delete parental rating by name.

GET

/metadata/content/v1/events

OPERATOR

Find events by query.

PUT

/metadata/content/v1/events

OPERATOR

Update event set.

POST

/metadata/content/v1/events

OPERATOR

Create an event.

DELETE

/metadata/content/v1/events

OPERATOR

Delete events by query.

POST

/metadata/content/v1/events/{eventId}/clientControls

OPERATOR

Create client controls on events.

DELETE

/metadata/content/v1/events/{eventId}/clientControls

OPERATOR

Delete clientControls to Events

GET

/metadata/content/v1/events/{eventId}

OPERATOR

Get an event by ID.

PUT

/metadata/content/v1/events/{eventId}

OPERATOR

Update an event by ID.

DELETE

/metadata/content/v1/events/{eventId}

OPERATOR

Delete an event by ID.

PUT

/metadata/content/v1/events/{eventId}/promotion

OPERATOR

Event promotion by ID.

PUT

/metadata/content/v1/events/bulkGet

OPERATOR

Bulk get events by ID.

Node links

GET

/metadata/content/v1/nodeLinks

OPERATOR

Get node links by resource type.

PUT

/metadata/content/v1/nodeLinks

OPERATOR

Update node links.

POST

/metadata/content/v1/nodeLinks

OPERATOR

Create node link.

DELETE

/metadata/content/v1/nodeLinks

OPERATOR

Delete node link by resource providerId and providerResourceId and node's provideId and providerResourceId.

DELETE

/metadata/content/v1/nodeLinks/{nodeLinkResourceType}/{nodeLinkResourceId}/node/{nodeId}

OPERATOR

Delete node links by resource providerId and providerResourceId.

GET

/metadata/content/v1/nodeLinks/{id}

OPERATOR

Get a node link by ID.

PUT

/metadata/content/v1/nodeLinks/{id}

OPERATOR

Update node link by ID.

POST

/metadata/content/v1/nodeLinks/{id}

OPERATOR

Copy or move contents between nodes.

DELETE

/metadata/content/v1/nodeLinks/{id}

OPERATOR

Delete a node link by ID.

PUT

/metadata/content/v1/nodeLinks/specontext

OPERATOR

Update the status per export set (SPE) context.

DELETE

/metadata/content/v1/nodeLinks/specontext/{specontext}

OPERATOR

Removes the status per export set (SPE) context, when the prefence set is modified since the last export.

Product links

PUT

/metadata/content/v1/productLinks

OPERATOR

Update product links set.

GET

/metadata/content/v1/productLinks/{marketableType}

OPERATOR

Get product links by marketable type, marketable ID set and use node relations flag.

DELETE

/metadata/content/v1/productLinks/{marketableType}

OPERATOR

Delete product links by query.

GET

/metadata/content/v1/productLinks/{marketableType}/{marketableId}/product/{productId}

OPERATOR

Get product links by marketable ID and product ID.

PUT

/metadata/content/v1/productLinks/{marketableType}/{marketableId}/product/{productId}

OPERATOR

Create or update product links by marketable ID and product ID.

DELETE

/metadata/content/v1/productLinks/{marketableType}/{marketableId}/product/{productId}

OPERATOR

Delete product link by marketable ID and product ID.

POST

/metadata/content/v1/productLinks/products

OPERATOR

Delete product link by in bulk based on product reference and multiple marketable references.

GET

/metadata/content/v1/productLinks/{marketableType}/export

OPERATOR

Find the product link for export by marketable type.

PUT

/metadata/content/v1/productLinks/specontext

OPERATOR

Update status per export set (SPE) context on product links.

Technical channels

GET

/metadata/content/v1/technicalChannels

OPERATOR

Find technical channels by query.

PUT

/metadata/content/v1/technicalChannels

OPERATOR

Update technical channels.

POST

/metadata/content/v1/technicalChannels

OPERATOR

Create a technical channel.

DELETE

/metadata/content/v1/technicalChannels

OPERATOR

Delete technical channels by providerId and providerResourceId.

GET

/metadata/content/v1/technicalChannels/{technicalChannelId}

OPERATOR

Get technical channel by ID.

PUT

/metadata/content/v1/technicalChannels/{technicalChannelId}

OPERATOR

Update a technical channel by ID.

DELETE

/metadata/content/v1/technicalChannels/{technicalChannelId}

OPERATOR

Delete technical channel by ID.

DELETE

/metadata/content/v1/technicalChannels/{technicalChannelId}/sessionGroupId

OPERATOR

Delete session group ID from technical channel.

DELETE

/metadata/content/v1/technicalChannels/{technicalChannelId}/usageRule

OPERATOR

Delete usage rule from technical channel.

DELETE

/metadata/content/v1/technicalChannels/{technicalChannelId}/cdnTokenDetails

OPERATOR

Delete CdnTokenDetails on technical channel.

DELETE

/metadata/content/v1/technicalChannels/{technicalChannelId}/{providerId}/{providerResourceId}/securityInfo

OPERATOR

Delete security info on technical channel.

PUT

/metadata/content/v1/technicalChannels/command

OPERATOR

Update technical channel by action. Used for export scenarios. The possible values are ["updateExportStatus"].

Technical contents

GET

/metadata/content/v1/technicalContents

OPERATOR

Find technical contents by query.

PUT

/metadata/content/v1/technicalContents

OPERATOR

Update technical contents.

POST

/metadata/content/v1/technicalContents

OPERATOR

Create technical content.

DELETE

/metadata/content/v1/technicalContents

OPERATOR

Delete technical content by providerId and providerResourceId.

GET

/metadata/content/v1/technicalContents/{technicalContentId}

OPERATOR

Get technical content by ID.

PUT

/metadata/content/v1/technicalContents/{technicalContentId}

OPERATOR

Update technical content by ID.

DELETE

/metadata/content/v1/technicalContents/{technicalContentId}

OPERATOR

Delete technical content by ID.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/cdnTokenDetails

OPERATOR

Delete CdnTokenDetails on technical content.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/playableAsset

OPERATOR

Delete playable asset by providerId and providerResourceId.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/securityInfo

OPERATOR

Delete security info on technical content.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/playableAsset/assetDeviceLocation/{assetDeviceLocationType}

OPERATOR

Delete playable asset ADL by type.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/assets/{assetType}

OPERATOR

Delete supplementary asset by type.

DELETE

/metadata/content/v1/technicalContents/{providerId}/{providerResourceId}/assets/{assetType}/assetDeviceLocation/{assetDeviceLocationType}

OPERATOR

Delete ADL for a given supplementary asset type.

PUT

/metadata/content/v1/technicalContents/command

OPERATOR

Update technical contents based on action.

GET

/metadata/content/v1/technicalContents/export

OPERATOR

Find technical contents for export.

Trailer links

PUT

/metadata/content/v1/trailerLinks

OPERATOR

Update trailer links.

GET

/metadata/content/v1/trailerLinks/{promotableType}

OPERATOR

Get trailer links.

DELETE

/metadata/content/v1/trailerLinks/{promotableType}

OPERATOR

Delete trailer links by query.

GET

/metadata/content/v1/trailerLinks/{promotableType}/{promotableId}/trailer/{trailerId}

OPERATOR

Get trailer link by promotable ID and trailer ID.

PUT

/metadata/content/v1/trailerLinks/{promotableType}/{promotableId}/trailer/{trailerId}

OPERATOR

Create or update trailer link by promotable ID and trailer ID.

DELETE

/metadata/content/v1/trailerLinks/{promotableType}/{promotableId}/trailer/{trailerId}

OPERATOR

Delete trailer link by promotable ID and trailer ID.

GET

/metadata/content/v1/trailerLinks/{promotableType}/export

OPERATOR

Find trailer links for export.

PUT

/metadata/content/v1/trailerLinks/speContext

OPERATOR

Update status per export set (SPE) context on trailer links.

Content groups

GET

/metadata/content/v2/contentGroups/{contentGroupId}

OPERATOR

Get content group by ID.

Nodes

GET

/metadata/content/v2/nodes/{nodeId}

OPERATOR

Get a node by ID.

Location Endpoint /cpm/admin/v1

GET

/metadata/admin/v1/rules

OPERATOR

POST

/metadata/admin/v1/rules

OPERATOR

DELETE

/metadata/admin/v1/rules

OPERATOR

GET

/metadata/admin/v1/rules/{rulePackage}/{ruleName}

OPERATOR

POST

/metadata/admin/v1/rules/{rulePackage}/{ruleName}

OPERATOR

DELETE

/metadata/admin/v1/rules/{rulePackage}/{ruleName}

OPERATOR

Location Endpoint /workflow

GET

/workflow/v1/workflowJobs

OPERATOR

Returns workflow jobs based on filter and limit. If no filter/limit is specified, the total number of results are limited to the maximum set limit on that resource. This will always return a totalRecords element, whose value is irrespective of the limit or page being set.

PUT

/workflow/v1/workflowJobs

OPERATOR

Updates or creates a set of workflowJobs. If a provided job has no ID, it will be created, otherwise it will be updated. (The identifier is the concatenation of the profileId, the owner id and the owner type separated by an underscore.) All the attributes must be specified otherwise they will be nullified (except the id, profileId, ownerId and ownerType wich are part of the identifier and will never be updated once the job created).

POST

/workflow/v1/workflowJobs

OPERATOR

Creates a set of workflowJobs. If the creation of one workflowJob is not possible then nothing will be created. The identifier is the concatenation of the profileId, the owner id and the owner type separated by an underscore.

DELETE

/workflow/v1/workflowJobs

OPERATOR

Deletes all jobs based on the identifiers specified in the query parameter.

GET

/workflow/v1/workflowJobs/{workflowJobId}

OPERATOR

Retrieves one workflowJob specifying its identifier.

PUT

/workflowJobs/{workflowJobId}

OPERATOR

Updates one workflowJob by specifying its identifier. (The identifier is the concatenation of the profileId, the owner id and the owner type separated by an underscore.) All the attributes must be specified otherwise they will be nullified (except the id, profileId, ownerId and ownerType wich are part of the identifier and will never be updated once the job created).

DELETE

/workflow/v1/workflowJobs/{workflowJobId}

OPERATOR

Deletes one workflowJob by specifying its identifier.

PATCH

/workflowJobs/{workflowJobId}

OPERATOR

Partial modification of an existing workflow job resource by specifying its identifier. When an attribute is not specified, its existing value is retained. Attributes metadataSet and workflowInputProperties are merged with the existing ones.

POST

/workflowJobs/amendEventSchedule

OPERATOR

Amend the schedule of any workflow jobs concerning the given event ID / owner ID.

POST

/workflowJobs/processStuckJobs

OPERATOR

Processes the jobs that are stuck.

Location Endpoint /cwm2harmonic-vos-adapter/cxf/pri/v1

POST

/cwm2harmonic-vos-adapter/cxf/pri/v1/capturedassets

OPERATOR

Create captured assets.

GET

/cwm2harmonic-vos-adapter/cxf/pri/v1/capturedassets/{id}?sourceId&assetRelativePath

OPERATOR

Get captured asset by ID.

DELETE

/cwm2harmonic-vos-adapter/cxf/pri/v1/capturedassets/{id}?sourceId&assetRelativePath

OPERATOR

Delete captured asset by ID.

Bundled accounts

POST

/crm-gateway/v1/bundled/accounts

OPERATOR

Create a bundled account.

Accounts

GET

/crm-gateway/v1/accounts/{uid}

OPERATOR

Retrieve an account by ID.

PUT

/crm-gateway/v1/accounts/{uid}

OPERATOR

Update account.

DELETE

/crm-gateway/v1/accounts/{uid}

OPERATOR

Remove all data associated with the account ID passed in.

GET

/crm-gateway/v1/accounts

OPERATOR

Search the accounts collection.

POST

/crm-gateway/v1/accounts

OPERATOR

Add an account.

Devices

GET

/crm-gateway/v1/devices

OPERATOR

Get devices.

POST

/crm-gateway/v1/devices

OPERATOR

Create a new device.

DELETE

/crm-gateway/v1/devices

OPERATOR

Delete Device(s) using account UID.

GET

/crm-gateway/v1/devices/{uid}

OPERATOR

Get a device by UID.

PUT

/crm-gateway/v1/devices/{uid}

OPERATOR

Update a device by ID.

DELETE

/crm-gateway/v1/devices/{uid}

OPERATOR

Delete a device.

Entitlements

GET

/crm-gateway/v1/rmg/v1/entitlements

OPERATOR

Get entitlements.

PUT

/crm-gateway/v1/rmg/v1/entitlements

OPERATOR

Update entitlement.

POST

/crm-gateway/v1/rmg/v1/entitlements

OPERATOR

Add an entitlement.

POST

/crm-gateway/v1/rmg/v1/entitlements/device

OPERATOR

Add an entitlement for a device.

PUT

/crm-gateway/v1/rmg/v1/entitlements/{uid}

OPERATOR

Update entitlement by entitlement ID.

DELETE

/crm-gateway/v1/rmg/v1/entitlements/{uid}

OPERATOR

Delete an entitlement.

DELETE

/crm-gateway/v1/rmg/v1/entitlements/account/{accountId}

OPERATOR

Delete an entitlement by account ID.

Devices additional properties

GET

/crm-gateway/v1/devices/{uid}/additionalproperties

OPERATOR

Get a device's additional properties.

DELETE

/crm-gateway/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Delete all additional aroperties on a device.

GET

/crm-gateway/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Get a device's additional properties by group name.

POST

/crm-gateway/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Creates additional properties on a device.

PUT

/crm-gateway/v1/devices/{uid}/additionalproperties/custom

OPERATOR

Updates the additional properties on a device.

Users

POST

/crm-gateway/v1/rmg/v1/users

OPERATOR

Add a user.

GET

/crm-gateway/v1/rmg/v1/users/{uid}

OPERATOR

Get an user by UID.

Message broadcast

GET

/mib/v1/devices/{deviceType}/{deviceId}

OPERATOR

Gets the device information.

PUT

/mib/v1/devices/{deviceType}/{deviceId}

OPERATOR

Provisions a new device in DMM for IP Messaging.

GET

/mib/v1/topics

OPERATOR

Retrieves topics.

GET

/mib/v1/topics/{topicName}/devices

OPERATOR

Gets the topic Information.

PUT

/mib/v1/topics/{topicName}/devices

OPERATOR

Creates a topic with/without devices.

Message producer

POST

/messaging/v1/topics/{topicName}/inbox

OPERATOR

Sends a message to be routed to a topic within the messaging system.

POST

/messaging/v1/clients/{clientId}/inbox

OPERATOR

Sends a message to be routed to a specific client within the messaging system.

FIPS codes

GET

/mib/v1/accounts/{accountId}/fipsCodes

OPERATOR

Retreive the list of FIPS codes for specified account ID.

PUT

/mib/v1/accounts/{accountId}/fipsCodes

OPERATOR

Associate FIPS codes with account.

DELETE

/mib/v1/accounts/{accountId}/fipsCodes

OPERATOR

Delete the association between FIPS codes and account.

v2 Millicom anonymous signon

POST

/ias/v2/anonymoustoken

CLIENT

Retrieve Millicom device anonymous token.

Content

POST

/ias/v2/cdn_token

CLIENT

Retrieve content token with CDN token.

POST

/ias/v2/isPPVAuthorised

CLIENT

Retrieve content token for PPV event.

POST

/ias/v2/content_token

CLIENT

Retrieves a content token.

DAS service

POST

/ias/v2/das-token/user/{userId}/password/{password}

CLIENT

Validates user and password credentials, gets device ID from DAS server, creating a new device, and returns an SSP token with optional device information.

GET

/ias/v2/das-token/user/authorised

CLIENT

Get device ID using devAuthToken  and DAS SDK data.

v3 DAS service

POST

/ias/v3/das-token

CLIENT

Validates user and password credentials from the request body, gets device ID from DAS server, creating a new device, and returns an SSP token with optional device information.

Operator signon

POST

/ias/v2/operator/token/actions/signon-by-account-id

OPERATOR

Validates account ID credentials, if DAS challenge provided gets device ID from DAS server, creating a new device and returns an SSP token with optional device information.

This API is used exclusively for SSP deployments for integration by third-party operators.

v2 OATH signon

POST

/ias/v2/token?grantType=password

CLIENT

Retrieve device token.

POST

/ias/v2/token?grantType=client_credentials

CLIENT

Retrieve device token.

POST

/ias/v2/token?grantType=selfservice

CLIENT

Retrieve device token.

POST

/ias/v2/token?grantType=refresh_token

CLIENT

Retrieve device token.

v3 OATH signon

POST

/ias/v3/token/actions/signOnByUserNamePassword

CLIENT

Retrieve device token using username, password, and device details.

POST

/ias/v3/token/actions/signOnByCasn

CLIENT

Retrieve device token using the device's casn identifier.

POST

/ias/v3/token/actions/signOnBySmartCardId

CLIENT

Retrieve device token using the device's smartcard identifier.

POST

/ias/v3/token/actions/signOnByTVKeyActivation

CLIENT

Retrieve signon token using TVKey activation and optional device information. In order for the API to work, the device must be pre-provisioned.

v3 OATH

POST

/ias/v3/token/actions/refresh

CLIENT

Refreshes a signon token.

POST

/ias/v3/token/actions/signOut

CLIENT

Signs out from an account, the account ID is obtained from the provided access token.

v3 SSP signon

POST

/ias/v3/token/actions/signOnByAccountId

CLIENT

Retrieve device token using account ID and device details.

v2 signout

POST

/ias/v2/signout

CLIENT

Sign out.

Location detection

GET

/ias/v2/actions/is-in-house

CLIENT

API test for in house by IP address.

v1 locale information

GET

/ias/v1/localeInfo

CLIENT

Provides client locale specific information based upon the address of the client application.

GET

/ias/v1/operator/localeInfo

OPERATOR

Provides client locale specific information based upon the address provided as a query parameter.

v2 get password reset token

POST

/ias/v2/operator/token/resetPasswordSecret

OPERATOR

Retrieve token for reset password.

POST

/ias/v2/operator/token/resetPinSecret

OPERATOR

Retrieve token for reset PIN.

v2 self-service

POST

/ias/v2/selfservicetoken

CLIENT

Self-service token.

v3 self-service

POST

/ias/v3/selfservicetoken

CLIENT

Self-service token.

v1 Starhub OAUTH STB signon

POST

/ias/v1/starhub/token/actions/managed-signon-by-casn

CLIENT

Retrieve device token by supplying a StarHub OAuth access token and an associated set-top box CASN.

Token validation service

GET

/token/v1/validate

CLIENT

Validate and decode an OPF3 JWT token.

Tigo native app configuration

GET

/ias/v2/tigo/nativeAppConfiguration

OPERATOR

Return the configuration used by a native app by country code and client type.

Tigo signon

POST

/ias/v2/authenticated

OPERATOR

Sign in with authenticated Tigo token.

Client APIs

GET

/ihs/v1/{resource_type}/{resource_id}

CLIENT

Get image asynchronously. Resource types: contents, programs, series, channels , persons.

PUT

/ihs/v1/{resource_type}/{resource_id}

OPERATOR

Delete the images and corresponding references of the image resource.

Default metadata APIs

GET

/ihs/v1/metadata/default/{imageName}

OPERATOR

Delete the images and corresponding references of the image resource

PUT

/ihs/v1/metadata/default/{imageName}

OPERATOR

Creates default image metadata by image name.

DELETE

/ihs/v1/metadata/default/{imageName}

OPERATOR

Deletes the default images and corresponding references of the image resource.

GET

/ihs/v1/metadata/default

CLIENT

Retrieve Default Image metadata. wild card not supported

POST

/ihs/v1/metadata/default

OPERATOR

Create default image metadata for a set of image resources

External client APIs

GET

/ihs/v1/external/preferred/{resourceType}/{resourceId}

CLIENT

Retrieve the image metadata for preferred image selection.

Metadata APIs

GET

/ihs/v1/metadata

OPERATOR

Retrieves the image metadata based on the provided filters.

PUT

/ihs/v1/metadata

OPERATOR

Creates image metadata for a set of image resources.

DELETE

/ihs/v1/metadata

OPERATOR

Deletes the images and corresponding references of the image resource.

Preferred image APIs

GET

/ihs/v1/metadata/preferred/{resourceType}/{resourceId}

CLIENT

Retrieve the image metadata for preferred image selection

PUT

/ihs/v1/metadata/preferred/{resourceType}/{resourceId}

OPERATOR

Update the image metadata with the preferred image selection

GET

/images/v1/image/{contentType}/{id}/{imageType}

CLIENT

Request an image.

PUT

/mas/v1/channelEvents

OPERATOR

Creates a new events using channelEvents API

PUT

/mas/v1/channelSetEvents

OPERATOR

API to create new events on multiple channels in one go

GET

/mas/v1/contentGroups

OPERATOR

Retrieves contentGroups.

PUT

/mas/v1/contentGroups

OPERATOR

Creates a new contentGroup. Unless specified, the contentGroup ID will be system generated.

DELETE

/mas/v1/contentGroups

OPERATOR

Delete specified contentGroups passed as IDs.

GET

/mas/v1/contentGroups/{contentId}

OPERATOR

Retrieves a specified contentGroup.

DELETE

/mas/v1/contentGroups/{contentId}

OPERATOR

Deletes a specified contentGroup.

GET

/mas/v1/contentGroups/export

OPERATOR

Retrieves contentGroups eligible for export.

GET

/mas/v1/contentStatus/{technicalContentId}

OPERATOR

Retreive the prcessing status of specified content

DELETE

/mas/v1/contentStatus/{technicalContentId}

OPERATOR

Delete the processing status of specified content

POST

/mas/v1/delete/editorialContents

OPERATOR

Deletes a specified editorial contents with all dependent entities (technical content, event, CPW, etc.).

POST

/mas/v1/delete/technicalContents

OPERATOR

Deletes a specified technical contents with all dependent entities.

GET

/mas/v1/editorialChannels

OPERATOR

Retrieves  editorial channels.

PUT

/mas/v1/editorialChannels

OPERATOR

Creates a new editorialChannel. Unless specified, the editorialChannel ID will be system generated.

DELETE

/mas/v1/editorialChannels

OPERATOR

Deletes editorial channels by specified IDs.

GET

/mas/v1/editorialChannels/{editorialChannelId}

OPERATOR

Retrieves a specified editorialChannel.

DELETE

/mas/v1/editorialChannels/{editorialChannelId}

OPERATOR

Deletes a specified editorialChannel.

GET

/mas/v1/editorialContents/node

OPERATOR

Retrieves eligible editorial contents based on node.

GET

/mas/v1/editorialContents

OPERATOR

Retrieves specified editorial contents based on IDs.

PUT

/mas/v1/editorialContents

OPERATOR

Creates a new editorialContent. Unless specified, the editorialContent ID will be system generated.

DELETE

/mas/v1/editorialContents

OPERATOR

Delete specified editorial contents based on IDs.

GET

/mas/v1/editorialContents/{editorialContentId}

OPERATOR

Retrieves a specified editorialContent.

DELETE

/mas/v1/editorialContents/{editorialContentId}

OPERATOR

Deletes a specified editorialContent.

GET

/mas/v1/editorialContents/export

OPERATOR

Retrieve list of exportable editorial contents

GET

/mas/v1/events

OPERATOR

Retrieves events based on spanning period.

PUT

/mas/v1/events

OPERATOR

Creates a new event. Unless specified, the event ID will be system generated.

DELETE

/mas/v1/events

OPERATOR

Deletes events based on IDs.

GET

/mas/v1/events/{eventId}

OPERATOR

Retrieves a specified event.

DELETE

/mas/v1/events/{eventId}

OPERATOR

Delete a specified event.

GET

/mas/v1/healthcheck

ADMIN

Retrieves status of all the dependent modules and gives the healthcheck for MAS.

GET

/mas/v1/ping

ADMIN

Pings MAS if it is up.

GET

/mas/v1/technicalContents

OPERATOR

Retrieves technical contents.

PUT

/mas/v1/technicalContents

OPERATOR

Creates a new technicalContent. Unless specified, the technicalContent ID will be system generated.

DELETE

/mas/v1/technicalContents

OPERATOR

Deletes technical content passed as IDs.

GET

/mas/v1/technicalContents/{technicalContentId}

OPERATOR

Retrieves a specified technicalContent.

DELETE

/mas/v1/technicalContents/{technicalContentId}

OPERATOR

Deletes a specified technicalContent.

DELETE

/mas/v1/technicalContents/{providerId}/{providerResourceId}/securityInfo

OPERATOR

Deletes security info of a technical content specified by providerId and providerResourceId.

VOD

GET

/metadata/delivery/GLOBAL/vod/nodes

CLIENT

Browse Video on Demand (VOD) catalogues.

GET

/metadata/delivery/v2/GLOBAL/vod/editorials

CLIENT

Browse Video on Demand (VOD) assets.

GET

/metadata/delivery/GLOBAL/vod/series

CLIENT

Browse Video on Demand (VOD) series.

GET

/metadata/delivery/GLOBAL/vod/products

CLIENT

Video On Demand (VOD) products.

BTV

GET

/metadata/delivery/GLOBAL/btv/services

CLIENT

Browse broadcast TV (BTV) Channels

GET

/metadata/delivery/GLOBAL/btv/programmes

CLIENT

Browse broadcast TV (BTV) Programmes - EPG

GET

/metadata/delivery/GLOBAL/btv/series

CLIENT

Browse broadcast TV (BTV) Series

GET

/metadata/delivery/GLOBAL/btv/products

CLIENT

Browse broadcast TV (BTV) Products

Search

GET

/metadata/solr/GLOBAL/search

CLIENT

Search for any kind of metadata entity

Changes

GET

/metadata/delivery/changes