Operation

post /data/eml/commandLogArchSessions/{id}
archiveSessions (archiveSessions : /data/eml/commandLogArchSessions/{id})
This is used to call the archiveSessions which comes under Administer

Path parameters

Name

IsRequired

Description

Enum

id required 'id'can be retrieved from the REST call '' ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional request ServletWebRequest ---
body2 optional session HttpSession ---
body3 optional form String ---

Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/npr/commandLogArchSessions/{id}
    archiveSessions (archiveSessions : /data/npr/commandLogArchSessions/{id})
    This is used to call the archiveSessions which comes under Administer

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 'id'can be retrieved from the REST call '' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    /data/npr/commandLogArchSessions/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.
    • text/xml
    • application/json
    Example Response Data
    { "ok": true, "id": "5", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    post /data/eml/commandLogs/{id}
    Retriving the ne with the id (commandLogAcknowleged : /data/eml/commandLogs/{id})
    This is used to retrieve the perticular commandLog details in the Administer Tab

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/npr/commandLogs/{id}
    Retriving the ne with the id (commandLogAcknowleged : /data/npr/commandLogs/{id})
    This is used to retrieve the perticular commandLog details in the Administer Tab

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    /data/npr/commandLogs/33 PayLoad: =========== {Tag: "Acknowledge"}

    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.
    • text/xml
    • application/json
    Example Response Data
    { "ok": true, "id": "756775242720737", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    get /data/asonNBI/sharedRiskGroups/{ids}/linkAsons
    get (get : /data/asonNBI/sharedRiskGroups/{ids}/linkAsons)
    get


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/eml/sharedRiskGroups/{ids}/linkAsons
    get (get : /data/eml/sharedRiskGroups/{ids}/linkAsons)
    get


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/eml/{table}
    Retrieves the objects in the given table (get : /data/eml/{table})
    /data/npr/{table} $$ This call is used to retrieve the following objects - Network Element,Node,Physical Connection,Contol Plane Domain,Shared Risk Group,ThreeR,Trail,OTN Capacity. The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR, 'trails' for Trail and 'wdmPorts' to get port details and 'otnCapacities' for OTN Capacity ^^ /data/npr/{table}/{ids} $$ This call used to retrieve a specific object in a given table.The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR,'trails' for Trail and 'otnCapacities' for OTN Capacity. The value 'ids' can be retrieved from the field 'id' of any element retrieved from the given table from the call /data/npr/{table}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/eml/{table}/{ids}
    Retrieves the objects in the given table (get : /data/eml/{table}/{ids})
    /data/npr/{table} $$ This call is used to retrieve the following objects - Network Element,Node,Physical Connection,Contol Plane Domain,Shared Risk Group,ThreeR,Trail,OTN Capacity. The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR, 'trails' for Trail and 'wdmPorts' to get port details and 'otnCapacities' for OTN Capacity ^^ /data/npr/{table}/{ids} $$ This call used to retrieve a specific object in a given table.The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR,'trails' for Trail and 'otnCapacities' for OTN Capacity. The value 'ids' can be retrieved from the field 'id' of any element retrieved from the given table from the call /data/npr/{table}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/eml/{table}/{ids}/{table2}
    Retrieves the objects in the given table (get : /data/eml/{table}/{ids}/{table2})
    /data/npr/{table} $$ This call is used to retrieve the following objects - Network Element,Node,Physical Connection,Contol Plane Domain,Shared Risk Group,ThreeR,Trail,OTN Capacity. The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR, 'trails' for Trail and 'wdmPorts' to get port details and 'otnCapacities' for OTN Capacity ^^ /data/npr/{table}/{ids} $$ This call used to retrieve a specific object in a given table.The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR,'trails' for Trail and 'otnCapacities' for OTN Capacity. The value 'ids' can be retrieved from the field 'id' of any element retrieved from the given table from the call /data/npr/{table}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/eml/{table}/{ids}/{table2}/{ids2}
    Retrieves the objects in the given table (get : /data/eml/{table}/{ids}/{table2}/{ids2})
    /data/npr/{table} $$ This call is used to retrieve the following objects - Network Element,Node,Physical Connection,Contol Plane Domain,Shared Risk Group,ThreeR,Trail,OTN Capacity. The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR, 'trails' for Trail and 'wdmPorts' to get port details and 'otnCapacities' for OTN Capacity ^^ /data/npr/{table}/{ids} $$ This call used to retrieve a specific object in a given table.The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR,'trails' for Trail and 'otnCapacities' for OTN Capacity. The value 'ids' can be retrieved from the field 'id' of any element retrieved from the given table from the call /data/npr/{table}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/npr/sharedRiskGroups/{ids}/linkAsons
    get (get : /data/npr/sharedRiskGroups/{ids}/linkAsons)
    get


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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 /data/npr/{table}
    Retrieves the objects in the given table (get : /data/npr/{table})
    This call is used to retrieve the following objects - Network Element,Node,Physical Connection,Contol Plane Domain,Shared Risk Group,ThreeR,Trail,OTN Capacity. The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR, 'trails' for Trail and 'wdmPorts' to get port details and 'otnCapacities' for OTN Capacity

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/{table} Example 1) /data/npr/nes 2) /data/npr/physicalConns 3) /data/npr/sharedRiskGroups 4) /data/npr/colorProfiles 5) /data/npr/aSAProfiles 6) /data/npr/trails 7) /data/npr/nodes

    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
    Response 1 --> [ { "ObjectId": null, "EventType": null, "ClassType": null, "IdClass": 3, "accessModule": "AccessModule_none", "alarmStatus": "AlarmStatus_cleared", "alarmSyntesis": "AlarmStatus_cleared", "alarmsEnabled": "ExtBoolean_true", "alarmsEnabledLP": "ExtBoolean_true", "alignAct": "AlignAct_notApplicable", "alignActPend": "AlignAct_notApplicable", "alrAligned": "ExtBoolean_true", "alrAlignment": "AlrAlignment_normal", "asonCtrPlaneType": "AsonCtrPlaneType_notApplicable", "assignSt": "AssignmentState_observed", "associatedNode": 1, "associatedNodeId": 51, "autoAlarmSyncro": "EnablingState_disabled", "availableCapNum": 0, "cTAccessStatus": "CTAccessStatus_notProvided", "comments": null, "communicationState": "CommState_available", "confDownldSt": "ConfDownloadState_enabled", "confMismatchObjsCount": 0, "confType": "ConfType_notMeaningful", "consistPhase": "ConsistPhase_allLayersProcessed", "consistSt": "ConsistencyStatus_normal", "controlPlaneStatus": "ControlPlaneStatus_notPresent", "creationDate": null, "dbModByCT": "Boolean_false", "emlDomId": 0, "emlNeId": null, "emlNeType": null, "ethSupported": "ExtBoolean_true", "failToAlignObjsCount": 0, "fdnMapper": "0/49", "fdnMapperNum": null, "ipAddress": null, "isPrimaryNE": "Boolean_true", "mainNTPAddress": null, "managedInterfaces": "MngInterface_notMeaningful", "managerList": null, "mibAlignmentState": "MibAlignmentState_notProvided", "nadString": "unknown", "namingMask": null, "neAlignment": "Alignment_normal", "neCommProb": "CommProb_none", "neFamily": "Ext Ntw", "id": 49, "key": "Ne/49", "className": "Ne", "neNotEmlAligned": "AlignmentState_aligned", "neSubType": "NeSubtype_notMeaningful", "neType": "NEType_virtualNe", "notAlignObjsCount": 0, "ntpEnabled": "Boolean_true", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "partnerNEGroupId": null, "partnerNEIP": null, "partnerNEId": null, "pdhSupported": "ExtBoolean_true", "pmMisalignment": "Boolean_false", "primLogin": null, "primPassword": null, "primaryOperationalState": "OperationalState_enabled", "productName": "External Network", "radioSupported": "ExtBoolean_true", "reachable": "Boolean_true", "resetSt": "ResetState_reset", "sdhSupported": "ExtBoolean_true", "secondaryAddress": null, "secondaryOpState": "OperationalState_notMeaningful", "securComm": null, "shortProductName": "Ext Ntw", "siteName": "BA", "snmpVersion": null, "snmpv2ReadComm": null, "snmpv2WriteComm": null, "snmpv3AuthMethod": null, "snmpv3PrivMethod": null, "snmpv3SecLevel": null, "snmpv3UsmAuthPwd": null, "snmpv3UsmPrivPwd": null, "snmpv3UsmUser": null, "sonetSupported": "ExtBoolean_true", "spareNTPAddress": null, "ssh2PublicKeyFile": null, "ssh2User": null, "supervisionState": "SupervisionState_notProvided", "supportedConnectId": null, "tid": null, "traffAffectNotAlignCount": 0, "tsdImVersion": "Not_TSD_IM_NE", "uploadSt": "UploadStatus_normal", "guiLabel": "L0_U1_VNE2", "version": "9.9", "wdmManagement": "WdmManager_sdhAppl", "wdmSupported": "ExtBoolean_true", "wrkSt": "WorkingState_normal" }, { "ObjectId": null, "EventType": null, "ClassType": null, "IdClass": 3, "accessModule": "AccessModule_none", "alarmStatus": "AlarmStatus_cleared", "alarmSyntesis": "AlarmStatus_cleared", "alarmsEnabled": "ExtBoolean_true", "alarmsEnabledLP": "ExtBoolean_true", "alignAct": "AlignAct_notApplicable", "alignActPend": "AlignAct_notApplicable", "alrAligned": "ExtBoolean_true", "alrAlignment": "AlrAlignment_normal", "asonCtrPlaneType": "AsonCtrPlaneType_notApplicable", "assignSt": "AssignmentState_observed", "associatedNode": 1, "associatedNodeId": 52, "autoAlarmSyncro": "EnablingState_disabled", "availableCapNum": 0, "cTAccessStatus": "CTAccessStatus_notProvided", "comments": null, "communicationState": "CommState_available", "confDownldSt": "ConfDownloadState_enabled", "confMismatchObjsCount": 0, "confType": "ConfType_notMeaningful", "consistPhase": "ConsistPhase_allLayersProcessed", "consistSt": "ConsistencyStatus_normal", "controlPlaneStatus": "ControlPlaneStatus_notPresent", "creationDate": null, "dbModByCT": "Boolean_false", "emlDomId": 0, "emlNeId": null, "emlNeType": null, "ethSupported": "ExtBoolean_true", "failToAlignObjsCount": 0, "fdnMapper": "0/50", "fdnMapperNum": null, "ipAddress": null, "isPrimaryNE": "Boolean_true", "mainNTPAddress": null, "managedInterfaces": "MngInterface_notMeaningful", "managerList": null, "mibAlignmentState": "MibAlignmentState_notProvided", "nadString": "unknown", "namingMask": null, "neAlignment": "Alignment_normal", "neCommProb": "CommProb_none", "neFamily": "Ext Ntw", "id": 50, "key": "Ne/50", "className": "Ne", "neNotEmlAligned": "AlignmentState_aligned", "neSubType": "NeSubtype_notMeaningful", "neType": "NEType_virtualNe", "notAlignObjsCount": 0, "ntpEnabled": "Boolean_true", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "partnerNEGroupId": null, "partnerNEIP": null, "partnerNEId": null, "pdhSupported": "ExtBoolean_true", "pmMisalignment": "Boolean_false", "primLogin": null, "primPassword": null, "primaryOperationalState": "OperationalState_enabled", "productName": "External Network", "radioSupported": "ExtBoolean_true", "reachable": "Boolean_true", "resetSt": "ResetState_reset", "sdhSupported": "ExtBoolean_true", "secondaryAddress": null, "secondaryOpState": "OperationalState_notMeaningful", "securComm": null, "shortProductName": "Ext Ntw", "siteName": "BA", "snmpVersion": null, "snmpv2ReadComm": null, "snmpv2WriteComm": null, "snmpv3AuthMethod": null, "snmpv3PrivMethod": null, "snmpv3SecLevel": null, "snmpv3UsmAuthPwd": null, "snmpv3UsmPrivPwd": null, "snmpv3UsmUser": null, "sonetSupported": "ExtBoolean_true", "spareNTPAddress": null, "ssh2PublicKeyFile": null, "ssh2User": null, "supervisionState": "SupervisionState_notProvided", "supportedConnectId": null, "tid": null, "traffAffectNotAlignCount": 0, "tsdImVersion": "Not_TSD_IM_NE", "uploadSt": "UploadStatus_normal", "guiLabel": "A_VNE", "version": "9.9", "wdmManagement": "WdmManager_sdhAppl", "wdmSupported": "ExtBoolean_true", "wrkSt": "WorkingState_normal" } ] Response 2 --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "aTozSpanLoss": "15.24", "aTozSpanLossL": "NA", "alarmStatus": "AlarmStatus_cleared", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_wdm", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 7, "key": "PhysicalConn/7", "className": "PhysicalConn", "currentFrequency": null, "defTime": "1466352782000", "direction": "Direction_bidirectional", "implSt": "ImplementationState_implemented", "latency": 0, "linkType": "LinkType_rm_internal", "linkUtilRatio": 0 "linkUtilThreshold": 30 "operationalState": "OperationalState_enabled", "otdrScanStatus": "ScanStatus_notMeaningful", "otdrSupported": "Boolean_false", "otnMapper": null, "otuSignalType": "OtuSignalType_otu2", "overlaySupport": "ExtBoolean_true", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_simple", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "INDER-PSS1/CWR-7-16-CLS7-INDER-PSS1#OCS/OCH-1-1-34-1", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-34-1/WDM", "zToaSpanLoss": "14.88", "zToaSpanLossL": "NA", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/SFD-25-1-9365", "aTozSpanLoss": "15.24", "aTozSpanLossL": "NA", "alarmStatus": "AlarmStatus_cleared", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_wdm", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 12, "key": "PhysicalConn/12", "className": "PhysicalConn", "currentFrequency": "193.65", "defTime": "1466352784000", "direction": "Direction_bidirectional", "implSt": "ImplementationState_implemented", "latency": 0, "linkType": "LinkType_rm_internal", "linkUtilRatio": 0 "linkUtilThreshold": 30 "operationalState": "OperationalState_enabled", "otdrScanStatus": "ScanStatus_notMeaningful", "otdrSupported": "Boolean_false", "otnMapper": null, "otuSignalType": "OtuSignalType_otu4", "overlaySupport": "ExtBoolean_true", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_simple", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "INDER-PSS1/SFD-25-1-9365-INDER-PSS1#OCS/OCH-1-1-36-1", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-36-1/WDM", "zToaSpanLoss": "14.88", "zToaSpanLossL": "NA", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ] Response 3 --> [ { "IdClass": 125, "aSite": null, "srgComment": null, "id": 2, "key": "SharedRiskGroup/2", "className": "SharedRiskGroup", "srgProbability": "SrgProb_high", "srgType": "SrgType_cable", "guiLabel": "test1", "zSite": null }, { "IdClass": 125, "aSite": null, "srgComment": null, "id": 1, "key": "SharedRiskGroup/1", "className": "SharedRiskGroup", "srgProbability": "SrgProb_high", "srgType": "SrgType_cable", "guiLabel": "test", "zSite": null } ] Response 4 --> [ { "IdClass": 180, "id": 1, "key": "ColorProfile/1", "className": "ColorProfile", "colorString": "0000.0000.0000.0000.0000.0000.0000", "colors": 0, "comment1": "Neutral profile without colors", "owner": "OperationalRule_automatic", "guiLabel": "NoColor" }, { "IdClass": 180, "id": 2, "key": "ColorProfile/2", "className": "ColorProfile", "colorString": "1111.1111.1111.1111.1111.1111.1111", "colors": 268435455, "comment1": "Profile with all 28 colors, used as default for exclude any vector", "owner": "OperationalRule_automatic", "guiLabel": "AllColors" } ] Response 5 --> [ { "IdClass": 86, "activeDegrTrsProb": "AlarmSevCode_warning", "activeFailedApeFailed": "AlarmSevCode_major", "activeFailedCxProb": "AlarmSevCode_major", "activeFailedEndPtFlr": "AlarmSevCode_major", "activeFailedPreempt": "AlarmSevCode_major", "activeFailedTrsProb": "AlarmSevCode_major", "activeFailedUnprot": "AlarmSevCode_major", "apeInProgress": "AlarmSevCode_minor", "aprLine": "AlarmSevCode_major", "aprUnavailable": "AlarmSevCode_major", "id": 0, "key": "ASAProfile/0", "className": "ASAProfile", "bandWidthReduced": "AlarmSevCode_minor", "channelAssigViolation": "AlarmSevCode_minor", "colorViolation": "AlarmSevCode_minor", "confMismatch": "AlarmSevCode_major", "connectivityProblem": "AlarmSevCode_major", "cpCommInterfaceProb": "AlarmSevCode_minor", "dcnFailure": "AlarmSevCode_warning", "degSignal": "AlarmSevCode_warning", "degradedProtection": "AlarmSevCode_warning", "earlyWarning": "AlarmSevCode_warning", "equipmentFailure": "AlarmSevCode_major", "exBer": "AlarmSevCode_major", "failedToAlignConsistSt": "AlarmSevCode_minor", "fecTca15m": "AlarmSevCode_minor", "fecTca24h": "AlarmSevCode_minor", "gainOutOfPlannedRange": "AlarmSevCode_warning", "gfpProtocolError": "AlarmSevCode_major", "gmreAutoRestDisabled": "AlarmSevCode_minor", "gmreDegraded": "AlarmSevCode_minor", "gmreInMigration": "AlarmSevCode_minor", "hdslFailure": "AlarmSevCode_warning", "highBER": "AlarmSevCode_major", "incomingFail": "AlarmSevCode_major", "incomingVlanSncFail": "AlarmSevCode_minor", "latencyViolation": "AlarmSevCode_warning", "lcasExceedDiffDelay": "AlarmSevCode_major", "lcasProtocolError": "AlarmSevCode_major", "linkDegradation": "AlarmSevCode_warning", "linkDiversityViolation": "AlarmSevCode_warning", "linkFailure": "AlarmSevCode_major", "lossOfPayload": "AlarmSevCode_major", "mSConfMismatch": "AlarmSevCode_major", "mediaFailure": "AlarmSevCode_major", "nominalUnvCommProblem": "AlarmSevCode_warning", "nominalUnvConfProblem": "AlarmSevCode_warning", "nominalUnvIndProblem": "AlarmSevCode_warning", "nominalUnvRevPreempt": "AlarmSevCode_warning", "nominalUnvTPBlocked": "AlarmSevCode_warning", "nominalUnvTransProblem": "AlarmSevCode_warning", "notAlignedConsistSt": "AlarmSevCode_warning", "notInUse01": "AlarmSevCode_major", "notInUse02": "AlarmSevCode_minor", "notInUse03": "AlarmSevCode_warning", "optIntrusionMonSusp": "AlarmSevCode_warning", "optLaneHighTC": "AlarmSevCode_minor", "optLaneLowTC": "AlarmSevCode_minor", "optPowerOutOfRange": "AlarmSevCode_minor", "opticalFeasViolation": "AlarmSevCode_minor", "opticalIntrusion": "AlarmSevCode_warning", "opticalParamFileError": "AlarmSevCode_minor", "oscFailure": "AlarmSevCode_warning", "otsEquipmentFail": "AlarmSevCode_major", "outgoingFail": "AlarmSevCode_major", "outgoingVlanSncFail": "AlarmSevCode_minor", "pdhFailure": "AlarmSevCode_warning", "powerFailure": "AlarmSevCode_minor", "qualityTC15": "AlarmSevCode_minor", "qualityTC24": "AlarmSevCode_minor", "rSFailure": "AlarmSevCode_major", "radioFailure": "AlarmSevCode_major", "reducedOCHConn": "AlarmSevCode_warning", "rerouteNotPossible": "AlarmSevCode_major", "sdhFailure": "AlarmSevCode_major", "serverMediaFailure": "AlarmSevCode_major", "sncActiveUnavailable": "AlarmSevCode_minor", "sncAutoRestDisabled": "AlarmSevCode_minor", "sncBackupUnavailable": "AlarmSevCode_warning", "sncFailedZEnd": "AlarmSevCode_minor", "sncFailure": "AlarmSevCode_minor", "sncReadyToRevert": "AlarmSevCode_warning", "sncRerouted": "AlarmSevCode_warning", "sncReversionBlocked": "AlarmSevCode_minor", "sncSncpDegraded": "AlarmSevCode_warning", "softRerouteInProgress": "AlarmSevCode_warning", "srgViolation": "AlarmSevCode_warning", "switchActive": "AlarmSevCode_warning", "tcDegSignal": "AlarmSevCode_warning", "tcFailure": "AlarmSevCode_major", "tcIncomingFail": "AlarmSevCode_minor", "tcOutgoingFail": "AlarmSevCode_minor", "tcTca15m": "AlarmSevCode_minor", "tcTca24h": "AlarmSevCode_minor", "tcaChannelMargin": "AlarmSevCode_minor", "testModeEnabled": "AlarmSevCode_warning", "thresholdCorrErr": "AlarmSevCode_minor", "transpIncomingLocked": "AlarmSevCode_major", "transpLocked": "AlarmSevCode_major", "transpOutgoingLocked": "AlarmSevCode_major", "tuningDegradation": "AlarmSevCode_warning", "underProtDegr": "AlarmSevCode_warning", "guiLabel": "default ASAP", "vlanSncFail": "AlarmSevCode_minor", "wavekeyIssue": "AlarmSevCode_warning" } ] Response 6 --> [ { "IdClass": 28, "a2EndClSlotNum": null, "a2EndPortId": null, "a2EndPortLabel": null, "a2EndTS": null, "a2EndTSGran": "TsGranularity_notMeaningful", "aEndClSlotNum": null, "aEndPortId": 562, "aEndPortLabel": "INDER-PSS3#OCS/GBE-1-1-44-13", "aEndTS": null, "aEndTSGran": "TsGranularity_notMeaningful", "aWdmFrequency": null, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "asonProtection": "ProtectionPathType_notProtected", "backupSt": "BackupSt_normal", "clientDependency": "ClientDependency_clientPorts", "confSt": "ConfigurationState_implemented", "defaultPriority": 4, "defaultRerouting": "RestorationMode_onTheFly", "defaultReversionMode": "ReversionMode_manual", "defaultSetupPriority": 5, "disjointedSt": "DisjointedSt_normal", "endToEndOtnTrailId": 349, "endToEndOtnTrailLabel": "inder-s3s4-44-13 ODU0#0", "excludeAnyColorId": 2, "excludeAnyColorName": "AllColors", "excludeAnyColorString": "1111.1111.1111.1111.1111.1111.1111", "gmreLabel": "inder-s3s4-44-13 ODU0#0Main 01", "includeAnyColorId": 1, "includeAnyColorName": "NoColor", "includeAnyColorString": "0000.0000.0000.0000.0000.0000.0000", "maxLatency": 0, "nativeName": "EMS:10.255.2.161\\MultiLayerSubnetwork:0\\SubnetworkConnection:1", "nodeId": 5, "npaId": 1, "npaLabel": "L1CP", "operationalState": "OperationalState_enabled", "priority": 4, "protType": "ProtectionPathType_notProtected", "protectionGroup": 0, "rerouting": "RestorationMode_onTheFly", "reversionBlockedSt": "ReversionBlockedSt_notBlocked", "reversionMode": "ReversionMode_manual", "reversionSt": "ReversionSt_notReady", "routingSt": "RoutingSt_normal", "sbnConnShape": "ConnShape_iShape", "serviceState": "ServiceState_notInService", "setupPriority": 5, "sncId": 1781, "sncType": "SncType_softPermanentConn", "sncpSwitchSt": "SNCPSwitchStatus_noSwitchForced", "tSlotGranularity": "TsGranularity_notMeaningful", "tcmLevel": "TcmLevel_noTcm", "testMode": "SncActiveState_inactive", "text1": null, "text2": null, "text3": null, "id": 1745, "key": "Trail/1745", "className": "Trail", "trailWrkSt": "TrsWrkState_normal", "transportNtw": "TransportNtwType_electric", "tunnelType": "TunnelType_notApplicable", "guiLabel": "inder-s3s4-44-13 ODU0#0Main", "waitForServerRestoration": "ExtBoolean_false", "wdmTrailLayer": "WdmTrailLayer_odu0", "z2EndClSlotNum": null, "z2EndPortId": null, "z2EndPortLabel": null, "z2EndTS": null, "z2EndTSGran": "TsGranularity_notMeaningful", "zEndClSlotNum": null, "zEndPortId": 4, "zEndPortLabel": "INDER-PSS4#OCS/GBE-1-1-44-13", "zEndTS": null, "zEndTSGran": "TsGranularity_notMeaningful", "zWdmFrequency": null } ]

    External Docs
    See Also :

    Operation

    get /data/npr/{table}/{ids}
    Retrieves the objects in the given table (get : /data/npr/{table}/{ids})
    This call used to retrieve a specific object in a given table.The values '{table}' can take are 'nes' for Network Element, 'nodes' for Nodes, 'physicalConns' for Physical Connection, 'controlPlaneDomains' for Contol Plane Domain, 'sharedRiskGroups' for Shared Risk Group, 'threeRs' for ThreeR,'trails' for Trail and 'otnCapacities' for OTN Capacity. The value 'ids' can be retrieved from the field 'id' of any element retrieved from the given table from the call /data/npr/{table}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    table required Table/Object for which data is required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/{table}/{ids} Example 1) /data/npr/nes/49 2) /data/npr/physicalConns/12 3) /data/npr/sharedRiskGroups/1 4) /data/npr/colorProfiles/1 5) /data/npr/aSAProfiles/0 6) /data/npr/trails/1745

    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
    Response 1 --> [ { "ObjectId": null, "EventType": null, "ClassType": null, "IdClass": 3, "accessModule": "AccessModule_none", "alarmStatus": "AlarmStatus_cleared", "alarmSyntesis": "AlarmStatus_cleared", "alarmsEnabled": "ExtBoolean_true", "alarmsEnabledLP": "ExtBoolean_true", "alignAct": "AlignAct_notApplicable", "alignActPend": "AlignAct_notApplicable", "alrAligned": "ExtBoolean_true", "alrAlignment": "AlrAlignment_normal", "asonCtrPlaneType": "AsonCtrPlaneType_notApplicable", "assignSt": "AssignmentState_observed", "associatedNode": 1, "associatedNodeId": 51, "autoAlarmSyncro": "EnablingState_disabled", "availableCapNum": 0, "cTAccessStatus": "CTAccessStatus_notProvided", "comments": null, "communicationState": "CommState_available", "confDownldSt": "ConfDownloadState_enabled", "confMismatchObjsCount": 0, "confType": "ConfType_notMeaningful", "consistPhase": "ConsistPhase_allLayersProcessed", "consistSt": "ConsistencyStatus_normal", "controlPlaneStatus": "ControlPlaneStatus_notPresent", "creationDate": null, "dbModByCT": "Boolean_false", "emlDomId": 0, "emlNeId": null, "emlNeType": null, "ethSupported": "ExtBoolean_true", "failToAlignObjsCount": 0, "fdnMapper": "0/49", "fdnMapperNum": null, "ipAddress": null, "isPrimaryNE": "Boolean_true", "mainNTPAddress": null, "managedInterfaces": "MngInterface_notMeaningful", "managerList": null, "mibAlignmentState": "MibAlignmentState_notProvided", "nadString": "unknown", "namingMask": null, "neAlignment": "Alignment_normal", "neCommProb": "CommProb_none", "neFamily": "Ext Ntw", "id": 49, "key": "Ne/49", "className": "Ne", "neNotEmlAligned": "AlignmentState_aligned", "neSubType": "NeSubtype_notMeaningful", "neType": "NEType_virtualNe", "notAlignObjsCount": 0, "ntpEnabled": "Boolean_true", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "partnerNEGroupId": null, "partnerNEIP": null, "partnerNEId": null, "pdhSupported": "ExtBoolean_true", "pmMisalignment": "Boolean_false", "primLogin": null, "primPassword": null, "primaryOperationalState": "OperationalState_enabled", "productName": "External Network", "radioSupported": "ExtBoolean_true", "reachable": "Boolean_true", "resetSt": "ResetState_reset", "sdhSupported": "ExtBoolean_true", "secondaryAddress": null, "secondaryOpState": "OperationalState_notMeaningful", "securComm": null, "shortProductName": "Ext Ntw", "siteName": "BA", "snmpVersion": null, "snmpv2ReadComm": null, "snmpv2WriteComm": null, "snmpv3AuthMethod": null, "snmpv3PrivMethod": null, "snmpv3SecLevel": null, "snmpv3UsmAuthPwd": null, "snmpv3UsmPrivPwd": null, "snmpv3UsmUser": null, "sonetSupported": "ExtBoolean_true", "spareNTPAddress": null, "ssh2PublicKeyFile": null, "ssh2User": null, "supervisionState": "SupervisionState_notProvided", "supportedConnectId": null, "tid": null, "traffAffectNotAlignCount": 0, "tsdImVersion": "Not_TSD_IM_NE", "uploadSt": "UploadStatus_normal", "guiLabel": "L0_U1_VNE2", "version": "9.9", "wdmManagement": "WdmManager_sdhAppl", "wdmSupported": "ExtBoolean_true", "wrkSt": "WorkingState_normal" } ] Response 2 --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/SFD-25-1-9365", "alarmStatus": "AlarmStatus_cleared", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_wdm", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 12, "key": "PhysicalConn/12", "className": "PhysicalConn", "currentFrequency": "193.65", "defTime": "1466352784000", "direction": "Direction_bidirectional", "implSt": "ImplementationState_implemented", "latency": 0, "linkType": "LinkType_rm_internal", "operationalState": "OperationalState_enabled", "otdrScanStatus": "ScanStatus_notMeaningful", "otdrSupported": "Boolean_false", "otnMapper": null, "otuSignalType": "OtuSignalType_otu4", "overlaySupport": "ExtBoolean_true", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_simple", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "INDER-PSS1/SFD-25-1-9365-INDER-PSS1#OCS/OCH-1-1-36-1", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-36-1/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ] Response 3 --> [ { "IdClass": 125, "aSite": null, "srgComment": null, "id": 1, "key": "SharedRiskGroup/1", "className": "SharedRiskGroup", "srgProbability": "SrgProb_high", "srgType": "SrgType_cable", "guiLabel": "test", "zSite": null } ] Response 4 --> [ { "IdClass": 180, "id": 1, "key": "ColorProfile/1", "className": "ColorProfile", "colorString": "0000.0000.0000.0000.0000.0000.0000", "colors": 0, "comment1": "Neutral profile without colors", "owner": "OperationalRule_automatic", "guiLabel": "NoColor" } ] Response 5 --> [ { "IdClass": 86, "activeDegrTrsProb": "AlarmSevCode_warning", "activeFailedApeFailed": "AlarmSevCode_major", "activeFailedCxProb": "AlarmSevCode_major", "activeFailedEndPtFlr": "AlarmSevCode_major", "activeFailedPreempt": "AlarmSevCode_major", "activeFailedTrsProb": "AlarmSevCode_major", "activeFailedUnprot": "AlarmSevCode_major", "apeInProgress": "AlarmSevCode_minor", "aprLine": "AlarmSevCode_major", "aprUnavailable": "AlarmSevCode_major", "id": 0, "key": "ASAProfile/0", "className": "ASAProfile", "bandWidthReduced": "AlarmSevCode_minor", "channelAssigViolation": "AlarmSevCode_minor", "colorViolation": "AlarmSevCode_minor", "confMismatch": "AlarmSevCode_major", "connectivityProblem": "AlarmSevCode_major", "cpCommInterfaceProb": "AlarmSevCode_minor", "dcnFailure": "AlarmSevCode_warning", "degSignal": "AlarmSevCode_warning", "degradedProtection": "AlarmSevCode_warning", "earlyWarning": "AlarmSevCode_warning", "equipmentFailure": "AlarmSevCode_major", "exBer": "AlarmSevCode_major", "failedToAlignConsistSt": "AlarmSevCode_minor", "fecTca15m": "AlarmSevCode_minor", "fecTca24h": "AlarmSevCode_minor", "gainOutOfPlannedRange": "AlarmSevCode_warning", "gfpProtocolError": "AlarmSevCode_major", "gmreAutoRestDisabled": "AlarmSevCode_minor", "gmreDegraded": "AlarmSevCode_minor", "gmreInMigration": "AlarmSevCode_minor", "hdslFailure": "AlarmSevCode_warning", "highBER": "AlarmSevCode_major", "incomingFail": "AlarmSevCode_major", "incomingVlanSncFail": "AlarmSevCode_minor", "latencyViolation": "AlarmSevCode_warning", "lcasExceedDiffDelay": "AlarmSevCode_major", "lcasProtocolError": "AlarmSevCode_major", "linkDegradation": "AlarmSevCode_warning", "linkDiversityViolation": "AlarmSevCode_warning", "linkFailure": "AlarmSevCode_major", "lossOfPayload": "AlarmSevCode_major", "mSConfMismatch": "AlarmSevCode_major", "mediaFailure": "AlarmSevCode_major", "nominalUnvCommProblem": "AlarmSevCode_warning", "nominalUnvConfProblem": "AlarmSevCode_warning", "nominalUnvIndProblem": "AlarmSevCode_warning", "nominalUnvRevPreempt": "AlarmSevCode_warning", "nominalUnvTPBlocked": "AlarmSevCode_warning", "nominalUnvTransProblem": "AlarmSevCode_warning", "notAlignedConsistSt": "AlarmSevCode_warning", "notInUse01": "AlarmSevCode_major", "notInUse02": "AlarmSevCode_minor", "notInUse03": "AlarmSevCode_warning", "optIntrusionMonSusp": "AlarmSevCode_warning", "optLaneHighTC": "AlarmSevCode_minor", "optLaneLowTC": "AlarmSevCode_minor", "optPowerOutOfRange": "AlarmSevCode_minor", "opticalFeasViolation": "AlarmSevCode_minor", "opticalIntrusion": "AlarmSevCode_warning", "opticalParamFileError": "AlarmSevCode_minor", "oscFailure": "AlarmSevCode_warning", "otsEquipmentFail": "AlarmSevCode_major", "outgoingFail": "AlarmSevCode_major", "outgoingVlanSncFail": "AlarmSevCode_minor", "pdhFailure": "AlarmSevCode_warning", "powerFailure": "AlarmSevCode_minor", "qualityTC15": "AlarmSevCode_minor", "qualityTC24": "AlarmSevCode_minor", "rSFailure": "AlarmSevCode_major", "radioFailure": "AlarmSevCode_major", "reducedOCHConn": "AlarmSevCode_warning", "rerouteNotPossible": "AlarmSevCode_major", "sdhFailure": "AlarmSevCode_major", "serverMediaFailure": "AlarmSevCode_major", "sncActiveUnavailable": "AlarmSevCode_minor", "sncAutoRestDisabled": "AlarmSevCode_minor", "sncBackupUnavailable": "AlarmSevCode_warning", "sncFailedZEnd": "AlarmSevCode_minor", "sncFailure": "AlarmSevCode_minor", "sncReadyToRevert": "AlarmSevCode_warning", "sncRerouted": "AlarmSevCode_warning", "sncReversionBlocked": "AlarmSevCode_minor", "sncSncpDegraded": "AlarmSevCode_warning", "softRerouteInProgress": "AlarmSevCode_warning", "srgViolation": "AlarmSevCode_warning", "switchActive": "AlarmSevCode_warning", "tcDegSignal": "AlarmSevCode_warning", "tcFailure": "AlarmSevCode_major", "tcIncomingFail": "AlarmSevCode_minor", "tcOutgoingFail": "AlarmSevCode_minor", "tcTca15m": "AlarmSevCode_minor", "tcTca24h": "AlarmSevCode_minor", "tcaChannelMargin": "AlarmSevCode_minor", "testModeEnabled": "AlarmSevCode_warning", "thresholdCorrErr": "AlarmSevCode_minor", "transpIncomingLocked": "AlarmSevCode_major", "transpLocked": "AlarmSevCode_major", "transpOutgoingLocked": "AlarmSevCode_major", "tuningDegradation": "AlarmSevCode_warning", "underProtDegr": "AlarmSevCode_warning", "guiLabel": "default ASAP", "vlanSncFail": "AlarmSevCode_minor", "wavekeyIssue": "AlarmSevCode_warning" } ] Response 6 --> [ { "IdClass": 28, "a2EndClSlotNum": null, "a2EndPortId": null, "a2EndPortLabel": null, "a2EndTS": null, "a2EndTSGran": "TsGranularity_notMeaningful", "aEndClSlotNum": null, "aEndPortId": 562, "aEndPortLabel": "INDER-PSS3#OCS/GBE-1-1-44-13", "aEndTS": null, "aEndTSGran": "TsGranularity_notMeaningful", "aWdmFrequency": null, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "asonProtection": "ProtectionPathType_notProtected", "backupSt": "BackupSt_normal", "clientDependency": "ClientDependency_clientPorts", "confSt": "ConfigurationState_implemented", "defaultPriority": 4, "defaultRerouting": "RestorationMode_onTheFly", "defaultReversionMode": "ReversionMode_manual", "defaultSetupPriority": 5, "disjointedSt": "DisjointedSt_normal", "endToEndOtnTrailId": 349, "endToEndOtnTrailLabel": "inder-s3s4-44-13 ODU0#0", "excludeAnyColorId": 2, "excludeAnyColorName": "AllColors", "excludeAnyColorString": "1111.1111.1111.1111.1111.1111.1111", "gmreLabel": "inder-s3s4-44-13 ODU0#0Main 01", "includeAnyColorId": 1, "includeAnyColorName": "NoColor", "includeAnyColorString": "0000.0000.0000.0000.0000.0000.0000", "maxLatency": 0, "nativeName": "EMS:10.255.2.161\\MultiLayerSubnetwork:0\\SubnetworkConnection:1", "nodeId": 5, "npaId": 1, "npaLabel": "L1CP", "operationalState": "OperationalState_enabled", "priority": 4, "protType": "ProtectionPathType_notProtected", "protectionGroup": 0, "rerouting": "RestorationMode_onTheFly", "reversionBlockedSt": "ReversionBlockedSt_notBlocked", "reversionMode": "ReversionMode_manual", "reversionSt": "ReversionSt_notReady", "routingSt": "RoutingSt_normal", "sbnConnShape": "ConnShape_iShape", "serviceState": "ServiceState_notInService", "setupPriority": 5, "sncId": 1781, "sncType": "SncType_softPermanentConn", "sncpSwitchSt": "SNCPSwitchStatus_noSwitchForced", "tSlotGranularity": "TsGranularity_notMeaningful", "tcmLevel": "TcmLevel_noTcm", "testMode": "SncActiveState_inactive", "text1": null, "text2": null, "text3": null, "id": 1745, "key": "Trail/1745", "className": "Trail", "trailWrkSt": "TrsWrkState_normal", "transportNtw": "TransportNtwType_electric", "tunnelType": "TunnelType_notApplicable", "guiLabel": "inder-s3s4-44-13 ODU0#0Main", "waitForServerRestoration": "ExtBoolean_false", "wdmTrailLayer": "WdmTrailLayer_odu0", "z2EndClSlotNum": null, "z2EndPortId": null, "z2EndPortLabel": null, "z2EndTS": null, "z2EndTSGran": "TsGranularity_notMeaningful", "zEndClSlotNum": null, "zEndPortId": 4, "zEndPortLabel": "INDER-PSS4#OCS/GBE-1-1-44-13", "zEndTS": null, "zEndTSGran": "TsGranularity_notMeaningful", "zWdmFrequency": null } ]

    External Docs
    See Also :

    Operation

    get /data/eml/blockingService
    getBlockingAsonSncList (getBlockingAsonSNCList : /data/eml/blockingService)
    This is used to get all the blockedAsonSnclist

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    ids required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/eml/commandLogs?{query}
    This is used to retrieve the command logs (getCommandLogs : /data/eml/commandLogs?{query})
    this is used to retrieve the command logs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    query required 'query' the value is used to get the command log' ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/npr/commandLogs?{query}
    This is used to retrieve the command logs (getCommandLogs : /data/npr/commandLogs?{query})
    this is used to retrieve the command logs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    query required 'query' the value is used to get the command log' ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/commandLogs /data/npr/commandLogs?operator=alcatel /data/npr/commandLogs?status=CommandStatus_Fail

    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.
    • */*
    Example Response Data
    /data/npr/commandLogs [ { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Login History", "app": "ClogApplication_PLATFORM", "client_host": "135.244.112.146", "clogPriority": "ClogPriority_low", "end_time": "1468320749000", "host": "inderOtne", "id": 278, "key": "CommandLog/278", "className": "CommandLog", "involved_object": "alcatel", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468320749000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Session open", "app": "ClogApplication_PLATFORM", "client_host": "135.244.112.146", "clogPriority": "ClogPriority_low", "end_time": "1468320583000", "host": "inderOtne", "id": 277, "key": "CommandLog/277", "className": "CommandLog", "involved_object": "nagamanm [Client user]", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468320583000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Session closed", "app": "ClogApplication_PLATFORM", "client_host": "135.250.24.238", "clogPriority": "ClogPriority_low", "end_time": "1468320040000", "host": "inderOtne", "id": 276, "key": "CommandLog/276", "className": "CommandLog", "involved_object": "nagamanm [Client user]", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468320040000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Session closed", "app": "ClogApplication_PLATFORM", "client_host": "135.250.92.78", "clogPriority": "ClogPriority_low", "end_time": "1468319869000", "host": "inderOtne", "id": 275, "key": "CommandLog/275", "className": "CommandLog", "involved_object": "iray [Client user]", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468319869000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "F_TGL_compCurrentRoute", "app": "ClogApplication_ASON", "client_host": "135.250.24.238", "clogPriority": "ClogPriority_low", "end_time": "1468316905000", "host": "inderOtne", "id": 274, "key": "CommandLog/274", "className": "CommandLog", "involved_object": "inder-s3s4-44-13 ODU0#0Main", "operator": "alcatel", "status": "CommandStatus_Fail", "subsys": "SubSystem_ASON", "utc_time": "1468316903000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "F_TGL_compNominalRoute", "app": "ClogApplication_ASON", "client_host": "135.250.24.238", "clogPriority": "ClogPriority_low", "end_time": "1468316904000", "host": "inderOtne", "id": 273, "key": "CommandLog/273", "className": "CommandLog", "involved_object": "inder-s3s4-44-13 ODU0#0Main", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_ASON", "utc_time": "1468316903000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Login History", "app": "ClogApplication_PLATFORM", "client_host": "135.250.24.238", "clogPriority": "ClogPriority_low", "end_time": "1468314946000", "host": "inderOtne", "id": 272, "key": "CommandLog/272", "className": "CommandLog", "involved_object": "alcatel", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468314946000" }, { "ack_operator": " ", "acknowledged_i": "Acknowledged_awaiting", "acknowledged_time": null, "act": "Session open", "app": "ClogApplication_PLATFORM", "client_host": "135.250.24.238", "clogPriority": "ClogPriority_low", "end_time": "1468314818000", "host": "inderOtne", "id": 271, "key": "CommandLog/271", "className": "CommandLog", "involved_object": "nagamanm [Client user]", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_SEC", "utc_time": "1468314818000" }, { "ack_operator": "Admin", "acknowledged_i": "Acknowledged_acknowledged", "acknowledged_time": "1468337868000", "act": "NtwConnCommission", "app": "ClogApplication_OTN", "client_host": "135.250.92.78", "clogPriority": "ClogPriority_low", "end_time": "1468299873000", "host": "inderOtne", "id": 269, "key": "CommandLog/269", "className": "CommandLog", "involved_object": "connName : inder-s1s2-gbe-44-2", "operator": "alcatel", "status": "CommandStatus_Success", "subsys": "SubSystem_OTN", "utc_time": "1468299871000" } ]

    External Docs
    See Also :

    Operation

    get /data/eml/routeService
    This is used to retrieve the route ason snc list (getRouteAsonSNCList : /data/eml/routeService)
    This is used to retrieve the list of the ason sncs

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    ids required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • */*

    External Docs
    See Also :
  • get : /data/npr/trails

  • Operation

    get /data/eml/nodes/{nodeId}/pathInNode
    inventory (inventory : /data/eml/nodes/{nodeId}/pathInNode)
    This is used to get the details of the trails and the pathInnode

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId' the id can be obtained from the REST data/npr/node/{nodeId}' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /data/eml/nodes/{nodeId}/trailInNode
    inventory (inventory : /data/eml/nodes/{nodeId}/trailInNode)
    This is used to get the details of the trails and the pathInnode

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId' the id can be obtained from the REST data/npr/node/{nodeId}' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /data/npr/nodes/{nodeId}/trailInNode
    inventory (inventory : /data/npr/nodes/{nodeId}/trailInNode)
    This is used to get the details of the trails and the pathInnode

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId' the id can be obtained from the REST data/npr/node/{nodeId}' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/nodes/{nodeId}/trailInNode --> /data/npr/nodes/2136/trailInNode

    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.
    • text/xml
    • application/json
    Example Response Data
    [ { "ObjectId": null, "EventType": null, "ClassType": null, "IdClass": 28, "alarmProp": "AlarmPropagation_notPerformed", "alarmStatus": "AlarmStatus_cleared", "alrPropAct": "AlmPropActivity_normal", "asapId": 0, "bitRate": null, "confSt": "ConfigurationState_implemented", "connectivity": "Connectivity_fullyConnected", "constrWdmFrequency": null, "defTime": 1467000611000, "defaultPriority": 4, "defaultRerouting": "RestorationMode_preCalculated", "defaultReversionMode": "ReversionMode_automatic", "defaultSetupPriority": 5, "excludeAnyColorId": 2, "excludeAnyColorName": "AllColors", "excludeAnyColorString": "1111.1111.1111.1111.1111.1111.1111", "holdOffTimeStatus": "HoldOffTimeStatus_noHoldOffTime", "inUseByClient": "ExtBoolean_notApplicable", "includeAnyColorId": 1, "includeAnyColorName": "NoColor", "includeAnyColorString": "0000.0000.0000.0000.0000.0000.0000", "intermCtpMon": "IntermCtpMon_disabled", "lastCmd": "TrailLastCmd_implement", "maxLatency": 0, "modificationTime": null, "operationalState": "OperationalState_enabled", "othPayloadStructure": null, "pm15": "Boolean_false", "pm24": "Boolean_false", "pm24QoS": "Boolean_false", "pmAutomatic": "Boolean_false", "pmGroup": null, "protType": "ProtectionPathType_notProtected", "protectionGroup": 0, "routeSaved": "Saved_notSaved", "routingModificationTime": null, "sdhAlarms": "EnablingAlrState_notMeaningful", "sdhAlrEnabRule": "EnablingRule_onImplementation", "serviceState": "ServiceState_notInService", "sncNumber": "SncNumber_noSnc", "sncpSwitchSt": "SNCPSwitchStatus_noSwitchForced", "tSlotGranularity": "TsGranularity_notMeaningful", "tcmLevel": "TcmLevel_noTcm", "text1": null, "text2": null, "text3": null, "toBeExported": "Boolean_false", "toBeReleased": "Boolean_false", "id": 2136, "key": "WdmTrail/2136", "className": "WdmTrail", "trailUsage": "TrailUsage_normal", "trailWrkSt": "TrsWrkState_normal", "transportNtw": "TransportNtwType_notMeaningful", "tunnelType": "TunnelType_notApplicable", "guiLabel": "NODE-C-NODE-D oms1", "virtual": "Virtual_normal", "waitForServerRestoration": "ExtBoolean_notApplicable", "wdmClientConf": "WdmClientConf_client", "wdmTrailLayer": "WdmTrailLayer_oms" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/checkDelNe/{neId}
    This is used to delete the NE (returnCheckNe : /data/eml/checkDelNe/{neId})
    This is used to delete the NE. while deleting the NE the services which are rididng over the NE should be deleted first

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required 'neId'can be retrieved from the REST call '/data/npr/nes/neId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :
  • /data/npr/ne

  • Operation

    delete /data/eml/nodes/{nodeId}
    DeleteNode (returnNeController : /data/eml/nodes/{nodeId})
    This is used to delete the Node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId'can be retrieved from the REST call '/data/npr/node/nodeId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional form String ---
    body2 optional request ServletWebRequest ---
    body3 optional session HttpSession ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /data/eml/nes
    The post method is used to post the values (returnNePostController : /data/eml/nes)
    This is used to update the values of the NE using modify function

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/nes/{neId}
    retriving the ne with the id (returnNePostWithIndexController : /data/eml/nes/{neId})
    This is used to post the values for the NE the values are SynchroniZe,Discover external physical connection,consistency

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required 'neId'can be retrieved from the REST call '/data/npr/nes/neId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/npr/nes/{neId}
    retriving the ne with the id (returnNePostWithIndexController : /data/npr/nes/{neId})
    This is used to post the values for the NE the values are SynchroniZe,Discover external physical connection,consistency

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required 'neId'can be retrieved from the REST call '/data/npr/nes/neId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/nes/{neId} --> /data/npr/nes/6 Request Payload --> { "Tag": "F_POP_neFullSyncro", "emlDomId": "100", "userLabel": "test001" } Example This is used to post the values for the NE the values are:- 1) SynchroniZe --> the values it support are NE parameters, Ports, Equipments, Alarms, Internal Links, Protection Groups, Cross Connections, Subnetwork Connections, Paths, Transmission Parameters, ASAPs, Ethernet Ports, Full Request --> /data/npr/nes/24 Response --> { "ok": true, "id": "2137202926172380", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 } 2) Discover external physical connection --> Request --> /data/npr/nes/24 Request Payload --> { "Tag": "WEBAPP_F_POP_uploadExtConn", "emlDomId": "100", "userLabel": "test001" } Response --> { "ok": true, "id": "2137727565656698", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 } 3) Consistency--> The values are Mark Audit, Notify Audit, Global Download Request --> /data/npr/nes/24 Payload Request --> { "Tag": "F_POP_TSDconsistNotifAudit", "emlDomId": "100", "userLabel": "test001" } Response --> { "ok": true, "id": "2137909462298287", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    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.
    • text/xml
    • application/json
    Example Response Data
    { "ok": true, "id": "2137909462298287", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    put /data/eml/nes
    The put method is used to update the values (returnNePutController : /data/eml/nes)
    This is used to update the values of the NE using modify function

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /data/eml/nes/{neId}
    retriving the ne with the id (returnNePutWithIndexController : /data/eml/nes/{neId})
    This is used to retrieve the perticular ne details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required 'neId'can be retrieved from the REST call '/data/npr/nes/neId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/nodes
    This post operation contains the operation such as synchronize, Discover external physical link, Supervision, Ping NE and PM (returnNodePostController : /data/eml/nodes)
    This is used to retrieve the post details of the node

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /data/eml/nodes/{nodeId}
    retriving the node with the id (returnNodePutController : /data/eml/nodes/{nodeId})
    this is used to retrieve the perticular node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId'can be retrieved from the REST call '/data/npr/node/nodeId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /data/eml/nodes/{nodeId}
    retriving the node with the id (returnPostNodeController : /data/eml/nodes/{nodeId})
    this is used to retrieve the perticular node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId'can be retrieved from the REST call '/data/npr/node/nodeId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/npr/nodes/{nodeId}
    retriving the node with the id (returnPostNodeController : /data/npr/nodes/{nodeId})
    this is used to retrieve the perticular node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId'can be retrieved from the REST call '/data/npr/node/nodeId' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/nodes/{nodeId} --> /data/npr/nodes/3 Example The nodes information can be obtained from the REST Request --> /data/npr/nodes?parentId=1%2C2%2C3 Response --> [ { "IdClass": 26, "alarmSyntesis": "AlarmStatus_cleared", "asonCtrPlaneType": "AsonCtrPlaneType_notApplicable", "associationPresent": "Boolean_false", "cTAccessStatus": "CTAccessStatus_ctConnEnab", "comment1": null, "comment2": null, "communicationState": "CommState_available", "ethPresent": "Boolean_false", "hierarchySubnet": "/2/3", "isMultiNEs": "Boolean_false", "localization": "76.06933593750438,31.283942875907968,0,null", "mibAlignmentState": "MibAlignmentState_aligned", "neAlignment": "Alignment_normal", "neSubType": "NeSubtype_notRepeater", "id": 3, "key": "Node/3", "className": "Node", "nodeType": "1830 PSS-4", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "parentId": 3, "parentLabel": "L1CP", "position": "1 662 324", "sdhPresent": "Boolean_false", "supervisionState": "SupervisionState_supervised", "guiLabel": "INDER-PSS4-01", "version": "8.1", "wdmPresent": "Boolean_true", "confDownldSt": "ConfDownloadState_enabled", "emlNeType": "1830PSS-4", "nadString": "unknown", "productName": "1830PSS-4", "reachable": "Boolean_true", "shortProductName": "pss-4", "siteName": "Bangalore" }, { "IdClass": 26, "alarmSyntesis": "AlarmStatus_activeReportableCritical", "asonCtrPlaneType": "AsonCtrPlaneType_notApplicable", "associationPresent": "Boolean_false", "cTAccessStatus": "CTAccessStatus_ctConnEnab", "comment1": null, "comment2": null, "communicationState": "CommState_available", "ethPresent": "Boolean_false", "hierarchySubnet": "/2/3", "isMultiNEs": "Boolean_false", "localization": "92.10937500000561,25.740645636131248,0,null", "mibAlignmentState": "MibAlignmentState_aligned", "neAlignment": "Alignment_normal", "neSubType": "NeSubtype_notRepeater", "id": 4, "key": "Node/4", "className": "Node", "nodeType": "1830 PSS-4", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "parentId": 3, "parentLabel": "L1CP", "position": "1 0 0", "sdhPresent": "Boolean_false", "supervisionState": "SupervisionState_supervised", "guiLabel": "INDER-PSS4-02", "version": "8.1", "wdmPresent": "Boolean_true", "confDownldSt": "ConfDownloadState_enabled", "emlNeType": "1830PSS-4", "nadString": "unknown", "productName": "1830PSS-4", "reachable": "Boolean_true", "shortProductName": "pss-4", "siteName": "BA" }, { "IdClass": 26, "alarmSyntesis": "AlarmStatus_activeReportableCritical", "asonCtrPlaneType": "AsonCtrPlaneType_ocs", "associationPresent": "Boolean_false", "cTAccessStatus": "CTAccessStatus_partiallyGranted", "comment1": null, "comment2": null, "communicationState": "CommState_available", "ethPresent": "Boolean_false", "hierarchySubnet": "/2/3", "isMultiNEs": "Boolean_true", "localization": "78.04687500000472,14.200613815815954,0,null", "mibAlignmentState": "MibAlignmentState_aligned", "neAlignment": "Alignment_failed", "neSubType": "NeSubtype_notMeaningful", "id": 5, "key": "Node/5", "className": "Node", "nodeType": "Compound", "otnConfDownldSt": "GlobConfDwnldSt_enabled", "parentId": 3, "parentLabel": "L1CP", "position": "1 668 356", "sdhPresent": "Boolean_false", "supervisionState": "SupervisionState_supervised", "guiLabel": "INDER-PSS3", "version": "8.1", "wdmPresent": "Boolean_true", "confDownldSt": "ConfDownloadState_enabled", "emlNeType": "1830PSS-OCS", "nadString": "unknown", "productName": "1830PSS", "reachable": "Boolean_true", "shortProductName": "pss", "siteName": "BA" } ]

    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.
    • text/xml
    • application/json
    Example Response Data
    { "ok": true, "id": "2068262129146435", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    get /data/eml/getSession
    ReturnSession (returnSession : /data/eml/getSession)
    This is used to retrieve the session details

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • RequestIdObj
  • Responses

    Response Messages

    Schema

    200success RequestIdObj
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/npr/getSession
    ReturnSession (returnSession : /data/npr/getSession)
    This is used to retrieve the session details

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • RequestIdObj
  • Responses

    Response Messages

    Schema

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

    Request --> /data/npr/getSession

    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.
    • */*
    Example Response Data
    Response --> { "id": "B8AE83BCE97F8F1563095DA9F90F55EE" }

    External Docs
    See Also :

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean The Npr response is created successfully ---
    id String string The Response id ---
    responseMessage String string Response message for the request ---
    responseList array[Object] object The List of response ---

    RequestIdObj

    Name

    Type

    Description

    Enum

    id String string --- ---