REST API for Session Delivery Manager Release 8.2

All REST Endpoints

admin

administration APIs

Get Information on SDM Servers: Method: get
Path: /{versionId}/admin/serverInfo
Login: Method: post
Path: /{versionId}/admin/login
Logout: Method: post
Path: /{versionId}/admin/logout

device configuration

device configuration APIs

Add a configuration element: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements/add
Assign a Device to Element Manager for FCAPS Management: Method: post
Path: /{versionId}/configuration/devices
Create a Configuration Element: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements/create
Delete a Configuration Element: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements/delete
Delete Pending Configuration Modifications: Method: delete
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configurationChanges
Get a Configuration Element Instance: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements/retrieve
Get a List of Configuration Element Instances: Method: get
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements
Get a List of Devices Associated with Element Manager: Method: get
Path: /{versionId}/configuration/devices
Get a List of Top-level Configuration Element Types: Method: get
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes
Get Additional Attribute Metadata: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes/attributeMetadata
Get Additional Element Metadata: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata
Get Device Configuration Management Summary Information: Method: get
Path: /{versionId}/configuration/devices/{deviceId}
Get Pending Configuration Modifications: Method: get
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configurationChanges
Load a Configuration for a Targeted Device: Method: get
Path: /{versionId}/configuration/devices/{deviceId}/loadConfig
Unassign a Device from Element Manager to Stop FCAPS Management: Method: delete
Path: /{versionId}/configuration/devices/{deviceId}
Update a Configuration Element: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/configElements/update
Update a Configuration Password: Method: post
Path: /{versionId}/configuration/deviceConfigs/{deviceId}/util/encryptPassword
Update the Configuration on a Device: Method: post
Path: /{versionId}/configuration/devices/{deviceId}/action

fault

/fault

Get a List of Alarms: Method: get
Path: /{versionId}/fault/alarms
Get a List of Northbound Trap Receivers: Method: get
Path: /{versionId}/fault/trapReceivers
Get Information of a Targeted Northbound Trap Receiver: Method: get
Path: /{versionId}/fault/trapReceivers/{trapReceiverId}
Initiate a Request for Synchronization of Events or Alarms: Method: post
Path: /{versionId}/fault/trapReceivers/{trapReceiverId}/action

fraud protection

Fraud protection APIs

Send FPL incremental updates from the FDP to the OCSDM Server: Method: post
Path: /{versionId}/telephonyFraud/FPLUpdate
Upload a Fraud Protection List File to the OCSDM Server: Method: post
Path: /{versionId}/telephonyFraud/FPLFileUpload

inventory/device

inventory device APIs

Get Device Information: Method: get
Path: /{versionId}/inventory/deviceMgmt/devices/{deviceId}
Get Device License Information: Method: get
Path: /{versionId}/inventory/deviceMgmt/devices/capabilities/entitlements
Get Device Management Summary Information: Method: get
Path: /{versionId}/inventory/deviceMgmt/devices
Lock or Unlock a Device: Method: post
Path: /{versionId}/inventory/deviceMgmt/devices/{deviceId}/action

inventory/device group

Device group APIs.

Add a Device Group: Method: post
Path: /{versionId}/inventory/deviceMgmt/deviceGroups
Delete a Device Group: Method: delete
Path: /{versionId}/inventory/deviceMgmt/deviceGroups/{groupId}
Get Device Group Information: Method: get
Path: /{versionId}/inventory/deviceMgmt/deviceGroups/{groupId}
Get Existing Device Groups: Method: get
Path: /{versionId}/inventory/deviceMgmt/deviceGroups
Update a Device Group: Method: put
Path: /{versionId}/inventory/deviceMgmt/deviceGroups/{groupId}

network function

Network function APIs

Add an NF: Method: post
Path: /{versionId}/inventory/nfMgmt/nfs
Delete an NF: Method: delete
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}
Get a Targeted NF: Method: get
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}
Get Information on an NF Group: Method: get
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}
Get List of NFs in Device Management: Method: get
Path: /{versionId}/inventory/nfMgmt/nfs
Get NF Device Groups: Method: get
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}/groups
Lock or Unlock Devices: Method: post
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}/action
Move an NF to Another Device Group Parent: Method: put
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}
Submit a Request to Resynchronize an NF: Method: post
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}/action
Update NF Information: Method: put
Path: /{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}

network function category

administration APIs

