Api Change Log

Application Versions⇑

Changes between 24.12.0 to 25.6.0

What's New⇑

1. POST/oamTemplateService/modifyOAMTemplateJson modifyOAMTemplateJson
2. POST/oamTemplateService/createOAMTemplateJson createOAMTemplate
3. POST/esmService/topoService/convertRoleToShared Convert non shared erp to shared erp
4. POST/esmService/bandwidth/computeBandwidth Compute ESM Bandwidth
5. POST/esmBrowser/topoMCLAGTemplate/publishMCLAGTemplateJson publishMCLAGTemplate
6. POST/esmBrowser/topoMCLAGTemplate/modifyMCLAGTemplateJson modifyMCLAGTemplate
7. POST/esmBrowser/topoMCLAGTemplate/deleteMCLAGTemplateJson deleteMCLAGTemplate
8. POST/esmBrowser/topoMCLAGTemplate/createMCLAGTemplateJson createMCLAGTemplate
9. POST/data/esmBrowser/topoLAGTemplate/modifyLAGTemplateJson modifyLAGTemplateJson
10. POST/esmBrowser/topoLAGTemplate/modifyLAGTemplateJson modifyLAGTemplateJson
11. POST/data/esmBrowser/topoLAGTemplate/createLAGTemplateJson createLAGTemplate
12. POST/esmBrowser/topoLAGTemplate/createLAGTemplateJson createLAGTemplate
13. GET/esmBrowser/topoService/GetAllErpForNetworkReport Gets range of ERP records as response
14. GET/data/esmBrowser/serviceUIDatas/getServiceIdByServiceName Gets Service ID of a service when service name is provided as input
15. GET/esmBrowser/serviceUIDatas/getServiceIdByServiceName Gets Service ID of a service when service name is provided as input
16. GET/preferences/getServiceIdByServiceName Gets Service ID of a service when service name is provided as input
17. GET/esmBrowser/service/getServiceIdByServiceName Gets Service ID of a service when service name is provided as input
18. GET/data/esmBrowser/service/getServiceIdByServiceName Gets Service ID of a service when service name is provided as input

What's Deleted⇑

1. POST/data/otn/labelUnassign This API is to un-assign the label from the business object(s). The POST request body used for WS-NOC operations can have following fields. The "nameSpace" can be any string and is a mandatory field. For WS-NOC, preferred value is "NOC". The "type" distinguishes the request type and is a mandatory field. It can have multiple values like “newLabel” (for createLabel request), “genericObject” (for labelAssign/labelUnassign). The "businessObjectId" is the Id of the object and is a mandatory field. The connection id can be obtained from 'data/otn/connections' REST call as id. The ne id can be retrieved as 'id' from the REST call '/data/npr/nes'. The "businessObjectType" is the type of the object and is a mandatory field. For WS-NOC it can be “trail” or "lopc" or ”path” or ”physicalConn” or ”ne”. The "labelNames" is the string array and is a mandatory field.
2. POST/data/otn/labelAssign Assign a label to the business object(s).
3. POST/data/otn/createNewLabel Create New Label
4. GET/internal/sso-shared-common/v1/session-info null
5. GET/data/otn/labelsByObjectId This API is to retrieve all the labels associated with the given business object.This API might get deprecated and would be replaced by /data/otn/labelsByBusinessObjectIdAndType API in future release.
6. GET/data/otn/labelsByBusinessObjectIdAndType This API is to retrieve all the labels associated with the given business object(uses new DB view).This is currently used only by ESM and might replace the /data/otn/labelsByObjectId API in future release.
7. GET/data/otn/labelNames This API is to retrieve all the label names created in the application
8. GET/esmBrowser/topoService/GetERPElementaryDetailsSAPJSON/{erpRingName} ERP Elementary SAP Details JSON
9. GET/esmBrowser/topoService/GetERPElementaryDetailsPortParamInfoJSON/{erpRingName} ERP Elementary Port Params Details JSON
10. GET/esmBrowser/topoService/GetERPDetailsJSON/{erpName} Erp Details
11. GET/esmBrowser/topoService/GetERPDetailsByNameJSON/{context} Erp Details
12. GET/data/esmBrowser/lAGUIDatas/getVlanMappingsByVsIdLagId/{vsId}/{lagId} getVlanMappingsByVsIdLagId
13. GET/esmBrowser/lAGUIDatas/getVlanMappingsByVsIdLagId/{vsId}/{lagId} getVlanMappingsByVsIdLagId
14. GET/data/esmBrowser/LAG/getVlanMappingsByVsIdLagId/{vsId}/{lagId} getVlanMappingsByVsIdLagId
15. GET/data/esmBrowser/lAGUIDatas/getLagVlanConversationJson/{lagId}/{vsId}/{status} Lag Vlan Conversation
16. GET/esmBrowser/lAGUIDatas/getLagVlanConversationJson/{lagId}/{vsId}/{status} Lag Vlan Conversation
17. GET/data/esmBrowser/LAG/getLagVlanConversationJson/{lagId}/{vsId}/{status} Lag Vlan Conversation
18. GET/esmBrowser/LAG/getAllElemLAGsJson/{localTimeZoneOffset}/{pageContext}/{selectedLagName} All Lags

