Differences in REST Response - JSON Format
This chapter identifies interface changes for the REST APIs and SOAP APIs.
SDM REST API - changes in the JSON structures
Starting with the SDM 8.2.5 Release, changes have been introduced in the REST API Response payload in JSON format due to the replacment of binding libraries. The SDM 8.2.5.0.1 release provides a fix for the JSON response 404 error. This fix introduced changes in the Request and Response Payload for JSON and XML formats. These changes observed in the SDM 8.2.5 and SDM 8.2.5.01 releases have been listed in the following sections.
Use the table below to check the differences in the REST API JSON responses between pre-8.2.5 release, 8.2.5 release, and 8.2.5.0.1 release.
The following table lists REST APIs and REST endpoints from the SDM 8.2.2, SDM 8.2.5 and the SDM 8.2.5.0.1 releases as examples.
Table 12-1 Differences in REST Response - JSON Format
| Serial Number | REST APIs | REST Endpoints | SDM 8.2.2 | SDM 8.2.5 | SDM 8.2.5.0.1 | Remarks |
|---|---|---|---|---|---|---|
| 1 | Login | /rest/v1.3/admin/login | NA | NA | NA | No change |
| 2 | Logout | /rest/v1.3/admin/logout | NA | NA | NA | No change |
| 3 | Get Information on SDM Servers | /rest/v1.3/admin/serverInfo | { "clusterMembers": { "clusterMember": [ { | { "clusterMembers": [ | "{ ""clusterMembers"": [" | 8.2.2 returns the tag "clusterMember" inside of "clusterMembers". |
| 4 | Add a configuration element | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/add | { "attributes": { "attribute": [ | { "attributes": [ | { "attributes": [ | 8.2.2 returns tag "attribute" inside of "attributes". |
| 5 | Assign a Device to Element Manager for FCAPS | /rest/v1.1/configuration/devices | "type": "restManagedDevice" | "type": "restManagedDevice", | 8.2.5 does not have the "type" tag. | |
| 6 | Create a Configuration Element | /rest/v1.1/configuration/deviceConfigs/ID1/configElements/create | { "attributes": { "attribute": [ | { "attributes": [ | { "attributes": [ | 8.2.2 retruns tag "attribute" inside of "attributes" . |
| 7 | Delete a Configuration Element | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/delete | NA | NA | NA | No Change |
| 8 | Delete Pending Configuration Modifications | /rest/v1.1/configuration/deviceConfigs/ID1/configurationChanges | NA | NA | NA | No change |
| 9 | Get a Configuration Element Instance | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/retrieve | { "attributes": { "attribute": [ and "childrenElements": { "childrenElement": [ | { "attributes": [ and "childrenElements": [ | "{ ""attributes"": [ and ""childrenElements"": [" | 8.2.2 retruns tag "attribute" inside of "attributes" and "childrenElement" inside of "childrenElements". . |
| 10 | Get a List of Configuration Element Instances | /rest/v1.1/configuration/deviceConfigs/ID2/configElements | { "configElement": [ { "attributes": { "attribute": [ and "childrenElements": { "childrenElement": [ | { "configElements": [ { "attributes": [ and "childrenElements": [ | "{ ""configElements"": [ { ""attributes"": [ and ""childrenElements"": [" | "8.2.2 retruns tag ""configElement"" ""attribute"" inside of attributes ""childrenElement"" inside of ""childrenElements"": " |
| 11 | Get a List of Devices associated with Element Manager | /rest/v1.3/configuration/devices | "device" | "devices" | "devices" | No remark |
| 12 | Get a List of Top-level Configuration Element Types | /rest/v1.3/configuration/deviceConfigs/ID1/elementTypes | { "elementType": [ | "devices" | "devices" | No remark |
| 13 | Retrieve Element Metadata | /rest/v1.1/configuration/deviceConfigs/ID4/elementTypes/elementMetadata | NA | """attributeMetadatas"": [ ""subElements"": []," | """attributeMetadatas"": [ ""subElements"": []," | No remark |
| 14 | Get additional attribute Metadata | /rest/v1.3/configuration/deviceConfigs/ID2/elementTypes/attributeMetadata | "enumeratedValues": { "enumeratedValue": [ | "enumeratedValues": [ | "enumeratedValues": [ | No remark |
| 15 | Get Device Configuration Management Summary | /rest/v1.3/configuration/devices/ID1/loadConfig | "type": "restManagedDevice" | NA | "type": "restManagedDevice" | 8.2.5 does not have "type" tag. |
| 16 | Get Pending Configuration Modification | /rest/v1.3/configuration/deviceConfigs/ID1/configurationChanges | "configurationChange": | "changedConfigElements": | "changedConfigElements": | No remark |
| 17 | Load a Configuration for a Targeted Device | /rest/v1.3/configuration/devices/ID1/loadConfig | "type": "restManagedDevice" | NA | "type": "restManagedDevice" | 8.2.5 does not have "type" tag |
| 18 | Unassign a Device from Element Manager to Stop FCAPS | /rest/v1.1/configuration/devices/ID3 | NA | NA | NA | No change |
| 19 | Update a Configuration Element | /rest/v1.3/configuration/deviceConfigs/ID3/configElements/update | { "attributes": { "attribute": [ and "childrenElements": { "childrenElement": [ | { "attributes": [ and "childrenElements": [ | "{ ""attributes"": [ and ""childrenElements"": [" | 8.2.2 returns tag attribute inside of attributes and"childrenElement" inside of "childrenElements". |
| 20 | Update a Configuration Password | /rest/v1.1/configuration/devices/ID4/action | NA | NA | NA | No change |
| 21 | Update the Configuration on a Device- save and activate | /rest/v1.3/configuration/deviceConfigs/ID3/configElements/update | NA | NA | NA | No change |
| 22 | Get a List of Alarms | /rest/v1.1/fault/alarms | NA | NA | NA | No change |
| 23 | Get a List of Northbound Trap Receivers | /rest/v1.1/fault/trapReceivers | "trapReceiver" | "trapReceivers" | "trapReceivers" | No remark |
| 24 | Get Information of a Targeted Northbound Trap Reciever | /rest/v1.1/fault/trapReceivers/ID1021 | NA | NA | NA | No change |
| 25 | Initiate a Request for Synchronization of Events or Alarms | /rest/v1.1/fault/trapReceivers/ID1021/action | NA | NA | NA | No change |
| 26 | Get Device Information | /rest/v1.2/inventory/deviceMgmt/devices/ID3 | "groupParameters": { "groupParameter": [ | "groupParameters": [ | "groupParameters": [ | 8.2.2 retruns tag "groupParameter" inside of "groupParameters" |
| 27 | Get Device License Information | /rest/v1.2/inventory/deviceMgmt/devices/capabilities/entitlements | NA | NA | NA | No change |
| 28 | Get Device Management Summary Information | /rest/v1.3/inventory/deviceMgmt/devices | "device" | "devices" | "devices" | No remark |
| 29 | Lock or Unlock a Device | /rest/v1.3/inventory/deviceMgmt/devices/ID4/action | NA | NA | NA | No change |
| 30 | Add a Device Group | /rest/v1.2/inventory/deviceMgmt/deviceGroups | NA | NA | NA | No change |
| 31 | Delete a Device Group | /rest/v1.1/inventory/deviceMgmt/deviceGroups/ID3 | NA | NA | NA | No change |
| 32 | Get Device Group Information | /rest/v1.2/inventory/deviceMgmt/deviceGroups/ID1 | NA | NA | NA | No change |
| 33 | Get Existing Device Groups | /rest/v1.3/inventory/deviceMgmt/deviceGroups | "deviceGroup" | "deviceGroups" | "deviceGroups" | No remark |
| 34 | Update a Device Group | /rest/v1.1/inventory/deviceMgmt/deviceGroups/ID7 | NA | NA | NA | No change |
| 35 | Add an NF | /rest/v1.1/inventory/nfMgmt/nfs | { "groups": { "group": [ | { "children": [ | "{ ""children"": [" | No remark |
| 36 | Delete an NF | /rest/v1.1/inventory/nfMgmt/nfs/ID3 | NA | NA | NA | No change |
| 37 | Get a Targeted NF | /rest/v1.1/inventory/nfMgmt/nfs/ID3 | { "groups": { "group": [ | { "children": [ | "{ ""children"": [" | No remark |
| 38 | Get Information on an NF Group | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID7 | "parameters": { "parameter": [ | "parameters": [ | "parameters": [ | No remark |
| 39 | Get List of NFs in Device Management | /rest/v1.1/inventory/nfMgmt/nfs | "nf" | "nfList" | "nfList" | No remark |
| 40 | Get NF Device Groups | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups | "deviceGroup" | "deviceGroups" | "deviceGroups" | No remark |
| 41 | Lock or Unlock a Devices | /rest/v1.3/inventory/deviceMgmt/devices/ID4/action | NA | NA | NA | No change |
| 42 | Move an NF to Another Device Group Parent | /rest/v1.1/inventory/nfMgmt/nfs/ID5 | NA | NA | NA | No change |
| 43 | Submit a Request to Resynchronize an NF | /rest/v1.1/inventory/nfMgmt/nfs/ID7/action | NA | NA | NA | No change |
| 44 | Update NF Information | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID7 | "parameters": { "parameter": [ | "parameters": [ | "parameters": [ | No remark |
| 45 | Get a Targeted category | /rest/v1.3/inventory/nfMgmt/nfCategories/ID1 | "nfTypes": { "nfType": [ | "nfTypes": [ | " ""nfTypes"": [ " | No remark |
| 46 | Get Additional Category Metadata | /rest/v1.1/inventory/nfMgmt/nfCategories/ID1/nfTypes/Device%20Cluster | "parameters": { "parameter": [ | "nfTypes" | "nfTypes" | No remark |
| 47 | Get Additional NF Metadata | /rest/v1.1/inventory/nfMgmt/nfCategories/ID1/nfTypes | "nfType" | "parameters": [ | "parameters": [ | No remark |
| 48 | Get NF Supported product Categories | /rest/v1.1/inventory/nfMgmt/nfCategories | "nfCategory" | "nfCategories" | "nfCategories" | No remark |
| 49 | Get All Plug-ins | /rest/v1.3/admin/plugins/ | "pluginInfo" | "pluginInfos" | "pluginInfos" | No remark |
| 50 | Get Plug-in Information | /rest/v1.1/admin/plugins/ID1 | "pluginClusterMembers": { "pluginClusterMember": [ | "clusterMembers": [ | "clusterMembers": [ | No remark |
| 51 | Perform a Plug-in Action | /rest/v1.3/admin/plugins/ID2/action | NA | NA | NA | No change |
| 52 | Remove a Plug-in | /rest/v1.1/admin/plugins/ID1 | NA | NA | NA | No change |
| 53 | Update Plug-in Information | /rest/v1.1/admin/plugins/ID1 | "pluginClusterMembers": { "pluginClusterMember": [ | "clusterMembers": [ | "clusterMembers": [ | No remark |
| 54 | Upload a Plug-in | /rest/v1.1/admin/plugins/?file= | "pluginClusterMembers": { "pluginClusterMember": [ | "clusterMembers": [ | "clusterMembers": [ | No remark |
| 55 | Add a route to routeSet | /rest/v1.3/routeSets/1/entries | NA | "description", "format", "priority", "weight" | "description", "format", "priority", "weight" | "description", "format", "priority", "weight" tags not present in 8.2.2. |
| 56 | Add an associated device to a route set | /rest/v1.3/routeSets/1/devices | NA | NA | NA | No change |
| 57 | Commit/Rollback/Cancel a route set update | /rest/v1.3/routeSets/routeUpdates/ID3/action | NA | NA | NA | No change |
| 58 | Create a new route set | /rest/v1.3/routeSets | NA | NA | NA | No change |
| 59 | Delete a particular Route Set by Id | /rest/v1.3/routeSets/2 | NA | NA | NA | No change |
| 60 | Delete associated device from specified route set | /rest/v1.3/routeSets/1/devices/ID7 | NA | NA | NA | No change |
| 61 | Delete Route Entry by ID | /rest/v1.3/routeSets/1/entries/ID1 | NA | NA | NA | No change |
| 62 | Execute some action on CSV file import | /rest/v1.3/routeSets/2/importFile | NA | NA | NA | No change |
| 63 | Execute user action on Add route set task | /rest/v1.3/routeSets/tasks/30/action | NA | NA | NA | No change |
| 64 | GET all associated device from a particular route set | /rest/v1.3/routeSets/1/devices | "associatedDevice" | "assocDevices" | "assocDevices" | No remark |
| 65 | Get All Existing Route sets | /rest/v1.3/routeSets | "routeSet" | "routeSets" | "routeSets" | No remark |
| 66 | Get ALL or subset of route entries from a particular route set | /rest/v1.3/routeSets | "routeSet" | "routeSets" | "routeSets" | No remark |
| 67 | Get all route updates on devices | /rest/v1.3/routeSets/routeUpdates | "routeUpdateTask" | "routeUpdateTaskList" | "routeUpdateTaskList" | No remark |
| 68 | Get Route Entry by ID | /rest/v1.3/routeSets/1/entries/ID1 | NA | "description", "format", "priority", "weight" | "description", "format", "priority", "weight" | "description", "format", "priority", "weight" tags not present in 822. |
| 69 | Get Route Sets by specifying a Route Set Id | /rest/v1.3/routeSets/1 | NA | NA | NA | No change |
| 70 | Get status of add route set task by restoring LRT from device | /rest/v1.3/routeSets/tasks/6?addMode=upload | NA | NA | NA | No change |
| 71 | Get status of update task by task id | /rest/v1.3/routeSets/routeUpdates/ID7 | "updateDeviceStatusList": { "updateDeviceStatus": [ | "deviceStatusList": [ | "deviceStatusList": [ | No remark |
| 72 | Get the list of templates on SDM Server | /rest/v1.3/routeSets/importTemplates | "importTemplate" | "importTemplates" | "importTemplates" | No remark |
| 73 | Get the status of the file import task | /rest/v1.3/routeSets/2/importFile/85 | "errorList": { "error": [ | "errorList": [ | "errorList": [ | No remark |
| 74 | Import a CSV File in to route Set | /rest/v1.3/routeSets/2/importFile | NA | NA | NA | No change |
| 75 | Modify a particular route set | /rest/v1.3/routeSets/1 | NA | NA | NA | No change |
| 76 | Modify Route Entry by Id | /rest/v1.3/routeSets/1/entries/ID1 | NA | "description", "format", "priority", "weight", "preference" | "description", "format", "priority", "weight", "preference" | "description", "format", "priority", "weight", "preference" tags not present in 8.2.2. |
| 77 | POST to Lock/Unlock/OverrideLock a RouteSet | /rest/v1.3/routeSets/1/action | NA | NA | NA | No change |
| 78 | Update all associated SBC devices with specified route sets | /rest/v1.3/routeSets/devices/action | NA | NA | NA | No change |
| 79 | Update specified SBC devices with specified route set | /rest/v1.3/routeSets/1/devices/action | NA | NA | NA | No change |
| 80 | Get User Account Information | /rest/v1.1/security/accountMgmt | NA | NA | NA | No change |
| 81 | Get User Information | /rest/v1.1/security/users/ID11 | NA | NA | NA | No change |
| 82 | Get Users | /rest/v1.1/security/users | "user" | "users" | "users" | No remark |
| 83 | Deregister key performance indicators (KPIs) for devices | /rest/v1.1/performance/devices/kpis?devices=ID7 | NA | NA | NA | No change |
| 84 | Display a list of device information that supports performance | /rest/v1.2/performance/devices | "device" | "devices" | "devices" | No remark |
| 85 | Display the supported KPIs | /rest/v1.1/performance/devices/kpis?pluginKey=Oracle-SessionDelivery-AcmeSD&componentType=DUMMY_SAMPLE&platform=3800&softwareVersion=SCX621m2p5 | NA | NA | NA | No change |
| 86 | Register KPIs for devices | /rest/v1.3/performance/devices/kpis | NA | NA | NA | No change |
| 87 | Retrieve KPI statistics for devices | /rest/v1.3/performance/devices/kpis/stats | NA | NA | NA | No change |
| 88 | Update registered KPIs for devices | /rest/v1.1/performance/devices/kpis | NA | NA | NA | No change |