Operation

post /data/npr/threeRs
Create a 3R (createThreeR : /data/npr/threeRs)
Create a 3R (it is used as a constraint in control plane provisioning).

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 call: Create ThreeR - Add Drop, Regen, Cross Regen /data/npr/threeRs/ Request Body: 1) Create ThreeR - (i) Add Drop Mode { "Tag": "Create3R", "npa": "Sushma", "npaid": "1", "aNode": "PSS32-100-59-77", "aNode_IdClass": 26, "aNode_alarmSyntesis": "AlarmStatus_activeReportableCritical", "aNode_asonCtrPlaneType": "AsonCtrPlaneType_ocs", "aNode_cTAccessStatus": "CTAccessStatus_ctConnEnab", "aNode_comment1": null, "aNode_comment2": null, "aNode_communicationState": "CommState_available", "aNode_ethPresent": "Boolean_false", "aNode_hierarchySubnet": null, "aNode_isMultiNEs": "Boolean_false", "aNode_localization": null, "aNode_mibAlignmentState": "MibAlignmentState_aligned", "aNode_neAlignment": "Alignment_failed", "aNode_neSubType": "NeSubtype_notRepeater", "aNode_id": 5, "aNode_key": "Node/5", "aNode_className": "Node", "aNode_otnConfDownldSt": "GlobConfDwnldSt_enabled", "aNode_parentId": 1, "aNode_parentLabel": "DEFAULT", "aNode_position": "1 0 0", "aNode_sdhPresent": "Boolean_false", "aNode_supervisionState": "SupervisionState_supervised", "aNode_guiLabel": "PSS32-100-59-77", "aNode_version": "9.0", "aNode_wdmPresent": "Boolean_true", "aNode_confDownldSt": "ConfDownloadState_enabled", "aNode_nadString": "unknown", "aNode_productName": "1830PSS", "aNode_reachable": "Boolean_true", "aNode_shortProductName": "pss", "aNode_siteName": "BA", "aPort": "PSS32-100-59-77/11QPA4-11-8-L1", "aPort_IdClass": 4, "aPort_alarmStatus": "AlarmStatus_cleared", "aPort_boardType": "TR%UNI%LINE", "aPort_cardType": "11QPA4", "aPort_clonePortPresent": "Boolean_false", "aPort_compModule": null, "aPort_consistSt": "ConsistencyStatus_normal", "aPort_currentFrequency": null, "aPort_direction": "Direction_bidirectional", "aPort_displayLabel": "11QPA4-11-8-L1", "aPort_encoding": "Encoding_nrz", "aPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "aPort_ethInterfaceType": "EthInterType_notApplicable", "aPort_fdnMapper": "NC_n=*EML_301_SNA/NE_n=*3/PTPn=*11QPA4-11-8-L1/:PORT", "aPort_fecType": "FecType_efec", "aPort_frequency": "tunable", "aPort_internalEmlAid": "11/8/1", "aPort_involvedIn3R": "Boolean_false", "aPort_involvedOnInternalCable": "Boolean_true", "aPort_involvedOnPhyConn": "Boolean_true", "aPort_neId": 3, "aPort_neLabel": "PSS32-100-59-77", "aPort_networkInterfaceType": "NetworkInterfaceType_uni", "aPort_operationalState": "OperationalState_enabled", "aPort_otuSignalType": "OtuSignalType_otu2", "aPort_physicalPortType": "PortType_notMeaningful", "aPort_portBitRate": "10709", "aPort_id": 1685, "aPort_key": "Port/1685", "aPort_className": "Port", "aPort_technology": "Technology_wdm", "aPort_uploadSt": "UploadStatus_normal", "aPort_usedDir": "Direction_bidirectional", "aPort_usedOnOtn": "Boolean_false", "aPort_guiLabel": "PSS32-100-59-77/11QPA4-11-8-L1", "aPort_wdmClientSignalType": "ClientSignalType_otu2", "aPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "aPort_wdmPhysicalPortRate": "10037.273Mbit/s", "aPort_wdmPortType": "WdmPortType_ops0", "aPort_wdmTransmissionMode": "WdmTransMode_addDrop", "aPort_width": 50, "zPort": "" } 1) Create ThreeR - (ii) Regen Mode { "Tag": "Create3R", "npa": "Sushma", "npaid": "1", "aNode": "PSS32-100-59-77", "aNode_IdClass": 26, "aNode_alarmSyntesis": "AlarmStatus_activeReportableCritical", "aNode_asonCtrPlaneType": "AsonCtrPlaneType_ocs", "aNode_cTAccessStatus": "CTAccessStatus_ctConnEnab", "aNode_comment1": null, "aNode_comment2": null, "aNode_communicationState": "CommState_available", "aNode_ethPresent": "Boolean_false", "aNode_hierarchySubnet": null, "aNode_isMultiNEs": "Boolean_false", "aNode_localization": null, "aNode_mibAlignmentState": "MibAlignmentState_aligned", "aNode_neAlignment": "Alignment_failed", "aNode_neSubType": "NeSubtype_notRepeater", "aNode_id": 5, "aNode_key": "Node/5", "aNode_className": "Node", "aNode_otnConfDownldSt": "GlobConfDwnldSt_enabled", "aNode_parentId": 1, "aNode_parentLabel": "DEFAULT", "aNode_position": "1 0 0", "aNode_sdhPresent": "Boolean_false", "aNode_supervisionState": "SupervisionState_supervised", "aNode_guiLabel": "PSS32-100-59-77", "aNode_version": "9.0", "aNode_wdmPresent": "Boolean_true", "aNode_confDownldSt": "ConfDownloadState_enabled", "aNode_nadString": "unknown", "aNode_productName": "1830PSS", "aNode_reachable": "Boolean_true", "aNode_shortProductName": "pss", "aNode_siteName": "BA", "aPort": "PSS32-100-59-77/11QPA4-11-8-L1", "aPort_IdClass": 4, "aPort_alarmStatus": "AlarmStatus_cleared", "aPort_boardType": "TR%UNI%LINE", "aPort_cardType": "11QPA4", "aPort_clonePortPresent": "Boolean_false", "aPort_compModule": null, "aPort_consistSt": "ConsistencyStatus_normal", "aPort_currentFrequency": null, "aPort_direction": "Direction_bidirectional", "aPort_displayLabel": "11QPA4-11-8-L1", "aPort_encoding": "Encoding_nrz", "aPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "aPort_ethInterfaceType": "EthInterType_notApplicable", "aPort_fdnMapper": "NC_n=*EML_301_SNA/NE_n=*3/PTPn=*11QPA4-11-8-L1/:PORT", "aPort_fecType": "FecType_efec", "aPort_frequency": "tunable", "aPort_internalEmlAid": "11/8/1", "aPort_involvedIn3R": "Boolean_false", "aPort_involvedOnInternalCable": "Boolean_true", "aPort_involvedOnPhyConn": "Boolean_true", "aPort_neId": 3, "aPort_neLabel": "PSS32-100-59-77", "aPort_networkInterfaceType": "NetworkInterfaceType_uni", "aPort_operationalState": "OperationalState_enabled", "aPort_otuSignalType": "OtuSignalType_otu2", "aPort_physicalPortType": "PortType_notMeaningful", "aPort_portBitRate": "10709", "aPort_id": 1685, "aPort_key": "Port/1685", "aPort_className": "Port", "aPort_technology": "Technology_wdm", "aPort_uploadSt": "UploadStatus_normal", "aPort_usedDir": "Direction_bidirectional", "aPort_usedOnOtn": "Boolean_false", "aPort_guiLabel": "PSS32-100-59-77/11QPA4-11-8-L1", "aPort_wdmClientSignalType": "ClientSignalType_otu2", "aPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "aPort_wdmPhysicalPortRate": "10037.273Mbit/s", "aPort_wdmPortType": "WdmPortType_ops0", "aPort_wdmTransmissionMode": "WdmTransMode_Regen", "aPort_width": 50, "zPort": "" } 1) Create ThreeR - (iii) Cross Regen Mode { "Tag": "Create3R", "npa": "Test-L0_GMRE", "npaid": "44", "aNode": "L0_GMRE_Site2", "aNode_IdClass": 26, "aNode_alarmSyntesis": "AlarmStatus_activeReportableCritical", "aNode_asonCtrPlaneType": "AsonCtrPlaneType_phn", "aNode_cTAccessStatus": "CTAccessStatus_ctConnEnab", "aNode_comment1": null, "aNode_comment2": null, "aNode_communicationState": "CommState_available", "aNode_ethPresent": "Boolean_false", "aNode_hierarchySubnet": "/2/7", "aNode_isMultiNEs": "Boolean_false", "aNode_localization": "-78.2226562499959,60.77735216033685,0,null", "aNode_mibAlignmentState": "MibAlignmentState_aligned", "aNode_neAlignment": "Alignment_normal", "aNode_neSubType": "NeSubtype_notRepeater", "aNode_id": 82, "aNode_key": "Node/82", "aNode_className": "Node", "aNode_otnConfDownldSt": "GlobConfDwnldSt_enabled", "aNode_parentId": 7, "aNode_parentLabel": "CP-SVT-OTN", "aNode_position": "1 362 264", "aNode_sdhPresent": "Boolean_false", "aNode_supervisionState": "SupervisionState_supervised", "aNode_guiLabel": "L0_GMRE_Site2", "aNode_version": "9.0", "aNode_wdmPresent": "Boolean_true", "aNode_confDownldSt": "ConfDownloadState_enabled", "aNode_nadString": "unknown", "aNode_productName": "1830PSS", "aNode_reachable": "Boolean_true", "aNode_shortProductName": "pss", "aNode_siteName": "BA-SIM", "aPort": "L0_GMRE_Site2/11QPA4-1-17-L1", "aPort_IdClass": 4, "aPort_alarmStatus": "AlarmStatus_cleared", "aPort_boardType": "TR%ODU2%LINE", "aPort_cardType": "11QPA4", "aPort_clonePortPresent": "Boolean_false", "aPort_compModule": null, "aPort_consistSt": "ConsistencyStatus_normal", "aPort_currentFrequency": null, "aPort_direction": "Direction_bidirectional", "aPort_displayLabel": "11QPA4-1-17-L1", "aPort_encoding": "Encoding_notMeaningful", "aPort_ethInterfaceRate": "EthInterfaceRate_notMeaningful", "aPort_ethInterfaceType": "EthInterType_notApplicable", "aPort_fdnMapper": "NC_n=*EML_102_SNA/NE_n=*80/PTPn=*11QPA4-1-17-L1/:PORT", "aPort_fecType": "FecType_efec", "aPort_frequency": "tunable", "aPort_internalEmlAid": "1/17/1", "aPort_involvedIn3R": "Boolean_false", "aPort_involvedOnInternalCable": "Boolean_false", "aPort_involvedOnPhyConn": "Boolean_true", "aPort_neId": 100, "aPort_neLabel": "L0_GMRE_Site2", "aPort_networkInterfaceType": "NetworkInterfaceType_notMeaningful", "aPort_operationalState": "OperationalState_enabled", "aPort_otuSignalType": "OtuSignalType_otu2", "aPort_physicalPortType": "PortType_notMeaningful", "aPort_portBitRate": "10709", "aPort_id": 14025, "aPort_key": "Port/14025", "aPort_className": "Port", "aPort_technology": "Technology_wdm", "aPort_uploadSt": "UploadStatus_normal", "aPort_usedDir": "Direction_bidirectional", "aPort_usedOnOtn": "Boolean_false", "aPort_guiLabel": "L0_GMRE_Site2/11QPA4-1-17-L1", "aPort_wdmClientSignalType": "ClientSignalType_otu2", "aPort_wdmInterfaceType": "WdmInterfaceType_blackAndWhite", "aPort_wdmPhysicalPortRate": "10037.273Mbit/s", "aPort_wdmPortType": "WdmPortType_ops0", "aPort_wdmTransmissionMode": "WdmTransMode_crossRegen", "aPort_width": 50, "zPort": "" }

    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) Create ThreeR - (i) Add Drop Mode { "ok": true, "id": "1897132873583491", "responseMessage": "Success", "responseList": [ { "requestType": "Info", "messagetag": "TDMmsg_95_73", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 0, "httpresponse": 0 } 1) Create ThreeR - (ii) Regen Mode { "ok": true, "id": "1897132873583456", "responseMessage": "Success", "responseList": [ { "requestType": "Info", "messagetag": "TDMmsg_91_71", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 0, "httpresponse": 0 } 1) Create ThreeR - (iii) Cross Regen Mode { "ok": true, "id": "1897132873583567", "responseMessage": "Success", "responseList": [ { "requestType": "Info", "messagetag": "TDMmsg_90_30", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 0, "httpresponse": 0 }

    External Docs
    See Also :

    Operation

    delete /data/npr/threeRs/{threerId}
    Delete a 3R. (deleteThreeR : /data/npr/threeRs/{threerId})
    Delete ThreeR using ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    threerId required 'ThreeRId'can be retrieved from the REST call '/data/npr/threeRs' ---
    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 ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    Request call: /data/npr/threeRs/21

    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: { "ok": true, "id": "1646999424038993", "responseMessage": " The action is correctly started.\nStarting the deletion in database of 3R regenerator\nCorrectly finished the deletion in database of 3R regenerator\nThe action has been correctly executed.\nThe action is successfully terminated.\n ", "responseList": null, "HTTPResponse": 0, "httpresponse": 0 }

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

  • 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 ---