What's Deprecated⇑

1. No Changes

What's Changed⇑

1. GET/esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset} This API checks if Sync is in progress and returns a boolean value true or false

   • Response

     • Changed response : [200]//checks if sync is in progress and a boolean value true or false is returned
2. GET/esmBrowser/svcTemplate/getGlobalPubServiceTemplatesJson/{svcType} Retrieve the Service Template details by service type

   • Parameters

     • svcType in path

   • Response

     • Changed response : [200]//Globally Published Template Identifier for the given Service Type is retrieved successfully
3. GET/esmBrowser/svcTemplate/getAllSvcTypeJson Gets all the different types of services available and supported

   • Response

     • Changed response : [200]//list of all the Service Types in Ethernet Service Manager is retrieved successfully
4. GET/esmBrowser/service/getSubnetNamefromId/{subnetId} Retrieves the subnet name for the corresponding subnet identifier

   • Response

     • Changed response : [200]//Retrieved the subnet name for the corresponding subnet identifier successfully
5. GET/preferences/getSubnetNamefromId/{subnetId} Retrieves the subnet name for the corresponding subnet identifier

   • Response

     • Changed response : [200]//Retrieved the subnet name for the corresponding subnet identifier successfully
6. GET/esmBrowser/RMD/GetTSOPGeneralDetailsMapByNeId/{neId}/{portName}/{rmdId}/{deviceType} Gets general details of TSOP device

   • Response

     • Changed response : [200]//Returns general Details of the TSOP device type in a Remote Managed Device using the Network Element Identifier,Port Name,Remote Managed Device Identifier and Device type. Note: This API returns a Map of String key-value pairs containing general information about the specified RMD device.
7. GET/data/esmBrowser/RMD/GetTSOPGeneralDetailsMapByNeId/{neId}/{portName}/{rmdId}/{deviceType} Gets general details of TSOP device

   • Response

     • Changed response : [200]//Returns general Details of the TSOP device type in a Remote Managed Device using the Network Element Identifier,Port Name,Remote Managed Device Identifier and Device type. Note: This API returns a Map of String key-value pairs containing general information about the specified RMD device.
8. GET/data/esmBrowser/e_RMDDatas/GetTSOPGeneralDetailsMapByNeId/{neId}/{portName}/{rmdId}/{deviceType} Gets general details of TSOP device

   • Response

     • Changed response : [200]//Returns general Details of the TSOP device type in a Remote Managed Device using the Network Element Identifier,Port Name,Remote Managed Device Identifier and Device type. Note: This API returns a Map of String key-value pairs containing general information about the specified RMD device.
9. GET/data/esmBrowser/RMD/GetSWVersionDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Gets the software version details by nodeid,portname and rmd id

   • Response

     • Changed response : [200]//Gets software version details by nodeid, portname and rmd id
10. GET/data/esmBrowser/e_RMDDatas/GetSWVersionDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Gets the software version details by nodeid,portname and rmd id

    • Response

      • Changed response : [200]//Gets software version details by nodeid, portname and rmd id
11. GET/esmBrowser/RMD/GetSWVersionDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Gets the software version details by nodeid,portname and rmd id

    • Response

      • Changed response : [200]//Gets software version details by nodeid, portname and rmd id
12. GET/data/esmBrowser/e_RMDDatas/GetPortInvDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Retrieves port inventory details of a port

    • Response

      • Changed response : [200]//Retrieves port inventory details of a port
13. GET/esmBrowser/RMD/GetPortInvDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Retrieves port inventory details of a port

    • Response

      • Changed response : [200]//Retrieves port inventory details of a port
14. GET/data/esmBrowser/RMD/GetPortInvDetailsMapByNeId/{localTimeZoneOffset}/{neId}/{portName}/{rmdId} Retrieves port inventory details of a port

    • Response

      • Changed response : [200]//Retrieves port inventory details of a port
15. GET/esmBrowser/RMD/GetEFMDetailsMapByNeId/{neId}/{portName}/{rmdId} Retrieves EFM details for a specified port using unique rmdId

    • Response

      • Changed response : [200]//Retrieves EFM details for a specified port using unique rmdId
16. GET/data/esmBrowser/RMD/GetEFMDetailsMapByNeId/{neId}/{portName}/{rmdId} Retrieves EFM details for a specified port using unique rmdId

    • Response

      • Changed response : [200]//Retrieves EFM details for a specified port using unique rmdId
