Operation
post /data/asonNBI/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId' it can be retrieved from /data/npr/npas?guiLabel={npaUserLabel}, where {npaUserLabel} is the user label of the NPA. | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
REST call: /data/asonNBI/npas/{npaId} Query Param: Fetch the NPA id from /data/asonNBI/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Example: /data/asonNBI/npas/21 Request Payload: { "Tag": "addLinksInNpa", "id": "21", "confSt": "ConfigurationState_implemented", "guiLabel": "L1NPA", "latency": "", "allPathCost": "", "asonWTR": "", "colorProfileName": "", "inniLinks_length": 1, "inniLinks_0_IdClass": 16, "inniLinks_0_alarmStatus": "AlarmStatus_cleared", "inniLinks_0_allPathCost": 20, "inniLinks_0_category": "physicalLink", "inniLinks_0_id": 667, "inniLinks_0_key": "AsonPotentialLink/667", "inniLinks_0_className": "AsonPotentialLink", "inniLinks_0_latency": 0, "inniLinks_0_linkType": "LinkType_split", "inniLinks_0_operationalState": "OperationalState_enabled", "inniLinks_0_srgPresent": "ObjectPresent_notPresent", "inniLinks_0_guiLabel": "lan-ops-1155-1155-site12" } 1)Implement an ASON NPA Example: /data/npr/npas/109 Request Payload { "Tag": "F_POP_Impl", "userLabel": "hema" } Response: { "ok": true, "id": "4052768114962323", "responseMessage": "ok", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "109", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "one", "comment2": "end", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 109, "key": "Npa/109", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "hema" }, "type": "Modify" } ] }, "httpresponse": 200 } 2)De-Implement ASON-NPA Example: /data/npr/npas/109 Request Payload { "Tag": "F_POP_Deimpl", "userLabel": "hema" } Response { "ok": true, "id": "4053063650589910", "responseMessage": "ok", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "109", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "one", "comment2": "end", "confSt": "ConfigurationState_defined", "modeOfOperation": "ProtOperationMode_revertive", "id": 109, "key": "Npa/109", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "hema" }, "type": "Modify" } ] }, "httpresponse": 200 }
Produces
text/xml
application/json
Example Response Data
Response: { "ok": true, "id": "518177026493285", "responseMessage": "Adding Link(s) to NPA Validation is successful", "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": { "/oms1350/events/npr/LinkAson": [ { "targetObj": { "myclass": "LinkAson", "id": "667" }, "attributes": { "IdClass": 16, "a2PortLabel": "", "aNodeId": -1, "aPortLabel": "", "alarmStatus": "AlarmStatus_cleared", "allPathCost": 20, "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "category": "", "colorProfileId": 1, "colorProfileName": "", "colorString": "", "id": 667, "key": "LinkAson/667", "className": "LinkAson", "defTime": 1460462446302, "implSt": "ImplementationState_implemented", "infrastructure": "", "latency": 0, "linkType": "LinkType_i_nni", "npaId": -1, "operationalState": "OperationalState_enabled", "otnMapper": 1640, "otuSignalType": "OtuSignalType_notMeaningful", "srgPresent": "ObjectPresent_notPresent", "teLinkId": -1, "teLinkName": "", "tunnelTrailId": -1, "guiLabel": "lan-ops-1155-1155-site12", "wrkSt": "WorkingState_normal", "z2PortLabel": "", "zNodeId": -1, "zPortLabel": "" }, "type": "Modify" } ], "/oms1350/events/npr/Npa": [ { "targetObj": { "myclass": "Npa", "id": "21" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 21, "key": "Npa/21", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "L1NPA" }, "type": "Modify" } ] }, "httpresponse": 200 }
Operation
post /data/npr/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId' it can be retrieved from /data/npr/npas?guiLabel={npaUserLabel}, where {npaUserLabel} is the user label of the NPA. | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
REST call: /data/npr/npas/{npaId} Query Param: Fetch the NPA id from /data/npr/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Example: /data/npr/npas/21 Request Payload: { "Tag": "addLinksInNpa", "id": "21", "confSt": "ConfigurationState_implemented", "guiLabel": "L1NPA", "latency": "", "allPathCost": "", "asonWTR": "", "colorProfileName": "", "inniLinks_length": 1, "inniLinks_0_IdClass": 16, "inniLinks_0_alarmStatus": "AlarmStatus_cleared", "inniLinks_0_allPathCost": 20, "inniLinks_0_category": "physicalLink", "inniLinks_0_id": 667, "inniLinks_0_key": "AsonPotentialLink/667", "inniLinks_0_className": "AsonPotentialLink", "inniLinks_0_latency": 0, "inniLinks_0_linkType": "LinkType_split", "inniLinks_0_operationalState": "OperationalState_enabled", "inniLinks_0_srgPresent": "ObjectPresent_notPresent", "inniLinks_0_guiLabel": "lan-ops-1155-1155-site12" } 1)Implement an ASON NPA Example: /data/npr/npas/109 Request Payload { "Tag": "F_POP_Impl", "userLabel": "hema" } Response: { "ok": true, "id": "4052768114962323", "responseMessage": "ok", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "109", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "one", "comment2": "end", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 109, "key": "Npa/109", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "hema" }, "type": "Modify" } ] }, "httpresponse": 200 } 2)De-Implement ASON-NPA Example: /data/npr/npas/109 Request Payload { "Tag": "F_POP_Deimpl", "userLabel": "hema" } Response { "ok": true, "id": "4053063650589910", "responseMessage": "ok", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "109", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "one", "comment2": "end", "confSt": "ConfigurationState_defined", "modeOfOperation": "ProtOperationMode_revertive", "id": 109, "key": "Npa/109", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "hema" }, "type": "Modify" } ] }, "httpresponse": 200 }
Produces
text/xml
application/json
Example Response Data
Response: { "ok": true, "id": "518177026493285", "responseMessage": "Adding Link(s) to NPA Validation is successful", "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": { "/oms1350/events/npr/LinkAson": [ { "targetObj": { "myclass": "LinkAson", "id": "667" }, "attributes": { "IdClass": 16, "a2PortLabel": "", "aNodeId": -1, "aPortLabel": "", "alarmStatus": "AlarmStatus_cleared", "allPathCost": 20, "asonAdmState": "AdminState_notApplicable", "asonAutoRestoration": "ExtOperSt_notMeaningful", "asonWTR": 60, "category": "", "colorProfileId": 1, "colorProfileName": "", "colorString": "", "id": 667, "key": "LinkAson/667", "className": "LinkAson", "defTime": 1460462446302, "implSt": "ImplementationState_implemented", "infrastructure": "", "latency": 0, "linkType": "LinkType_i_nni", "npaId": -1, "operationalState": "OperationalState_enabled", "otnMapper": 1640, "otuSignalType": "OtuSignalType_notMeaningful", "srgPresent": "ObjectPresent_notPresent", "teLinkId": -1, "teLinkName": "", "tunnelTrailId": -1, "guiLabel": "lan-ops-1155-1155-site12", "wrkSt": "WorkingState_normal", "z2PortLabel": "", "zNodeId": -1, "zPortLabel": "" }, "type": "Modify" } ], "/oms1350/events/npr/Npa": [ { "targetObj": { "myclass": "Npa", "id": "21" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 21, "key": "Npa/21", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "L1NPA" }, "type": "Modify" } ] }, "httpresponse": 200 }
Operation
post /data/asonNBI/npas
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
REST call: /data/asonNBI/npas Request Payload: { "Tag": "createNpa", "userLabel": "TestNPA", "comment1": "NPA1", "comment2": "" }
Produces
text/xml
application/json
Example Response Data
Response: { "ok": true, "id": "518326274444650", "responseMessage": "NPA Creation Validation is successful", "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
Operation
post /data/npr/npas
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
REST call: /data/npr/npas Request Payload: { "Tag": "createNpa", "userLabel": "TestNPA", "comment1": "NPA1", "comment2": "" }
Produces
text/xml
application/json
Example Response Data
Response: { "ok": true, "id": "518326274444650", "responseMessage": "NPA Creation Validation is successful", "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
Operation
delete /data/asonNBI/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'npaId'can be retrieved from the REST call '/data/npr/npas/npaLabel={npaUserLabel}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
Rest call: /data/asonNBI/npas/{npaId} Query Param: Fetch the NPA id from /data/asonNBI/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Request Payload: {"userLabel":"ASON-NPA1"}
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "28385226703682", "responseMessage": "Delete NPA Validation is successful", "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 }
Operation
delete /data/npr/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'npaId'can be retrieved from the REST call '/data/npr/npas/npaLabel={npaUserLabel}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
Rest call: /data/npr/npas/{npaId} Query Param: Fetch the NPA id from /data/npr/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Request Payload: {"userLabel":"ASON-NPA1"}
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "28385226703682", "responseMessage": "Delete NPA Validation is successful", "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 }
Operation
post /data/asonNBI/npas/discover/{nodeIds}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
nodeIds | required | nodeIdsStr | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
text/xml
application/json
External Docs
Operation
post /data/npr/npas/discover/{nodeIds}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
nodeIds | required | nodeIdsStr | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
Rest Call: /discover/{nodeIds}
Produces
text/xml
application/json
Example Response Data
Response: {}
External Docs
Operation
put /data/asonNBI/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId'can be retrieved from the REST call '/data/nprs/npas?npaUserLabel={userLabel}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
Request--->/data/asonNBI/npas/{npaId} Query Param: Fetch the NPA id from /data/asonNBI/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Example: /data/asonNBI/npas/41 Request Payload { "comment1": "For L0CP Region", "comment2": "Region AB", "Tag": "modify", "guiLabel": "ASON-NPA1" }
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "733860890189154", "responseMessage": "NPA Creation Validation is successful", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "41", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "For L0CP Region", "comment2": "Region AB", "confSt": "ConfigurationState_defined", "modeOfOperation": "ProtOperationMode_revertive", "id": 41, "key": "Npa/41", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "ASON-NPA1" }, "type": "Modify" } ] }, "httpresponse": 200 }
Operation
put /data/npr/npas/{npaId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId'can be retrieved from the REST call '/data/nprs/npas?npaUserLabel={userLabel}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
Request--->/data/npr/npas/{npaId} Query Param: Fetch the NPA id from /data/npr/npas?guiLabel="{npaUserLabel}" {npaUserLabel} = "ASON-NPA1" Example: /data/npr/npas/41 Request Payload { "comment1": "For L0CP Region", "comment2": "Region AB", "Tag": "modify", "guiLabel": "ASON-NPA1" }
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "733860890189154", "responseMessage": "NPA Creation Validation is successful", "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": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "41", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_cleared", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "For L0CP Region", "comment2": "Region AB", "confSt": "ConfigurationState_defined", "modeOfOperation": "ProtOperationMode_revertive", "id": 41, "key": "Npa/41", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_normal", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "ASON-NPA1" }, "type": "Modify" } ] }, "httpresponse": 200 }
Operation
delete /data/asonNBI/npas/{npaId}/linkAsons/{linkIds}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId'can be retrieved from the REST call '/data/nprs/npas?npaLabel='{npaUserLabel}' | --- |
linkIds | required | 'LinkIds'can be retrieved from the REST call '/data/nprs/npas?npaId='{npaId}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
Rest call: /data/asonNBI/npas/{npaId}/linkAsons/{linkId} Example: Unassign of 2 ASON Links, with Ids 68 and 70, from an ASON NPA with Id 1: DELETE /oms1350/data/asonNBI/npas/1/linkAsons/68,70 Rest call: /data/asonNBI/npas/1/linkAsons/68
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "735418594583013", "responseMessage": "Validation for Unassign Links from NPA is successful", "responseList": [ { "requestType": "Info", "messagetag": "ActionInProgress", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 200, "asonResponseList": [ { "requestType": "Info", "messagetag": "ActionInProgress", "errorMsgData": [ null ], "requestStatus": "Success" } ], "requestStatus": "Success", "eventableObjects": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "1", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_activeReportableMinor", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "ASON_L0CP", "comment2": "Managed by Automation", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 1, "key": "Npa/1", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_deimplementing", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "ASON_L0CP" }, "type": "Modify" } ] }, "httpresponse": 200 }
Operation
delete /data/npr/npas/{npaId}/linkAsons/{linkIds}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaId | required | 'NpaId'can be retrieved from the REST call '/data/nprs/npas?npaLabel='{npaUserLabel}' | --- |
linkIds | required | 'LinkIds'can be retrieved from the REST call '/data/nprs/npas?npaId='{npaId}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
Rest call: /data/npr/npas/{npaId}/linkAsons/{linkId} Example: Unassign of 2 ASON Links, with Ids 68 and 70, from an ASON NPA with Id 1: DELETE /oms1350/data/npr/npas/1/linkAsons/68,70 Rest call: /data/npr/npas/1/linkAsons/68
Produces
*/*
Example Response Data
Response: { "ok": true, "id": "735418594583013", "responseMessage": "Validation for Unassign Links from NPA is successful", "responseList": [ { "requestType": "Info", "messagetag": "ActionInProgress", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 200, "asonResponseList": [ { "requestType": "Info", "messagetag": "ActionInProgress", "errorMsgData": [ null ], "requestStatus": "Success" } ], "requestStatus": "Success", "eventableObjects": { "/oms1350/events/npr/Npa": [ { "targetObj": { "id": "1", "className": "Npa" }, "attributes": { "IdClass": 34, "alarmStatus": "AlarmStatus_activeReportableMinor", "asapName": "default ASAP", "bundlingRule": "BundlingRule_withSameRisks", "comment1": "ASON_L0CP", "comment2": "Managed by Automation", "confSt": "ConfigurationState_implemented", "modeOfOperation": "ProtOperationMode_revertive", "id": 1, "key": "Npa/1", "className": "Npa", "npaReductionCostFactor": 20, "npaType": "NpaType_ason", "npaUsageCost": 20, "npaWrkSt": "NpaWorkingState_deimplementing", "operationalState": "OperationalState_disabled", "operatorCommand": "OperatorCommand_notMeaningful", "plusAPSMode": "PlusAPSMode_genericAPS", "protSwitchMode": "ProtSwitchMode_bidirectional", "protectionStatus": "ProtStatus_notMeaningful", "supportedAu3": "SupportedAu3_notMeaningful", "switchUponSD": "Boolean_true", "timeSlotInterchange": "TimeSlotInterchange_allowed", "trafficPosition": "TrafficPosition_notMeaningful", "transpTechnology": "ConnecTechnology_wdm", "guiLabel": "ASON_L0CP" }, "type": "Modify" } ] }, "httpresponse": 200 }