REST API for Session Delivery Manager Release 8.1

All REST Endpoints

admin

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

device configuration

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

fault

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

fraud protection

Incremental update FPL list to the SDM server: Method: post
Path: /rest/{versionId}/telephonyFraud/FPLUpdate
Upload the FPL full list file to the SDM server: Method: post
Path: /rest/{versionId}/telephonyFraud/FPLFileUpload

inventory/device

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

inventory/device group

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

network function

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

network function category

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

plugin

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

security

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