Operation

get /data/npr/physicalConns/alarmed/{probCause}
alarmedPhysicalConn (alarmedPhysicalConn : /data/npr/physicalConns/alarmed/{probCause})
alarmedPhysicalConn

Path parameters

Name

IsRequired

Description

Enum

probCause required probCause ---
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/physicalConns/alarmed/{probCause} --> /data/npr/physicalConns/alarmed/APR%20Line

    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
    Response: [ { "IdClass": 16, "a2PortLabel": "SVT_Site3-1/AM2125A-1-7-LINEOUT", "aNodeId": 6, "aPortLabel": "SVT_Site4-1/AM2125A-1-7-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 8, "key": "PhysicalConn/8", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757132000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site4-1/AM2125A-1-7-LINEOUT-SVT_Site3-1/AM2125A-1-6-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site4-1/AM2125A-1-6-LINEIN", "zNodeId": 5, "zPortLabel": "SVT_Site3-1/AM2125A-1-6-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site1-1/AM2125A-1-11-LINEOUT", "aNodeId": 7, "aPortLabel": "SVT_Site5-1/AM2125A-1-3-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 7, "key": "PhysicalConn/7", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757132000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site5-1/AM2125A-1-3-LINEOUT-SVT_Site1-1/AM2125A-1-10-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site5-1/AM2125A-1-2-LINEIN", "zNodeId": 3, "zPortLabel": "SVT_Site1-1/AM2125A-1-10-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site3-1/AM2125A-1-11-LINEOUT", "aNodeId": 7, "aPortLabel": "SVT_Site5-1/AM2125A-1-11-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 9, "key": "PhysicalConn/9", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757132000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site5-1/AM2125A-1-11-LINEOUT-SVT_Site3-1/AM2125A-1-10-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site5-1/AM2125A-1-10-LINEIN", "zNodeId": 5, "zPortLabel": "SVT_Site3-1/AM2125A-1-10-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site2-1/AM2125A-1-7-LINEOUT", "aNodeId": 5, "aPortLabel": "SVT_Site3-1/AM2125A-1-3-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 4, "key": "PhysicalConn/4", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757130000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site3-1/AM2125A-1-3-LINEOUT-SVT_Site2-1/AM2125A-1-6-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site3-1/AM2125A-1-2-LINEIN", "zNodeId": 4, "zPortLabel": "SVT_Site2-1/AM2125A-1-6-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site2-1/AM2125A-1-3-LINEOUT", "aNodeId": 3, "aPortLabel": "SVT_Site1-1/AM2125A-1-3-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 3, "key": "PhysicalConn/3", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757130000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site1-1/AM2125A-1-3-LINEOUT-SVT_Site2-1/AM2125A-1-2-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site1-1/AM2125A-1-2-LINEIN", "zNodeId": 4, "zPortLabel": "SVT_Site2-1/AM2125A-1-2-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site2-1/AM2125A-1-11-LINEOUT", "aNodeId": 7, "aPortLabel": "SVT_Site5-1/AM2125A-1-7-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757131000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_true", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site5-1/AM2125A-1-7-LINEOUT-SVT_Site2-1/AM2125A-1-10-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site5-1/AM2125A-1-6-LINEIN", "zNodeId": 4, "zPortLabel": "SVT_Site2-1/AM2125A-1-10-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site4-1/AM2125A-1-11-LINEOUT", "aNodeId": 7, "aPortLabel": "SVT_Site5-1/AM2125A-1-15-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 10, "key": "PhysicalConn/10", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757133000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site5-1/AM2125A-1-15-LINEOUT-SVT_Site4-1/AM2125A-1-10-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site5-1/AM2125A-1-14-LINEIN", "zNodeId": 6, "zPortLabel": "SVT_Site4-1/AM2125A-1-10-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": "SVT_Site1-1/AM2125A-1-7-LINEOUT", "aNodeId": 6, "aPortLabel": "SVT_Site4-1/AM2125A-1-3-LINEOUT", "alarmStatus": "AlarmStatus_activeReportableMajor", "allPathCost": 20, "asapId": 0, "asapName": "default ASAP", "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "clientSignalType": "ClientSignalType_notMeaningful", "clientTechnology": "Technology_notMeaningful", "colorProfileId": 1, "commissionedStatus": "CommissionedStatus_notApplicable", "id": 6, "key": "PhysicalConn/6", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1464757131000, "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_notMeaningful", "overlaySupport": "ExtBoolean_false", "pm15m": "PmStatus_notEnabled", "pm24h": "PmStatus_notEnabled", "serviceState": "ServiceState_notInService", "shape": "Shape_fourEnded", "sltePresent": "Boolean_false", "srgPresent": "ObjectPresent_notPresent", "thrdPartyNtwDescription": null, "thrdPartyNtwName": null, "ultraLongSpan": "Boolean_false", "guiLabel": "SVT_Site4-1/AM2125A-1-3-LINEOUT-SVT_Site1-1/AM2125A-1-6-LINEIN", "wdmConnectionType": "WdmPortType_ots", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": "SVT_Site4-1/AM2125A-1-2-LINEIN", "zNodeId": 3, "zPortLabel": "SVT_Site1-1/AM2125A-1-6-LINEIN", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    External Docs
    See Also :

    Operation

    post /data/npr/physicalConns/{connectIds}
    commandPhysicalConn (commandPhysicalConn : /data/npr/physicalConns/{connectIds})
    commandPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectIds required connIdsStr ---
    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: Example for Implement/De-Implement/Set in service/Set out of service Ex: --> /data/npr/physicalConns/1822 Request Payload: Set in Service { "Tag": "F_POP_ServiceState_inService", "userLabel": "IW-ASON-SITE-2_OCH-1-1-41-1_MCS-9-2-AD6" } Ex: --> /data/npr/physicalConns/1822 Request Payload: Set out of services { "Tag": "F_POP_ServiceState_notInService", "userLabel": "IW-ASON-SITE-2_OCH-1-1-41-1_MCS-9-2-AD6" } Ex: --> /data/npr/physicalConns/1822 Request Payload: De-Implement { "Tag": "F_POP_Deimpl", "userLabel": "IW-ASON-SITE-2_OCH-1-1-41-1_MCS-9-2-AD6" } Ex: --> /data/npr/physicalConns/1822 Request Payload: Implement { "Tag": "F_POP_Impl", "userLabel": "IW-ASON-SITE-2_OCH-1-1-41-1_MCS-9-2-AD6" } Modify Link Utilization Profile on Physical Connection Request: data/npr/physicalConns/364 { "Tag":"updatelinkUtilProfile", "PhysicalConn_0_id":364, "PhysicalConn_0_key":"PhysicalConn/364" "linkUtilProfile":"HIGH" } Common Example: /data/npr/physicalConns/{connectIds} --> /data/npr/physicalConns/63 Request Payload --> { "Tag": "correlateSrg", "id": "63", "guiLabel": "test", "srg_length": 1, "srg_0_IdClass": 125, "srg_0_id": 22, "srg_0_key": "SharedRiskGroup/22", "srg_0_className": "SharedRiskGroup", "srg_0_srgProbability": "SrgProb_high", "srg_0_srgType": "SrgType_cable", "srg_0_guiLabel": "test 1" } Example for Request parameter: The rest call for the connectId can be obtained from Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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
    Response: Implement/De-Implement/Set in service/Set out of service { "ok": true, "id": "5266572801025677", "responseMessage": "ok", "responseList": [ { "requestType": "Info", "messagetag": "TDMmsg_95_73", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 200, "httpresponse": 200 } Response: Modify Link Utilization Profile on Physical conn { "ok":true, "id":"1265269101183391", "responseMessage":"Modify % Link Utilization Threshold - Completed", "responseList":[ { "requestType":"Info", "messagetag":"TDMmsg_95_73", "errorMsgData":[null], "requestStatus":"Success" } ], "HTTPResponse":200, "asonResponseList":[{"requestType":"Info","messagetag":"TDMmsg_95_73","errorMsgData":[null],"requestStatus":"Success"}],"requestStatus":"Success","eventableObjects":{},"httpresponse":200}

    External Docs
    See Also :

    Operation

    post /data/npr/physicalConns
    createPhysicalConn (createPhysicalConn : /data/npr/physicalConns)
    createPhysicalConn

    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/physicalConns Request Payload ---> OPS { "Tag": "CMD_WIZTYPE_createConn", "userLabel": "q", "tecnologyDomain": "OTN", "connectionType": "chooserConnWdm", "dummyWDMconnectionType": "OPS", "WDMconnectionType": "WdmPortType_ops0", "interfacetype": "-", "clientSignalType": "ClientSignalType_notMeaningful", "OCSPhotonicInterworkingType": "notmeaningful", "constAllocation": "20", "aNode": "PSS32-100-62-98", "aPort": "PSS32-100-62-98#OCS/OCH-1-1-38-1", "zNode": "PSS32-100-62-98", "zPort": "PSS32-100-62-98/SFD-41-1-9200" } Request Payload ---> OTS { "Tag": "CMD_WIZTYPE_createConn", "userLabel": "Test_OTS", "tecnologyDomain": "OTN", "connectionType": "chooserConnWdm", "WDMconnectionIwType": "Technology_wdm", "WDMconnectionType": "WdmPortType_ots", "constAllocation": "20", "ultraLongSpan": "Boolean_false", "aNode": "MRN-06-SITE1", "aNode_id": 3, "aNode_guiLabel": "MRN-06-SITE1", "aNode_emlNeType": "1830PSS-PHN", "aNode_productName": "1830PSS", "aPort": "MRN-06-SITE1/CWR-10-4-THRU", "aPort_IdClass": 4, "aPort_alarmStatus": "AlarmStatus_cleared", "aPort_boardType": "MUX%LINE", "aPort_cardType": "CWR8-88", "aPort_clonePortPresent": "Boolean_false", "aPort_compModule": null, "aPort_consistSt": "ConsistencyStatus_normal", "aPort_currentFrequency": null, "aPort_direction": "Direction_bidirectional", "aPort_displayLabel": "CWR-10-4-THRU", "aPort_encoding": "Encoding_notMeaningful", "aPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "aPort_ethInterfaceType": "EthInterType_notApplicable", "aPort_fdnMapper": "NC_n=*EML_101_SNA/NE_n=*1/PTPn=*CWR-10-4-THRU/:PORT", "aPort_fecType": "FecType_notMeaningful", "aPort_frequency": "##", "aPort_internalEmlAid": "10/4/2", "aPort_involvedIn3R": "Boolean_false", "aPort_involvedOnInternalCable": "Boolean_false", "aPort_involvedOnPhyConn": "Boolean_false", "aPort_neId": 1, "aPort_neLabel": "MRN-06-SITE1", "aPort_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "aPort_operationalState": "OperationalState_enabled", "aPort_otuSignalType": "OtuSignalType_notMeaningful", "aPort_physicalPortType": "PortType_notMeaningful", "aPort_portBitRate": null, "aPort_id": 37322, "aPort_key": "Port/37322", "aPort_className": "Port", "aPort_technology": "Technology_wdm", "aPort_uploadSt": "UploadStatus_normal", "aPort_usedDir": "Direction_bidirectional", "aPort_usedOnOtn": "Boolean_false", "aPort_guiLabel": "MRN-06-SITE1/CWR-10-4-THRU", "aPort_wdmClientSignalType": "ClientSignalType_notMeaningful", "aPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "aPort_wdmPhysicalPortRate": null, "aPort_wdmPortType": "WdmPortType_ots", "aPort_wdmTransmissionMode": "WdmTransMode_notMeaningful", "aPort_width": -1, "zNode": "MRN-06-SITE2", "zNode_id": 4, "zNode_guiLabel": "MRN-06-SITE2", "zNode_emlNeType": "1830PSS-OCS", "zNode_productName": "1830PSS", "zPort": "MRN-06-SITE2/CWR-7-2-THRU", "zPort_IdClass": 4, "zPort_alarmStatus": "AlarmStatus_cleared", "zPort_boardType": "MUX%LINE", "zPort_cardType": "CWR8-88", "zPort_clonePortPresent": "Boolean_false", "zPort_compModule": null, "zPort_consistSt": "ConsistencyStatus_normal", "zPort_currentFrequency": null, "zPort_direction": "Direction_bidirectional", "zPort_displayLabel": "CWR-7-2-THRU", "zPort_encoding": "Encoding_notMeaningful", "zPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "zPort_ethInterfaceType": "EthInterType_notApplicable", "zPort_fdnMapper": "NC_n=*EML_101_SNA/NE_n=*3/PTPn=*CWR-7-2-THRU/:PORT", "zPort_fecType": "FecType_notMeaningful", "zPort_frequency": "##", "zPort_internalEmlAid": "7/2/2", "zPort_involvedIn3R": "Boolean_false", "zPort_involvedOnInternalCable": "Boolean_false", "zPort_involvedOnPhyConn": "Boolean_false", "zPort_neId": 3, "zPort_neLabel": "MRN-06-SITE2", "zPort_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "zPort_operationalState": "OperationalState_enabled", "zPort_otuSignalType": "OtuSignalType_notMeaningful", "zPort_physicalPortType": "PortType_notMeaningful", "zPort_portBitRate": null, "zPort_id": 36313, "zPort_key": "Port/36313", "zPort_className": "Port", "zPort_technology": "Technology_wdm", "zPort_uploadSt": "UploadStatus_normal", "zPort_usedDir": "Direction_bidirectional", "zPort_usedOnOtn": "Boolean_false", "zPort_guiLabel": "MRN-06-SITE2/CWR-7-2-THRU", "zPort_wdmClientSignalType": "ClientSignalType_notMeaningful", "zPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "zPort_wdmPhysicalPortRate": null, "zPort_wdmPortType": "WdmPortType_ots", "zPort_wdmTransmissionMode": "WdmTransMode_notMeaningful", "zPort_width": -1 } Request Payload: Y-Cable { "Tag": "CMD_WIZTYPE_createConn", "userLabel": "Test-ycable", "tecnologyDomain": "OTN", "connectionType": "chooserConnWdmY-Cable", "WDMconnectionType": "WdmPortType_ops0", "interfacetype": "-", "clientSignalType": "ClientSignalType_notMeaningful", "constAllocation": "20", "aNode": "MRN-06-SITE1", "aNode_id": 3, "aNode_guiLabel": "MRN-06-SITE1", "aNode_productName": "1830PSS", "aPort": "MRN-06-SITE1#OCS/OCH-1-1-36-1", "aPort_IdClass": 4, "aPort_alarmStatus": "AlarmStatus_cleared", "aPort_boardType": "OTU2", "aPort_cardType": "11QCUPC", "aPort_clonePortPresent": "Boolean_true", "aPort_compModule": "T-XFP", "aPort_consistSt": "ConsistencyStatus_normal", "aPort_currentFrequency": "193.65", "aPort_direction": "Direction_bidirectional", "aPort_displayLabel": "OCH-1-1-36-1", "aPort_encoding": "Encoding_nrz", "aPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "aPort_ethInterfaceType": "EthInterType_notApplicable", "aPort_fdnMapper": "NC_n=*EML_101_SNA/NE_n=*2/PTPn=*OCH-1-1-36-1/:PORT", "aPort_fecType": "FecType_notMeaningful", "aPort_frequency": "193.65", "aPort_internalEmlAid": null, "aPort_involvedIn3R": "Boolean_false", "aPort_involvedOnInternalCable": "Boolean_false", "aPort_involvedOnPhyConn": "Boolean_false", "aPort_neId": 2, "aPort_neLabel": "MRN-06-SITE1#OCS", "aPort_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "aPort_operationalState": "OperationalState_enabled", "aPort_otuSignalType": "OtuSignalType_otu2", "aPort_physicalPortType": "PortType_notMeaningful", "aPort_portBitRate": null, "aPort_id": 36165, "aPort_key": "Port/36165", "aPort_className": "Port", "aPort_technology": "Technology_wdm", "aPort_uploadSt": "UploadStatus_normal", "aPort_usedDir": "Direction_bidirectional", "aPort_usedOnOtn": "Boolean_false", "aPort_guiLabel": "MRN-06-SITE1#OCS/OCH-1-1-36-1", "aPort_wdmClientSignalType": "ClientSignalType_otu2", "aPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "aPort_wdmPhysicalPortRate": "10037.273Mbit/s", "aPort_wdmPortType": "WdmPortType_ops0", "aPort_wdmTransmissionMode": "WdmTransMode_notMeaningful", "aPort_width": -1, "zNode": "MRN-06-SITE2", "zNode_id": 4, "zNode_guiLabel": "MRN-06-SITE2", "zNode_productName": "1830PSS", "zPort": "MRN-06-SITE2/130SCX10-16-2-C4", "zPort_IdClass": 4, "zPort_alarmStatus": "AlarmStatus_cleared", "zPort_boardType": null, "zPort_cardType": "130SCX10", "zPort_clonePortPresent": "Boolean_false", "zPort_compModule": null, "zPort_consistSt": "ConsistencyStatus_normal", "zPort_currentFrequency": null, "zPort_direction": "Direction_bidirectional", "zPort_displayLabel": "130SCX10-16-2-C4", "zPort_encoding": "Encoding_notMeaningful", "zPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "zPort_ethInterfaceType": "EthInterType_notApplicable", "zPort_fdnMapper": "NC_n=*EML_101_SNA/NE_n=*3/PTPn=*130SCX10-16-2-C4/:PORT", "zPort_fecType": "FecType_notMeaningful", "zPort_frequency": "B&W", "zPort_internalEmlAid": "16/2/5", "zPort_involvedIn3R": "Boolean_false", "zPort_involvedOnInternalCable": "Boolean_false", "zPort_involvedOnPhyConn": "Boolean_false", "zPort_neId": 3, "zPort_neLabel": "MRN-06-SITE2", "zPort_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "zPort_operationalState": "OperationalState_enabled", "zPort_otuSignalType": "OtuSignalType_otu0", "zPort_physicalPortType": "PortType_notMeaningful", "zPort_portBitRate": null, "zPort_id": 36259, "zPort_key": "Port/36259", "zPort_className": "Port", "zPort_technology": "Technology_wdm", "zPort_uploadSt": "UploadStatus_normal", "zPort_usedDir": "Direction_bidirectional", "zPort_usedOnOtn": "Boolean_false", "zPort_guiLabel": "MRN-06-SITE2/130SCX10-16-2-C4", "zPort_wdmClientSignalType": "ClientSignalType_notProvisioned", "zPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "zPort_wdmPhysicalPortRate": "1244.000Mbit/s", "zPort_wdmPortType": "WdmPortType_ops0", "zPort_wdmTransmissionMode": "WdmTransMode_notMeaningful", "zPort_width": null, "z2Port": "MRN-06-SITE2/130SCX10-16-2-C4", "z2Port_IdClass": 4, "z2Port_alarmStatus": "AlarmStatus_cleared", "z2Port_boardType": null, "z2Port_cardType": "130SCX10", "z2Port_clonePortPresent": "Boolean_false", "z2Port_compModule": null, "z2Port_consistSt": "ConsistencyStatus_normal", "z2Port_currentFrequency": null, "z2Port_direction": "Direction_bidirectional", "z2Port_displayLabel": "130SCX10-16-2-C4", "z2Port_encoding": "Encoding_notMeaningful", "z2Port_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "z2Port_ethInterfaceType": "EthInterType_notApplicable", "z2Port_fdnMapper": "NC_n=*EML_101_SNA/NE_n=*3/PTPn=*130SCX10-16-2-C4/:PORT", "z2Port_fecType": "FecType_notMeaningful", "z2Port_frequency": "B&W", "z2Port_internalEmlAid": "16/2/5", "z2Port_involvedIn3R": "Boolean_false", "z2Port_involvedOnInternalCable": "Boolean_false", "z2Port_involvedOnPhyConn": "Boolean_false", "z2Port_neId": 3, "z2Port_neLabel": "MRN-06-SITE2", "z2Port_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "z2Port_operationalState": "OperationalState_enabled", "z2Port_otuSignalType": "OtuSignalType_otu0", "z2Port_physicalPortType": "PortType_notMeaningful", "z2Port_portBitRate": null, "z2Port_id": 36259, "z2Port_key": "Port/36259", "z2Port_className": "Port", "z2Port_technology": "Technology_wdm", "z2Port_uploadSt": "UploadStatus_normal", "z2Port_usedDir": "Direction_bidirectional", "z2Port_usedOnOtn": "Boolean_false", "z2Port_guiLabel": "MRN-06-SITE2/130SCX10-16-2-C4", "z2Port_wdmClientSignalType": "ClientSignalType_notProvisioned", "z2Port_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "z2Port_wdmPhysicalPortRate": "1244.000Mbit/s", "z2Port_wdmPortType": "WdmPortType_ops0", "z2Port_wdmTransmissionMode": "WdmTransMode_notMeaningful", "z2Port_width": null } Example The rest call for the connectId can be obtained from Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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
    Response: { "ok": true, "id": "3702870453310652", "responseMessage": "ok", "responseList":[{ "requestType":"Info", "messagetag":"TDMmsg_95_73", "errorMsgData":[null], "requestStatus":"Success" }], "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    post /data/npr/physicalConns/Eqm
    createPhysicalConnEqm (createPhysicalConnEqm : /data/npr/physicalConns/Eqm)
    createPhysicalConnEqm

    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/physicalConns/Eqm Request Pay Load { "Tag": "CMD_WIZTYPE_createConn", "userLabel": "OPS_L0", "tecnologyDomain": "OTN", "connectionType": "chooserConnWdm", "dummyWDMconnectionType": "OPS", "WDMconnectionType": "WdmPortType_ops0", "interfacetype": "-", "clientSignalType": "ClientSignalType_notMeaningful", "OCSPhotonicInterworkingType": "notmeaningful", "constAllocation": "20", "aNode": "L0-SAN-SITE1", "aPort": "L0-SAN-SITE1/CWR-18-4-CLS1", "zNode": "L0-SAN-SITE1", "zPort": "L0-SAN-SITE1#OCS/OCH-1-1-9-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.
    • text/xml
    • application/json
    Example Response Data
    { "ok": true, "id": "1543578673549478", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    delete /data/npr/physicalConns/{connectId}
    deletePhysicalConn (deletePhysicalConn : /data/npr/physicalConns/{connectId})
    deletePhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    Request /data/npr/physicalConns/{connectId} --> /data/npr/physicalConns/62 Request payload { "userLabel": "Automation test" } Example The rest call for the connectId can be obtained from Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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
    { "ok": true, "id": "758239083233619", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    get /data/asonNBI/physicalConns/{connectId}/fiberCharacteristic
    fiberCharContr (fiberCharContr : /data/asonNBI/physicalConns/{connectId}/fiberCharacteristic)
    fiberCharContr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required id ---
    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/physicalConns/{connectId}/fiberCharacteristic
    fiberCharContr (fiberCharContr : /data/npr/physicalConns/{connectId}/fiberCharacteristic)
    fiberCharContr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required id ---
    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/asonNBI/physicalConns/{id}/physicalConnsList
    getAssociatedPhyLinksForDarkFiber (getAssociatedPhyLinksForDarkFiber : /data/asonNBI/physicalConns/{id}/physicalConnsList)
    getAssociatedPhyLinksForDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    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/physicalConns/{id}/physicalConnsList
    getAssociatedPhyLinksForDarkFiber (getAssociatedPhyLinksForDarkFiber : /data/npr/physicalConns/{id}/physicalConnsList)
    getAssociatedPhyLinksForDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    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

    post /data/asonNBI/physicalConns/darkFiberList/physicalLinkIds
    getDarkFiberIdsForPhyLinks (getDarkFiberIdsForPhyLinks : /data/asonNBI/physicalConns/darkFiberList/physicalLinkIds)
    getDarkFiberIdsForPhyLinks

    Query parameters

    Name

    IsRequired

    Description

    darkFiberList required ---

    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 :

    Operation

    post /data/npr/physicalConns/darkFiberList/physicalLinkIds
    getDarkFiberIdsForPhyLinks (getDarkFiberIdsForPhyLinks : /data/npr/physicalConns/darkFiberList/physicalLinkIds)
    getDarkFiberIdsForPhyLinks

    Query parameters

    Name

    IsRequired

    Description

    darkFiberList required ---

    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 :

    Operation

    get /data/asonNBI/physicalConns/{id}/darkfiber
    getDarkFibersToAssociateForPhyLink (getDarkFibersToAssociateForPhyLink : /data/asonNBI/physicalConns/{id}/darkfiber)
    getDarkFibersToAssociateForPhyLink

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    action required ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«object»
    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/physicalConns/{id}/darkfiber
    getDarkFibersToAssociateForPhyLink (getDarkFibersToAssociateForPhyLink : /data/npr/physicalConns/{id}/darkfiber)
    getDarkFibersToAssociateForPhyLink

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    action required ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«object»
    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/asonNBI/physicalConns/{connectId}/OlpLink
    inventory (inventory : /data/asonNBI/physicalConns/{connectId}/OlpLink)
    inventory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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/physicalConns/{connectId}/OlpLink
    inventory (inventory : /data/npr/physicalConns/{connectId}/OlpLink)
    inventory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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/physicalConns/{connectId}/pathInPhyConn
    inventory (inventory : /data/npr/physicalConns/{connectId}/pathInPhyConn)
    inventory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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/physicalConns/{connectId}/pathInPhyConn --> /data/npr/physicalConns/242/pathInPhyConn The REST for the connect id can be obtained from Example Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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": 0, "alarmProp": "AlarmPropagation_successAfterImplemented", "alarmPropRule": "PropagationRule_whenImplemented", "alarmStatus": "AlarmStatus_activeReportableMajor", "allocationConstraint": "AllocationConstraint_noRestriction", "alrPropAct": "AlmPropActivity_normal", "asapId": 0, "availabilityStatus": "AvailabilityStatus_notMeaningful", "bitRate": null, "clientConnPresent": "ObjectPresent_notPresent", "comment1": null, "comment2": null, "comment3": null, "confSt": "ConfigurationState_implemented", "connectivity": "Connectivity_fullyConnected", "defTime": 1467012379000, "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", "includeAnyColorId": 1, "includeAnyColorName": "NoColor", "includeAnyColorString": "0000.0000.0000.0000.0000.0000.0000", "intermCtpMon": "IntermCtpMon_disabled", "lastCmd": "TrailLastCmd_implement", "modificationTime": null, "operationalState": "OperationalState_enabled", "pathGroup": null, "id": 2, "key": "WdmPath/2", "className": "WdmPath", "pathRate": "PathRate_eth100Gb", "pathWrkSt": "PathWorkingState_normal", "pdhAlarms": "EnablingAlrState_notMeaningful", "pdhAlrEnabRule": "EnablingRule_onImplementation", "pm15": "Boolean_true", "pm24": "Boolean_true", "pmAutomatic": "Boolean_true", "pmGroup": null, "protType": "ProtectionPathType_notProtected", "routeSaved": "Saved_notSaved", "routingModificationTime": null, "sdhAlarms": "EnablingAlrState_enabled", "sdhAlrEnabRule": "EnablingRule_onImplementation", "securityLabel": 0, "serviceState": "ServiceState_notInService", "serviceType": "ServiceType_ethernet", "sncNumber": "SncNumber_noSnc", "sncpSwitchSt": "SNCPSwitchStatus_noSwitchForced", "text1": null, "text2": null, "text3": null, "userId": "otn@MAINOTNE", "guiLabel": "B_4_1_9___C_4_1_9 01#1" } ]

    External Docs
    See Also :

    Operation

    get /data/npr/physicalConns/{connectId}/trailInPhyConn
    inventory (inventory : /data/npr/physicalConns/{connectId}/trailInPhyConn)
    inventory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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/physicalConns/{connectId}/trailInPhyConn --> /data/npr/physicalConns/242/trailInPhyConn The REST for the connect id can be obtained from Example Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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": 1467012378000, "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_enabled", "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": 2389, "key": "WdmTrail/2389", "className": "WdmTrail", "trailUsage": "TrailUsage_normal", "trailWrkSt": "TrsWrkState_normal", "transportNtw": "TransportNtwType_photonic", "tunnelType": "TunnelType_notApplicable", "guiLabel": "NODE-B-NODE-B och10", "virtual": "Virtual_normal", "waitForServerRestoration": "ExtBoolean_notApplicable", "wdmClientConf": "WdmClientConf_client", "wdmTrailLayer": "WdmTrailLayer_och" } ]

    External Docs
    See Also :

    Operation

    put /data/npr/physicalConns/{connectId}
    modifyPhysicalConn (modifyPhysicalConn : /data/npr/physicalConns/{connectId})
    modifyPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    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/physicalConns/{connectId} --> /data/npr/physicalConns/62 Request payload { "Tag": "modifyLabels", "guiLabel": "test100", "userLabel": "Automation test" } Example The rest call for the connectId can be obtained from Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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
    { "ok": true, "id": "756775242720737", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    get /data/npr/physicalConns/pie
    piePhysicalConn (piePhysicalConn : /data/npr/physicalConns/pie)
    piePhysicalConn

    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

    /data/npr/physicalConns/pie

    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
    { "chartDetails": [ { "count": 7, "tag": "APR Line" } ] }

    External Docs
    See Also :

    Operation

    get /data/asonNBI/physicalConns/{connectId}/{port}/wavelenPar
    prtWavelenParameters (prtWavelenParameters : /data/asonNBI/physicalConns/{connectId}/{port}/wavelenPar)
    prtWavelenParameters

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    port required prtSide ---
    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/physicalConns/{connectId}/{port}/wavelenPar
    prtWavelenParameters (prtWavelenParameters : /data/npr/physicalConns/{connectId}/{port}/wavelenPar)
    prtWavelenParameters

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    port required prtSide ---
    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/asonNBI/physicalConns/{connectId}/linkAsons
    retrieveASONLinks (retrieveASONLinks : /data/asonNBI/physicalConns/{connectId}/linkAsons)
    retrieveASONLinks

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/npr/physicalConns/{connectId}/linkAsons
    retrieveASONLinks (retrieveASONLinks : /data/npr/physicalConns/{connectId}/linkAsons)
    retrieveASONLinks

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

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

    Request: /data/npr/physicalConns/{connectId}/linkAsons --> data/npr/physicalConns/63/linkAsons

    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;charset=UTF-8
    Example Response Data
    Response: [ { "IdClass":16, "phyConnType":"PhyConnType_wdm", "a2PortLabel":null, "aNodeId":24, "aPortLabel":"pss32-41.75.92/RA5P-1-12-LINEIN/CLONE", "alarmStatus":"AlarmStatus_cleared", "allPathCost":20, "asonAdmState":"AdminState_locked", "asonAutoRestoration":"ExtOperSt_enabled", "asonWTR":60, "category":"OMSlink", "colorProfileId":1, "colorProfileName":"NoColor", "colorString":"0000.0000.0000.0000.0000.0000.0000", "id":70, "key":"LinkAson/70", "className":"LinkAson", "defTime":"2018-09-12", "implSt":"ImplementationState_implemented", "infrastructure":"LINK", "latency":0, "linkType":"LinkType_i_nni", "npaId":21, "otnMapper":159, "otuSignalType":"OtuSignalType_notMeaningful", "srgPresent":"ObjectPresent_notPresent", "teLinkId":100101, "teLinkName":"pss32-41.75.92/pss32-41.75.93-100101", "threerResource":"ThreerResource_notMeaningful", "tunnelTrailId":0, "guiLabel":"pss32-41.75.92/AWBEGR-1-16-LINEOUT-pss32-41.75.93/RA5P-1-2-LINEIN/1", "wrkSt":"WorkingState_failedToDeimplNpa", "z2PortLabel":null, "zNodeId":25, "zPortLabel":"pss32-41.75.93/RA5P-1-2-LINEIN/CLONE", "frequencyNumber":88, "flexGridSupport":"FlexGridSupport_yes", "band":"BandIdentification_cBand", "interShelf":"InterShelf_normal", "tcmDefectRaisingTime":0, "sharedLink":"SharedPort_NA" } ]

    External Docs
    See Also :

    Operation

    get /data/asonNBI/physicalConns/linkUtilProfile/{profileName}
    retrieveLinkUtilPhysicalConns (retrieveLinkUtilPhysicalConns : /data/asonNBI/physicalConns/linkUtilProfile/{profileName})
    retrieveLinkUtilPhysicalConns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileName required profileName ---
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/npr/physicalConns/linkUtilProfile/{profileName}
    retrieveLinkUtilPhysicalConns (retrieveLinkUtilPhysicalConns : /data/npr/physicalConns/linkUtilProfile/{profileName})
    retrieveLinkUtilPhysicalConns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileName required profileName ---
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/npr/physicalConns/timerPm/{connectId}/{pm15}/{pm24}
    timerPmPhysicalConn (timerPmPhysicalConn : /data/npr/physicalConns/timerPm/{connectId}/{pm15}/{pm24})
    timerPmPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectId required connectId ---
    pm15 required pm15 [PmStatus_notEnabled, PmStatus_planned, PmStatus_started, PmStatus_startFailed, PmStatus_stopped, PmStatus_stopFailed]
    pm24 required pm24 [PmStatus_notEnabled, PmStatus_planned, PmStatus_started, PmStatus_startFailed, PmStatus_stopped, PmStatus_stopFailed]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    Request /data/npr/physicalConns/timerPm/{connectId}/{pm15}/{pm24} --> /data/npr/physicalConns/timerPm/5/PmStatus_started/PmStatus_started Example The rest call for the connectId can be obtained from Request --> /data/npr/physicalConns Response --> [ { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS5", "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": 5, "key": "PhysicalConn/5", "className": "PhysicalConn", "currentFrequency": null, "defTime": 1466332982000, "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_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-CLS5-INDER-PSS1#OCS/OCH-1-1-33-3", "wdmConnectionType": "WdmPortType_ops0", "wdmLinkType": "WdmLinkType_otn", "wdmProtConnType": "WdmProtType_notMeaningful", "wrkSt": "WorkingState_normal", "z2PortLabel": null, "zNodeId": 8, "zPortLabel": "INDER-PSS1#OCS/OCH-1-1-33-3/WDM", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" }, { "IdClass": 16, "a2PortLabel": null, "aNodeId": 8, "aPortLabel": "INDER-PSS1/CWR-7-16-CLS7", "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": 1466332982000, "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_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", "colorProfileName": "NoColor", "colorString": "0000.0000.0000.0000.0000.0000.0000" } ]

    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 :

    DarkFiberResponseData«object»

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[Object] object --- ---
    status String string --- ---
    message String string --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---