Differences in REST Response - XML Format
Use the table below to check the differences in the REST API XML response between the SDM 9.0.0 release and 9.0.1 and later releases.
Here is the list of REST APIs from the SDM 9.0.0 and SDM 9.0.1 and later
releases listed as examples.
Table 11-3 Differences in REST Response - XML Format
| Serial Number | REST APIs | URL Examples | SDM 9.0.0 | SDM 9.0.1 and Later Releases | Remarks |
|---|---|---|---|---|---|
| 1 | Login | /rest/v1.3/admin/login | NA | NA | No change |
| 2 | Logout | /rest/v1.3/admin/logout | NA | NA | No change |
| 3 | Get Information on SDM Servers | /rest/v1.3/admin/serverInfo | "<serverInfo> <clusterMembers> <clusterMember> <downTime>NA</downTime>" | "<serverInfo> <clusterMembers> <downTime>NA</downTime>" | 9.0.0 has "clusterMember" inside of "clusterMembers" but 9.0.1 and later releases only have "clusterMembers" |
| 4 | Add a configuration element | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/add | "<configElement> <attributes> <attribute> <childrenElements> <childrenElement> <attributes> <attribute>" | "<configElement> <attributes> <childrenElements> <attributes>" | "9.0.0 has <attribute> inside of <attributes>. 9.0.1 and later releases have only <attributes>. Similarly for childrenElements tag as well." |
| 5 | Assign a Device to Element Manager for FCAPS | /rest/v1.1/configuration/devices | NA | NA | No changes |
| 6 | Create a Configuration Element | /rest/v1.1/configuration/deviceConfigs/ID1/configElements/create | "<configElement> <attributes> <attribute>" | "<configElement> <attributes>" | 9.0.0 has an <attribute> inside of <attributes>. 9.0.1 and later releases have only <attributes>. |
| 7 | Delete a Configuration Element | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/delete | NA | NA | No changes |
| 8 | Delete Pending Configuration Modifications | /rest/v1.1/configuration/deviceConfigs/ID1/configurationChanges | NA | NA | No changes |
| 9 | Get a Configuration Element Instance | /rest/v1.3/configuration/deviceConfigs/ID1/configElements/retrieve | "<configElement> <attributes> <attribute> <childrenElements> <childrenElement> <attributes> <attribute>" | "<configElement> <attributes> <childrenElements> <attributes>" | "9.0.0 has <attribute> inside of <attributes>. 9.0.1 and later releases have only <attributes>. Similarly for childrenElements tag as well." |
| 10 | Get a List of Configuration Element Instances | /rest/v1.1/configuration/deviceConfigs/ID2/configElements | "<configElements> <configElement> <attributes> <attribute>" | "<configElements> <configElements> <attributes>" | No remarks |
| 11 | Get a List of Devices associated with Element Manager | /rest/v1.3/configuration/devices | "<devices> <device>" | "<devices> <devices>" | No remarks |
| 12 | Get a List of Top-level Configuration Element Types | /rest/v1.3/configuration/deviceConfigs/ID1/elementTypes | "<elementTypes> <elementType>" | "<elementTypes> <types>" | No remarks |
| 13 | Get additional Element Metadata | /rest/v1.1/configuration/deviceConfigs/ID1/elementTypes/elementMetadata | "<elementMetadata> <attributeMetadatas> <attributeMetadata>" | "<elementMetadata> <attributeMetadatas>" | No remarks |
| 14 | Get additional attribute Metadata | /rest/v1.3/configuration/deviceConfigs/ID2/elementTypes/attributeMetadata | "<enumeratedValues> <enumeratedValue>deny</enumeratedValue> <enumeratedValue>permit</enumeratedValue> </enumeratedValues>" | " <enumeratedValues>deny</enumeratedValues> <enumeratedValues>permit</enumeratedValues>" | No remarks |
| 15 | Get Device Configuration Management Summary | /rest/v1.3/configuration/devices/ID1/loadConfig | NA | NA | No changes |
| 16 | Get Pending Configuration Modification | "<configurationChanges> <configurationChange>" | "<configurationChanges> <changedConfigElements>" | "<configurationChanges> <changedConfigElements>" | 9.0.0 has subtag <configurationChange>, 9.0.1 and later releases have subtag <changedConfigElements> |
| 17 | Load a Configuration for a Targeted Device | /rest/v1.3/configuration/devices/ID1/loadConfig | NA | NA | No changes |
| 18 | Unassign a Device from Element Manager to Stop FCAPS | /rest/v1.1/configuration/devices/ID3 | NA | NA | No changes |
| 19 | Update a Configuration Element | /rest/v1.3/configuration/deviceConfigs/ID3/configElements/update | "<configElement> <attributes> <attribute> <childrenElements> <childrenElement> <attributes> <attribute>" | "<configElement> <attributes> <childrenElements> <attributes>" | "9.0.0 has <attribute> inside of <attributes>. 9.0.1 and later releases have only <attributes>. Similarly for childrenElements tag as well." |
| 20 | Update a Configuration Password | /rest/v1.3/configuration/deviceConfigs/ID3/util/encryptPassword | NA | NA | No changes |
| 21 | Update the Configuration on a Device | /rest/v1.3/configuration/deviceConfigs/ID3/configElements/update | "<configElement> <attributes> <attribute> <childrenElements> <childrenElement> <attributes> <attribute>" | "<configElement> <attributes> <childrenElements> <attributes>" | "9.0.0 has <attribute> inside of <attributes>. 9.0.1 and later releases have only <attributes>. Similarly for childrenElements tag as well." |
| 22 | Get a List of Alarms | /rest/v1.1/fault/alarms | NA | NA | No changes |
| 23 | Get a List of Northbound Trap Receivers | /rest/v1.1/fault/trapReceivers | <trapReceivers> <trapReceiver> | "<trapReceivers> <trapReceivers>" | 9.0.0 has subtag <trapReciever>, but 9.0.1 and later releases have it as <trapRecievers> |
| 24 | Get Information of a Targeted Northbound Trap Reciever | /rest/v1.1/fault/trapReceivers/ID1021 | NA | NA | No changes |
| 25 | Initiate a Request for Synchronization of Events or Alarms | /rest/v1.1/fault/trapReceivers/ID1021/action | NA | NA | No changes |
| 26 | Get Device Information | /rest/v1.2/inventory/deviceMgmt/devices/ID3 | <groupParameters> <groupParameter> | <groupParameters> | 9.0.0 has <groupParameter> subtag, 9.0.1 and later releases have <groupParameters> |
| 27 | Get Device License Information | /rest/v1.2/inventory/deviceMgmt/devices/capabilities/entitlements | NA | NA | No changes |
| 28 | Get Device Management Summary Information | /rest/v1.3/inventory/deviceMgmt/devices | "<devices> <device>" | "<devices> <devices>" | 9.0.0 has subtag <device>, but 9.0.1 and later releases have it as <devices> |
| 29 | Lock or Unlock a Device | /rest/v1.3/inventory/deviceMgmt/devices/ID4/action | NA | NA | No changes |
| 30 | Add a Device Group | /rest/v1.2/inventory/deviceMgmt/deviceGroups | NA | NA | No changes |
| 31 | Delete a Device Group | /rest/v1.1/inventory/deviceMgmt/deviceGroups/ID3 | NA | NA | No changes |
| 32 | Get Device Group Information | /rest/v1.2/inventory/deviceMgmt/deviceGroups/ID1 | NA | NA | No changes |
| 33 | Get Existing Device Groups | /rest/v1.3/inventory/deviceMgmt/deviceGroups | "<deviceGroups> <deviceGroup>" | "<deviceGroups> <deviceGroups>" | 9.0.0 has subtag <deviceGroup>, but 9.0.1 and later releases have it as <deviceGroups> |
| 34 | Update a Device Group | /rest/v1.1/inventory/deviceMgmt/deviceGroups/ID7 | NA | NA | No change |
| 35 | Add an NF | /rest/v1.1/inventory/nfMgmt/nfs | "<nf> <groups> <group>" | "<nf> <children>" | 9.0.0 has <groups> and <group>, 9.0.1 and later releases have the <children> tag. |
| 36 | Delete an NF | /rest/v1.1/inventory/nfMgmt/nfs/ID3 | NA | NA | No changes |
| 37 | Get a Targeted NF | /rest/v1.1/inventory/nfMgmt/nfs/ID3 | "<nf> <groups> <group>" | "<nf> <children>" | 9.0.0 has <groups> and <group>, 9.0.1 and later releases have <children> tag. |
| 38 | Get Information on an NF Group | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID7 | " <parameters> <parameter>" | <parameters> | 9.0.0 has <parameters> and <parameter>, 9.0.1 and later releases have <parameters>. |
| 39 | Get List of NFs in Device Management | /rest/v1.1/inventory/nfMgmt/nfs | "<deviceGroups> <deviceGroup> <parameters> <parameter>" | "<nfs> <nfList>" | Different tags in both. 9.0.0 has parameters and paramter as well. |
| 40 | Submit a Request to Resynchronize an NF | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups | " <parameters> <parameter>" | <parameters> | 9.0.0 has <parameters> and <parameter>, 9.0.1 and later releases have <parameters>. |
| 41 | Lock or Unlock a Devices | /rest/v1.3/inventory/deviceMgmt/devices/ID4/action | NA | NA | No changes |
| 42 | Move an NF to Another Device Group Parent | /rest/v1.1/inventory/nfMgmt/nfs/ID5 | NA | NA | No changes |
| 43 | Submit a Request to Resynchronize an NF | /rest/v1.1/inventory/nfMgmt/nfs/ID7/action | NA | NA | No changes |
| 44 | Update NF Information | /rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID7 | " <parameters> <parameter>" | <parameters> | 9.0.0 has <parameters> and <parameter>, 9.0.1 and later releases have <parameters>. |
| 45 | Get a Targeted category | /rest/v1.3/inventory/nfMgmt/nfCategories/ID1 | " <nfTypes> <nfType>" | <nfTypes> | 9.0.0 has <nfTypes> and <nfType>, 9.0.1 and later releases have <nfTypes>. |
| 46 | Get Additional Category Metadata | /rest/v1.1/inventory/nfMgmt/nfCategories/ID1/nfTypes/Device%20Cluster | " <nfCategory> <parameters> <parameter>" | " <category> <parameters>" | "9.0.0 has <nfCategory>, 9.0.1 and later releases have <category>. 9.0.0 has <parameters> and <parameter>, 9.0.1 and later releases have <parameters>." |
| 47 | Get Additional NF Metadata | /rest/v1.1/inventory/nfMgmt/nfCategories/ID1/nfTypes | "<nfTypes> <nfType>" | "<nfTypes> <nfTypes>" | 9.0.0 has <nfTypes> and <nfType>, 9.0.1 and later releases have 2 <nfTypes>. |
| 48 | Get NF Supported product Categories | /rest/v1.1/inventory/nfMgmt/nfCategories | "<nfCategories> <nfCategory>" | "<nfCategories> <nfCategories>" | 9.0.0 has <nfCategories> and <nfCategory>, 9.0.1 and later releases have 2 <nfCategories> tags. |
| 49 | Get All Plug-ins | /rest/v1.3/admin/plugins/ | " <pluginInfo> <pluginClusterMembers> <pluginClusterMember>" | "<pluginInfos> <clusterMembers>" | "9.0.0 has <pluginInfos> and <pluginInfo>, 9.0.1 and later releases have 2 <pluginInfos> tags. Also subtags in 9.0.0 are 2 <pluginClusterMembers> and <pluginClusterMember>, 9.0.1 and later releases have only <clusterMembers>" |
| 50 | Get Plug-in Information | /rest/v1.1/admin/plugins/ID1 | "<pluginInfo> <pluginClusterMembers> <pluginClusterMember>" | "<pluginInfo> <clusterMembers>" | "Subtags in 9.0.0 are 2 <pluginClusterMembers> and <pluginClusterMember>, 9.0.1 and later releases have only <clusterMembers>" |
| 51 | Perform a Plug-in Action | /rest/v1.3/admin/plugins/ID2/action | NA | NA | No changes |
| 52 | Remove a Plug-in | /rest/v1.1/admin/plugins/ID1 | NA | NA | No changes |
| 53 | Update Plug-in Information | /rest/v1.1/admin/plugins/ID1 | "<pluginInfo> <pluginClusterMembers> <pluginClusterMember>" | "<pluginInfo> <clusterMembers>" | "Subtags in 9.0.0 are 2 <pluginClusterMembers> and <pluginClusterMember>, 9.0.1 and later releases have only <clusterMembers>" |
| 54 | Upload a Plug-in | /rest/v1.1/admin/plugins/?file= | "<pluginInfo> <pluginClusterMembers> <pluginClusterMember>" | "<pluginInfo> <clusterMembers>" | "Subtags in 9.0.0 are 2 <pluginClusterMembers> and <pluginClusterMember>, 9.0.1 and later releases have only <clusterMembers>" |
| 55 | Add a route to routeSet | /rest/v1.3/routeSets/1/entries | NA | NA | No changes |
| 56 | Add an associated device to a route set | /rest/v1.3/routeSets/1/devices | NA | NA | No changes |
| 57 | Commit/Rollback/Cancel a route set update | /rest/v1.3/routeSets/routeUpdates/ID3/action | NA | NA | No changes |
| 58 | Create a new route set | /rest/v1.3/routeSets | NA | NA | No changes |
| 59 | Delete a particular Route Set by Id | /rest/v1.3/routeSets/2 | NA | NA | No changes |
| 60 | Delete associated device from specified route set | /rest/v1.3/routeSets/1/devices/ID7 | NA | NA | No changes |
| 61 | Delete Route Entry by ID | /rest/v1.3/routeSets/1/entries/ID1 | NA | NA | No changes |
| 62 | Execute some action on CSV file import | /rest/v1.3/routeSets/2/importFile | NA | NA | No changes |
| 63 | Execute user action on Add route set task | /rest/v1.3/routeSets/tasks/30/action | NA | NA | No changes |
| 64 | GET all associated device from a particular route set | /rest/v1.3/routeSets/1/devices | "<associatedDevices> <associatedDevice>" | "<associatedDevices> <assocDevices>" | 9.0.0 has <associatedDevice> subtag, while 9.0.1 and later releases have <assocDevices> subtag. |
| 65 | Get All Existing Route sets | /rest/v1.3/routeSets | <routeSet> | <routeSets> | 9.0.0 has <routeSet> subtag, while 9.0.1 and later releases have <routeSets> subtag. |
| 66 | Get ALL or subset of route entries from a particular route set | /rest/v1.3/routeSets/1/entries | NA | NA | No changes |
| 67 | Get all route updates on devices | /rest/v1.3/routeSets/routeUpdates | "<routeUpdateTasks> <routeUpdateTask>" | "<routeUpdateTasks> <routeUpdateTaskList>" | 9.0.0 has <routeUpdateTask> subtag, while 9.0.1 and later releases have <routeUpdateTaskList> subtag. |
| 68 | Get Route Entry by ID | /rest/v1.3/routeSets/1/entries/ID1 | NA | NA | No changes |
| 69 | Get Route Sets by specifying a Route Set Id | /rest/v1.3/routeSets/1 | NA | NA | No changes |
| 70 | Get status of add route set task by restoring LRT from device | /rest/v1.3/routeSets/tasks/6?addMode=upload | NA | NA | No changes |
| 71 | Get status of update task by task id | /rest/v1.3/routeSets/routeUpdates/ID5 | "<routeUpdateTaskDetails> <updateDeviceStatusList> <updateDeviceStatus>" | "<routeUpdateTaskDetails> <deviceStatusList>" | "9.0.0 has <updateDeviceStatusList> and subtag <updateDeviceStatus>, while 9.0.1 and later releases have only <deviceStatusList> subtag." |
| 72 | Get the list of templates on SDM Server | /rest/v1.3/routeSets/importTemplates | "<importTemplates> <importTemplate>" | "<importTemplates> <importTemplates>" | 9.0.0 has <importTemplate> subtag, while 9.0.1 and later releases have <importTemplates> subtag. |
| 73 | Get the status of the file import task | /rest/v1.3/routeSets/2/importFile/85 | <errorList/> | NA | Extra line <errorList/> coming in 9.0.0 response. |
| 74 | Import a CSV File in to route Set | /rest/v1.3/routeSets/2/importFile | NA | NA | No changes |
| 75 | Modify a particular route set | /rest/v1.3/routeSets/1 | NA | NA | No changes |
| 76 | Modify Route Entry by Id | /rest/v1.3/routeSets/1/entries/ID1 | NA | NA | No changes |
| 77 | POST to Lock/Unlock/OverrideLock a RouteSet | /rest/v1.3/routeSets/1/action | NA | NA | No changes |
| 78 | Update all associated SBC devices with specified route sets | /rest/v1.3/routeSets/devices/action | NA | NA | No changes |
| 79 | Update specified SBC devices with specified route set | /rest/v1.3/routeSets/1/devices/action | NA | NA | No changes |
| 80 | Get User Account Information | /rest/v1.1/security/accountMgmt | NA | NA | No changes |
| 81 | Get User Information | /rest/v1.1/security/users/ID11 | NA | NA | No changes |
| 82 | Get Users | /rest/v1.1/security/users | <user> | <users> | 9.0.0 has main tag as <users> and subtag as <user>, 9.0.1 and later releases have both tags as <users>. |
| 83 | Deregister key performance indicators (KPIs) for devices | /rest/v1.1/performance/devices/kpis?devices=ID2 | NA | NA | No changes |
| 84 | Display a list of device information that supports performance | /rest/v1.2/performance/devices | "<devices> <device>" | "<devices> <devices>" | 9.0.0 has subtag <device>, but 9.0.1 and later releases have it as <devices> |
| 85 | Display the supported KPIs | /rest/v1.1/performance/devices/kpis?pluginKey=Oracle-SessionDelivery-AcmeSD&componentType=DUMMY_SAMPLE&platform=4500&softwareVersion=SCZ900 | NA | NA | No changes |
| 86 | Register KPIs for devices | /rest/v1.3/performance/devices/kpis | NA | NA | No changes |
| 87 | Retrieve KPI statistics for devices | /rest/v1.3/performance/devices/kpis/stats | NA | NA | No changes |
| 88 | Update registered KPIs for devices | /rest/v1.1/performance/devices/kpis | NA | NA | No changes |