17. GET/data/esmBrowser/e_RMDDatas/GetEFMDetailsMapByNeId/{neId}/{portName}/{rmdId} Retrieves EFM details for a specified port using unique rmdId

    • Response

      • Changed response : [200]//Retrieves EFM details for a specified port using unique rmdId
18. GET/esmBrowser/RMD/GetCustNetworkPortDetailsByNeId/{localTimeZoneOffset}/{context}/{neId}/{portName}/{rmdId} Gets all customer network port details of a specified port name using neId and RmdId

    • Response

      • Changed response : [200]//Retrieved all customer network port details of a specified port name using neId and RmdId successfully
19. GET/data/esmBrowser/e_RMDDatas/GetCustNetworkPortDetailsByNeId/{localTimeZoneOffset}/{context}/{neId}/{portName}/{rmdId} Gets all customer network port details of a specified port name using neId and RmdId

    • Response

      • Changed response : [200]//Retrieved all customer network port details of a specified port name using neId and RmdId successfully
20. GET/data/esmBrowser/RMD/GetCustNetworkPortDetailsByNeId/{localTimeZoneOffset}/{context}/{neId}/{portName}/{rmdId} Gets all customer network port details of a specified port name using neId and RmdId

    • Response

      • Changed response : [200]//Retrieved all customer network port details of a specified port name using neId and RmdId successfully
21. GET/oamTestBrowser/getTestSuiteIDbyTestSuiteName/{tsName} Gets test suite ID of a test suite when test suite name is provided as input

    • Response

      • Changed response : [200]//Retrieved test suite ID of a test suite by passing test suite name as input successfully
22. GET/oamTestBrowser/getLSPTestCaseIDbyTestCaseName/{tcName} Gets LSP test case ID provided test case name as input

    • Response

      • Changed response : [200]//Retrieved LSP test case ID by using test case name as input
23. GET/esmBrowser/packetSwitchTemplate/getPacketSwitchTemplateById/{id} Retrieves particular PacketSwitch Template details by template id

    • Parameters

      • id in path
24. GET/esmBrowser/mplstpLspTemplate/getMplsTpTunnelTemplateName/{id}

    • Response

      • Changed response : [200]//tunnel template name is retrieved successfully
25. GET/esmBrowser/l2Cards/GetServicesOnAPort/{neName}/{portName}/{portType}/{localTimeZoneOffset} Gets list of all L2 cards Service riding on a port

    • Parameters

      • portType in path
26. GET/esmBrowser/RMD/GetCustNetworkPortDetailsMapById/{localTimeZoneOffset}/{context}/{neName}/{portName}/{rmdId} Retrieves all Customer Network Port details by RmdId

    • Parameters

      • context in path
27. POST/esmBrowser/carrierLinks/getLinkFromChannelName Gets All Links with respect to a channel

    • Request

      • Schema incompatible

        Changed body: 'application/json'

        Changed property type: managementState (string -> integer)

28. GET/esmBrowser/labelsByObjectId Gets list of all the labels associated to an entity(service,lag,tunnel)

    • Parameters

      • fromType in query
29. GET/esmBrowser/genericSvcTemplate/getAllTemplatesByPath/{context}/{localTimeZoneOffset}/{globalFolderFlag} Retrieves list of all the published and unpublished templates(service,erp,mclag etc.) based on context

    • Parameters

      • globalFolderFlag in path
30. GET/esmBrowser/genericSvcTemplate/getAllPublishedTemplatesByPath/{context}/{localTimeZoneOffset}/{globalFolderFlag} Retrieves list of all the published templates(service,erp,mclag etc.) based on context

    • Parameters

      • globalFolderFlag in path
31. GET/esmBrowser/carrierLinks/getAllLinksForMPLSTP_NPA/{LinkOrLagLink}/{SelectedlinkIdList}

    • Parameters

      • LinkOrLagLink in path
32. GET/esmBrowser/carrierLinks/GetAllLinksBytype/{type} Gets list of links based on link type

    • Parameters

      • type in path
      • linkId in query change into not required
33. GET/esmBrowser/carrierLinks/GetAllLinksByParentId/{type}/{parentId} Fetches the laglinks details by parentId

    • Parameters

      • type in path
34. POST/esmBrowser/mplstpNpa/scheduleChannelDelete

    • Request

      • Schema incompatible

        Changed body: 'application/json'
35. POST/esmService/mplstpNpa/scheduleChannelDelete

    • Request

      • Schema incompatible

        Changed body: 'application/json'
36. GET/esmBrowser/svcTemplate/getServiceTemplateDetails/{id} Retriev particular Service Template details by template id

    • Parameters

      • id in path