Get a Targeted Category: Method: get
Path: /{versionId}/inventory/nfMgmt/nfCategories/{nfCategoryId}
Get Additional Category Metadata: Method: get
Path: /{versionId}/inventory/nfMgmt/nfCategories/{nfCategoryId}/nfTypes
Get Additional NF Metadata: Method: get
Path: /{versionId}/inventory/nfMgmt/nfCategories/{nfCategoryId}/nfTypes/{nfTypeName}
Get NF Supported product Categories: Method: get
Path: /{versionId}/inventory/nfMgmt/nfCategories

performance

Performance APIs

Deregister key performance indicators (KPIs) for devices: Method: delete
Path: /{versionId}/performance/devices/kpis
Display a list of device information that supports performance: Method: get
Path: /{versionId}/performance/devices
Display the supported KPIs: Method: get
Path: /{versionId}/performance/devices/kpis
Register KPIs for devices: Method: post
Path: /{versionId}/performance/devices/kpis
Retrieve KPI statistics for devices: Method: post
Path: /{versionId}/performance/devices/kpis/stats
Update registered KPIs for devices: Method: put
Path: /{versionId}/performance/devices/kpis

plugin

plugin APIs

Get All Plug-ins: Method: get
Path: /{versionId}/admin/plugins
Get Plug-in Information: Method: get
Path: /{versionId}/admin/plugins/{pluginId}
Perform a Plug-in Action: Method: post
Path: /{versionId}/admin/plugins/{pluginId}/action
Remove a Plug-in: Method: delete
Path: /{versionId}/admin/plugins/{pluginId}
Update Plug-in Information: Method: put
Path: /{versionId}/admin/plugins/{pluginId}
Upload a Plug-in: Method: post
Path: /{versionId}/admin/plugins

route sets management

Route sets management APIs.

Add a route to routeSet.: Method: post
Path: /{versionId}/routeSets/{routeSetId}/entries
Add an associated device to a route set: Method: post
Path: /{versionId}/routeSets/{routeSetId}/devices
Commit/Rollback/Cancel a route set update.: Method: post
Path: /{versionId}/routeSets/routeUpdates/{taskId}/action
Create a new route Set: Method: post
Path: /{versionId}/routeSets
Delete a particular Route Set by Id: Method: delete
Path: /{versionId}/routeSets/{routeSetId}
Delete associated device from specified route set: Method: delete
Path: /{versionId}/routeSets/{routeSetId}/devices/{deviceGroupId}
Delete Route Entry by ID: Method: delete
Path: /{versionId}/routeSets/{routeSetId}/entries/{entryId}
Execute some action on CSV file import: Method: post
Path: /{versionId}/routeSets/{routeSetId}/importFile/{taskId}/action
Execute user action on Add route set task.: Method: post
Path: /{versionId}/routeSets/tasks/{taskId}/action
GET all associated device from a perticular route set: Method: get
Path: /{versionId}/routeSets/{routeSetId}/devices
Get All Existing Route Sets: Method: get
Path: /{versionId}/routeSets
Get All or subset of route entries from a perticular routeset: Method: get
Path: /{versionId}/routeSets/{routeSetId}/entries
GET all route updates on devices.: Method: get
Path: /{versionId}/routeSets/routeUpdates
Get Route Entry by ID: Method: get
Path: /{versionId}/routeSets/{routeSetId}/entries/{entryId}
Get Route Sets by specifying a Route Set Id.: Method: get
Path: /{versionId}/routeSets/{routeSetId}
GET status of add route set task by restoring LRT from device.: Method: get
Path: /{versionId}/routeSets/tasks/{taskId}
Get status of update task by task id: Method: get
Path: /{versionId}/routeSets/routeUpdates/{taskId}
GET the list of templates on the SDM Server: Method: get
Path: /{versionId}/routeSets/importTemplates
Get the status of the file import task: Method: get
Path: /{versionId}/routeSets/{routeSetId}/importFile/{taskId}
Import a CSV File in to route Set: Method: post
Path: /{versionId}/routeSets/{routeSetId}/importFile
Modify a perticular RouteSet: Method: put
Path: /{versionId}/routeSets/{routeSetId}
Modify Route Entry by Id: Method: put
Path: /{versionId}/routeSets/{routeSetId}/entries/{entryId}
POST to Lock/Unlock/OverrideLock a RouteSet: Method: post
Path: /{versionId}/routeSets/{routeSetId}/action
Update all associated SBC devices with specified route sets.: Method: post
Path: /{versionId}/routeSets/devices/action
Update specified SBC devices with specified route set: Method: post
Path: /{versionId}/routeSets/{routeSetId}/devices/action

security

/security

Get User Account Information: Method: get
Path: /{versionId}/security/accountMgmt
Get User Information: Method: get
Path: /{versionId}/security/users/{userId}
Get Users: Method: get
Path: /{versionId}/security/users