Operation

post /esmBrowser/RMD/DeleteRMD
Delete RMD (deleteRMD : /esmBrowser/RMD/DeleteRMD)

This operation is used to cleanup/delete entities for the RMD.

This is a scheduled operation in ESM. User can choose to modify a RMD for a future time or modify it right away. Modification will start at the scheduled time.
The deletion commands are sent to NE. If the commands are successful, RMD , RMD specific attributes, Access Interface Id are deleted from ESM.

Entities to be cleaned up on NE : RMD, Access Interface Id

If all the commands executed are successful, the Job will be marked Success.
If any of the commands deployed to NE are failed job will be marked as Failed.

Request body

Name

IsRequired

Description

Data Type

Enum

body required RMD Data nRMDIdHolder ---

Return type
  • RMDIdRespHolder
  • Responses

    Response Messages

    Schema

    200success RMDIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <RMDIdHolder> <req> <rmdid>2</rmdid> <accessinterfaceid>3</accessinterfaceid> <handle>27</handle> <description/> <devicename>REST-K-11QCE12X-2-7-2</devicename> <devicetype>EFM</devicetype> <nename>REST-K</nename> <portname>11QCE12X-2-7-C2</portname> <ouid>10:01:01</ouid> </req> <reqId> <clientName/> <reqId>5</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>RMD_REST-K-11QCE12X-2-7-2_Mon Mar 14 2016 23:03:09 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>RMD_REST-K-11QCE12X-2-7-2_Mon Mar 14 2016 23:03:09 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </RMDIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <RMDIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <errorReason>No errors</errorReason> <msgCode>RMD Deleted</msgCode> <opMsg/> <paramCount>8</paramCount> <parameters>3</parameters> <parameters>REST-K-11QCE12X-2-7-2</parameters> <parameters>0</parameters> <parameters>2</parameters> <parameters>REST-K</parameters> <parameters>11QCE12X-2-7-C2</parameters> <parameters>10:01:01</parameters> <parameters>27</parameters> </responseId> </RMDIdResponse>

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetRMDAlarms/{localTimeZoneOffset}/{neName}/{portName}/{rmdId}
    Get Remote Managed Device Alarms (getAllRMDAlarmsList : /esmBrowser/RMD/GetRMDAlarms/{localTimeZoneOffset}/{neName}/{portName}/{rmdId})
    getAllRMDAlarmsList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • AlarmNMLEMLListModel
  • Responses

    Response Messages

    Schema

    200success AlarmNMLEMLListModel
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetRMDAlarms/+5:30/REST-K/11QCE12X-2-7-X1/1?request.preventCache=1457946190942

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "alarmNmlEmlData": [ { "source": "PSS32-BA-02/11QCE12X/1/10/RMD1,RMD", "serverAlarmType": null, "neSeverity": "MAJOR", "neAlarmType": "EQUIPMENT", "neProbableCause": "RmdDNR", "neOccurenceTime": "Thu Aug 11 12:53:38 IST 2016", "typeName": "--", "nmlOccurenceTime": "--", "nmlSeverity": "--", "nmlProbableCause": "--", "errorOccured": null, "entryId": null } ], "nmlSeverity": null, "neSeverity": null }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/getAllRMDs/{localTimeZoneOffset}
    get All RMD Details (getAllRMDs : /esmBrowser/RMD/getAllRMDs/{localTimeZoneOffset})
    getAllRMDs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---

    Return type
  • RMD Data Model
  • Responses

    Response Messages

    Schema

    200success RMD Data Model
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/getAllRMDs/+5:30?request.preventCache=1457946190710

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "handle": 1, "lastupdatedtime": "2016-03-14 11:21:54", "scheduletime": "--", "portname": "11QCE12X-2-7-X1", "resetvalue": null, "objectscope": 1, "vsid": 1, "createtime": "2016-02-25 19:12:03", "portmode": "PORTMODE_NETWORK", "description": null, "mark": 0, "nename": "REST-K", "newdevicename": null, "accessinterfaceid": 1, "macaddress": "10:10:10:10:10:11", "devicestatus": "Device Not Reachable", "devicetype": "cEDD", "firmwareversion": null, "mcmacaddress": "11:10:10:00:00:02", "operationstate": 0, "ouid": "10:10:10", "pktprocessornvmversion": null, "pktprocessorversion": null, "devicename": "REST-K-11QCE12X-2-7-1", "urid": "1:1:1", "id": 1 } ]

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetAllServicesWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedServiceName}
    get All Service With Alarm State (getAllServicesWithAlarmState : /esmBrowser/RMD/GetAllServicesWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedServiceName})
    getAllServicesWithAlarmState

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset, the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    nodeName required nodeName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    pageContext required pageContext, allowed values are Operate, Deploy ---
    selectedServiceName required selectedServiceName, can be retrived as serviceName from GetAllServicesWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedHServiceName} ---

    Return type
  • ServiceUIDataModel
  • Responses

    Response Messages

    Schema

    200success ServiceUIDataModel
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetAllServicesWithAlarmState_ForRMD/{localTimeZoneOffset}/{rmdId}/{vsId}
    Get All Services With Alarm State For RMD (getAllServicesWithAlarmStateForRMD : /esmBrowser/RMD/GetAllServicesWithAlarmState_ForRMD/{localTimeZoneOffset}/{rmdId}/{vsId})
    GetAllServicesWithAlarmState_ForRMD

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---
    vsId required vsId, can be retrived as VSID attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • ServiceUIDataModel
  • Responses

    Response Messages

    Schema

    200success ServiceUIDataModel
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetAllServicesWithAlarmState_ForRMD/+5:30/2/1?request.preventCache=1457975789735

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"svcMapperDataList":[{"serviceId":115,"serviceName":"Svc-Mod-Policy_70","serviceDescr":null,"serviceType":"EVPL","customerName":"DiscoveredCustomer4","managementState":"Commissioned","operationState":"down","serviceState":"In Service","createTime":"2016-07-05 11:44:58","lastUpdatedTime":"2016-07-07 13:42:16","scheduleTime":"--","author":null,"description":null,"cvlan":"2027","svlan":null,"reserveResource":null,"preProvCLICommand":null,"postProvCLICommand":null,"templateID":0,"templateDeleteFlag":0,"alarmSeverity":"Clear:Clear","alarmToolTip1":null,"alarmToolTip2":null,"alarmToolTip3":null,"alarmToolTip4":null,"alarmToolTip5":null,"toolTipCount":0,"mdFormat":null,"mdLevel":0,"maFormat":null,"maName":null,"ccmInterval":null,"direction":false,"active":false,"ccmEnable":false,"enable":false,"aisLevel":null,"controlMepEnabled":false,"ccmPriority":0,"aisPriority":0,"aisInterval":0,"interfaceType":null,"lowestPriorityDefect":null,"oamConfigured":true,"remark":"--","pmState":1,"pmstartTime":null,"pmendTime":null,"llf":false,"l2pt":false,"lacp":false,"l2cp":false,"vlanRangeEnabled":false,"mipValue":null,"policyId":null,"policyName":null,"ringHubName":null,"repProf15m":null,"repProf24h":null,"tcaProfName":null,"defaultPort":false,"defaultNode":false,"fragmentType":null,"ntwktechnology":null,"oamsupported":false,"vneInvolved":false,"mdlevel":0,"pmStartTime":null,"pmEndTime":null,"hubInst":null},{"serviceId":114,"serviceName":"NEW-1","serviceDescr":null,"serviceType":"EVPL","customerName":"DiscoveredCustomer4","managementState":"Commissioned","operationState":"down","serviceState":"Out Of Service","createTime":"2016-07-05 11:38:36","lastUpdatedTime":"2016-07-05 14:08:27","scheduleTime":"--","author":null,"description":null,"cvlan":"2003","svlan":null,"reserveResource":null,"preProvCLICommand":null,"postProvCLICommand":null,"templateID":0,"templateDeleteFlag":0,"alarmSeverity":"Clear:Clear","alarmToolTip1":null,"alarmToolTip2":null,"alarmToolTip3":null,"alarmToolTip4":null,"alarmToolTip5":null,"toolTipCount":0,"mdFormat":null,"mdLevel":0,"maFormat":null,"maName":null,"ccmInterval":null,"direction":false,"active":false,"ccmEnable":false,"enable":false,"aisLevel":null,"controlMepEnabled":false,"ccmPriority":0,"aisPriority":0,"aisInterval":0,"interfaceType":null,"lowestPriorityDefect":null,"oamConfigured":true,"remark":"--","pmState":-1,"pmstartTime":null,"pmendTime":null,"llf":false,"l2pt":false,"lacp":false,"l2cp":false,"vlanRangeEnabled":false,"mipValue":null,"policyId":null,"policyName":null,"ringHubName":null,"repProf15m":null,"repProf24h":null,"tcaProfName":null,"defaultPort":false,"defaultNode":false,"fragmentType":null,"ntwktechnology":null,"oamsupported":false,"vneInvolved":false,"mdlevel":0,"pmStartTime":null,"pmEndTime":null,"hubInst":null}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetCFMDetails/{neName}/{portName}/{rmdId}
    GetCFMDetails (getCFMDetails : /esmBrowser/RMD/GetCFMDetails/{neName}/{portName}/{rmdId})
    Get CFM Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Config_Fault_Data
  • Responses

    Response Messages

    Schema

    200success RMD_Config_Fault_Data
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetCFMDetails/REST-K/11QCE12X-2-7-C1/3?request.preventCache=1457976129336

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"cfmdetails":null}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetCFMDetailsMap/{neName}/{portName}/{rmdId}
    GetCFMDetailsMap (getCFMDetailsMap : /esmBrowser/RMD/GetCFMDetailsMap/{neName}/{portName}/{rmdId})
    Get CFM Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Config_Fault_Data
  • Responses

    Response Messages

    Schema

    200success RMD_Config_Fault_Data
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetCFMDetailsMap/ESM-4V1-M/11QPE24-1-6-C3/3

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { date: " ", acronymCode: " ", swPartNo: " ", extraData: " ", modType: " ", cleiCode: " ", unitPartNo: " ", frequency: "0", maxCaseTemp: "0", modVendor: " ", factId: " ", intrchngMarking: " ", modVendorSlNo: " " }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetCustNetworkPortDetails/{localTimeZoneOffset}/{context}/{neName}/{portName}/{rmdId}
    GetCustNetworkPortDetails (getCustNetDetails : /esmBrowser/RMD/GetCustNetworkPortDetails/{localTimeZoneOffset}/{context}/{neName}/{portName}/{rmdId})
    Get Custom Network Port Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    context required context,allowed values are Operate, Deploy ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Network_Cust
  • Responses

    Response Messages

    Schema

    200success RMD_Network_Cust
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetCustNetworkPortDetails/+5:30/2/REST-K/11QCE12X-2-7-X1/1?request.preventCache=1457946936672

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "custNetowrkDetails": { "provPauseMode": "Disabled", "actualDuplexMode": "Not Available", "mdi_mdixMode": "Not Available", "actualSpeed": "Not Available", "actualPauseMode": "Not Available", "provSpeed": "1000 Mbps", "autoNegoStatus": "Not Available", "provDuplexMode": "Full", "autoNegEnabled": "Enabled", "operState": "DOWN", "forwdMode": "Not Applicable", "trafficEnabled": "Enabled", "autoNegoFBEnabled": "No", "macAddr": "00:00:00:00:00:00" } }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetCustNetworkPortDetailsMap/{localTimeZoneOffset}/{context}/{neName}/{portName}/{rmdId}
    GetCustNetworkPortDetailsMap (getCustNetDetailsMap : /esmBrowser/RMD/GetCustNetworkPortDetailsMap/{localTimeZoneOffset}/{context}/{neName}/{portName}/{rmdId})
    Get Custom Network Port Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    context required context,allowed values are Operate, Deploy ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Network_Cust
  • Responses

    Response Messages

    Schema

    200success RMD_Network_Cust
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetCustNetworkPortDetailsMap/+5:30/2/ESM-4V1-M/11QPE24-1-6-C5/5

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { provPauseMode: "Disabled", actualDuplexMode: "Not Available", mdi_mdixMode: "Not Available", actualSpeed: "Not Available", actualPauseMode: "Not Available", provSpeed: "1000 Mbps", autoNegoStatus: "Not Available", provDuplexMode: "Full", autoNegEnabled: "Enabled", operState: "DOWN", forwdMode: "Not Applicable", trafficEnabled: "Not Applicable", autoNegoFBEnabled: "Yes", macAddr: "00:00:00:00:00:00" }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetEFMDetails/{neName}/{portName}/{rmdId}
    GetEFMDetails (getEFMDetails : /esmBrowser/RMD/GetEFMDetails/{neName}/{portName}/{rmdId})
    Get EFM Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_EFM_Data
  • Responses

    Response Messages

    Schema

    200success RMD_EFM_Data
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetEFMDetails/REST-K/11QCE12X-2-7-C2/2?request.preventCache=1457976015322

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"efmdetails":null}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetEFMDetailsMap/{neName}/{portName}/{rmdId}
    GetEFMDetailsMap (getEFMDetailsMap : /esmBrowser/RMD/GetEFMDetailsMap/{neName}/{portName}/{rmdId})
    Get EFM Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_EFM_Data
  • Responses

    Response Messages

    Schema

    200success RMD_EFM_Data
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetEFMDetailsMap/ESM-4V1-M/11QPE24-1-6-C1/1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { date: " ", acronymCode: " ", swPartNo: " ", extraData: " ", modType: " ", cleiCode: " ", unitPartNo: " ", frequency: "0", maxCaseTemp: "0", modVendor: " ", factId: " ", intrchngMarking: " ", modVendorSlNo: " " }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetPortInvDetails/{localTimeZoneOffset}/{neName}/{portName}/{rmdId}
    GetPortInvDetails (getPortInvDetails : /esmBrowser/RMD/GetPortInvDetails/{localTimeZoneOffset}/{neName}/{portName}/{rmdId})
    Get Port Inventory details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset, client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Port_Inventory
  • Responses

    Response Messages

    Schema

    200success RMD_Port_Inventory
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetPortInvDetails/+5:30/REST-K/11QCE12X-2-7-X1/1?request.preventCache=1457948167224

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "portInvDetails": { "factId1": " ", "date": " ", "modVendorSlNo3": " ", "maxCaseTemp1": "0", "modVendorSlNo1": " ", "maxCaseTemp3": "0", "intrchngMarking3": " ", "cleiCode3": " ", "swPartNo3": " ", "extraData": " ", "factId3": " ", "intrchngMarking1": " ", "modType": " ", "swPartNo1": " ", "frequency1": "0", "frequency3": "0", "cleiCode1": " ", "unitPartNo": " ", "frequency": "0", "maxCaseTemp": "0", "modVendor1": " ", "modVendor": " ", "extraData3": " ", "unitPartNo3": " ", "extraData1": " ", "unitPartNo1": " ", "modVendor3": " ", "modVendorSlNo": " ", "acronymCode": " ", "swPartNo": " ", "modType1": " ", "modType3": " ", "date3": " ", "date1": " ", "cleiCode": " ", "factId": " ", "intrchngMarking": " ", "acronymCode1": " ", "acronymCode3": " " } }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetPortInvDetailsMap/{localTimeZoneOffset}/{neName}/{portName}/{rmdId}
    GetPortInvDetailsMap (getPortInvDetailsMap : /esmBrowser/RMD/GetPortInvDetailsMap/{localTimeZoneOffset}/{neName}/{portName}/{rmdId})
    Get Port Inventory details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset, client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Port_Inventory
  • Responses

    Response Messages

    Schema

    200success RMD_Port_Inventory
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetPortInvDetailsMap/+5:30/ESM-4V1-M/11QPE24-1-6-C2/2

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { date: " ", acronymCode: " ", swPartNo: " ", extraData: " ", modType: " ", cleiCode: " ", unitPartNo: " ", frequency: "0", maxCaseTemp: "0", modVendor: " ", factId: " ", intrchngMarking: " ", modVendorSlNo: " " }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/getRMDbyHandle/{rmdHandle}/{localTimeZoneOffset}
    get All RMD Details (getRMDbyHandle : /esmBrowser/RMD/getRMDbyHandle/{rmdHandle}/{localTimeZoneOffset})
    getAllRMDs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    rmdHandle required rmdHandle,the value of rmdHandle can be got using getAllRMDs ---
    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---

    Return type
  • RMD Data Model
  • Responses

    Response Messages

    Schema

    200success RMD Data Model
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetRMDDetails/{localTimeZoneOffset}/{rmdId}/{neName}/{portName}/{accessInterfaceId}
    GetRMDDetails (getRmdDetails : /esmBrowser/RMD/GetRMDDetails/{localTimeZoneOffset}/{rmdId}/{neName}/{portName}/{accessInterfaceId})
    Get RMD Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    accessInterfaceId required accessInterfaceId, can be retrived as ACCESSINTERFACEID attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD Data Model
  • Responses

    Response Messages

    Schema

    200success RMD Data Model
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetRMDDetails/+5:30/1/PSS32-BA-01/11QPE24-1-4-C12/1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"handle":4,"accessinterfaceid":1,"devicestatus":"Device Not Reachable","devicetype":"CFM","firmwareversion":"0.0.0.0","macaddress":"00:19:3a:00:1c:3c","mcmacaddress":"01:19:3a:00:00:02","operationstate":0,"ouid":"00:19:3a","pktprocessornvmversion":"0.0.0.0","pktprocessorversion":"0.0.0.0","portname":"11QPE24-1-4-C12","devicename":"PSS32-BA-01-11QPE24-1-4-1","urid":null,"newdevicename":null,"lastupdatedtime":"2016-07-08 17:25:29","scheduletime":null,"description":null,"nename":"PSS32-BA-01","createtime":"2016-06-29 17:43:46","vsid":3,"portmode":"PORTMODE_ACCESS","mark":0,"objectscope":1,"resetvalue":null,"id":1}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetRMDForService/{localTimeZoneOffset}/{serviceName}
    GetRMDForService (getRmdForService : /esmBrowser/RMD/GetRMDForService/{localTimeZoneOffset}/{serviceName})
    Get RMD For Service

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    serviceName required serviceName, can be retrived as serviceName from GetAllServicesWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedHServiceName} ---

    Return type
  • RMD Data Model
  • Responses

    Response Messages

    Schema

    200success RMD Data Model
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetRMDForService/+5:30/NEW-1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [{"handle":13,"accessinterfaceid":2,"devicestatus":"Normal","devicetype":"EFM","firmwareversion":"1.2.3.19","macaddress":"00:19:3a:00:31:4c","mcmacaddress":"01:19:3a:00:00:02","operationstate":0,"ouid":"00:19:3a","pktprocessornvmversion":"1.1.1.9","pktprocessorversion":"1.1.1.9","portname":"11QCE12X-1-6-C4","devicename":"PSS32-BA-01-11QCE12X-1-6-1","urid":null,"newdevicename":null,"lastupdatedtime":"2016-07-08 17:25:28","scheduletime":"--","description":null,"nename":"PSS32-BA-01","createtime":"2016-07-05 18:27:32","vsid":1,"portmode":null,"mark":0,"objectscope":1,"resetvalue":null,"id":1}]

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetRMDForServiceFromServiceId/{localTimeZoneOffset}/{serviceId}
    GetRMDForServiceFromServiceId (getRmdForServiceFromServiceId : /esmBrowser/RMD/GetRMDForServiceFromServiceId/{localTimeZoneOffset}/{serviceId})
    Get RMD For Service

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    serviceId required serviceId, can be retrived as id from GetAllServicesWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedHServiceName} ---

    Return type
  • RMD Data Model
  • Responses

    Response Messages

    Schema

    200success RMD Data Model
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetSWVersionDetailsMap/{localTimeZoneOffset}/{neName}/{portName}/{rmdId}
    GetSWVersionDetailsMap (getSWVersionDetailsMap : /esmBrowser/RMD/GetSWVersionDetailsMap/{localTimeZoneOffset}/{neName}/{portName}/{rmdId})
    Get Software image version details for cEDD equipment

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required localTimeZoneOffset,client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. ---
    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_Port_Inventory
  • Responses

    Response Messages

    Schema

    200success RMD_Port_Inventory
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPDecapDetails/{neName}/{portName}/{rmdId}
    GetTSOPDecapDetails (getTsopDecapDetails : /esmBrowser/RMD/GetTSOPDecapDetails/{neName}/{portName}/{rmdId})
    Get TSOPDecap Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_DecapDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_DecapDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetTSOPDecapDetails/PSS32-BA-01/11QCE12X-1-6-C6/3

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"tsopDecapDtls":{"tsopDecapForceGais":"No","tsopDecapUnknownEcid":"0","tsopDecapGais":"Yes","tsopDecapRTPPayloadTypeMismatchDefect":"No","tsopDecapGaisStatus":"Inactive","tsopDecapClrThreshold":"8","tsopDecapInclInvalidLmBits":"Yes","tsopDecapExptdRtpHeader":"Yes","tsopDecapRTPClockSrc":"Ethernet","tsopDecapRTPExptdSsrc":"0","tsopDecapInclStray":"No","tsopDecapRaiseThreshold":"8","tsopDecapInclMalformed":"Yes","tsopDecapTimingMode":"Differential","tsopDecapRTPFreq":"25 MHz","tsopDecapExptdEcid":"0","tsopDecapExptdRtpPayloadType":"0"}}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPDecapDetailsMap/{neName}/{portName}/{rmdId}
    GetTSOPDecapDetailsMap (getTsopDecapDetailsMap : /esmBrowser/RMD/GetTSOPDecapDetailsMap/{neName}/{portName}/{rmdId})
    Get TSOPDecap Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_DecapDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_DecapDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetTSOPDecapDetailsMap/ESM-4V1-M/11QPE24-1-6-C5/5

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { tsopDecapDtls: { tsopDecapForceGais: "No", tsopDecapUnknownEcid: "0", tsopDecapGais: "Yes", tsopDecapRTPPayloadTypeMismatchDefect: "No", tsopDecapGaisStatus: "Inactive", tsopDecapClrThreshold: "8", tsopDecapInclInvalidLmBits: "Yes", tsopDecapExptdRtpHeader: "Yes", tsopDecapRTPClockSrc: "Ethernet", tsopDecapRTPExptdSsrc: "0", tsopDecapInclStray: "No", tsopDecapRaiseThreshold: "8", tsopDecapInclMalformed: "Yes", tsopDecapTimingMode: "Differential", tsopDecapRTPFreq: "25 MHz", tsopDecapExptdEcid: "0", tsopDecapExptdRtpPayloadType: "0" } }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPEncapDetails/{neName}/{portName}/{rmdId}
    GetTSOPEncapDetails (getTsopEncapDetails : /esmBrowser/RMD/GetTSOPEncapDetails/{neName}/{portName}/{rmdId})
    Get TSOPEncap Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_EncapDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_EncapDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetTSOPEncapDetails/PSS32-BA-01/11QCE12X-1-6-C6/3

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"tsopEncapDtls":{"tsopEncapIncludeLOF":"Yes","tsopEncapRTPHeader":"Yes","tsopEncapRTPClockSrc":"Ethernet","tsopEncapGAISStatuc":"Inactive","tsopEncapEnabled":"No","tsopEncapIncludeLOS":"Yes","tsopEncapECId":"0","tsopEncapRTPFreq":"25 MHz","tsopEncapRTPPayloadType":"0","tsopEncapRTPssrc":"0"}}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPEncapDetailsMap/{neName}/{portName}/{rmdId}
    GetTSOPEncapDetailsMap (getTsopEncapDetailsMap : /esmBrowser/RMD/GetTSOPEncapDetailsMap/{neName}/{portName}/{rmdId})
    Get TSOPEncap Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_EncapDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_EncapDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetTSOPEncapDetailsMap/ESM-4V1-M/11QPE24-1-6-C5/5

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { tsopEncapIncludeLOF: "Yes", tsopEncapRTPHeader: "Yes", tsopEncapRTPClockSrc: "Ethernet", tsopEncapGAISStatuc: "Inactive", tsopEncapEnabled: "No", tsopEncapIncludeLOS: "Yes", tsopEncapECId: "4", tsopEncapRTPFreq: "25 MHz", tsopEncapRTPPayloadType: "0", tsopEncapRTPssrc: "0" }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPGeneralDetails/{neName}/{portName}/{rmdId}/{deviceType}
    GetTSOPGeneralDetails (getTsopGeneralDetails : /esmBrowser/RMD/GetTSOPGeneralDetails/{neName}/{portName}/{rmdId}/{deviceType})
    Get TSOP General Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---
    deviceType required deviceType, TSOP DEVICETYPE retrived from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_GeneralDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_GeneralDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetTSOPGeneralDetails/PSS32-BA-01/11QCE12X-1-6-C6/3/TSoP-OC3

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"tsopGeneralDtls":{"tsopInLoopType":"0","tsopOutLoopEnabled":"00:19:3a:11:11:11","tsopDestMacAddr":"00:00:00:00:00:00","tsopDestMacCheck":"No","tsopMacAddr":"00:19:3a:11:11:11","tsopMaxJBSize":"0","tsopMaxChannel":"0","tsopOutLoopType":"0","tsopInLoopEnabled":"00:19:3a:11:11:11"},"rate":"OC3","loopBack":"None"}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPGeneralDetailsMap/{neName}/{portName}/{rmdId}/{deviceType}
    GetTSOPGeneralDetailsMap (getTsopGeneralDetailsMap : /esmBrowser/RMD/GetTSOPGeneralDetailsMap/{neName}/{portName}/{rmdId}/{deviceType})
    Get TSOP General Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---
    deviceType required deviceType, TSOP DEVICETYPE retrived from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_GeneralDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_GeneralDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetTSOPGeneralDetailsMap/ESM-4V1-M/11QPE24-1-6-C5/5/TSoP-OC12

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { tsopInLoopType: "0", tsopOutLoopEnabled: "00:00:10:00:01:00", tsopDestMacAddr: "00:00:00:00:00:00", tsopDestMacCheck: "No", rate: "OC12", tsopMacAddr: "00:00:10:00:01:00", tsopMaxJBSize: "0", tsopMaxChannel: "0", tsopOutLoopType: "0", tsopInLoopEnabled: "00:00:10:00:01:00", loopBack: "None" }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPJitterDetails/{neName}/{portName}/{rmdId}
    GetTSOPJitterDetails (getTsopJitterDetails : /esmBrowser/RMD/GetTSOPJitterDetails/{neName}/{portName}/{rmdId})
    Get TSOPJitter Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_JitterDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_JitterDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/RMD/GetTSOPJitterDetails/PSS32-BA-01/11QCE12X-1-6-C6/3

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"tsopGeneralDtls":{"tsopInLoopType":"0","tsopOutLoopEnabled":"00:19:3a:11:11:11","tsopDestMacAddr":"00:00:00:00:00:00","tsopDestMacCheck":"No","tsopMacAddr":"00:19:3a:11:11:11","tsopMaxJBSize":"0","tsopMaxChannel":"0","tsopOutLoopType":"0","tsopInLoopEnabled":"00:19:3a:11:11:11"},"rate":"OC3","loopBack":"None"}

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMD/GetTSOPJitterDetailsMap/{neName}/{portName}/{rmdId}
    GetTSOPJitterDetailsMap (getTsopJitterDetailsMap : /esmBrowser/RMD/GetTSOPJitterDetailsMap/{neName}/{portName}/{rmdId})
    Get TSOPJitter Details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName, can be retrived as NENAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    portName required portName, can be retrived as PORTNAME attribute from getAllRMDs/{localTimeZoneOffset} ---
    rmdId required rmdId, can be retrived as id attribute from getAllRMDs/{localTimeZoneOffset} ---

    Return type
  • RMD_TSOP_JitterDetails
  • Responses

    Response Messages

    Schema

    200success RMD_TSOP_JitterDetails
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    https://135.250.185.244:8443/oms1350/esmBrowser/RMD/GetTSOPJitterDetailsMap/ESM-4V1-M/11QPE24-1-6-C5/5

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { tsopJBRecenterIncrement: "10", tsopJBMinFillLevel: "0", tsopJBHighThreshold: "56", tsopJBLowThreshold: "8", tsopJBShiftPosition: "0", tsopJBRecenterPosition: "32", tsopJBRecenterThreshold: "100", tsopJBMaxFillLevel: "0" }

    External Docs
    See Also :

    Operation

    post /esmBrowser/RMD/ResetRMD
    ResetRMD (resetRMD : /esmBrowser/RMD/ResetRMD)

    Used to reset RMD on NE.

    There are four types of reset :
    1. Warm1,
    2. Warm2,
    3. Warm3,
    4. Cold.

    This is a scheduled operation in ESM. Only schedule now is supported for reset.
    If all the commands executed are successful, the Job will be marked Success.
    If any of the commands deployed to NE are failed job will be marked as Failed.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required RMD Data nRMDIdHolder ---

    Return type
  • RMDIdRespHolder
  • Responses

    Response Messages

    Schema

    200success RMDIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <RMDIdHolder> <req> <rmdid>1</rmdid> <accessinterfaceid>1</accessinterfaceid> <handle>1</handle> <description/> <devicename>REST-K-11QCE12X-2-7-1</devicename> <devicetype>cEDD</devicetype> <nename>REST-K</nename> <portname>11QCE12X-2-7-X1</portname> <ouid>10:10:10</ouid> <resetValue>RMD Warm1 Reset</resetValue> </req> <reqId> <clientName/> <reqId>7</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>RMD_REST-K-11QCE12X-2-7-1_Mon Mar 14 2016 15:20:23 UTC+5:30</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>RMD_REST-K-11QCE12X-2-7-1_Mon Mar 14 2016 15:20:23 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </RMDIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <RMDIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>RMD_RESET_SUCCESS_JOB</msgCode> <opMsg/> <paramCount>0</paramCount> </responseId> </RMDIdResponse>

    External Docs
    See Also :

    Operation

    post /esmBrowser/RMD/scheduleModifyRMD
    scheduleModifyRMD (scheduleModifyRMD : /esmBrowser/RMD/scheduleModifyRMD)

    This operation is used for modification of RMD attributes.

    It is a scheduled operation in ESM. The user can choose to modify a RMD for a future time or modify it right away. Modification will start at the scheduled time. This operation will first update the ESM database with the changes done on the RMD by user and then it deploys the changes to the NE. The set of modifiable attributes depend on the device type.

    The modification is allowed for the following entities using this operation :
    Remote managed device name
    Author(not propagated to NE)
    Description
    Customer port attriubte
    Network port attributes
    CFM/EFM/TSoP specific attributes

    All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
    If all the commands executed are successful, the Job will be marked Success.
    On successful modification, RMD details will be updated with modified attribute values.
    If any of the commands deployed to NE are failed job will be marked as Failed.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required RMD Data nRMDIdHolder ---

    Return type
  • RMDIdRespHolder
  • Responses

    Response Messages

    Schema

    200success RMDIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <RMDIdHolder> <req> <rmdid>1</rmdid> <accessinterfaceid>1</accessinterfaceid> <handle>1</handle> <description/> <devicename>REST-K-11QCE12X-2-7-1</devicename> <devicetype>2</devicetype> <nename>REST-K</nename> <portname>11QCE12X-2-7-X1</portname> <ouid>10:10:10</ouid> <isMepToBeDeletedForCFM>1</isMepToBeDeletedForCFM> <rmdPortAttributesList> <rmdPortAttributes> <portAttributeType>2</portAttributeType> <portAttributeMap> <entry> <key>trafficEnabled</key> <value>Enabled</value> </entry> <entry> <key>autoNegEnabled</key> <value>Enabled</value> </entry> <entry> <key>forwdMode</key> <value>Not Applicable</value> </entry> </portAttributeMap> </rmdPortAttributes> <rmdPortAttributes> <portAttributeType>1</portAttributeType> <portAttributeMap> <entry> <key>autoNegEnabled</key> <value>Enabled</value> </entry> <entry> <key>forwdMode</key> <value>Not Applicable</value> </entry> </portAttributeMap> </rmdPortAttributes> <rmdPortAttributes> <portAttributeType>2</portAttributeType> <portAttributeMap> <entry> <key>provSpeed</key> <value>1000 Mbps</value> </entry> <entry> <key>provDuplexMode</key> <value>Full</value> </entry> </portAttributeMap> </rmdPortAttributes> <rmdPortAttributes> <portAttributeType>1</portAttributeType> <portAttributeMap> <entry> <key>autoNegoFBEnabled</key> <value>No</value> </entry> </portAttributeMap> </rmdPortAttributes> </rmdPortAttributesList> <cfmDetailData/> </req> <reqId> <clientName/> <reqId>4</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>RMD_REST-K-11QCE12X-2-7-1_Mon Mar 14 2016 15:24:27 UTC+5:30</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>RMD_REST-K-11QCE12X-2-7-1_Mon Mar 14 2016 15:24:27 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </RMDIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <RMDIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>RMD_MODIFY_SUCCESS_JOB_001</msgCode> <opMsg/> <paramCount>0</paramCount> </responseId> </RMDIdResponse>

    External Docs
    See Also :

    AlarmNMLEMLListModel

    Name

    Type

    Description

    Enum

    alarmNmlEmlData array[AlarmNmlEmlUIDataModel] AlarmNmlEmlUIDataModel Alarm NML EML Data List ---
    nmlSeverity String string NML Alarm Severity [CRITICAL, MAJAOR, MINOR, NA]
    neSeverity String string NE Alarm Severity [CRITICAL, MAJAOR, MINOR, NA]
    items array[AlarmNmlEmlUIDataModel] AlarmNmlEmlUIDataModel --- ---

    AlarmNmlEmlUIDataModel

    Name

    Type

    Description

    Enum

    source String string Source of the Alarm ---
    serverAlarmType String string server Alarm type ---
    neSeverity String string NE Alarm Severity [CRITICAL, MAJOR, MINOR, NA]
    neAlarmType String string NE Alarm Type ---
    neProbableCause String string NE Alarm probable cause ---
    neOccurenceTime String string NE Alarm occurence time ---
    typeName String string Alarm type name ---
    nmlOccurenceTime String string NML Alarm Occurence time ---
    nmlSeverity String string NML Alarm severity ---
    nmlProbableCause String string NML Alarm probable cause ---
    id Integer integer --- ---
    key String string --- ---
    className String string --- ---

    CFMDetailsDataRest

    Name

    Type

    Description

    Enum

    cfmDtlParamMap Object object getCfmDtlParamMap ---

    EFMOAMDataRest

    Name

    Type

    Description

    Enum

    efmOamParamMap Object object getEfmOamParamMap ---

    ESMSchedulerDataModel

    Name

    Type

    Description

    Enum

    jobName String string Job Name ---
    jobDescription String string Job description ---
    trigger ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel Job Trigger data model ---
    username String string User name ---

    ESMSchedulerTriggerDataModel

    Name

    Type

    Description

    Enum

    name String string Trigger Name ---
    timeOffset String string User PC time zone offset ---
    expression String string Job trigger expression ---
    deployNow String string Deploy Now [Yes]
    type String string Job Type ---

    HubInst

    Name

    Type

    Description

    Enum

    hubList array[nHubData] nHubData HubList ---

    nHubData

    Name

    Type

    Description

    Enum

    vsid Integer integer Vsid ---
    neName String string NEName ---
    packName String string PackName ---
    hubName String string HubName ---

    nRMDIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId Request Header Request Header --- ---
    req RMDId RMDId --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    operationName String string --- ---
    activate Boolean boolean --- ---

    Request Header

    Name

    Type

    Description

    Enum

    respBeanRef String string --- ---
    selectiveSyncViaPolling Boolean boolean --- ---
    clientName String string ClientName ---
    reqId String string ReqId ---

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---

    RMD Data Model

    Name

    Type

    Description

    Enum

    handle Long long handle ---
    notificationTime Long long --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    rmdId Integer integer --- ---
    portPrimaryState String string PortPrimaryState [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance]

    RMD_Config_Fault_Data

    Name

    Type

    Description

    Enum

    CFMDetails Object object --- ---

    RMD_EFM_Data

    Name

    Type

    Description

    Enum

    EFMDetails Object object --- ---

    RMD_Network_Cust

    Name

    Type

    Description

    Enum

    custNetowrkDetails Object object getCustNetowrkDetails ---

    RMD_Port_Inventory

    Name

    Type

    Description

    Enum

    portInvDetails Object object getPortInvDetails ---

    RMD_TSOP_DecapDetails

    Name

    Type

    Description

    Enum

    tsopDecapDtls Object object getTsopDecapDtls ---

    RMD_TSOP_EncapDetails

    Name

    Type

    Description

    Enum

    tsopEncapDtls Object object getTsopEncapDtls ---

    RMD_TSOP_GeneralDetails

    Name

    Type

    Description

    Enum

    tsopGeneralDtls Object object getTsopGeneralDtls ---
    rate String string getRate ---
    loopBack String string getLoopBack ---

    RMD_TSOP_JitterDetails

    Name

    Type

    Description

    Enum

    tsopJiiterDtls Object object getTsopJiiterDtls ---

    RMDId

    Name

    Type

    Description

    Enum

    accessinterfaceid Integer integer Accessinterfaceid ---
    efmOamData EFMOAMDataRest EFMOAMDataRest getEfmOamData ---
    description String string getDescription ---
    handle Long long getHandle ---
    devicetype Integer integer getDevicetype ---
    resetValue String string get Reset Value [00:19:3A ]
    tsopDetailData TSOPDetailDataRest TSOPDetailDataRest getTsopDetailData ---
    rmdPortAttributes array[RMDPortAttributes] RMDPortAttributes getRmdPortAttributes ---
    isMepToBeDeletedForCFM String string value for Is Mep To Be Deleted For CFM [0, 1]
    rmdPortInventoryData RMDPortInventoryData RMDPortInventoryData getRmdPortInventoryData ---
    nename String string getNename ---
    ouid String string getOuid ---
    portname String string getPortname ---
    devicename String string getDevicename ---
    cfmDetailData CFMDetailsDataRest CFMDetailsDataRest getCfmDetailData ---
    rmdid Integer integer getRmdid ---

    RMDIdRespHolder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model getResponseId ---
    req RMDId RMDId getReq ---
    schedReqMapper ESMSchedulerDataModel ESMSchedulerDataModel getSchedReqMapper ---

    RMDPortAttributes

    Name

    Type

    Description

    Enum

    portAttributeType String string getPortAttributeType ---
    portAttributeMap Object object getPortAttributeMap ---

    RMDPortInventoryData

    Name

    Type

    Description

    Enum

    portInventoryType String string Inventory Type [1, 2, 3]
    portInventoryDataMap Object object Port Inventory data ---

    ServiceUIDataModel

    Name

    Type

    Description

    Enum

    serviceId Long long ServiceId ---
    serviceName String string Unique name for the service ---
    serviceDescr String string Description for the service ---
    serviceType String string Service type [EPL, EVPL, EPLAN, EVPLAN, EPTREE, EVPTREE]
    customerName String string Customer name ---
    managementState String string Current management state of the erp ---
    operationState String string Operational state [up, down, unknown, transition, --]
    serviceState String string Service state [In service, Out of service, Not in service, Inconsistent, partial, unknown , --]
    createTime Date DateTime Service creation time ---
    lastUpdatedTime Date DateTime Service last updated time ---
    scheduleTime Date DateTime Service scheduled time ---
    author String string Author for the service ---
    description String string Description for the service ---
    cvlan String string Customer VLAN ID ---
    svlan String string Subscriber VLAN ID ---
    reserveResource String string Ports to be reserved ---
    preProvCLICommand String string Pre CLI commands ---
    postProvCLICommand String string Post CLI commands ---
    templateID Long long Template ID ---
    templateDeleteFlag Integer integer Flag required to delete service Template [0]
    alarmSeverity String string alarm severity ---
    alarmToolTip1 String string AlarmToolTip1 ---
    alarmToolTip2 String string AlarmToolTip2 ---
    alarmToolTip3 String string AlarmToolTip3 ---
    alarmToolTip4 String string AlarmToolTip4 ---
    alarmToolTip5 String string AlarmToolTip5 ---
    toolTipCount Integer integer ToolTipCount ---
    mdFormat String string Maintenance Domain Format [Y.1731 supports only NONE Format for MD]
    mdLevel Integer integer Maintenance Domain Level ---
    maFormat String string Maintenance Association Format [ITU-ICC]
    maName String string Ma Name ---
    ccmInterval String string Ccm Interval ---
    direction Boolean boolean MEP direction ---
    active Boolean boolean MEP Active ---
    ccmEnable Boolean boolean CCM Enabled ---
    enable Boolean boolean AIS Enabled ---
    aisLevel array[Integer] integer AIS levels list ---
    controlMepEnabled Boolean boolean Control MEP enabled ---
    ccmPriority Integer integer CCM Priority [0, 1, 2, 3, 4, 5, 6, 7]
    aisPriority Integer integer AIS priority [0, 1, 2, 3, 4, 5, 6, 7]
    aisInterval Integer integer AIS Interval [1, 60]
    interfaceType String string MEP Interface type [SAP, PATH]
    lowestPriorityDefect String string Lowest priority deffect on the MEP ['All Defects', 'MAC, Remote, Error, Xcon', 'Remote, Error, Xcon', 'Error, Xcon', 'Xcon only', 'No defects Xcon or lower']
    oamConfigured Boolean boolean isOamConfigured ---
    oamConfiguredStr String string --- ---
    tdmPluggableConfiguredStr String string --- ---
    remark String string Service Remark ---
    pmState Integer integer Performnce Monitoring report state ---
    pmStateStr String string --- ---
    pmstartTime Date DateTime Performnce Monitoring report generation starting Time ---
    pmendTime Date DateTime Performnce Monitoring report generation End Time ---
    llf Boolean boolean isLlf ---
    l2pt Boolean boolean isL2pt ---
    lacp Boolean boolean isLacp ---
    l2cp Boolean boolean Enable EPL Option 2 Tunneling ---
    vlanRangeEnabled Boolean boolean isVlanRangeEnabled ---
    mipValue String string Mip Value [Default, Explicit]
    protectionConfigured Boolean boolean isProtectionConfigured ---
    switchState String string --- ---
    proConfd String string --- ---
    pwStatusSignalEnabled String string Status Signal Enable/Disable ---
    pwControlChannelEnabled String string Control Channel Enable/Disable ---
    pwAcknowledgementEnabled String string PW Acknowledgement Enable/Disable ---
    epStandbySignallingMaster String string Stand By Signalling Master ---
    epStandbySignallingSlave String string Stand By Signalling Slave ---
    pwRefreshTimer Long long Refresh Timer in Seconds ---
    pwRequestTimer Long long Request Timer in Seconds ---
    pwRetryTimer Long long Retry Timer in Seconds ---
    pwTimeoutMultiplier Long long Timeout Multiplier in Seconds ---
    epRevertTimer Long long Revert Timer in Seconds ---
    epActiveHoldDelay Long long Active Hold Delay in deciSeconds ---
    policyId String string --- ---
    policyName String string --- ---
    ringHubName String string --- ---
    trunkSvlanId String string --- ---
    branchSvlanId String string --- ---
    eTreeType String string --- ---
    repProf15m String string 15 min PM report profile ---
    repProf24h String string 24 hour PM report profile ---
    tcaProfName String string TCA profile name to be used ---
    defaultPort Boolean boolean --- ---
    defaultNode Boolean boolean --- ---
    fragmentType String string Fragment Type [All Frames, Tagged Frames]
    ntwktechnology String string --- ---
    vlanRangeType String string --- ---
    frameTagType String string --- ---
    alarmStatus String string --- ---
    serverAlarmStatus String string --- ---
    notificationTime Long long --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    cacCheck Boolean boolean isCac ---
    pmEndTime Date DateTime Performnce Monitoring report generation End Time ---
    hubInst HubInst HubInst --- ---
    asymmetricTree Boolean boolean --- ---
    mclagEndpoint Boolean boolean --- ---
    pmStartTime Date DateTime Performnce Monitoring report generation starting Time ---
    mdlevel Integer integer Maintenance Domain Level ---
    vneInvolved Boolean boolean --- ---
    singleCardService Boolean boolean --- ---

    TSOPDecapAttributes

    Name

    Type

    Description

    Enum

    tsopDecapParamMap Object object getTsopDecapParamMap ---

    TSOPDetailDataRest

    Name

    Type

    Description

    Enum

    tsopDtlParamMap Object object getTsopDtlParamMap ---

    TSOPEncapAttributes

    Name

    Type

    Description

    Enum

    tsopEncapParamMap Object object TSOP Encap Attributes Map ---

    TSOPJitterAttributes

    Name

    Type

    Description

    Enum

    tsopJitterParamMap Object object getTsopJitterParamMap ---

    VS Pack Data

    Name

    Type

    Description

    Enum

    psd Boolean boolean --- ---
    packetSwitch Boolean boolean isPacketSwitch ---
    ehName String string EH Name ---
    psId Integer integer PSID ---
    neName String string Node Name ---
    vsNativeName String string VS Name ---
    ncName String string --- ---