Operation

post /data/otn/connections/{id}/abort
to abort Connection for specified Id (abortConnection : /data/otn/connections/{id}/abort)

Path parameters

Name

IsRequired

Description

Enum

id required connection id can be obtained from '/data/otn/connections' REST call as id ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional httpSession HttpSession ---
body2 optional locale Locale ---
Query parameters

Name

IsRequired

Description

orderNumber required ---
orderId required ---
type required ---
connName optional ---

Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/1952/abort?orderNumber=D2931&orderId=3849&type=NtwConnAbort&connName=73-INFRA%20OTU4%231

    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
    { "message": "Abort Order Action for order D2931 and connection 73-INFRA OTU4#1 Completed Successfully", "messageId": "OH1101I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1336176642331952", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/wlt/{id}/{dir}/acceptPower/{isProtection}
    acceptPower (acceptPower : /data/otn/wlt/{id}/{dir}/acceptPower/{isProtection})
    acceptPower

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    isProtection required isProtection ---
    dir required dir ---

    Return type
  • DeferredResult«Otn connection Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn connection Response»
    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/otn/connections/{id}/action
    Move order to Implemented or Allocated or Commissioned or complete step specified by Connection ID (actionConnection : /data/otn/connections/{id}/action)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/1917/action?orderNumber=R2865&orderId=3754&type=NtwConnAllocate&connName=NODE_C/4DPA4-2-3-C1%20NODE_D/4DPA4-2-11-C1%20DSR

    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
    { "message": "Abort Order Action for order D2931 and connection 73-INFRA OTU4#1 Completed Successfully", "messageId": "OH1101I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1378375414331917", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/notes/add
    add a new note (addNewNote : /data/otn/notes/add)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj NoteData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/asap
    To enable alarm profile or disable alarm reporting for connection specified by connection ID (asapConnection : /data/otn/connections/{id}/asap)
    Enables alarm profile or disables alarm reporting specified by connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    https://135.250.203.135:8443/oms1350/data/otn/connections/147/asap?orderNumber=A141&orderId=141&type=NtwConnManualEnableASAP&connName=NODE_1/ALPHG-12-15-LINE%20NODE_2/ALPHG-12-15-LINE%20OMS

    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
    { "message": "ASAP value setting for connection NODE_1/ALPHG-12-15-LINE NODE_2/ALPHG-12-15-LINE OMS completed successfully.", "messageId": "OH1127I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "NODE_1/ALPHG-12-15-LINE NODE_2/ALPHG-12-15-LINE OMS", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1605241392447616", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/alarms/ason
    Returns only ASON related Alarm details for given connection ID (asonAlarms : /data/otn/connections/{id}/alarms/ason)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections'REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/112/alarms/ason

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [ { "nodeName": "PSS64-41-210-1", "almraiseNature": "primary", "className": "alarm", "monitorValue": "Empty", "nAlmSeverity": "Warning", "eAlmProbCauseVal": "1052", "eRate": "", "connId": "112", "id": "0", "key": "0/alarm", "eAlmNativeProbCause": "SncpDegraded", "timeRaised": "2018-03-01T09:19:18Z", "eAlmSeverity": "Warning", "almDetails": "SNC Sncp Degraded", "almRaiseTime": "2018-03-01T09:19:18Z", "neUserLabel": "PSS64-41-210-1#OCS", "connectionRate": "ODU2E", "thresholdValue": "Empty", "eSAStatus": "AFFECTING", "eAlmDetails": "SNCP degraded", "eAlmProbCause": "SncpDegraded", "nprNeId": "2", "nAlmDetails": "SNC Sncp Degraded", "effectiveRate": "", "nProbableCause": "sncSncpDegraded", "connectionName": "PP_SNCtst ODU2E#0Main", "tpNativeName": "PP_SNCtst ODU2E#0Main", "sAStatusStr": "Service Failed" }, { "nodeName": "PSS64-41-210-1", "almraiseNature": "primary", "className": "alarm", "monitorValue": "Empty", "nAlmSeverity": "Warning", "eAlmProbCauseVal": "1049", "eRate": "", "connId": "112", "id": "1", "key": "1/alarm", "eAlmNativeProbCause": "ReadyToRevert", "timeRaised": "2018-03-01T09:26:42Z", "eAlmSeverity": "Warning", "almDetails": "SNC Ready To Revert", "almRaiseTime": "2018-03-01T09:26:42Z", "neUserLabel": "PSS64-41-210-1#OCS", "connectionRate": "ODU2E", "thresholdValue": "Empty", "eSAStatus": "NON_AFFECTING", "eAlmDetails": "Ready to revert", "eAlmProbCause": "ReadyToRevert", "nprNeId": "2", "nAlmDetails": "SNC Ready To Revert", "effectiveRate": "", "nProbableCause": "sncReadyToRevert", "connectionName": "PP_SNCtst ODU2E#0Main", "tpNativeName": "PP_SNCtst ODU2E#0Main", "sAStatusStr": "Non-Service Affecting" }, { "nodeName": "PSS64-41-210-1", "almraiseNature": "secondary", "className": "alarm", "monitorValue": "Empty", "nAlmSeverity": "Warning", "eAlmProbCauseVal": "1048", "eRate": "", "connId": "112", "id": "2", "key": "2/alarm", "eAlmNativeProbCause": "Rerouted", "timeRaised": "2018-03-01T08:46:44Z", "eAlmSeverity": "Warning", "almDetails": "SNC Rerouted", "almRaiseTime": "2018-03-01T08:46:44Z", "neUserLabel": "PSS64-41-210-1#OCS", "connectionRate": "ODU2E", "thresholdValue": "Empty", "eSAStatus": "NON_AFFECTING", "eAlmDetails": "Rerouted", "eAlmProbCause": "Rerouted", "nprNeId": "2", "nAlmDetails": "SNC Rerouted", "effectiveRate": "", "nProbableCause": "sncRerouted", "connectionName": "PP_SNCtst ODU2E#0Main", "tpNativeName": "PP_SNCtst ODU2E#0Main", "sAStatusStr": "Non-Service Affecting" } ], "failedCompletion": false, "successfulCompletion": false, "timeout": 0, "nadString": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/asonId
    to get asonId for connection specified by Id (asonIdFromOtnConnectionId : /data/otn/connections/{id}/asonId)
    returns asonId for connection specified by ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be derived as id from '/data/otn/connections' REST call ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/23/asonId

    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
    43

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/networkslice/connections/{connectionId}/assignSlice
    Assign Slice Id to a connection (assignNetworkSliceToConnection : /data/otn/networkslice/connections/{connectionId}/assignSlice)
    assignNetworkSliceToConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectionId required connectionId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req NetworkSliceReqResp ---

    Return type
  • NetworkSliceReqResp
  • Responses

    Response Messages

    Schema

    200success NetworkSliceReqResp
    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/otn/networkslice/connections/{connectionId}/assignSlice --> /data/otn/networkslice/connections/62/assignSlice { "sliceId" : "sliceName" }

    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: { "sliceId": "sliceName", "entityId": 62, "entityType": 1, "status": "SUCCESS", "errorMessage": null }

    External Docs
    See Also :

    Operation

    post /data/otn/ports/wlt/autoPowerAdjust
    to adjust power for a given connection id(Both A-end and Z-end details should be sent in Request) (autoAdjust : /data/otn/ports/wlt/autoPowerAdjust)
    autoAdjust

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req Otn WLT Adjust Request ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/ports/wlt/autoPowerAdjust PayLoad: {"wltKey":"conn(679).OPD_AZ","ldPorts":[{"id":1,"key":"ALPHG-1-17-LINE-9400.000/316699","className":"powerMeasurementPoint","guiLabel":"ALPHG-1-17-LINE-9400.000","neName":"PSS-32-NODE-A","portDirection":"Egress","powerMgmt":"Automatic","adjStatus":"Initial","adjResult":null,"label":"powerMeasurementPoint","portId":316699,"portName":"ALPHG-1-17-LINE-9400.000","neId":89,"ptpId":311103},{"id":2,"key":"ALPHG-1-17-LINE-9400.000/325139","className":"powerMeasurementPoint","guiLabel":"ALPHG-1-17-LINE-9400.000","neName":"PSS-32-NODE-C","portDirection":"Ingress","powerMgmt":"Automatic","adjStatus":"Initial","adjResult":null,"label":"powerMeasurementPoint","portId":325139,"portName":"ALPHG-1-17-LINE-9400.000","neId":93,"ptpId":318615}]}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "message": "Command Accepted", "messageId": "I18N_COMMAND_ACCEPTED", "messageSeverity": "", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :

    Operation

    post /data/otn/connections/{id}/autodetachclients
    to disassociate clients from the selected infrastructure connection (autodetachclients : /data/otn/connections/{id}/autodetachclients)
    Please Note: supported only for managed plane connections

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/337/autodetachclients

    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
    { "message": "Detach Clients completed successfully", "status": "SUCCESS", }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/autoreattachclients
    to reassociate clients from the selected infrastructure connection (autoreattachclients : /data/otn/connections/{id}/autoreattachclients)
    Please Note: supported only for managed plane connections

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/337/autoreattachclients

    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
    { "message": "Reattach Clients completed successfully", "status": "SUCCESS", }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/autoremoveprotection
    To remove the protection of a protected control plane connection specified by connection ID (autoremoveprotection : /data/otn/connections/{id}/autoremoveprotection)
    Please Note: supported only for L1,L0 connections ( except for few like GR and OPSA with CDC-F)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    actiontype required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/26469/autoremoveprotection?orderNumber=R40628&orderId=50747&actiontype=removeprotection&type=protection&connName=10GbE_IW_Test

    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
    { "message": "Modify order to Commissioned action completed successfully for Order Number IR40635 and Connection Name 10GbE_IW_Test", "messageId": "OH1001I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "10GbE_IW_Test", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/cancel
    To deactivate or delete a connection specified by connection ID (cancelConnection : /data/otn/connections/{id}/cancel)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Query parameters

    Name

    IsRequired

    Description

    orderName optional ---
    orderId optional ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/1952/cancel?orderNumber=D2931&orderId=3849&type=NtwConnCancel&connName=73-INFRA%20OTU4%231

    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
    { "message": "Delete order action is not allowed for order D2931 and connection 73-INFRA OTU4#1 because another order action is already in progress", "messageId": "OH1028E", "messageSeverity": "E", "status": "FAILURE", "connectionName": "73-INFRA OTU4#1", "connectionId": 1952, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1043493670971952", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/clientHierarchy
    to get client Hierarchy details for given connection Id (clientHierarchysById : /data/otn/connections/{id}/clientHierarchy)
    returns client Hierarchy information for connection Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Query parameters

    Name

    IsRequired

    Description

    query optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/439/clientHierarchy

    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
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ className: "trail", id: "247", key: "trail/247", guiLabel: "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-13T05:24:06Z", orderId: "299", groupOrderId: "248", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", connectionAlias: "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU1", effectiveRate: "ODU1", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A282", customerName: "None", serviceState: "ServiceState_ON", provisionableWavekey: "N/A", a1NeName: "NODE_1", a1PortName: "4DPA4-21-15-L1-1", z1NeName: "NODE_2", z1PortName: "4DPA4-21-15-L2-1", a1NodeName: "NODE_1", z1NodeName: "NODE_2", aNodeId: 3, zNodeId: 5, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_1/4DPA4-21-15-L1-1", zPortLabel: "NODE_2/4DPA4-21-15-L2-1", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/247", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", aportLabel: "NODE_1/4DPA4-21-15-L1-1", zportLabel: "NODE_2/4DPA4-21-15-L2-1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "249", key: "path/249", guiLabel: "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-13T05:24:12Z", orderId: "301", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "DSR", effectiveRate: "FC400", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A284", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "N/A", a1NeName: "NODE_2", a1PortName: "4DPA4-21-15-C3", z1NeName: "NODE_1", z1PortName: "4DPA4-21-15-C1", a1NodeName: "NODE_2", z1NodeName: "NODE_1", aNodeId: 5, zNodeId: 3, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_2/4DPA4-21-15-C3", zPortLabel: "NODE_1/4DPA4-21-15-C1", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/249", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", aportLabel: "NODE_2/4DPA4-21-15-C3", zportLabel: "NODE_1/4DPA4-21-15-C1", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }], data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/client
    to get client details for given connection Id (clientssById : /data/otn/connection/{id}/client)
    returns client information for given connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/439/client

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [1] 0: { "className": "trail" "id": "247" "key": "trail/247" "guiLabel": "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-13T05:24:06Z" "orderId": "299" "groupOrderId": "248" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "connectionAlias": "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "ODU1" "effectiveRate": "ODU1" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A282" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "4DPA4-21-15-L1-1" "z1NeName": "NODE_2" "z1PortName": "4DPA4-21-15-L2-1" "a1NodeName": "NODE_1" "z1NodeName": "NODE_2" "aNodeId": 3 "zNodeId": 5 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/4DPA4-21-15-L1-1" "zPortLabel": "NODE_2/4DPA4-21-15-L2-1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/247" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/4DPA4-21-15-L1-1" "zportLabel": "NODE_2/4DPA4-21-15-L2-1" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - - "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/computeLatency
    to compute the latencyMeasurement by connection ID's Or Connection Name's (computeLatencyMeasurementByConnectionIds : /data/otn/connections/computeLatency)
    computeLatencyMeasurementByConnectionIds

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required latencyValue ConnectionInputList ---

    Return type
  • ComputeLatencyMeasurementResponse
  • Responses

    Response Messages

    Schema

    200success ComputeLatencyMeasurementResponse
    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/otn/connections/computeLatency Request Payload: By ConnectionName { "connectionNameList":[ "11QPA4B-LL1 ODU2E:1 DSR:1" ] } By ConnectionId { "connectionIdList":[ "1894" ] }

    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
    /data/otn/connections/computeLatency Output : { "reqCompletionStatus":11, "requestId":0, "clientName":null, "clientLocation":null, "clientUser":null, "sessionId":"", "mdcId":null, "sequenceNum":0, "moreToCome":false, "messages":[ ], "errcde":null, "errorParams":null, "message":"Latency Measurement Initiated Successfully", "computeLatencyJobInfo":{ "1894":{ "jobId":5602, "taskId":5586, "requestId":"4845955125338941", "isValidUser":true } }, "failedCompletion":false, "successfulCompletion":true, "nadString":"", "timeout":0 }

    External Docs
    See Also :

    Operation

    get /data/otn/physicalConns/{nprId}/otnConnectionId
    to get otn connection Id for physical connection specified by nprId (connectionIdFromNprId : /data/otn/physicalConns/{nprId}/otnConnectionId)
    returns otn Connection Id for physical connection specified by NprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId can be retrieved from '/data/npr/physicalConns' as 'id' ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    /data/otn/physicalConns/17/otnConnectionId

    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
    231

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

  • Operation

    get /data/otn/physicalConns/{nprId}/otnConnectionIds
    to get otn connection Id for physical connection specified by nprId (connectionIdsFromNprIds : /data/otn/physicalConns/{nprId}/otnConnectionIds)
    returns otn Connection Id for physical connection specified by NprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId can be retrieved from '/data/npr/physicalConns' as 'id' ---

    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

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

  • Operation

    post /data/otn/physicalConns/otnConnectionIds
    to get otn connection Id for physical connection specified by nprId (connectionIdsFromNprIdsInRequestBody : /data/otn/physicalConns/otnConnectionIds)
    returns otn Connection Id for physical connection specified by NprId

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required nprId can be retrieved from '/data/npr/physicalConns' as 'id' String ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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.
    • application/json

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

  • Operation

    get /data/otn/connections/{id}/structure
    to get structure details for given connection Id (connectionStructureFromId : /data/otn/connections/{id}/structure)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/43/structure

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ className: "trail", id: "246", key: "trail/246", guiLabel: "NODE_1/4DPA4-21-15-L1 NODE_2/4DPA4-21-15-L2 OTU1", hasChildren: "true", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-13T05:24:01Z", orderId: "298", groupOrderId: "248", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", connectionAlias: "NODE_1/4DPA4-21-15-L1 NODE_2/4DPA4-21-15-L2 OTU1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU1", effectiveRate: "OTU1", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", frequency: "N/A", orderNumber: "A281", customerName: "None", serviceState: "ServiceState_ON", provisionableWavekey: "N/A", a1NeName: "NODE_1", a1PortName: "4DPA4-21-15-L1", z1NeName: "NODE_2", z1PortName: "4DPA4-21-15-L2", a1NodeName: "NODE_1", z1NodeName: "NODE_2", aNodeId: 3, zNodeId: 5, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_1/4DPA4-21-15-L1", zPortLabel: "NODE_2/4DPA4-21-15-L2", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/246", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", timeSlots_numTotal: "1", timeSlots_numUsed: "1", timeSlots_numRsvd: "0", timeSlots_numFree: "0", timeSlots: [{ className: "payloadSlot", id: "692", key: "payloadSlot/692", guiLabel: "1", state: "LCS_IN_EFFECT", objRef: { className: "trail", id: "247", key: "trail/247", guiLabel: "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" } }], aportLabel: "NODE_1/4DPA4-21-15-L1", zportLabel: "NODE_2/4DPA4-21-15-L2", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "247", key: "trail/247", guiLabel: "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", parentId: "246", hasChildren: "true", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: 0, connectionType: "trail", receivedDate: "2016-04-13T05:24:06Z", orderId: "299", groupOrderId: "248", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", connectionAlias: "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU1", effectiveRate: "ODU1", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", orderNumber: "A282", customerName: "None", serviceState: "ServiceState_ON", provisionableWavekey: "N/A", a1NeName: "NODE_1", a1PortName: "4DPA4-21-15-L1-1", z1NeName: "NODE_2", z1PortName: "4DPA4-21-15-L2-1", a1NodeName: "NODE_1", z1NodeName: "NODE_2", aNodeId: 3, zNodeId: 5, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_1/4DPA4-21-15-L1-1", zPortLabel: "NODE_2/4DPA4-21-15-L2-1", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/247", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", timeSlots_numTotal: "4", timeSlots_numUsed: "1", timeSlots_numRsvd: "0", timeSlots_numFree: "3", timeSlots: [{ className: "payloadSlot", id: "694", key: "payloadSlot/694", guiLabel: "1", state: "LCS_IN_EFFECT", objRef: { className: "path", id: "249", key: "path/249", guiLabel: "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR" } }, { className: "payloadSlot", id: "695", key: "payloadSlot/695", guiLabel: "2", state: "LCS_UNUSED" }, { className: "payloadSlot", id: "696", key: "payloadSlot/696", guiLabel: "3", state: "LCS_UNUSED" }, { className: "payloadSlot", id: "697", key: "payloadSlot/697", guiLabel: "4", state: "LCS_UNUSED" }], aportLabel: "NODE_1/4DPA4-21-15-L1-1", zportLabel: "NODE_2/4DPA4-21-15-L2-1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "249", key: "path/249", guiLabel: "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR", parentId: "247", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: 0, connectionType: "path", receivedDate: "2016-04-13T05:24:12Z", orderId: "301", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "DSR", effectiveRate: "FC400", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", orderNumber: "A284", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "N/A", a1NeName: "NODE_2", a1PortName: "4DPA4-21-15-C3", z1NeName: "NODE_1", z1PortName: "4DPA4-21-15-C1", a1NodeName: "NODE_2", z1NodeName: "NODE_1", aNodeId: 5, zNodeId: 3, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_2/4DPA4-21-15-C3", zPortLabel: "NODE_1/4DPA4-21-15-C1", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/249", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", timeSlots_numTotal: "0", timeSlots_numUsed: "0", timeSlots_numRsvd: "0", timeSlots_numFree: "0", timeSlots: [], aportLabel: "NODE_2/4DPA4-21-15-C3", zportLabel: "NODE_1/4DPA4-21-15-C1", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }], data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/physicalConns/{nprId}
    to get otn connection record for physical connection specified by nprId (connectionsFromNprIds : /data/otn/physicalConns/{nprId})
    returns otn Connection Id for physical connection specified by NprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId can be retrieved from '/data/npr/physicalConns' as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • get : /data/npr/physicalConns

  • Operation

    post /data/otn/physicalConns
    to get otn connection record for physical connection specified by nprId in POST body (connectionsFromNprIdsAsRequestBody : /data/otn/physicalConns)
    returns bandwidth use data for given ots connection ID(s)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required nprId can be retrieved from '/data/npr/physicalConns' as 'id' String ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/Connection/{id}/convertCurrentToNominal
    to convert current Route to Nominal Route for rerouted SubNetworkConnection (convertCurrentToNominal : /data/otn/Connection/{id}/convertCurrentToNominal)
    Please Note: Operation only for Control Plane Connection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    asonId required ---
    connectionName required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/Connection/883/convertCurrentToNominal?asonId=9449&connectionName=LINK-NODE1-2-WITH7Main

    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
    { "message": "Modify order to Commissioned action completed successfully for Order Number IR1460 and Connection Name LINK-NODE1-2-WITH7", "messageId": "OH1001I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "g-LINK-NODE1-2-WITH7", "connectionId": 1045, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/crossConnects/create
    to create a cross connection (createCrossConnection : /data/otn/crossConnects/create)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    neName required ---
    aEnd required ---
    zEnd required ---
    cdrChannelId required ---
    cdrChannelRate required ---
    cdrChannelLabel required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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.
    • application/json

    External Docs
    See Also :
  • listCrossConnectionsFromNode : /data/otn/nodes/{nprNodeId}/crossConnects

  • Operation

    post /data/otn/connections/internallinks
    To create Internal Links (createInternalConnection : /data/otn/connections/internallinks)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req contains the A End Port and Z End Port details between which Internal Link needs to be created (Mandatory) InternalConnectionReq ---
    body2 optional httpSession HttpSession ---
    body3 optional locale Locale ---

    Return type
  • InternalConnectionRsp
  • Responses

    Response Messages

    Schema

    200success InternalConnectionRsp
    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/otn/connections/internallinks Payload: { "connectionName": "", "crossRegenPort": "", "fromport1": "11DPM12-24-6-L1", "mvacPort": "", "protectionPort": "", "serviceRate": "OTU2", "tid": "NODE-1", "toport1": "SFD-24-7-9190", "toport2": "", "vaPort": "VA1" }

    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
    { "message": "Move order to Commissioned action completed successfully for Order Number A944 and Connection Name NODE_2/11DPM12-3-2-L1/SFD-3-3-9210/OS", "opStatus": "SUCCESS", "connectionId": "-1", "connectionName": "", "failed": "SUCCESS" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/Connection
    to create or modify control plane or manage plane connections which includes infrastructure, Logical Link and service (createModifyConnection : /data/otn/Connection)
    Please note it is an asynchronous call

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required req OtnConnectionRequest ---
    body2 optional httpSession HttpSession ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/Connection PayLoad: { "containerRateMap":{ "FC100":"TxContainer0", "1GbE":"TxContainer7", "1GbEConv":"TxContainer7", "FE":"TxContainer7", "SDSDI":"TxContainer0", "FC200":"TxContainer1", "HDSDI":"TxContainer1", "OC48":"TxContainer12", "OC-48":"TxContainer12", "STM16":"TxContainer12", "STM-16":"TxContainer12", "STM16MS":"TxContainer1", "STM-16MS":"TxContainer1", "OC192":"TxContainer2", "OC-192":"TxContainer2", "STM64":"TxContainer2", "STM-64":"TxContainer2", "STM64MS":"TxContainer2", "STM-64MS":"TxContainer2", "OC768":"TxContainer3", "OC-768":"TxContainer3", "STM256":"TxContainer3", "STM-256":"TxContainer3", "100GbE":"TxContainer4", "FC400":"TxContainer13", "FC800":"TxContainer11", "40GbeMLD":"TxContainer5", "DDR":"TxContainer5", "3GSDI":"TxContainer5", "10GbE":"TxContainer6", "OC3":"TxContainer7", "OC-3":"TxContainer7", "OC12":"TxContainer7", "OC-12":"TxContainer7", "STM1":"TxContainer7", "STM-1":"TxContainer7", "STM4":"TxContainer7", "STM-4":"TxContainer7", "FC1200":"TxContainer99", "FC1600":"TxContainer9", "FC3200":"TxContainer5", "40GbE":"TxContainer3", "CBR10G3":"TxContainer10", "default":"TxContainer", "FlexClientRate":"TxContainer5" }, "protectiontype":"9", "networkProtectionMode":"0", "clientprotectiontype":"0", "switchType":"0", "reversionTimer":"N/A", "ycableswitchmode":"bi", "ycableprotectionmode":"standard", "ycableholdofftime":"0", "ycablerevertivemode":"Disabled", "ycablerestoretime":"5", "nwkholdofftime":"0", "nwkprotectedMethod":"0", "nwkprotectingMethod":"0", "nwksignaldegrade":"0", "nwkrevertivemode":"1", "nwkwaittime":"5", "opsbrevertivemode":"Enabled", "opsbrestoretime":"25", "serviceratetype":"Ethernet", "servicerate":"1GbE", "signalType":"1GbE", "connshape":"8", "fecMode":"UseNEValue", "wavekeytype":"auto", "AZWaveKeyPreference":"none", "ZAWaveKeyPreference":"none", "provisionwavekey":"keyed", "Latency":"true", "containerrate":"ODU0", "LOSPropagation":"BothAZ", "xmnActualBitRate":"Default", "ssfDelayTimer":"Use NE Value", "bandwidth":"10", "alarmEnable":"NOTSET", "autoInService":"Disable", "AutoInServiceTimer":"Default", "pm15min":"false", "pm24hr":"true", "nimEnabled":"true", "linkUtilProfile":"MEDIUM", "ASONRouted":"false", "preferredRestorationMode":"norestore", "reversionMode":"manual", "waitForServerRestoration":"na", "defaultpriority":"4", "defaultsetuppriority":"5", "lopc":"false", "lBandFreq":"", "routing":"1", "autoprovision":"true", "integratedprovision":"false", "orderstep":"9", "routedisplay":"true", "allowUncommissioned":"true", "cirrate":"0", "cbs":"CBS16", "ebs":"CBS16", "trailrate":"ODU0", "omsProtectionMode":"OMSP", "aendworkport":"porta", "fec":"UseNEValue", "encoding":"", "waveShape":"", "phaseEncoding":"Absolute", "spectrumWidth":"", "MRNTunnel":"false", "ASONConnectionType":"noTunnel", "showAllPorts":"false", "rollBack":"false", "fromporttype1":"Terminated", "fromPort1XFP":"", "toporttype1":"Terminated", "toPort1XFP":"", "fromporttype2":"Terminated", "fromPort2XFP":"", "toporttype2":"Terminated", "toPort2XFP":"", "fromaside":"working", "toaside":"working", "ycablesignaldegrade":"Disabled", "fromwkPort1XFP":"", "fromprotPort1XFP":"", "towkPort1XFP":"", "toprotPort1XFP":"", "ycabletimeslot":"1", "odukTraceMismatchAction":"UseNevalue", "odukTraceMismatchDectMode":"UseNevalue", "ProvisionedBitRate":"UseNEValue", "ProvisionedBitRateDsr":"UseNEValue", "fecEnable":"UseNEValue", "asymInterwk":"UseNEValue", "Odu4InterworkingMode":"UseNEValue", "encryptionState":"UseNEValue", "encryptionSwitchOverToNextKey":"UseNEValue", "PayloadTypeMismatchResponse":"UseNEValue", "mappingmode":"UseNEValue", "EncapsulationMode":"UseNEValue", "apsEnable":"UseNEValue", "ssmSupport":"UseNEValue", "outQl":"UseNEValue", "polarization":"usenevalue", "opsaRevertiveMode":"disable", "opsaWaitToRestore":"1", "clientSwitchMode":"uni", "clientholdofftime":"0", "clientprotectedMethod":"0", "clientprotectingMethod":"0", "clientsignaldegrade":"0", "clientwaittime":"5", "clientrevertivemode":"1", "nwkprotectiontype":"0", "nwkSwitchMode":"uni", "nwkprotectedMethod3":"0", "nwkprotectingMethod3":"0", "asonsubntwkprttype":"SNCP", "softRevertiveSncpMode":"NodeDefault", "softRevertiveSncpTimeout":60, "routingeffort":"2", "ignorealarm4route":"false", "sysAssignFreq":"true", "usecwdmfreq":"false", "reinstate":"none", "rearrange":"soft", "subsea":"false", "ordersensitive":"false", "opticalImpairmentRouting":"", "tpmonitor15":"2", "direction15":"0", "reportinfo15":"1", "pmdata15":"0", "tpmonitor24":"2", "direction24":"0", "reportinfo24":"0", "pmdata24":"0", "wavekeyassignment":"system", "azwavekeypref":"none", "zawavekeypref":"none", "azwavekeyrekey":"NORekey", "zawavekeyrekey":"NORekey", "tcmLevel":"notcm", "hasycable1":"no", "txParamData":[ { "parameter":"AEndNegotn", "name":"AEndnegotn", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Enabled", "Disabled" ], "maxlength":0 }, "midCols":[ "" ], "provisioningLayer":"", "selected":false }, { "parameter":"ZEndNegotn", "name":"ZEndnegotn", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Enabled", "Disabled" ], "maxlength":0 }, "midCols":[ "" ], "provisioningLayer":"", "selected":false }, { "parameter":"CRCFraming", "name":"crcFraming", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Standard", "Non-Standard" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ALOSPropagation", "name":"AEndLaserState", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "Laser On" ], "maxlength":0 }, "midCols":[ "" ], "provisioningLayer":"", "selected":true }, { "parameter":"ZLOSPropagation", "name":"ZEndLaserState", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Laser On", "Laser Off" ], "maxlength":0 }, "midCols":[ "" ], "provisioningLayer":"", "selected":true }, { "parameter":"AEndinopsb", "name":"AEndinopsb", "currentValue":"Y", "type":"Enumeration", "editorArgs":{ "options":[ "Y", "Use NE Value", "N" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"BurstIntervalSDDetection", "name":"brstintvl", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"BurstThresholdSDDetection", "name":"brstthr", "currentValue":"Use NE Value", "type":"String", "editorArgs":null, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"AEndCSFConsequenctAction", "name":"AEndCsf", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "No Action" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"AEndSSFConsequenctAction", "name":"AEndSsf", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "No Action" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"AEndSSDConsequenctAction", "name":"AEndssd", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "No Action" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkSourceAZTTI", "name":"TrailTraceActualTx", "currentValue":"Use NE Value", "type":"String", "editorArgs":{ "options":null, "maxlength":15 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkSourceZATTI", "name":"TrailTraceExpectedRx", "currentValue":"Use NE Value", "type":"String", "editorArgs":{ "options":null, "maxlength":15 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkTTIMonitor", "name":"TrailTraceMonitor", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Source Enabled", "Disabled" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkTraceMismatchMonitor", "name":"TrailTraceEnablePoints", "currentValue":"Enable End-points only", "type":"Enumeration", "editorArgs":{ "options":[ "Enable End-points only", "Enable All", "Use NE Value" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkTTIMismatchConsequentAction", "name":"CAonTIM", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Enable", "Disable" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"SignalDegradeThreshold", "name":"degUcbThr", "value":"4" "currentValue":"2", "type":"String", "editorArgs":{ "options":null }, "midCols":[ null ], "provisioningLayer":null, "selected":true }, { "parameter":"SignalDegradeDetection", "name":"degUcbMon", "value":"Enabled" "currentValue":"Disabled", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value "Enabled", "Disabled" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":true }, { "parameter":"SignalDegradeInterval", "name":"degUcbIntvl", "value":"5" "currentValue":"6", "type":"String", "editorArgs":{ "options":null }, "midCols":[ null ], "provisioningLayer":null, "selected":true }, { "parameter":"SignalDegradeDetection", "name":"degUcbMon", "value":"Enabled" "currentValue":"Disabled", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value "Enabled", "Disabled" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":true }, { "parameter":"ODUkPayloadTypeResp", "name":"PayloadTypeMismatchResponse", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Enable", "Disable" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"Payloadtype", "name":"payloadType", "currentValue":"Use NE Value", "type":"String", "editorArgs":null, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkBurstIntervalSDDetection", "name":"brstintvl", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkBurstThresholdSDDetection", "name":"brstthr", "currentValue":"Use NE Value", "type":"String", "editorArgs":null, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkALOSPropagation", "name":"AEndLaserState", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Laser On", "Laser Off" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ODUkZLOSPropagation", "name":"ZEndLaserState", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "Laser On", "Laser Off" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ZEndCSFConsequenctAction", "name":"ZEndCsf", "currentValue":"Use NE Value", "type":"Enumeration", "editorArgs":{ "options":[ "Use NE Value", "No Action", "Laser Off" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ZEndSSFConsequenctAction", "name":"ZEndSsf", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "No Action" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false }, { "parameter":"ZEndSSDConsequenctAction", "name":"ZEndssd", "currentValue":"Laser Off", "type":"Enumeration", "editorArgs":{ "options":[ "Laser Off", "Use NE Value", "No Action" ], "maxlength":0 }, "midCols":[ null ], "provisioningLayer":null, "selected":false } ], "eirrate":"0", "hasopsa":"no", "payloadType":"UseNEValue", "fromne1":"PSS32-41.89.17", "fromne1_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.17", "id":"3", "productName":"1830PSS_32" }, "ycablefromne_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.17", "id":"3", "productName":"1830PSS_32" }, "asidefromne":"PSS32-41.89.17", "bsidefromne":"PSS32-41.89.17", "asidefromne_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.17", "id":"3", "productName":"1830PSS_32" }, "bsidefromne_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.17", "id":"3", "productName":"1830PSS_32" }, "ycablefromne":"PSS32-41.89.17", "tone1":"PSS32-41.89.18", "tone1_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.18", "id":"4", "productName":"1830PSS_32" }, "ycabletone":"PSS32-41.89.18", "ycabletone_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.17", "id":"3", "productName":"1830PSS_32" }, "asidetone":"PSS32-41.89.18", "bsidetone":"PSS32-41.89.18", "asidetone_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.18", "id":"4", "productName":"1830PSS_32" }, "bsidetone_AdditionalInfo":{ "type":"NODE", "name":"PSS32-41.89.18", "id":"4", "productName":"1830PSS_32" }, "fromport1":"OPS-2-4-SIG", "fromport1_AdditionalInfo":{ "neId":6, "neName":"PSS32-41.89.17", "portName":"OPS-2-4-SIG", "label":"OPS-2-4-SIG", "portid":14, "cardName":"OPSB", "portGrpMode":"N/A", "odukrate":"OCHT", "rate":"OCHT", "frequencyType":null }, "hasopsb":"yes", "hasycable":"no", "hassdx":"no", "toport1":"OPS-2-4-SIG", "toport1_AdditionalInfo":{ "neId":8, "neName":"PSS32-41.89.18", "portName":"OPS-2-4-SIG", "label":"OPS-2-4-SIG", "portid":520, "cardName":"OPSB", "portGrpMode":"N/A", "odukrate":"OCHT", "rate":"OCHT", "frequencyType":null }, "asidetoport":"11DPM8-2-5-C1", "bsidefromport":"11DPM8-2-6-C1", "bsidetoport":"11DPM8-2-6-C1", "isOCSEnd":"no", "asidetoport_AdditionalInfo":{ }, "bsidefromport_AdditionalInfo":{ }, "bsidetoport_AdditionalInfo":{ }, "connectionname":"OPSB Service", "asidefromport":"11DPM8-2-5-C1", "asidefromport_AdditionalInfo":{ "neId":6, "neName":"PSS32-41.89.17", "portName":"11DPM8-2-5-C1", "label":"11DPM8-2-5-C1", "portid":109, "cardName":"11DPM8", "portGrpMode":"N/A", "frequencyType":"unknown" }, "operation":"create", "routefrequency":"", "routefrequency2":"", "otnRoutingConstraints":[ ], "frombside":"Protection", "tobside":"Protection", "customerName":"", "requestId":678231, "eventChannel":"/oms1350/events/otn/prov/jobEvent/678231" }

    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
    { "message": "Command Accepted", "messageId": "I18N_COMMAND_ACCEPTED", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "g-swagger_svc1", "connectionId": 1545, "orderNumber": "", "orderId": "", "orderStep": 0, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • listLinkConnectionsFromConnection : /data/otn/connections/{connId}/linkConnection
  • getEligiblePorts : /data/otn/connectionTP
  • get3RPorts : /data/otn/3RPorts

  • Operation

    post /data/otn/Connection/UsingTemplate
    to create or modify control plane or manage plane connections which includes infrastructure, Logical Link and service based on template (createModifyConnectionBasedOnTemplate : /data/otn/Connection/UsingTemplate)
    template ID can be retrieved from '/data/otn/connectionTemplates/folders/{folderId}/templates' REST call; Please note it is an asynchronous call

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required req OtnConnectionRequest ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/Connection/UsingTemplate PayLoad: { "templateId": "21", "revertive": "2", "reversionTimer": "N/A", "serviceratetype": "Ethernet", "servicerate": "1GbE", "signalType": "1GbE", "connshape": "8", "LOSPropagation": "BothAZ", "xmnActualBitRate": "Default", "alarmEnable": "NOTSET", "autoInService": "Enable", "AutoInServiceTimer": "Default", "preferredRestorationMode": "norestore", "reversionMode": "manual", "waitForServerRestoration": "false", "lopc": "false", "routing": "1", "autoprovision": "true", "integratedprovision": "false", "orderstep": "9", "routedisplay": "true", "allowUncommissioned": "true", "provisionwavekey": "keyed", "cirrate": "0", "cbs": "CBS16", "ebs": "CBS16", "trailrate": "ODU0", "aendworkport": "porta", "fec": "UseNEValue", "transmissionmode": "", "phaseEncoding": "Absolute", "MRNTunnel": "false", "ASONConnectionType": "noTunnel", "showAllPorts": "false", "fromporttype1": "Terminated", "fromPort1XFP": "", "toporttype1": "Terminated", "toPort1XFP": "", "fromporttype2": "Terminated", "fromPort2XFP": "", "toporttype2": "Terminated", "toPort2XFP": "", "fromaside": "working", "toaside": "working", "ycablesignaldegrade": "Disabled", "ycableswitchmode": "uni", "ycablerevertivemode": "Disabled", "ycablerestoretime": "5", "ycabletimeslot": "1", "odukTraceMismatchAction": "UseNevalue", "odukTraceMismatchDectMode": "UseNevalue", "ProvisionedBitRate": "UseNEValue", "ProvisionedBitRateDsr": "UseNEValue", "fecEnable": "UseNEValue", "asymInterwk": "UseNEValue", "Odu4InterworkingMode": "UseNEValue", "encryptionState": "UseNEValue", "encryptionSwitchOverToNextKey": "UseNEValue", "PayloadTypeMismatchResponse": "UseNEValue", "mappingmode": "UseNEValue", "EncapsulationMode": "UseNEValue", "apsEnable": "UseNEValue", "ssmSupport": "UseNEValue", "outQl": "UseNEValue", "clientholdofftime": "0", "clientprotectedMethod": "0", "clientprotectingMethod": "0", "clientsignaldegrade": "0", "clientwaittime": "5", "clientrevertivemode": "1", "nwkprotectiontype": "0", "nwkholdofftime": "0", "nwkprotectedMethod": "0", "nwkprotectedMethod3": "0", "nwkprotectingMethod": "0", "nwkprotectingMethod3": "0", "nwksignaldegrade": "0", "nwkwaittime": "5", "nwkrevertivemode": "1", "asonsubntwkprttype": "SNCP", "routingeffort": "2", "ignorealarm4route": "false", "sysAssignFreq": "true", "usecwdmfreq": "false", "reinstate": "none", "rearrange": "soft", "ordersensitive": "false", "tpmonitor15": "2", "direction15": "0", "reportinfo15": "1", "pmdata15": "0", "tpmonitor24": "2", "direction24": "0", "reportinfo24": "0", "pmdata24": "0", "wavekeytype": "auto", "wavekeyassignment": "system", "azwavekeypref": "none", "zawavekeypref": "none", "azwavekeyrekey": "NORekey", "zawavekeyrekey": "NORekey", "tcmLevel": "notcm", "hasycable1": "no", "txParamData": [{ "parameter": "AEndNegotn", "name": "AEndnegotn", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "ZEndNegotn", "name": "ZEndnegotn", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "CRCFraming", "name": "crcFraming", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Standard", "Non-Standard"], "maxlength": 0 } }, { "parameter": "ODUkSourceAZTTI", "name": "TrailTraceActualTx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "ODUkSourceZATTI", "name": "TrailTraceExpectedRx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "ODUkTTIMonitor", "name": "TrailTraceMonitor", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Source Enabled", "Disabled"], "maxlength": 0 } }, { "parameter": "ODUkTTIMismatchConsequentAction", "name": "CAonTIM", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "ODUkPayloadTypeResp", "name": "PayloadTypeMismatchResponse", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "Payloadtype", "name": "payloadType", "currentValue": "Use NE Value", "type": "String", "editorArgs": null }, { "parameter": "ODUkBurstIntervalSDDetection", "name": "brstintvl", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10"], "maxlength": 0 } }, { "parameter": "ODUkBurstThresholdSDDetection", "name": "brstthr", "currentValue": "Use NE Value", "type": "String", "editorArgs": null }], "eirrate": "0", "payloadType": "UseNEValue", "fromne1": "PSS32-20-5-32", "ycablefromne": "PSS32-20-5-32", "fromport1": "11DPM12-8-3-C1", "fromport1_AdditionalInfo": { "neId": 7, "neName": "PSS32-20-5-32", "portName": "11DPM12-8-3-C1", "label": "11DPM12-8-3-C1", "portid": 17827, "cardName": "11DPM12", "portGrpMode": "N/A", "odukrate": "1GbE", "rate": "1GbE" }, "hasopsb": "no", "hasycable": "no", "hassdx": "no", "tone1": "PSS32-20-5-33", "ycabletone": "PSS32-20-5-33", "toport1": "11DPM12-8-3-C1", "toport1_AdditionalInfo": { "neId": 10, "neName": "PSS32-20-5-33", "portName": "11DPM12-8-3-C1", "label": "11DPM12-8-3-C1", "portid": 18619, "cardName": "11DPM12", "portGrpMode": "N/A", "odukrate": "1GbE", "rate": "1GbE" }, "connectionname": "Swagger_11DPM12_ODU0_DSR", "operation": "create", "routefrequency": "", "requestId": 722440, "eventChannel": "/oms1350/events/otn/prov/jobEvent/722440", "otnRoutingConstraints": [], "defaultpriority": "4", "defaultsetuppriority": "5", "frombside": "Protection", "tobside": "Protection", "customerName": "" }

    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
    { "message": "Command Accepted", "messageId": "I18N_COMMAND_ACCEPTED", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "g-Swagger_11DPM12_ODU0_DSR", "connectionId": 218, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • listLinkConnectionsFromConnection : /data/otn/connections/{connId}/linkConnection
  • getEligiblePorts : /data/otn/connectionTP
  • get3RPorts : /data/otn/3RPorts
  • getTemplates : /data/otn/connectionTemplates/folders/{folderId}/templates

  • Operation

    post /data/otn/connections/{id}/tcm/createTCM
    to create Tandem Connection Monitoring(TCM) for given connection id (createTCM : /data/otn/connections/{id}/tcm/createTCM)
    The default parameters can be fetched from 'showTCMCreatelist' REST call

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from 'id' attribute of '/data/otn/connections' REST call ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required tcmReqfinal TCMconnectionRequest ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/509/tcm/createTCM { "connectionName": "ODU4 LL", "connectionId": "509", "level": "6", "position": "1", "a1NodeName": "SRNode-1", "z1NodeName": "SRNode-2", "a1PortName": "OTUODU4-1-1-36-1", "z1PortName": "OTUODU4-2-4-L1-CH1", "a2NodeName": "", "z2NodeName": "", "a2PortName": "", "z2PortName": "", "alarmEnabling": "Enabled", "profileName": "ODU4TCM", "pm15MinuteCollectionType": "Yes", "pm15MinuteMonitoringSelection": "TCM Termination", "pm15MinuteDirection": "Unidirectional", "pm15MinuteReportInfo": "CSV 2 Hr", "pm15MinuteDataPurgePolicy": "Keep PM Data upon Connection Deletion", "pm24HourCollectionType": "No", "pm24HourMonitoringSelection": "TCM Termination", "pm24HourDirection": "Unidirectional", "pm24HourReportInfo": "CSV 24 Hr", "pm24HourDataPurgePolicy": "Keep PM Data upon Connection Deletion", "TCMTrailTraceActualDestTx": "Use NE Value", "TCMTrailTraceActualTx": "Use NE Value", "TCMTrailTraceExpectedDestRx": "Use NE Value", "TCMTrailTraceExpectedRx": "Use NE Value", "TCMTrailTraceActualOsTx": "Use NE Value", "CAonLTCDef": "Use NE Value", "TCMTrailTraceMonitor": "Use NE Value", "CAonTCMTIM": "Use NE Value", "CAonTCMDef": "Use NE Value" }

    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
    { "message": "TCM Ports Provisioning completed successfully.", "messageId": "OH1157I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "ODU4 LL ", "connectionId": 509, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • showTCMCreatelist : /data/otn/connections/{id}/tcm/createTCMInfo

  • Operation

    get /data/otn/connections/{id}/currentRouteL1RD
    currentRouteL1RDById (currentRouteL1RDById : /data/otn/connections/{id}/currentRouteL1RD)
    currentRouteL1RDById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    sdhConnectionId required ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/currentRouteRD
    to get Current Route Details for given connection ID (currentRouteRDById : /data/otn/connections/{id}/currentRouteRD)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    sdhConnectionId required ---
    ochTrailLabel required ---
    aNodeId required ---
    aPortName required ---
    zNodeId required ---
    zPortName required ---
    aNodeName required ---
    zNodeName required ---
    is3R required ---
    protectionRole required ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/delete
    To deactivate and delete a connection (deleteConnection : /data/otn/connections/{id}/delete)
    Please note it is an synchronous call

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from 'id' attribute of '/data/otn/connections' REST call ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber optional ---
    orderId optional ---
    type required ---
    connName optional ---
    asynchronous optional ---
    requestId optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/1550/delete?type=NtwConnDelete

    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
    { "message": "Remove order action for order ID2353 and connection ser-11dpm12 completed successfully. ", "messageId": "OH1018I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "ser-11dpm12", "connectionId": 1550, "orderNumber": "", "orderId": "", "orderStep": 0, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/crossConnects/delete
    to delete a cross connection (deleteCrossConnection : /data/otn/crossConnects/delete)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    neName required ---
    crossConnectionName required ---
    sncId required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/crossConnects/delete?neName=PHN-1&crossConnectionName=PRU-SER%2332%20ODU1%231&sncId=1625

    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
    { "message": "Simple(Bi) Cross connection between 11DPM12-16-6-L1-1-1 and 11DPM12-16-6-C2 on PHN-1 successfully removed", "messageId": "OH1048I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1365373214331625", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • listCrossConnectionsFromNode : /data/otn/nodes/{nprNodeId}/crossConnects

  • Operation

    post /data/otn/networkinventory/delete/networkdatafile/{ntwfilename}
    to delete Network Data File (deleteJob : /data/otn/networkinventory/delete/networkdatafile/{ntwfilename})
    deletes Network Data File

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ntwfilename required ntwfilename ---

    Return type
  • NPT Adapter Connections Response
  • Responses

    Response Messages

    Schema

    200success NPT Adapter Connections Response
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/otn/networkslice/deleteSlice/{sliceId}
    delete SliceId from all the resources (deleteNetworkSlice : /data/otn/networkslice/deleteSlice/{sliceId})
    deleteNetworkSlice

    Path parameters

    Name

    IsRequired

    Description

    Enum

    sliceId required sliceId ---

    Return type
  • NetworkSliceReqResp
  • Responses

    Response Messages

    Schema

    200success NetworkSliceReqResp
    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/otn/networkslice/deleteSlice/{sliceId} --> /data/otn/networkslice/deleteSlice/sliceName

    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: { "sliceId": "sliceName", "entityId": null, "entityType": 0, "status": "SUCCESS", "errorMessage": null }

    External Docs
    See Also :

    Operation

    post /data/otn/notes/delete
    edit a new note (deleteNote : /data/otn/notes/delete)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj NoteData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/tcm/deleteTCM
    to delete Tandem Connection Monitoring(TCM) for given connection id (deleteTCMTP : /data/otn/connections/{id}/tcm/deleteTCM)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from 'id' attribute of '/data/otn/connections' REST call ---
    Query parameters

    Name

    IsRequired

    Description

    connectionName required ---
    level required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/1107/tcm/deleteTCM?connectionName=H%20ODU4LL%20NW

    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
    { "message": "TCM Ports Provisioning completed successfully.", "messageId": "OH1157I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/txTemplate/deleteTXtemplate
    To remove tx template by template name (deleteTXtemplate : /data/otn/txTemplate/deleteTXtemplate)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    templatename required ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/rcTemplate/deleterctemplate
    To remove rc template by template name (deleterctemplate : /data/otn/rcTemplate/deleterctemplate)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    templatename required ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/notes/edit
    edit a new note (editNote : /data/otn/notes/edit)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj NoteData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/alarms/eqm
    Returns only EQM related Alarm details for given connection ID (eqmAlarms : /data/otn/connections/{id}/alarms/eqm)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections'REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/10/alarms/eqm

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    {"reqCompletionStatus":0,"requestId":0,"clientName":null,"clientLocation":null,"clientUser":null,"sessionId":"","mdcId":null,"sequenceNum":0,"moreToCome":false,"messages":[],"errcde":null,"errorParams":null,"nextTasks":null,"items":[{"nodeName":"SRNode-1","almraiseNature":"Primary","className":"alarm","nAlmSeverity":"Critical","eRate":null,"connId":"-1","id":"0","key":"0/alarm","eAlmNativeProbCause":"Card missing","timeRaised":"2016-04-28T07:28:21Z","eAlmSeverity":"Critical","almDetails":"Equipment Failure","almRaiseTime":"2016-04-28T07:28:21Z","neUserLabel":"SRNode-1","connectionRate":"Not_Applicable","eSAStatus":"Service Affecting","eAlmDetails":"Card missing","eAlmProbCause":"Card missing","nprNeId":"-1","nAlmDetails":"Equipment Failure","effectiveRate":"*","nProbableCause":"Not Alarmed","connectionName":"Not_Applicable","tpNativeName":"SLOT-2-3","sAStatusStr":null}],"successfulCompletion":false,"failedCompletion":false}

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/networkinventory/generate/networkdatafile
    to get all BIT data (generateNtwkDataFile : /data/otn/networkinventory/generate/networkdatafile)
    returns all bulk data - connections,TL,XC,PTP,Nes,Equipments,ASONSncs,SRGs,NPAa,OptFeas,OptFeasLband,NeDetails,cepeligiblelayers,potentialctps,ftps details

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req EPTAdapterInventoryReq ---
    body2 optional httpSession HttpSession ---
    body3 optional locale Locale ---

    Return type
  • NPT Adapter Connections Response
  • Responses

    Response Messages

    Schema

    200success NPT Adapter Connections Response
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/3RPorts
    to get 3R ports for Amplifier(Regenerator) Connection (get3RPorts : /data/otn/3RPorts)

    Query parameters

    Name

    IsRequired

    Description

    neName required ---
    nodeName optional ---
    nodeId optional ---
    nprNodeId required ---
    rate required ---
    isLBand optional ---
    isMultiLayerService optional ---

    Return type
  • Otn3RPortInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/3RPorts?rate=ODU4&nprNodeId=22&neName=PHN-1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "nextTasks": null, "items": [ { "className": "Otn3RPort", "label": "130SCA1-7-12-L1, 130SCA1-7-14-L1", "guiLabel": "130SCA1-7-12-L1, 130SCA1-7-14-L1", "key": "130SCA1-7-12-L1/297219", "id": ? 1, "neId": ? 58, "neName": "PHN-1", "port1id": ? 297219, "port1Name": "130SCA1-7-12-L1", "port2id": ? 297229, "port2Name": "130SCA1-7-14-L1", "rate": "ODU4", "port1Id": ? 297219, "port2Id": ? 297229 }, { "className": "Otn3RPort", "label": "130SNX10-17-4-L1, 130SNX10-17-6-L1", "guiLabel": "130SNX10-17-4-L1, 130SNX10-17-6-L1", "key": "130SNX10-17-4-L1/343343", "id": ? 2, "neId": ? 58, "neName": "PHN-1", "port1id": ? 343343, "port1Name": "130SNX10-17-4-L1", "port2id": ? 343462, "port2Name": "130SNX10-17-6-L1", "rate": "ODU4", "port1Id": ? 343343, "port2Id": ? 343462 } ] }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/{id}/asonRoutingDisplay
    getASONRoutingDisplayData (getASONRoutingDisplayData : /data/otn/connections/{id}/asonRoutingDisplay)
    getASONRoutingDisplayData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    connType required connType ---

    Return type
  • Array
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/networkConnections/stats/alarms/{type}
    gives count of pending connections in different stage or count of different alarms based on type (getAlarmStatsByTypeOfConnection : /data/otn/connections/networkConnections/stats/alarms/{type})
    getAlarmStatsByTypeOfConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    type required Type: PendingConnection,NA ---

    Return type
  • StatsJson
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/networkConnections/stats/alarms/PendingConnection

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { chartDetails: [ { additionalParameter: { pendingConnState: "1" }, count: 6, tag: "PLANNED" }, { additionalParameter: { pendingConnState: "2" }, count: 1, tag: "LOCAL_DESIGN" }, { additionalParameter: { pendingConnState: "4" }, count: 10, tag: "LOW_LEVEL_DESIGN_FAILED" }, { additionalParameter: { pendingConnState: "7" }, count: 13, tag: "IMPLEMENTATION_FAILED" }, { additionalParameter: { pendingConnState: "8" }, count: 1, tag: "IMPLEMENTAION" }, { additionalParameter: { pendingConnState: "13" }, count: 1, tag: "LOCAL_DESIGN_FAILED" } ] }

    External Docs
    See Also :

    Operation

    get /data/otn/alarmsNetworkImpact
    Returns Network wide impact of different physical correlated alarms (getAlarmsNetworkImpact : /data/otn/alarmsNetworkImpact)
    Provides the number of services impacted by each physical correlated alarm


    Return type
  • List
  • Responses

    Response Messages

    Schema

    200success List
    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/otn/networkinventory/npas
    Retrieves a list of physical connections which have been deployed in the Network (getAllAsonNPAs : /data/otn/networkinventory/npas)
    The data shall include OTS connections and Topological Links.Only connections in Order Step Commissioned shall be returned.

    The inventory data files shall contain the attributes listed below for each connection:
    npaId : Number
    npaName : String
    npaWrkState : Enumeration
    npaOprState : Enumeration
    TE-LINKS
    teLinkId : Number
    telinkName : String
    linkMetric : int
    latency : int
    colorprofileName : string
    colorprofileId : int
    colorBits : hexint
    linkType : enum
    linkprotectionType : enum
    bundlingRate : enum
    sharedRiskGroupssrgName : String
    ASON-LINKSconnectionName : String
    connectionRate : enum
    telinkName : String
    ane1Name : netid
    zne1Name : netid
    atp1Name
    ztp1Name
    ane2Name :netid
    zne2Name :netid
    atp2Name
    ztp2Name
    linkType : enum
    3RLIST3RName : String
    asonName : String
    asonsncName : String
    connectionName : String
    nodeName : enum
    aendotPort
    zendotPort
    aendmuxPort
    zendmuxPORT
    configurationState
    neId
    aIfindex
    zIfindex
    aportInfo
    zportInfo
    3rName


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/asonsncs
    Retrieves a list ASON SNCs (getAllAsonSNCs : /data/otn/networkinventory/asonsncs)
    The data shall include List od ASON ASNs and the rotues

    ASONSNCDATA :
    asonsncname : 200 character string
    trialId
    connectionname
    sncrole : 0, 1, -1
    operationalstate : 0, 1
    wdmlayer : enum
    configurationstate : enum
    tranportnetwork : enum
    protection : enum
    restorationmode : enum
    tcmlevel : enum
    maxlatency : integer
    priority : integer
    setuppriority : integer
    reversionmode : enum
    waitforserverrestoration : enum
    includecolors : string
    excludecolors : string
    asapname : string
    mrntunneltype : enum
    ane1name
    zne1name
    atp1name
    ztp1name
    ane2name
    zne2name
    atp2name
    ztp2name
    ROUTEDATA
    serverid : num
    ncgroupid : num
    serverlinkname
    containertype
    connectiontype : enum
    connectionrate : num
    protectiontype : enum
    immediateserver : enum
    frequency
    routeprotectiontypeprotectionGroup
    neName
    reliablePort
    workingPort
    protectionPort
    switchCommand


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/cepeligiblelayers
    Retrieves details of all cepeligiblelayers stored in OMS. (getAllCepEligibleLayers : /data/otn/networkinventory/cepeligiblelayers)
    layerprotocol
    tpId :
    nprNeId :
    tpType :


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /data/otn/networkinventory/cepeligiblelayers REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/cepeligiblelayers/cepeligiblelayers.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "getAllCepEligibleLayers", "objectScope": "getAllCepEligibleLayers", "responseStatus": "SUCCESS", "fileGenerationTime": "21/08/2019 05:17:10", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.100.102/OTNE_1-19/data_extraction/npt/inventory/cepeligiblelayers/cepeligiblelayers.json" ] } Response with inventory details using the above HTTP URL: [ { "tpName": "8P20-4-7-C5", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40122", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C6", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40128", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C7", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40134", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-L1", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,ODU2|ODU,OTU2|PHOTONIC_MEDIA,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40140", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C8", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40144", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-L2", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,ODU2|ODU,OTU2|PHOTONIC_MEDIA,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40150", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C1", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR", "tpId": "40154", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C2", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40161", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C3", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40168", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C4", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE|DSR,FE|DSR,OC-12|DSR,OC-192|DSR,OC-3|DSR,OC-48|DSR,STM-1|DSR,STM-16|DSR,STM-4|DSR", "tpId": "40174", "nprNeId": "2", "tpType": "0" } ]

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/allxctopology
    Retrieves a list of all OCH cross connections and related data for all Network Elements stored in OMS. (getAllCrossConnects : /data/otn/networkinventory/allxctopology)
    Only cross connections with sncState of active shall be returned. Cross connections with sncState of local shall not be returned.The response shall contain the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each port :
    userLabel : 0-60 characters
    direction : Valid values - unidirectional, bidirectional
    rate : Cross Connection Rate. Valid values - OCH, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU3e2, ODU4, DSR
    sncType : Cross Connection Shape. Valid values - CS_SIMPLE, CS_DOUBLE_SIMPLE
    frequency : Example format 9410.000
    fixedXC : Interger
    width : Valid values - 37500, 50000, 62500, 75000
    connectionName : Name of Connection Using the OCH XC
    sncid : OMS XC identifier
    xcId : Integer
    zaXcId : Integer
    waveKeyConfiguration : Valid values - Auto, Manual, Unkeyed
    zaWaveKeyConfiguration : Valid values - Auto, Manual, Unkeyed
    azWaveKey1 : Integer
    azWaveKey2 : Integer
    zaWaveKey1 : Integer
    zaWaveKey2 : Integer
    waveKeyingPref : Valid values - NA, None, DupsOK, NoDups
    zawaveKeyingPref : Valid values - NA, None, DupsOK, NoDups
    azDupsUnlocked : Valid values - NotReceived, Yes, No
    zaDupsUnlocked : Valid values - NotReceived, Yes, No
    attributeNameValue
    azTopology : Header.For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction.
    order : Integer in the range 0-100
    PortName: Port AID e.g. ALPHG---
    zaTopology : Header. For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction.
    order : Integer in the range 0-100
    PortName: Port AID e.g. ALPHG---
    A1 End
    PortName : Port AID
    NEName : NE TID
    Z1 End
    PortName : Port AID
    NEName : NE TID
    A2 End
    PortName : Port AID
    NEName : NE TID
    Z2 End
    PortName : Port AID
    NEName : NE TID


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/ftps
    Retrieves details of all Ftps stored in OMS. (getAllFtps : /data/otn/networkinventory/ftps)
    The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each ftp.
    For optional parameters, if there is no value for the parameter, the parameter will not be included in the file.
    neName : ne TID - Mandatory
    otnNeid : OMS NE Identifier
    cardName : Circuit Pack Type - Mandatory
    portName : port AID - Mandatory
    portRate : port Rate - Mandatory
    portDirection : Direction of Port - Mandatory
    primaryState : IS, OOS-AU, OOS-MA, OOS-AUMA
    secondaryState : AINS, FLT, MEA, UAS, UEQ, MT, SDEE, SGEO, FAF, LPBK, UNKNOWN multivalued, delimited by &
    trailTraceActualTx : Transmitted Source Trail Trace
    trailTraceActualDestTx : Transmitted Destination Trail Trace
    trailTraceActualOsTx : Transmitted Operator Specific Trail Trace
    trailTraceExpectedRx : Expected Source Trail Trace
    trailTraceExpectedDestRx : Expected Destination Trail Trace
    trailTraceActualOsRx : Expected Operator Specific Trail Trace
    timeslotActualTx : Timeslot Map


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /data/otn/networkinventory/ftps REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/ftps/ftps.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "getAllFtps", "objectScope": "getAllFtps", "responseStatus": "SUCCESS", "fileGenerationTime": "21/08/2019 05:31:25", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.100.102/OTNE_1-19/data_extraction/npt/inventory/ftps/ftps.json" ] } Response with inventory details using the above HTTP URL: [ { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C1", "portRate": "ODU0", "portDirection": "Bidirectional", "primaryState": "OOS-AU", "secondaryState": "Supporting Entity Outage", "trailTraceActualTx": "00", "trailTraceActualDestTx": "00", "trailTraceActualOsTx": "00", "trailTraceExpectedRx": "00", "trailTraceExpectedDestRx": "00" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C2", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C3", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C4", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C5", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C6", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C7", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU0-4-7-C8", "portRate": "ODU0", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C1", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C2", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C3", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C4", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C5", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C6", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C7", "portRate": "ODU1", "portDirection": "Bidirectional" }, { "neName": "10.41.55.227", "otnNeid": "8", "cardName": "8P20", "portName": "ODU1-4-7-C8", "portRate": "ODU1", "portDirection": "Bidirectional" } ]

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/opticalfeasibiltyLband
    Retrieves a list of Lband optical feasibility data (getAllLbandOptFeas : /data/otn/networkinventory/opticalfeasibiltyLband)
    The data shall include the wavelength set and impairment entry.

    The inventory data files shall contain the attributes listed below for each connection:
    LBAND OPTICAL FEASIBILITY DATA :
    nename : NE TID
    portname
    maxallowedchannels_L : 1-96
    pmd_L : 0-10000
    pdl_L : 0-500000
    dcufree_L : Yes, No
    fibertype_L : SSMF, ELEAF, TWRS, TWC, TWP, Mixed, LS
    dispersion_L : -40000 to 78000
    WAVELENGTH SET ENTRY :
    encodingType_L : NRZ, PDPSK, COHERENT, 50GHz,62p5GHz, 16qam
    channelmask_L : String of HEX values
    IMPAIRMENT ENTRY :
    index
    encoding_L
    bitrate_L
    compmodule_L
    fectype_L
    phaseEncoding_L
    osnr_L
    nlp_L
    osnrnp_L
    nlpnp_L
    perchannelpower_L


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/allnedetails
    Retrieves details of all Network Elements including ENEs stored in OMS. (getAllNeDetails : /data/otn/networkinventory/allnedetails)
    The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each NE.
    userLabel : NE Name
    productName : For managed NEs, the Shelf Type of the Main Shelf. For ENEs the value shall be "ENE".
    nodeType : Valid values are ENE, 1830PSS-1-AHP, 1830PSS-1-GBEH, 1830PSS-1-MD4H, 1830PSS-1-MSAH, 1830PSS-32, 1830PSS-4, 1830PSS-OCS, 1830PSD, 1830PSI-2T, 1830PSI-M
    nodeName : NE TID
    latitude : Latitude measurement from map position
    longitude : Longitude measurement from map position
    mapXposition : Relative position on x axis on the network map
    mapYposition : Relative position on y axis on the network map


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call: /data/otn/networkinventory/allnedetails REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/nedetails/nedetails.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "allNeDetails", "objectScope": "allNeDetails", "responseStatus": "SUCCESS", "fileGenerationTime": "23/07/2019 15:05:33", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/nedetails/nedetails.json" ] } Response with inventory details using the above HTTP URL: [ { "userLabel": "10.40.1.192", "productName": "PSDSHELF", "nodeType": "1830PSD", "nodeName": "10.40.1.192", "latitude": 0, "longitude": 0, "mapXposition": 0, "mapYposition": 0 }, { "userLabel": "10.40.1.193", "productName": "PSDSHELF", "nodeType": "1830PSD", "nodeName": "10.40.1.193", "latitude": 0, "longitude": 0, "mapXposition": 0, "mapYposition": 0 } ]

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/opticalfeasibilty
    Retrieves a list of optical feasibility data (getAllOptFeas : /data/otn/networkinventory/opticalfeasibilty)
    The data shall include the wavelength set and impairment entry.

    The inventory data files shall contain the attributes listed below for each connection:
    OPTICAL FEASIBILITY DATA :
    nename : NE TID
    portname
    maxallowedchannels : 1-96
    pmd : 0-10000
    pml : 0-500000
    dcufree : Yes, No
    fibertype : SSMF, ELEAF, TWRS, TWC, TWP, Mixed, LS, DSF, LX1830SSMF, LX1830G654
    dispersion : -40000 to 78000
    dispersion1546:
    cd1830LX:
    WAVELENGTH SET ENTRY :
    EncodingType : NRZ, PDPSK, COHERENT, 50GHz,62p5GHz, 16qam, 75GHz, 87.5GHz
    channelmask : String of HEX values
    IMPAIRMENT ENTRY
    index
    encoding
    bitrate
    compmodule
    fectype
    phaseEncoding
    osnr
    nlp
    osnrnp
    nlpnp
    perchannelpower


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/allphysicalports
    Retrieves a list of all PTPs for all Network Elements stored in OMS. (getAllPhysicalPorts : /data/otn/networkinventory/allphysicalports)
    The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each port.The term 'Direct Mapping' means the valid values of the field are exactly the values returned for the MIB parameter.

    NEName : NE TID
    otnNeid : OMS NE Identifier
    PortName : Port AID
    PortRate : Rate on port e.g. OTS,OS
    signalType : Assigned Signal Rate e.g. OTS,OS
    oppositeDirectionPort : Port ID
    pluggableModuleType : Example Auto, User, SS-1.1 etc.
    installedPartNumber : Direct Mapping
    eptDemandName : Direct Mapping
    oprMode : Valid values - fullRate, subRate, QinQ
    Frequency : Format NNNN.XXX e.g. 9410.000
    receiveFrequency : Format NNNN.XXX e.g. 9410.000
    fectype : OT Line and Client Ports. Valid values - AFEC, EFEC, EFEC2, HPFEC, NOFEC, RSFEC, SDFEC, SDFEC-G2, UFEC, USDFEC
    Encoding : Valid values - 8QAM, 16QAM
    waveShape : Valid values - Single, Super, Alien
    monitoredPort : Port ID
    connectedLDOTDRPort : Port ID
    PtpioSigPortConnFrom : Port ID
    PtpioSigPortConnTo : Port ID
    connectedLineDCM : shelf/slot/DCM
    connectedLinePort : IROADM-shelf-slot-port(MIB Parameter tnDcmPortInfoIroadmConnAddress)
    minPlannedLossIn : Direct Mapping(MIB Parameter tnWaveKeyDecodeMinPlannedLossIn)
    maxPlannedLossIn : Direct Mapping(MIB Parameter tnWaveKeyDecodeMaxPlannedLossIn)
    typicalPlannedLossIn : Direct Mapping(MIB Parameter tnWaveKeyDecodeTypicalPlannedLossIn)
    minPlannedLossOut : Direct Mapping(MIB Parameter tnWaveKeyDecodeMinPlannedLossOut)
    maxPlannedLossOut : Direct Mapping(MIB Parameter tnWaveKeyDecodeMaxPlannedLossOut)
    typicalPlannedLossOut : Direct Mapping(MIB Parameter tnWaveKeyDecodeTypicalPlannedLossOut)
    actualTilt : Direct Mapping
    allowedGainDelta : Direct Mapping
    Attenuation : Direct Mapping
    autoEgressAdjustment : Valid values - YES, NO
    egressOAPpcOut : Valid values are -10 to 10
    egressRipple : Direct Mapping
    fiberLength : Direct Mapping
    fiberType : Valid values - DSF, ELEAF, LS, SSMF, TWC, TWP, TWRS
    forcedPerChannelOutputPower : Direct Mapping.
    gain : Direct Mapping
    gainMode : Valid values - LOW, HIGH
    gainTilt: Direct Mapping
    ingressRippleAllowance : Direct Mapping
    initialLoss : Direct Mapping
    initialTargetGain : Direct Mapping
    inputToOutputGain : Direct Mapping
    maxAttenuation : Direct Mapping
    maxGain : Direct Mapping
    maximumChannelsPerDegree : Direct Mapping
    minAddChannelPower : Direct Mapping
    minAttenuation : Direct Mapping
    minExpressChannelPower : Direct Mapping
    minGain : Direct Mapping
    perChannelInputPowerDeviation : Direct Mapping
    perChannelOutputPower : Direct Mapping
    perChannelOutputPowerAdjustment : Direct Mapping
    perChannelOutputPowerDeviation : Direct Mapping
    portPowerIn : Direct Mapping
    powerManagementType : Valid values - Automatic, Manual
    ramanSignalOutputPower : Direct Mapping
    ramanTotalInputPower : Direct Mapping
    signalOutputPower : Direct Mapping
    spanLossDefault : Direct Mapping
    spliceMargin : Direct Mapping
    targetGain : Direct Mapping
    targetTilt : Direct Mapping
    totalInputPower : Direct Mapping
    totalOutputPower : Direct Mapping
    voaSet : Direct Mapping
    userLabel : 255 character string
    primaryState : IS, OOS-AU, OOS-MA, OOS-AUMA Optional
    secondaryState : AINS, FLT, MEA, UAS, UEQ, MT, SDEE, SGEO,FAF, LPBK, UNKNOWN - multivalued, delimited by &
    portIndex : ifIndex
    totalOutputPowerL : Direct Mapping
    signalOutputPowerL : Direct Mapping Optional
    perChannelOutputPowerL : Direct Mapping
    perChannelOutputPowerDeviationL : Direct Mapping
    gainModeL : LOW, HIGH
    gainL : Direct Mapping
    minGainL : Direct Mapping
    maxGainL : Direct Mapping
    allowedGainDeltaL : Direct Mapping
    targetTiltL Direct Mapping
    gainTiltL Direct Mapping
    actualTiltL Direct Mapping
    inputToOutputGainL Direct Mapping
    perChannelInputPowerDeviationL : Direct Mapping
    totalInputPowerL : Direct Mapping
    voaSetL : Direct Mapping
    singleFiberBidi : Dual, Single
    singleFiberChannelPlan : RedBlue, SFC, NA
    ConnectedToPort : Port ID e.g. OSCTAPR-[1..24]-[2..5, 8..11]-VA
    gridType : Standard, 1.25GHz
    perChannelInputPower : Direct Mapping
    gridStepSize : 1.25, 6.25
    TxFreqOffset : -2, -1, 0, 1, 2
    RxFreqOffset : -2, -1, 0, 1, 2
    oscRxPowerIn : Direct Mapping
    oscTxPowerOut : Direct Mapping
    oscTxPowerIn : Direct Mapping
    connectedOTDRport : Port ID e.g. OTDR---P[1..8]
    oscSfpTxPowerOut : Direct Mapping
    oscSfpRxPowerIn : Direct Mapping
    spanLossTilt : Direct Mapping
    spanLossTiltL : Direct Mapping
    autoGainAdjustment : Enable, Disable
    autoTiltAdjustment : Enable, Disable
    externalAmp : Yes, No
    measuredLossIn : Direct Mapping
    commissionedLossIn : Direct Mapping
    measuredLossOut : Direct Mapping
    commissionedLossOut : Direct Mapping
    measuredLossInL : Direct Mapping
    commissionedLossInL : Direct Mapping
    measuredLossOutL : Direct Mapping
    commissionedLossOutL : Direct Mapping
    typicalPlannedLossInL : Direct Mapping
    minPlannedLossInL : Direct Mapping
    maxPlannedLossInL : Direct Mapping
    typicalPlannedLossOutL : Direct Mapping
    minPlannedLossOutL : Direct Mapping
    maxPlannedLossOutL : Direct Mapping
    encapsulationMode : Direct Mapping
    subGridModeType : NotDefined, 6250, 50000, 100000, 150000, 200000
    dcmPresentIn : Yes, No
    attenuationL : Direct Mapping
    egressOAPowerGainL :Direct Mapping
    transmissionMode : Direct Mapping
    inLoop : Direct Mapping
    outLoop : Direct Mapping
    portDirection : NA, Bidirectional, Source, Sink
    otsigIdentifier : Direct Mapping
    otsigOtuStruct : Direct Mapping
    payloadRate : Direct Mapping
    baudRate : Direct Mapping
    phaseEncode : Direct Mapping
    polarizationTrack : Direct Mapping
    cdPreComp : Direct Mapping
    iopMode : Direct Mapping
    otsigProfile : Direct Mapping
    powerMgmtPowerOffsetIn : [
    powerMgmtBitRate : Direct Mapping
    powerMgmtEncoding : Direct Mapping
    powerMgmtOffsetInPowerOffset : Direct Mapping
    ]
    attributeNameValue : {
    }
    lldpRemotePeers: [
    {
    EnabledCap: Enabled capabilities,
    SysName: System Name,
    ChassisID: Chassis ID,
    ChassisIDSubType: Chassis ID Subtype,
    SysCap: Supported capabilities,
    PortID: Port ID,
    PortIDSubType: Port Id Subtype,
    SysDesc: System Description,
    DestinatioMAC: Destination MAC address,
    PortDesc: Port Description,
    }
    ]
    }


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call: /data/otn/networkinventory/allphysicalports REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/allphysicalports/physicalports.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "allphysicalports", "objectScope": "allphysicalports", "responseStatus": "SUCCESS", "fileGenerationTime": "26/02/2019 01:55:02", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/allphysicalports/physicalports.json" ] } Response with inventory details using the above HTTP URL: [ { "NEName": "MP_ACDC_SITE1", "otnNeid": "33", "cardName": "112SNA1", "PortName": "112SNA1-2-5-C1", "PortRate": "OS", "signalType": null, "oppositeDirectionPort": null, "pluggableModuleType": "Auto", "installedPartNumber": null, "eptDemandName": null, "oprMode": null, "Frequency": null, "receiveFrequency": null, "fectype": null, "Encoding": null, "waveShape": null, "monitoredPort": null, "connectedLDOTDRPort": null, "PtpioSigPortConnFrom": null, "PtpioSigPortConnTo": null, "connectedLineDCM": null, "connectedLinePort": null, "minPlannedLossIn": null, "maxPlannedLossIn": null, "typicalPlannedLossIn": null, "minPlannedLossOut": null, "maxPlannedLossOut": null, "typicalPlannedLossOut": null, "actualTilt": null, "allowedGainDelta": null, "Attenuation": null, "autoEgressAdjustment": null, "egressOAPpcOut": null, "egressRipple": null, "fiberLength": null, "fiberType": null, "forcedPerChannelOutputPower": null, "gain": null, "gainMode": null, "gainTilt": null, "ingressRippleAllowance": null, "initialLoss": null, "initialTargetGain": null, "inputToOutputGain": null, "maxAttenuation": null, "maxGain": null, "maximumChannelsPerDegree": null, "minAddChannelPower": null, "minAttenuation": null, "minExpressChannelPower": null, "minGain": null, "perChannelInputPowerDeviation": null, "perChannelOutputPower": null, "perChannelOutputPowerAdjustment": null, "perChannelOutputPowerDeviation": null, "portPowerIn": null, "powerManagementType": null, "ramanSignalOutputPower": null, "ramanTotalInputPower": null, "signalOutputPower": null, "spanLossDefault": null, "spliceMargin": null, "targetGain": null, "targetTilt": null, "totalInputPower": null, "totalOutputPower": null, "voaSet": null, "userLabel": null, "primaryState": "OOS-AUMA", "secondaryState": "Unassigned", "portIndex": "33882624", "BaseLineReason_OPT": null, "BaseLineReason_OPR": null, "BaseLineValue_OPT": null, "BaseLineValue_OPR": null, "BaseLineTime_OPT": null, "BaseLineTime_OPR": null, "transmitPower": null, "receivePower": null, "totalOutputPowerL": null, "signalOutputPowerL": null, "perChannelOutputPowerL": null, "perChannelOutputPowerDeviationL": null, "gainModeL": null, "gainL": null, "minGainL": null, "maxGainL": null, "allowedGainDeltaL": null, "targetTiltL": null, "gainTiltL": null, "actualTiltL": null, "inputToOutputGainL": null, "perChannelInputPowerDeviationL": null, "phaseEncoding": null, "totalInputPowerL": null, "voaSetL": null, "singleFiberBidi": null, "singleFiberChannelPlan": null, "ConnectedToPort": null, "gridType": null, "perChannelInputPower": null, "gridStepSize": null, "TxFreqOffset": null, "RxFreqOffset": null, "oscRxPowerIn": null, "oscTxPowerOut": null, "oscTxPowerIn": null, "connectedOTDRport": null, "oscSfpTxPowerOut": null, "oscSfpRxPowerIn": null, "spanLossTilt": null, "spanLossTiltL": null, "autoGainAdjustment": null, "autoTiltAdjustment": null, "externalAmp": null, "measuredLossIn": null, "commissionedLossIn": null, "measuredLossOut": null, "commissionedLossOut": null, "measuredLossInL": null, "commissionedLossInL": null, "measuredLossOutL": null, "commissionedLossOutL": null, "typicalPlannedLossInL": null, "minPlannedLossInL": null, "maxPlannedLossInL": null, "typicalPlannedLossOutL": null, "minPlannedLossOutL": null, "maxPlannedLossOutL": null, "encapsulationMode": null, "subGridModeType": null, "dcmPresentIn": null, "attenuationL": null, "egressOAPowerGainL": null, "transmissionMode": null, "inLoop": "normal", "outLoop": "normal", "portDirection": "Bidirectional", "otsigIdentifier": null, "otsigOtuStruct": null, "payloadRate": null, "baudRate": null, "phaseEncode": null, "polarizationTrack": null, "cdPreComp": null, "iopMode": null, "otsigProfile": null, "powerMgmtPowerOffsetIn": [], "attributeNameValue": {}, "lldpRemotePeers": [] }, { "NEName": "MP_ACDC_SITE1", "otnNeid": "33", "cardName": "112SNA1", "PortName": "112SNA1-2-5-L1", "PortRate": "OS", "signalType": "OTU4", "oppositeDirectionPort": null, "pluggableModuleType": null, "installedPartNumber": null, "eptDemandName": null, "oprMode": null, "Frequency": null, "receiveFrequency": null, "fectype": "AFEC", "Encoding": null, "waveShape": null, "monitoredPort": null, "connectedLDOTDRPort": null, "PtpioSigPortConnFrom": null, "PtpioSigPortConnTo": null, "connectedLineDCM": null, "connectedLinePort": null, "minPlannedLossIn": null, "maxPlannedLossIn": null, "typicalPlannedLossIn": null, "minPlannedLossOut": null, "maxPlannedLossOut": null, "typicalPlannedLossOut": null, "actualTilt": null, "allowedGainDelta": null, "Attenuation": null, "autoEgressAdjustment": null, "egressOAPpcOut": null, "egressRipple": null, "fiberLength": null, "fiberType": null, "forcedPerChannelOutputPower": null, "gain": null, "gainMode": null, "gainTilt": null, "ingressRippleAllowance": null, "initialLoss": null, "initialTargetGain": null, "inputToOutputGain": null, "maxAttenuation": null, "maxGain": null, "maximumChannelsPerDegree": null, "minAddChannelPower": null, "minAttenuation": null, "minExpressChannelPower": null, "minGain": null, "perChannelInputPowerDeviation": null, "perChannelOutputPower": null, "perChannelOutputPowerAdjustment": null, "perChannelOutputPowerDeviation": null, "portPowerIn": null, "powerManagementType": null, "ramanSignalOutputPower": null, "ramanTotalInputPower": null, "signalOutputPower": null, "spanLossDefault": null, "spliceMargin": null, "targetGain": null, "targetTilt": null, "totalInputPower": null, "totalOutputPower": null, "voaSet": null, "userLabel": null, "primaryState": "OOS-AUMA", "secondaryState": "Supporting Entity Outage", "portIndex": "33882368", "BaseLineReason_OPT": null, "BaseLineReason_OPR": null, "BaseLineValue_OPT": null, "BaseLineValue_OPR": null, "BaseLineTime_OPT": null, "BaseLineTime_OPR": null, "transmitPower": null, "receivePower": null, "totalOutputPowerL": null, "signalOutputPowerL": null, "perChannelOutputPowerL": null, "perChannelOutputPowerDeviationL": null, "gainModeL": null, "gainL": null, "minGainL": null, "maxGainL": null, "allowedGainDeltaL": null, "targetTiltL": null, "gainTiltL": null, "actualTiltL": null, "inputToOutputGainL": null, "perChannelInputPowerDeviationL": null, "phaseEncoding": null, "totalInputPowerL": null, "voaSetL": null, "singleFiberBidi": null, "singleFiberChannelPlan": null, "ConnectedToPort": null, "gridType": null, "perChannelInputPower": null, "gridStepSize": null, "TxFreqOffset": null, "RxFreqOffset": null, "oscRxPowerIn": null, "oscTxPowerOut": null, "oscTxPowerIn": null, "connectedOTDRport": null, "oscSfpTxPowerOut": null, "oscSfpRxPowerIn": null, "spanLossTilt": null, "spanLossTiltL": null, "autoGainAdjustment": null, "autoTiltAdjustment": null, "externalAmp": null, "measuredLossIn": null, "commissionedLossIn": null, "measuredLossOut": null, "commissionedLossOut": null, "measuredLossInL": null, "commissionedLossInL": null, "measuredLossOutL": null, "commissionedLossOutL": null, "typicalPlannedLossInL": null, "minPlannedLossInL": null, "maxPlannedLossInL": null, "typicalPlannedLossOutL": null, "minPlannedLossOutL": null, "maxPlannedLossOutL": null, "encapsulationMode": null, "subGridModeType": null, "dcmPresentIn": null, "attenuationL": null, "egressOAPowerGainL": null, "transmissionMode": "addDrop", "inLoop": "normal", "outLoop": "normal", "portDirection": "Bidirectional", "otsigIdentifier": null, "otsigOtuStruct": null, "payloadRate": null, "baudRate": null, "phaseEncode": null, "polarizationTrack": null, "cdPreComp": null, "iopMode": null, "otsigProfile": null, "powerMgmtPowerOffsetIn": [], "attributeNameValue": {}, "lldpRemotePeers": [] } ]

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/potentialctps
    Retrieves details of all potentialctps stored in OMS. (getAllPotentialCtps : /data/otn/networkinventory/potentialctps)
    The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each ptp / ftp.
    Layerrates list in potentialctps json file can have duplicate entries. It is the duty of NRCT to handle this
    tpName : tp Name
    cardType : card Name
    neName : ne Name
    layerRates : comma separated list of values.
    tpId :
    nprNeId :
    tpType :


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /data/otn/networkinventory/potentialctps REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/potentialctps/potentialctps.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "getAllPotentialCtps", "objectScope": "getAllPotentialCtps", "responseStatus": "SUCCESS", "fileGenerationTime": "20/08/2019 09:39:51", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.100.102/OTNE_1-19/data_extraction/npt/inventory/potentialctps/potentialctps.json" ] } Response with inventory details using the above HTTP URL: [ { "tpName": "8P20-4-7-C5", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40122", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C6", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40128", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C7", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40134", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-L1", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "odu2,odu2e,otu2", "tpId": "40140", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C8", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40144", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C1", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,1GbE,1GbE,FE,FE,FE,OC-12,OC-12,OC-12,OC-192,OC-192,OC-192,OC-3,OC-3,OC-3,OC-48,OC-48,OC-48,OC-48,OC-48,OC-48,STM-1,STM-1,STM-1,STM-16,STM-16,STM-16,STM-4,STM-4,STM-4,otu1", "tpId": "40154", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C2", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40161", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C3", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40168", "nprNeId": "2", "tpType": "0" }, { "tpName": "8P20-4-7-C4", "cardType": "8P20", "neName": "10.41.55.227", "layerRates": "1GbE,FE,OC-12,OC-192,OC-3,OC-48,OC-48,STM-1,STM-16,STM-4,otu1", "tpId": "40174", "nprNeId": "2", "tpType": "0" } ]

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/sharedriskgroups
    Retrieves a list of SRGs which have been deployed in the Network (getAllSRGs : /data/otn/networkinventory/sharedriskgroups)
    The data shall include Physical connections and ASON Links.Only connections in Order Step Commissioned shall be returned.

    The inventory data files shall contain the attributes listed below for each connection:
    srgId Number
    srgname: 200 character string
    risktype: Enumeration
    probability: Enumeration
    PhysicalConnections
    connection name: 200 Character String
    connection rate: Enumeration
    ane1name: NETID
    zne1name: NETID
    atp1name
    ztp1name
    ane2name: NETID
    zne2name: NETID
    atp2name
    ztp2name
    ASONlinks
    connection name: 200 Character String
    connection rate: Enumeration
    ane1name: NETID
    zne1name: NETID
    atp1name
    ztp1name
    ane2name: NETID
    zne2name: NETID
    atp2name
    ztp2name


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/system/configurationParameters
    Returns OMS System/Configuration Parameters (getAllSystemParameters : /data/otn/system/configurationParameters)
    getAllSystemParameters


    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/otn/networkinventory/alltopologicalinks
    Retrieves a list of SRG connections which have been deployed in the Network (getAllTopologicallinks : /data/otn/networkinventory/alltopologicalinks)
    The data shall include SRGs with their physical connections and ASON Links.The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each connection:
    connectionName: 200 character string
    connectionRate: Valid Values - OTS, OS
    allocationCost : 0-100
    connectionState : Commissioned
    direction: Valid Values - unidirectional, bidirectional
    operationalState
    serviceState
    otnLatency
    A1End
    NEName : NE TID
    PortName : Port ID of A1 end PTP
    PortRate : Rate of A1 end port
    Z1End
    NEName : NE TID
    PortName : Port ID of Z1 end PTP
    PortRate : Rate of Z1 end port
    A2End
    NEName : NE TID
    PortName : Port ID of A2 end PTP
    PortRate : Rate of A2 end port
    Z2End
    NEName : NE TID
    PortName : Port ID of Z2 end PTP
    PortRate : Rate of Z2 end port
    comment: 255 Character String
    otnLatency: Latency Contribution of Link


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call: /data/otn/networkinventory/alltopologicalinks REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/alltopologicallinks/topologicallinks.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "NPT", "objectType": "topologicallinks", "objectScope": "OTS/OS", "responseStatus": "SUCCESS", "fileGenerationTime": "26/02/2019 11:16:51", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.249.188.144/OTNE_1-19/data_extraction/npt/inventory/alltopologicallinks/topologicallinks.json" ] } Response with inventory details using the above HTTP URL: [{ "connectionName":"1/112SCX10-7-12-L1/1/OPS-7-11-SIG", "connectionRate":"OS", "allocationCost":"", "connectionState":"Commissioned", "direction":"bidirectional", "operationalState":"-1", "serviceState":"1", "comment":"", "otnLatency": "0", "A1End":{ "PortName":"OPS-7-11-SIG", "NEName":"REG_R187_CONFIGD_11", "PortRate":"OS" }, "A2End":{ "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "PortName":"112SCX10-7-12-L1", "NEName":"REG_R187_CONFIGD_11", "PortRate":"OS" }, "Z2End":{ "PortName":"", "NEName":"", "PortRate":"" } }]

    External Docs
    See Also :

    Operation

    get /data/otn/connection/lldp/{id}
    to retrieve the LLDP Parameter by connId (getConnectionLLDPParameterListById : /data/otn/connection/lldp/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required portName can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/lldp/nename/{neName}/port/{portName}
    to retrieve the LLDP Parameter by portName (getConnectionLLDPParameterListByPort : /data/otn/connection/lldp/nename/{neName}/port/{portName})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName can be derived as Id from '/data/otn/connections'REST call ---
    portName required portName can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/lldp/nename/NRCX_3/port/D5X500-1-7-C1

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "className": "path", "id": "330", "key": "path/330", "guiLabel": "LLDP-OPS-2 OTU4X2:1 OTU4:1 DSR:1", "vsClientState": "VSCS_NOT_APPLICABLE", "vsClientId": -1, "connectionType": "path", "receivedDate": "2017-09-14T17:24:51Z", "orderId": "873", "groupOrderId": "0", "groupOrderType": "GOT_NA", "connectionAlias": "LLDP-OPS-2 OTU4X2:1 OTU4:1 DSR:1", "orderStep": "CST_IN_EFFECT", "stepState": "SSTATE_COMPLETED", "orderType": "OT_ADD", "layerRate": "DSR", "effectiveRate": "100GbELANETH", "displayProtectionType": "DPT_UN_PROTECTED", "protectionRole": "PR_NA", "state": "CST_IN_EFFECT", "operationalState": "Up", "category": "CC_MANAGED_PLANE", "alarmEnabling": "Not Set", "alarmState": "Cleared", "alarmSeverity": "Cleared", "serverAlmState": "Cleared", "TCMEnabled": "TCM_STATUS_NA", "TCMASAPEnabled": "TCM_STATUS_NA", "nmlASAPName": "default ASAP", "frequency": "N/A", "orderNumber": "A405", "customerName": "None", "serviceState": "ServiceState_ON", "provisionableWavekey": "N/A", "a1NeName": "PSI-135.104.218.187", "a1PortName": "LCI2000-1-2-C10_1", "z1NeName": "SPIRITFLOAT", "z1PortName": "LCI2000-1-2-C4_1", "a2NeName": "", "z2NeName": "", "a1NodeName": "PSI-135.104.218.187", "z1NodeName": "SPIRITFLOAT", "aNodeId": 118, "zNodeId": 119, "a2NodeId": 0, "z2NodeId": 0, "aPortId": 886098, "zPortId": 886176, "a2PortId": 0, "z2PortId": 0, "aPortLabel": "PSI-135.104.218.187/LCI2000-1-2-C10_1", "zPortLabel": "SPIRITFLOAT/LCI2000-1-2-C4_1", "a1NodeAndPort": "PSI-135.104.218.187/LCI2000-1-2-C10_1", "z1NodeAndPort": "SPIRITFLOAT/LCI2000-1-2-C4_1", "pm24hour": "NotEnabled", "pm15min": "NotEnabled", "isPMSupported": "Required", "connectionDirection": "CD_BID", "nprTlId": "-1", "sdhConnectionId": "-1", "sdhClientId": "-1", "isUsedInSdh": "false", "fdn": "1/330", "mismatchType": "NA", "clientRouteState": "NA", "createdBy": "CB_SYSTEM_NOTIF", "endpoints": 2, "inconsistentMismatchType": "", "inconsistentAcknowledgedBy": "", "inconsistentEventDate": "", "inconsistentAckDate": "", "isL0CRRD": "false", "isCurrentRouteRD": "false", "serverConnId": 0, "serverConnectionCategory": "CC_NA", "allowAsonResources": "NA", "scId": "N/A", "encoding": "N/A", "autoInService": "N/A", "autoInServiceTimer": "N/A", "lineGranularity": 0, "containerType": "dsr", "opsaRevertiveMode": "NA", "opsaWaitToRestoreTime": "NA", "tcmenabled": "TCM_STATUS_NA", "tcmasapenabled": "TCM_STATUS_NA", "aportLabel": "PSI-135.104.218.187/LCI2000-1-2-C10_1", "zportLabel": "SPIRITFLOAT/LCI2000-1-2-C4_1" }, [{ "tpId": "886057", "portName": "PSI-135.104.218.187/LCI2000-1-2-C10_1", "destMACAddress": "Nearest Bridge", "chassisID": "A0:F3:E4:81:FA:30", "portId": "69238784", "systemName": "7750-NK06U" }] ], "data": null, "successfulCompletion": false, "failedCompletion": false, "nadString": "", "timeout": 0 }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/getLatency
    to get the latency on multiple connections by connection IDs (getConnectionLatency : /data/otn/connections/getLatency)
    getConnectionLatency

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connLatencyInfo ConnLatencySetReqResp ---

    Return type
  • ConnLatencySetReqResp
  • Responses

    Response Messages

    Schema

    200success ConnLatencySetReqResp
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/connectionstatus
    Retrieve status of the connection file generation request. (getConnectionStatus : /data/otn/networkinventory/connectionstatus)
    The response contains the response status and HTTP URL where the inventory data file can be accessed.HTTP URL for inventory data file shall be available ONLY when the response status is SUCCESS.

    Note: This command is only meant for Commissioned Connections.The output for this Command will have information on Commissioned state only.

    The response to all requests will include a response header with the attributes listed below :
    originatorApp : 1350OMS, NPT
    objectType : Valid Values - project, oduk, demand, route, equipment, networkElements, physicalPorts, routeIds, connections
    objectScope : Valid Values - network, project, routeDetail, routeIds, connections
    responseStatus : Valid Values - success, failed, partial_success, IN_PROGRESS
    fileGenerationTime : Valid Values - null, date & time

    connectionData - Header
    CONNECTIONID : Unique Connection Identifier
    CONNECTIONNAME : Connection Name
    CONTAINERTYPE : Container type for the connection
    NCGROUPID : Internal Use - Group Identifier for Integrated Connection Provisioning. Also used for re-arrange, broadcast, etc.
    GROUPCLASS : Enumeration(NotApplicable=0,DSR_ODU_ELECTRICAL_MP_INTEG=1,ODU_OTU_PHOTONIC_MP_INTEG=2,DSR_ODU_ELECTRICAL_CP_INTEG=3
    ODU_OTU_PHOTONIC_CP_INTEG=4)
    CONNECTIONQUALIFIER : Internal Use - Additional qualifier for system generated connection name
    CONNECTIONALIAS : Alias for the connection name
    CONNECTIONRATE : Layer rate of the connection
    SERVICERATE : Service=1,Trail/OS=2
    MSPAPSSWITCHTYPE : Internal Use - legacy SDH support
    CONNECTIONDIRECTION: NA=0,UNI=1,BID=2
    CONNECTIONCATEGORY : NA=0,MANAGED_PLANE=1,CONTROLLED_PLANE=2,MANAGED_AND_CONTROLLED_PLANE=3,MIXED_PLANE=4,GMRE_CONNECTION=5,GMRE_AND_MANAGED_PLANE=6
    EXTERNAL_OWNED_CONNECTION=7,MIXED_OWNERSHIP_MANAGED_PLANE_CONNECTION=8,RAW_CONNECTION=9,ASON_IMPLICIT_SERVER=10,ASON_LOGICAL_LINK=11,ASON_EDGE_DROP_LINK=12
    ASON_LOGICAL_EDGE_DROP_LINK=13,ASON_MRN_TERM_LINK=15,MP_IMPLICIT_SERVER=16,EDGE_HO_TRAIL=17,ASON_EDGE_HO_TRAIL=18
    CONNECTIONSHAPE: NA=0,ADD_DROP_A=1,ADD_DROP_Z=2,INTERCONNECT=3,DOUBLE_INTERCONNECT=4,DOUBLE_ADD_DROP=5,OPEN_ADD_DROP=6,EXPLICIT=7,SIMPLE=8,DOUBLE_SIMPLE=9
    SAME_ENDED=10,INTERCONNECT_W=11,INTERCONNECT_P=12,SAME_ENDED_SRC=13,SAME_ENDED_SINK=14,ADD_DROP_S=15,DOUBLE_ADD_DROP_D=16,DOUBLE_ADD_DROP_S_ROUTE_ONLY=17
    SIMPLE_DRI=18,DROP_AND_CONTINUE=18
    CONNECTIONSTATE : NA=0,PLANNED=1,LOCAL_DESIGN=2,LOW_LEVEL_DESIGN_IN_PROGRESS=3,LOW_LEVEL_DESIGN_FAILED=4,LOW_LEVEL_DESIGN=5,IMPLEMENTATION_IN_PROGRESS=6
    IMPLEMENTAION_FAILED=7,IMPLEMENTATION=8,IN_EFFECT=9,HISTORY=10,PREPLAN_COMPLETE=11,LOCAL_DESIGN_IN_PROGRESS=12,LOCAL_DESIGN_FAILED=13
    ADAPTED : Not used
    SERVICECONNECTION : SERVICE=1,TRAIL/OS=0
    ROUTESELECTIONMODE : NA=0,AUTOMATIC=1,PARTIAL=2,MANAUL=3,FS_CHANNELS=4,FS_XC=5,FS_CHANNELS_ORDER_SENSITIVE=6
    IGNOREALARM
    CUSTOMERNAME : Customer for connection included as part of connection creation
    CUSTOMERPRIORITY : Internal Use - Priority for Customer
    VPNID : Not used
    QUALITY : Internal Use - Legacy SDH supportDISCREPANCY : Internal Use - Identify discrepancy on connection or tpparameter
    CREATIONTIME : Connection creation time in UTC
    CREATEDBY : Connection Creator
    SERVERGROUPID : Internal Use - legacy SDH support
    CAPACITY : Internal Use - legacy SDH support
    EFFECTIVERATE : Real Rate of Connection
    PROTECTIONROLE : Internal Use - Legacy SDH support (NA=0,SERVICE=1,PROTECTION=2)
    PROTECTIONTYPE : Provisioned Protection type of connection for GUI display (NA=0,UN_PROTECTED=1,PROTECTED=2,YCABLE=3,OPSA=4,OPSB=5,SNCP=6,OMSP=7
    SERVER_PROTECTED=8,SERVER_PROTECTED_OPSA=9,SERVER_PROTECTED_OMSP=10,SERVER_PROTECTED_SNC_N=11,SERVER_PROTECTED_SNC_I=12,SERVER_PROTECTED_SNC_NC=13
    SERVER_PROTECTED_SNCP_N=14,E_SNCP=15,SNC_I=16,SNC_N=17,SNC_NC=18,SNCP_N=19)
    REVERTIVEMODE : Mode of reversion of connection(NA=0,REVERTIVE=1,NONREVERTIVE=2,REVERTIVE_AUTO=3,REVERTIVE_MAN=4)
    SERVERLAYERRATE : Server Layer rate for DSR service connection
    CONNECTIONTYPE : Type of connection(REGULAR=0,TANDEM=1,NOTAPPLICABLE=2,LOPC=3,VIRTUAL_SERVER=4)
    TANDEMASSOCIATIONTAG : Internal Use - legacy SDH support
    CONNECTIONNAMEFORMAT : Connection name format specified by user
    DISPLAYSERVICERATE : Internal Use - Rate of the service for display
    MANUALFAULTMARKINGSTATUS : Not used
    LOCKEDCAPACITY : Internal Use - legacy SDH support
    RESTORATIONTRIGGER : Not used
    INDIRECTSNCNAME : Internal Use - legacy SDH support
    SDHCONNECTIONID : Internal Use - legacy SDH support
    SDHCLIENTID : Internal Use - legacy SDH support
    SDHROUTEMODTIME :Internal Use - legacy SDH support
    OMSPTRAILID : Connection Identifier of the OMSP trail for OMSP connection
    SYSTEMLABEL : Not used
    TCMSTATUS : Internal Use - Tandem Connection Monitoring status for odu, out connections. Values can NA, enabled or disabled
    SERVICESTATE : Internal Use - Service state of the connection
    OPERATIONALSTATE : Operational state of the connection
    INVARIANTCONNID : Internal Use - Connection Identifier used by Northbound Interface client
    CONNECTIONLEVEL : Internal Use - Identifier for primary, secondary connections in integrated provisioning
    NCGIDFORMDFY : Not used
    ASSOCIATEDNPRTLID : Identifier used in NPR component. Internal to OMS
    PREFERREDRESTORATIONMODE : Preferred Restoration Mode for Control Plane connections
    BAND
    PROVISIONABLEWAVEKEY : Keyed, Unkeyed, Not Applicable
    WAVEKEYTYPE : Manual, Automatic, NA
    SPECTRUMWIDTH : Width of the Flex Grid Channel
    OFFSET : For Subsea the Frequency Offset
    FECTYPE : NOFEC, AFEC, EFEC, EFEC2, HPFEC, RSFEC, SDFEC, SDFEC-G2, UFEC, USDFEC, 802.3bj
    ENCODING : QPSK, SP-QPSK, 8QAM, 16QAM, 16QAM-250G
    WAVESHAPE : Single, Super, Alien
    PHASEENCODING : Absolute, Differential
    ASAPID : Internal Use - ASAP identifier
    NETWORKSLICEID:
    HOLDOFFTIME:
    WAITTORESTORETIME:
    RESTOREPRIORITY:
    SWITCHDIRECTION:
    ANE1NAME : NE name of A1 end port
    ZNE1NAME : NE name of Z1 end port
    ATP1NAME : Port ID of A1 end port
    A1PARENTTP:
    A1CTPTIMESLOT:
    A1TIMESLOTMAP:
    ZTP1NAME : Port ID of Z1 end port
    Z1PARENTTP:
    Z1CTPTIMESLOT:
    Z1TIMESLOTMAP:
    ANE2NAME : NE name of A2 end port
    ZNE2NAME : NE name of Z2 end port
    ATP2NAME : Port ID of A2 end port
    A2PARENTTP:
    A2CTPTIMESLOT:
    A2TIMESLOTMAP:
    ZTP2NAME : Port ID of Z2 end port

    Z2PARENTTP:
    Z2CTPTIMESLOT:
    Z2TIMESLOTMAP:
    routeData - Header
    SERVERID : Unique Connection Identifier for server layer connection
    NCGROUPID : Group Identifier for Integrated Connection Provisioning for server layer
    SERVERLINKNAME : Connection name for server layer connection
    IMMEDIATESERVER : Identifies connection as being in IMMEDIATE server layer
    FREQUENCY : Frequency used for server layer connection. Only applicable for OTUk (OCH) connect.Two frequencies are used when the connection is a 4-ended connection
    ROUTEPROTECTIONTYPE : Role of the server layer connection as part of a protected entity.(NA=0,UNPROTECTED=1,SERVICE=2,PROTECTION=3)
    routeConstraints
    CONSTRAINTTYPE : Enumeration
    CONSTRAINTNAME : String
    CONSTRAINTCONDITION : Enumeration
    CONSTRAINTROLE : Enumeration
    FREQUENCY : Integer
    CHANNEL : Integer
    PROTECTIONGROUP - Header
    NENAME:
    RELIABLEPORT:
    WORKINGPORT:
    PROTECTIONPORT:
    SWITCHCOMMAND:
    SWITCHREASON:
    errorCode : 40 character string
    errorReason : 255 character string
    errorParams


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/networkinventory/connectionstatus

    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
    { "responseHeader": { "originatorApp": "NPT", "objectType": "connections", "objectScope": "connections", "responseStatus": "SUCCESS", "fileGenerationTime": "13/08/2019 14:12:00", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.100.102/OTNE_1-19/data_extraction/npt/inventory/connection/connections.tar.gz" ] } Example of the extracted connections.json file: { "Response": { "All_connections": [ { "connectionData": [ { "CONNECTIONID": 1, "CONNECTIONNAME": "MC-S1/11STMM10-1-5-L1/SFD-30-1-9355/OS", "CONTAINERTYPE": "os", "NCGROUPID": 0, "GROUPCLASS": 0, "CONNECTIONQUALIFIER": "0", "CONNECTIONALIAS": "2/11STMM10-1-5-L1/2/SFD-30-1-9355", "CONNECTIONRATE": 20, "SERVICERATE": 2, "MSPAPSSWITCHTYPE": 0, "CONNECTIONDIRECTION": 2, "CONNECTIONCATEGORY": 0, "CONNECTIONSHAPE": 8, "CONNECTIONSTATE": 9, "ADAPTED": 0, "SERVICECONNECTION": 0, "ROUTESELECTIONMODE": 1, "IGNOREALARM": 1, "CUSTOMERNAME": "None", "CUSTOMERPRIORITY": "", "VPNID": "", "QUALITY": "", "DISCREPANCY": 0, "CREATIONTIME": 1557213567, "CREATEDBY": 2, "SERVERGROUPID": 0, "CAPACITY": 0, "EFFECTIVERATE": "OTU2", "PROTECTIONROLE": 0, "PROTECTIONTYPE": 1, "REVERTIVEMODE": 0, "SERVERLAYERRATE": 0, "CONNECTIONTYPE": 0, "TANDEMASSOCIATIONTAG": 0, "CONNECTIONNAMEFORMAT": 1, "DISPLAYSERVICERATE": 2, "MANUALFAULTMARKINGSTATUS": 0, "LOCKEDCAPACITY": 0, "RESTORATIONTRIGGER": 0, "INDIRECTSNCNAME": "", "SDHCONNECTIONID": "", "SDHCLIENTID": "", "SDHROUTEMODTIME": "", "OMSPTRAILID": 0, "SYSTEMLABEL": "", "TCMSTATUS": 0, "SERVICESTATE": 1, "OPERATIONALSTATE": 0, "INVARIANTCONNID": 1, "CONNECTIONLEVEL": 0, "NCGIDFORMDFY": 0, "ASSOCIATEDNPRTLID": 0, "PREFERREDRESTORATIONMODE": "", "BAND": "", "PROVISIONABLEWAVEKEY": "", "WAVEKEYTYPE": "", "SPECTRUMWIDTH": "0", "OFFSET": "0", "FECTYPE": "", "ENCODING": "", "WAVESHAPE": "", "PHASEENCODING": "", "ASAPID": 0, "NETWORKSLICEID": "", "HOLDOFFTIME": "", "WAITTORESTORETIME": "", "RESTOREPRIORITY": "", "SWITCHDIRECTION": "", "ANE1NAME": "MC-S1", "ZNE1NAME": "MC-S1", "ATP1NAME": "11STMM10-1-5-L1", "A1PARENTTP": "", "A1CTPTIMESLOT": "0", "A1TIMESLOTMAP": "", "ZTP1NAME": "SFD-30-1-9355", "Z1PARENTTP": "", "Z1CTPTIMESLOT": "0", "Z1TIMESLOTMAP": "", "ANE2NAME": "", "ZNE2NAME": "", "ATP2NAME": "", "A2PARENTTP": "", "A2CTPTIMESLOT": "", "A2TIMESLOTMAP": "", "ZTP2NAME": "", "Z2PARENTTP": "", "Z2CTPTIMESLOT": "", "Z2TIMESLOTMAP": "" } ], "routeData": [], "routeConstraints": [], "protectionGroup": [] }, { "connectionData": [ { "CONNECTIONID": 2, "CONNECTIONNAME": "MC-S1/11QPE24-1-7-X1/SFD-27-1-9350/OS", "CONTAINERTYPE": "os", "NCGROUPID": 0, "GROUPCLASS": 0, "CONNECTIONQUALIFIER": "0", "CONNECTIONALIAS": "2/11QPE24-1-7-X1/2/SFD-27-1-9350", "CONNECTIONRATE": 20, "SERVICERATE": 2, "MSPAPSSWITCHTYPE": 0, "CONNECTIONDIRECTION": 2, "CONNECTIONCATEGORY": 0, "CONNECTIONSHAPE": 8, "CONNECTIONSTATE": 9, "ADAPTED": 0, "SERVICECONNECTION": 0, "ROUTESELECTIONMODE": 1, "IGNOREALARM": 1, "CUSTOMERNAME": "None", "CUSTOMERPRIORITY": "", "VPNID": "", "QUALITY": "", "DISCREPANCY": 0, "CREATIONTIME": 1557213568, "CREATEDBY": 2, "SERVERGROUPID": 0, "CAPACITY": 0, "EFFECTIVERATE": "OTU2E", "PROTECTIONROLE": 0, "PROTECTIONTYPE": 1, "REVERTIVEMODE": 0, "SERVERLAYERRATE": 0, "CONNECTIONTYPE": 0, "TANDEMASSOCIATIONTAG": 0, "CONNECTIONNAMEFORMAT": 1, "DISPLAYSERVICERATE": 2, "MANUALFAULTMARKINGSTATUS": 0, "LOCKEDCAPACITY": 0, "RESTORATIONTRIGGER": 0, "INDIRECTSNCNAME": "", "SDHCONNECTIONID": "", "SDHCLIENTID": "", "SDHROUTEMODTIME": "", "OMSPTRAILID": 0, "SYSTEMLABEL": "", "TCMSTATUS": 0, "SERVICESTATE": 1, "OPERATIONALSTATE": 0, "INVARIANTCONNID": 2, "CONNECTIONLEVEL": 0, "NCGIDFORMDFY": 0, "ASSOCIATEDNPRTLID": 0, "PREFERREDRESTORATIONMODE": "", "BAND": "", "PROVISIONABLEWAVEKEY": "", "WAVEKEYTYPE": "", "SPECTRUMWIDTH": "0", "OFFSET": "0", "FECTYPE": "", "ENCODING": "", "WAVESHAPE": "", "PHASEENCODING": "", "ASAPID": 0, "NETWORKSLICEID": "", "HOLDOFFTIME": "", "WAITTORESTORETIME": "", "RESTOREPRIORITY": "", "SWITCHDIRECTION": "", "ANE1NAME": "MC-S1", "ZNE1NAME": "MC-S1", "ATP1NAME": "11QPE24-1-7-X1", "A1PARENTTP": "", "A1CTPTIMESLOT": "0", "A1TIMESLOTMAP": "", "ZTP1NAME": "SFD-27-1-9350", "Z1PARENTTP": "", "Z1CTPTIMESLOT": "0", "Z1TIMESLOTMAP": "", "ANE2NAME": "", "ZNE2NAME": "", "ATP2NAME": "", "A2PARENTTP": "", "A2CTPTIMESLOT": "", "A2TIMESLOTMAP": "", "ZTP2NAME": "", "Z2PARENTTP": "", "Z2CTPTIMESLOT": "", "Z2TIMESLOTMAP": "" } ], "routeData": [], "routeConstraints": [], "protectionGroup": [] } ] }, "ResponseHeader": { "originatorApp": "1350OMS", "objectType": "Connections", "objectScope": "Connections", "responseStatus": "SUCCESS", "errorCode": "", "errorReason": "", "errorParams": [] } }

    External Docs
    See Also :
  • getConnections : /data/otn/networkinventory/connections

  • Operation

    get /data/otn/networkinventory/connections
    Retrieves a List of Deployed Connections (getConnections : /data/otn/networkinventory/connections)
    This request triggers generation of an Inventory file that includes all the connection information. The generated 'json' file will be compressed to tar.gz form.
    The connections retrieved from OMS will include all types of connections defined in 1350 OMS object model:
    OS Connections (Physical Links : both external & internal OS links)
    OTS Connections (Physical Links : both internal & external links between WDM nodes)
    OMS Connections (at OMS layer)
    ODUk Connections (at all supported ODU layer rates in 1350 OMS object model)
    OTUk Connections (at all supported OTU layer rates in 1350 OMS object model)
    Service Connections (at all supported service layer rates in 1350 OMS object model)

    Note: This command is only meant for Commissioned Connections.The output for this Command will have information on Commissioned state only.

    The route of each connection will be included.The response contains only the response status.Inventory file URL is not specified as part of response for this request.For the inventory file URL, the call /networkinventory/connectionstatus is required to be executed .

    The inventory data files contains the attributes listed below for each connection and the connection route:
    connectionData - Header
    CONNECTIONID : Unique Connection Identifier
    CONNECTIONNAME : Connection Name
    CONTAINERTYPE : Container type for the connection
    NCGROUPID : Internal Use - Group Identifier for Integrated Connection Provisioning. Also used for re-arrange, broadcast, etc.
    GROUPCLASS : Enumeration
    CONNECTIONQUALIFIER : Internal Use - Additional qualifier for system generated connection name
    CONNECTIONALIAS : Alias for the connection name
    CONNECTIONRATE : Layer rate of the connection
    SERVICERATE
    MSPAPSSWITCHTYPE : Internal Use - legacy SDH support
    CONNECTIONDIRECTION
    CONNECTIONCATEGORY
    CONNECTIONSHAPE
    CONNECTIONSTATE
    ADAPTED : Not used
    SERVICECONNECTION
    ROUTESELECTIONMODE
    IGNOREALARM
    CUSTOMERNAME : Customer for connection included as part of connection creation
    CUSTOMERPRIORITY : Internal Use - Priority for Customer
    VPNID : Not used
    QUALITY : Internal Use - Legacy SDH supportDISCREPANCY : Internal Use - Identify discrepancy on connection or tpparameter
    CREATIONTIME : Connection creation time in UTC
    CREATEDBY : Connection Creator
    SERVERGROUPID : Internal Use - legacy SDH support
    CAPACITY : Internal Use - legacy SDH support
    EFFECTIVERATE : Real Rate of Connection
    PROTECTIONROLE : Internal Use - Legacy SDH support
    PROTECTIONTYPE : Provisioned Protection type of connection for GUI display
    REVERTIVEMODE : Mode of reversion of connection
    SERVERLAYERRATE : Server Layer rate for DSR service connection
    CONNECTIONTYPE : Type of connection
    TANDEMASSOCIATIONTAG : Internal Use - legacy SDH support
    CONNECTIONNAMEFORMAT : Connection name format specified by user
    DISPLAYSERVICERATE : Internal Use - Rate of the service for display
    MANUALFAULTMARKINGSTATUS : Not used
    LOCKEDCAPACITY : Internal Use - legacy SDH support
    RESTORATIONTRIGGER : Not used
    INDIRECTSNCNAME : Internal Use - legacy SDH support
    SDHCONNECTIONID : Internal Use - legacy SDH support
    SDHCLIENTID : Internal Use - legacy SDH support
    SDHROUTEMODTIME :Internal Use - legacy SDH support
    OMSPTRAILID : Connection Identifier of the OMSP trail for OMSP connection
    SYSTEMLABEL : Not used
    TCMSTATUS : Internal Use - Tandem Connection Monitoring status for odu, out connections. Values can NA, enabled or disabled
    SERVICESTATE : Internal Use - Service state of the connection
    OPERATIONALSTATE : Operational state of the connection
    INVARIANTCONNID : Internal Use - Connection Identifier used by Northbound Interface client
    CONNECTIONLEVEL : Internal Use - Identifier for primary, secondary connections in integrated provisioning
    NCGIDFORMDFY : Not used
    ASSOCIATEDNPRTLID : Identifier used in NPR component. Internal to OMS
    PREFERREDRESTORATIONMODE : Preferred Restoration Mode for Control Plane connections
    BAND
    PROVISIONABLEWAVEKEY : Keyed, Unkeyed, Not Applicable
    WAVEKEYTYPE : Manual, Automatic, NA
    SPECTRUMWIDTH : Width of the Flex Grid Channel
    OFFSET : For Subsea the Frequency Offset
    FECTYPE : NOFEC, AFEC, EFEC, EFEC2, HPFEC, RSFEC, SDFEC, SDFEC-G2, UFEC, USDFEC, 802.3bj
    ENCODING : QPSK, SP-QPSK, 8QAM, 16QAM, 16QAM-250G
    WAVESHAPE : Single, Super, Alien
    PHASEENCODING : Absolute, Differential
    ASAPID : Internal Use - ASAP identifier
    NETWORKSLICEID:
    HOLDOFFTIME:
    WAITTORESTORETIME:
    RESTOREPRIORITY:
    SWITCHDIRECTION:
    ANE1NAME : NE name of A1 end port
    ZNE1NAME : NE name of Z1 end port
    ATP1NAME : Port ID of A1 end port
    A1PARENTTP:
    A1CTPTIMESLOT:
    A1TIMESLOTMAP:
    ZTP1NAME : Port ID of Z1 end port
    Z1PARENTTP:
    Z1CTPTIMESLOT:
    Z1TIMESLOTMAP:
    ANE2NAME : NE name of A2 end port
    ZNE2NAME : NE name of Z2 end port
    ATP2NAME : Port ID of A2 end port
    A2PARENTTP:
    A2CTPTIMESLOT:
    A2TIMESLOTMAP:
    ZTP2NAME : Port ID of Z2 end port

    Z2PARENTTP:
    Z2CTPTIMESLOT:
    Z2TIMESLOTMAP:
    routeData - Header
    SERVERID : Unique Connection Identifier for server layer connection
    NCGROUPID : Group Identifier for Integrated Connection Provisioning for server layer
    SERVERLINKNAME : Connection name for server layer connection
    CONTAINERTYPE : Container type for the server layer connection
    CONNECTIONTYPE : Type of server connection
    CONNECTIONRATE : Layer rate of the server connection
    PROTECTIONTYPE : Provisioned Protection type of server connection
    IMMEDIATESERVER : Identifies connection as being in IMMEDIATE server layer
    FREQUENCY : Frequency used for server layer connection. Only applicable for OTUk (OCH) connect.Two frequencies are used when the connection is a 4-ended connection
    ROUTEPROTECTIONTYPE : Role of the server layer connection as part of a protected entity.Two entries are used when the connection is a 4-ended connection


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    data/otn/networkinventory/connections

    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
    { "responseHeader": { "originatorApp": "NPT", "objectType": "connections", "objectScope": "connections", "responseStatus": "IN_PROGRESS", "fileGenerationTime": null, "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": null }

    External Docs
    See Also :

    Operation

    post /data/otn/Connection/Params
    to get context based Tx params (getContextBasedTxParams : /data/otn/Connection/Params)
    returns context based Tx params

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connReq OtnConnectionRequest ---

    Return type
  • OtnEndPointResponse
  • Responses

    Response Messages

    Schema

    200success OtnEndPointResponse
    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.
    • application/json
    Example Response Data
    { "groups": [{ "paramList": [{ "label": "Use NE Value", "name": "Use NE Value", "type": "ABC", "value": "Use NE Value" }, { "label": "RSFEC", "name": "RSFEC", "type": "ABC", "value": "RSFEC" }, { "label": "NOFEC", "name": "NOFEC", "type": "ABC", "value": "NOFEC" }, { "label": "EFEC", "name": "EFEC", "type": "ABC", "value": "EFEC" }, { "label": "EFEC2", "name": "EFEC2", "type": "ABC", "value": "EFEC2" }, { "label": "AFEC", "name": "AFEC", "type": "ABC", "value": "AFEC" }], "groupname": "FEC" }, { "paramList": [{ "label": "Default", "name": "SignalType", "type": "ABC", "value": "Default" }], "groupname": "SignalType" }, { "paramList": [{ "label": "no", "name": "no", "type": "no", "value": "no" }], "groupname": "HasOPSB" }, { "paramList": [{ "label": "no", "name": "no", "type": "no", "value": "no" }], "groupname": "HasYcable" }, { "paramList": [{ "label": "no", "name": "no", "type": "no", "value": "no" }], "groupname": "has112SDX11" }, { "paramList": [{ "label": "yes", "name": "yes", "type": "yes", "value": "yes" }], "groupname": "isIntegratedProvRequired" }], "txParamTableData": [{ "parameter": "TTIMismatchConsequentAction", "name": "CAonTIM", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "PayloadTypeResp", "name": "PayloadTypeMismatchResponse", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "Payloadtype", "name": "payloadType", "currentValue": "Use NE Value", "type": "String", "editorArgs": null }, { "parameter": "SourceAZTTI", "name": "TrailTraceActualTx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "SourceZATTI", "name": "TrailTraceExpectedRx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "TTIMonitor", "name": "TrailTraceMonitor", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Source Enabled", "Disabled"], "maxlength": 0 } }, { "parameter": "TraceMismatchMonitor", "name": "TrailTraceEnablePoints", "currentValue": "Enable End-points only", "type": "Enumeration", "editorArgs": { "options": ["Enable End-points only", "Enable All", "Use NE Value"], "maxlength": 0 } }, { "parameter": "BurstIntervalSDDetection", "name": "brstintvl", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10"], "maxlength": 0 } }, { "parameter": "BurstThresholdSDDetection", "name": "brstthr", "currentValue": "Use NE Value", "type": "String", "editorArgs": null }, { "parameter": "apsEnable", "name": "apsEnable", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Standard", "Proprietary"], "maxlength": 0 } }, { "parameter": "OTUkSourceAZTTI", "name": "TrailTraceActualTx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "OTUkSourceZATTI", "name": "TrailTraceExpectedRx", "currentValue": "Use NE Value", "type": "String", "editorArgs": { "options": null, "maxlength": 15 } }, { "parameter": "TTIMonitor", "name": "TrailTraceMonitor", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Source Enabled", "Disabled"], "maxlength": 0 } }, { "parameter": "OTUkTTIMismatchConsequentAction", "name": "CAonTIM", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Enable", "Disable"], "maxlength": 0 } }, { "parameter": "RegenResponse", "name": "regenResponse", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "Laser On", "Laser Off"], "maxlength": 0 } }, { "parameter": "ProvisionedBitRate", "name": "ProvisionedBitRate", "currentValue": "10.709", "type": "Enumeration", "editorArgs": { "options": ["10.709", "Use NE Value", "11.049", "11.096"], "maxlength": 0 } }, { "parameter": "OTUkBurstIntervalSDDetection", "name": "brstintvl", "currentValue": "Use NE Value", "type": "Enumeration", "editorArgs": { "options": ["Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10"], "maxlength": 0 } }, { "parameter": "OTUkBurstThresholdSDDetection", "name": "brstthr", "currentValue": "Use NE Value", "type": "String", "editorArgs": null }] }

    External Docs
    See Also :

    Operation

    get /data/otn/crossConnects/{id}
    to get XC details for given XC Id (getCrossConnectById : /data/otn/crossConnects/{id})
    returns XC information for given XC ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/nodes/{nprNodeId}/crossConnects' REST call as sncId ---

    Return type
  • XCInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/crossConnects/33

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "items": [{ "className": "crossConnect", "id": "0", "key": "crossConnect/0", "sncId": "33" }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • listCrossConnectionsFromNode : /data/otn/nodes/{nprNodeId}/crossConnects

  • Operation

    get /data/otn/networkinventory/xctopology
    Retrieves a list of all OCH cross connections and related data for all Network Elements stored in OMS. (getCrossConnects : /data/otn/networkinventory/xctopology)
    Only cross connections with sncState of active shall be returned. Cross connections with sncState of local shall not be returned.The response shall contain the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each port :
    userLabel : 0-60 characters
    direction : Valid values - unidirectional, bidirectional
    rate : Cross Connection Rate. Valid values - OCH, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU3e2, ODU4, DSR
    sncType : Cross Connection Shape. Valid values - CS_SIMPLE, CS_DOUBLE_SIMPLE
    frequency : Example format 9410.000
    fixedXC : Interger
    width : Valid values - 50000, 62500, 75000
    connectionName : Name of Connection Using the OCH XC
    sncid : OMS XC identifier
    xcId : Integer
    zaXcId : Integer
    waveKeyConfiguration : Valid values - Auto, Manual, Unkeyed
    zaWaveKeyConfiguration : Valid values - Auto, Manual, Unkeyed
    azWaveKey1 : Integer
    azWaveKey2 : Integer
    zaWaveKey1 : Integer
    zaWaveKey2 : Integer
    waveKeyingPref : Valid values - NA, None, DupsOK, NoDups
    zawaveKeyingPref : Valid values - NA, None, DupsOK, NoDups
    azDupsUnlocked : Valid values - NotReceived, Yes, No
    zaDupsUnlocked : Valid values - NotReceived, Yes, No
    sncState : Valid values - LOCAL, PENDING, PARTIAL, ACTIVE, NMLUSED
    attributeNameValue
    azTopology : Header.For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction.
    order : Integer in the range 0-100
    PortName: Port AID e.g. ALPHG---
    zaTopology : Header. For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction.
    order : Integer in the range 0-100
    PortName: Port AID e.g. ALPHG---
    A1 End
    portRole : Working or Protection in SNCP
    PortName : Port AID
    NEName : NE TID
    Z1 End
    portRole : Working or Protection in SNCP
    PortName : Port AID
    NEName : NE TID
    A2 End
    portRole : Working or Protection in SNCP
    PortName : Port AID
    NEName : NE TID
    Z2 End
    portRole : Working or Protection in SNCP
    PortName : Port AID
    NEName : NE TID


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /data/otn/networkinventory/xctopology REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/crossconnections/crossconnections.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "OMS", "objectType": "crossconnections", "objectScope": "crossconnections", "responseStatus": "SUCCESS", "fileGenerationTime": "22/02/2019 21:12:37" "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/crossconnections/crossconnections.json" ] } Response with inventory details using the above HTTP URL: [ { "userLabel": "LL 2 OTU4#1", "direction": "bidirectional", "rate": "OCH", "sncType": "CS_SIMPLE", "frequency": "9200.000", "fixedXC": "0", "width": "50000", "connectionName": "LL 2 OTU4#1", "sncid": "252", "xcId": "2", "zaXcId": null, "waveKeyConfiguration": "Unkey Manual", "zaWaveKeyConfiguration": null, "azWaveKey1": null, "azWaveKey2": null, "zaWaveKey1": null, "zaWaveKey2": null, "waveKeyingPref": "None", "zawaveKeyingPref": "NA", "azDupsUnlocked": "No", "zaDupsUnlocked": "NotReceived", "sncState": "LOCAL", "attributeNameValue": {}, "azTopology": [], "zaTopology": [], "A1End": { "portRole": null, "parentPortName": "SFD-2-3-9200", "NEName": "PSS32-42.27.198", "PortName": "SFD-2-3-9200.000" }, "Z1End": { "portRole": null, "parentPortName": "SFD-2-3-OMD", "NEName": "PSS32-42.27.198", "PortName": "SFD-2-3-OMD-9200.000" }, "A2End": { "portRole": null, "parentPortName": "", "NEName": "", "PortName": "" }, "Z2End": { "portRole": null, "parentPortName": "", "NEName": "", "PortName": "" } }, { "userLabel": "LL 2 OTU4#1", "direction": "bidirectional", "rate": "OCH", "sncType": "CS_SIMPLE", "frequency": "9200.000", "fixedXC": "0", "width": "50000", "connectionName": "LL 2 OTU4#1", "sncid": "253", "xcId": "2", "zaXcId": null, "waveKeyConfiguration": "Unkey Manual", "zaWaveKeyConfiguration": null, "azWaveKey1": null, "azWaveKey2": null, "zaWaveKey1": null, "zaWaveKey2": null, "waveKeyingPref": "NA", "zawaveKeyingPref": "None", "azDupsUnlocked": "NotReceived", "zaDupsUnlocked": "No", "sncState": "LOCAL", "attributeNameValue": {}, "azTopology": [], "zaTopology": [], "A1End": { "portRole": null, "parentPortName": "SFD-2-4-OMD", "NEName": "PSS32-42.27.199", "PortName": "SFD-2-4-OMD-9200.000" }, "Z1End": { "portRole": null, "parentPortName": "SFD-2-4-9200", "NEName": "PSS32-42.27.199", "PortName": "SFD-2-4-9200.000" }, "A2End": { "portRole": null, "parentPortName": "", "NEName": "", "PortName": "" }, "Z2End": { "portRole": null, "parentPortName": "", "NEName": "", "PortName": "" } } ]

    External Docs
    See Also :

    Operation

    get /data/otn/connection/{id}/e2eCurrentPhysicalRoute
    to get End-to-End physical routing details for given connection ID (getE2ECurrentRouteRD : /data/otn/connection/{id}/e2eCurrentPhysicalRoute)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/e2eCurrentPhysicalRoute
    to get End-to-End physical routing details for given connection ID (getE2ECurrentRouteRD : /data/otn/connections/{id}/e2eCurrentPhysicalRoute)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/physicalConns/{id}/e2ePhysicalRoute
    to get End-to-End Routing Details for given physical connection ID (getE2EPhysicalConnectionRD : /data/otn/physicalConns/{id}/e2ePhysicalRoute)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/test/connection/{id}/e2eRoute
    Not a supported API. (getE2ERoute : /data/otn/test/connection/{id}/e2eRoute)
    getE2ERoute

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/test/connections/{id}/e2eRoute
    Not a supported API. (getE2ERoute : /data/otn/test/connections/{id}/e2eRoute)
    getE2ERoute

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/{id}/e2ePhysicalRoute
    to get End-to-End physical routing details for given connection ID (getE2ERouteRD : /data/otn/connection/{id}/e2ePhysicalRoute)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/e2ePhysicalRoute
    to get End-to-End physical routing details for given connection ID (getE2ERouteRD : /data/otn/connections/{id}/e2ePhysicalRoute)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/connectionTP
    to get port details for connection (getEligiblePorts : /data/otn/connection/connectionTP)
    Along with 'rate' either 'nodeName' or 'nodeId' must be used

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate required ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • OtnConnectionPortTPInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/connectionTP?nodeName=PHN-2&rate=ODU2

    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
    "nextTasks": null, "items": [ { "className": "connectionTP", "label": "11QPEN4-1-3-L1-1", "guiLabel": "11QPEN4-1-3-L1-1", "key": "11QPEN4-1-3-L1-1/296770", "id": 19, "neId": 72, "neName": "PHN-2", "neLabel": "", "neModel": "", "nodeName": "PHN-2", "portid": 296770, "portName": "11QPEN4-1-3-L1-1", "rate": "ODU2", "type": "CTP", "cardName": "11QPEN4", "availability": "Available", "frequency": "", "rxFrequency": "", "oprMode": "N/A", "layerRate": 245, "direction": 1, "timeslot": 0, "alarmState": 0, "ptpId": 296766, "ptpName": "11QPEN4-1-3-L1", "ptpRate": "OS", "connectionId": -1, "connectionName": "", "connectionRate": "", "port": "PHN-2/11QPEN4-1-3-L1-1", "portGrpMode": "N/A", "odukPort": null, "portId": 296770 }, { "className": "connectionTP", "label": "11QPEN4-1-3-L2-1", "guiLabel": "11QPEN4-1-3-L2-1", "key": "11QPEN4-1-3-L2-1/296765", "id": 18, "neId": 72, "neName": "PHN-2", "neLabel": "", "neModel": "", "nodeName": "PHN-2", "portid": 296765, "portName": "11QPEN4-1-3-L2-1", "rate": "ODU2", "type": "CTP", "cardName": "11QPEN4", "availability": "Available", "frequency": "", "rxFrequency": "", "oprMode": "N/A", "layerRate": 245, "direction": 1, "timeslot": 0, "alarmState": 0, "ptpId": 296761, "ptpName": "11QPEN4-1-3-L2", "ptpRate": "OS", "connectionId": -1, "connectionName": "", "connectionRate": "", "port": "PHN-2/11QPEN4-1-3-L2-1", "portGrpMode": "N/A", "odukPort": null, "portId": 296765 } }]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connectionTP
    to get port details for connection (getEligiblePorts : /data/otn/connectionTP)
    Along with 'rate' either 'nodeName' or 'nodeId' must be used

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate required ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • OtnConnectionPortTPInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/connectionTP?nodeName=PHN-2&rate=ODU2

    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
    { "nextTasks": null, "items": [ { "className": "connectionTP", "label": "11QPEN4-1-3-L1-1", "guiLabel": "11QPEN4-1-3-L1-1", "key": "11QPEN4-1-3-L1-1/296770", "id": 19, "neId": 72, "neName": "PHN-2", "neLabel": "", "neModel": "", "nodeName": "PHN-2", "portid": 296770, "portName": "11QPEN4-1-3-L1-1", "rate": "ODU2", "type": "CTP", "cardName": "11QPEN4", "availability": "Available", "frequency": "", "rxFrequency": "", "oprMode": "N/A", "layerRate": 245, "direction": 1, "timeslot": 0, "alarmState": 0, "ptpId": 296766, "ptpName": "11QPEN4-1-3-L1", "ptpRate": "OS", "connectionId": -1, "connectionName": "", "connectionRate": "", "port": "PHN-2/11QPEN4-1-3-L1-1", "portGrpMode": "N/A", "odukPort": null, "portId": 296770 }, { "className": "connectionTP", "label": "11QPEN4-1-3-L2-1", "guiLabel": "11QPEN4-1-3-L2-1", "key": "11QPEN4-1-3-L2-1/296765", "id": 18, "neId": 72, "neName": "PHN-2", "neLabel": "", "neModel": "", "nodeName": "PHN-2", "portid": 296765, "portName": "11QPEN4-1-3-L2-1", "rate": "ODU2", "type": "CTP", "cardName": "11QPEN4", "availability": "Available", "frequency": "", "rxFrequency": "", "oprMode": "N/A", "layerRate": 245, "direction": 1, "timeslot": 0, "alarmState": 0, "ptpId": 296761, "ptpName": "11QPEN4-1-3-L2", "ptpRate": "OS", "connectionId": -1, "connectionName": "", "connectionRate": "", "port": "PHN-2/11QPEN4-1-3-L2-1", "portGrpMode": "N/A", "odukPort": null, "portId": 296765 } ] }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/getHaStatus
    to get HA status (getHaStatus : /data/otn/getHaStatus)
    to get HA status


    Return type
  • HaStatus
  • Responses

    Response Messages

    Schema

    200success HaStatus
    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/otn/port/fiberChars
    to get loss data for port by Id (getLossDataForPorts : /data/otn/port/fiberChars)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional get layout from /data/otn/wlt2/layout reques WLT Response ---
    Query parameters

    Name

    IsRequired

    Description

    portId required ---
    connId optional ---
    connType optional ---
    direction required ---
    band optional ---
    currentRouteIdList optional ---

    Return type
  • DeferredResult«TPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«TPInventoryResponse»
    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.
    • application/json

    External Docs
    See Also :
  • getEligiblePorts : /data/otn/connectionTP

  • Operation

    get /data/otn/networkinventory/neattrinfo
    retrieves all NE Attr (getNeAttrInfo : /data/otn/networkinventory/neattrinfo)
    to get NPR NEID and CLUSTERID


    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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/otn/networkinventory/networkfilesandstatus
    to get list of all Network Data Full/Partial Files details (getNetworkDataFiles : /data/otn/networkinventory/networkfilesandstatus)
    returns all Network Data File Names,status,Progress, Url of file, time


    Return type
  • EPTAdapterInventoryResponse
  • Responses

    Response Messages

    Schema

    200success EPTAdapterInventoryResponse
    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/otn/connections/{id}/OCHTrailList
    getOCHTrailConnList (getOCHTrailConnList : /data/otn/connections/{id}/OCHTrailList)
    getOCHTrailConnList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    clientId required ---
    sdhConnectionId required ---
    connectionName required ---
    category required ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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/otn/olcState
    to retrieve connections with olc state of maintenance or to see if any stale connections in DB with OLCState (getOLCState : /data/otn/olcState)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn optional ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/ancestors
    to check if any object in the hierarchy (exclusive) is in Maintenance state (getOlcStateObjectAncestors : /data/otn/olcState/ancestors)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/ascendants
    to check if any object in the hierarchy (exclusive) is in Maintenance state (getOlcStateObjectAncestors : /data/otn/olcState/ascendants)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/selfAndAncestors
    to check if any object in the hierarchy (inclusive) is in Maintenance state (getOlcStateObjectAndAncestors : /data/otn/olcState/selfAndAncestors)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/selfAndAscendants
    to check if any object in the hierarchy (inclusive) is in Maintenance state (getOlcStateObjectAndAncestors : /data/otn/olcState/selfAndAscendants)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/selfAndDescendants
    to retrieve OlcState objects for the specified entity and its descendents (getOlcStateObjectAndDescendents : /data/otn/olcState/selfAndDescendants)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/selfAndDescendents
    to retrieve OlcState objects for the specified entity and its descendents (getOlcStateObjectAndDescendents : /data/otn/olcState/selfAndDescendents)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/descendants
    to retrieve OLCState data for any decendents in maintenance state (getOlcStateObjectDescendents : /data/otn/olcState/descendants)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/olcState/descendents
    to retrieve OLCState data for any decendents in maintenance state (getOlcStateObjectDescendents : /data/otn/olcState/descendents)
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/{id}/getPGDetails
    getPGDetailsById (getPGDetailsById : /data/otn/connections/{id}/getPGDetails)
    getPGDetailsById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/physicalports
    Retrieves a list of all PTPs for all Network Elements stored in OMS. (getPhysicalPorts : /data/otn/networkinventory/physicalports)
    The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The inventory data files shall contain the attributes listed below for each port.

    Note: Number of files = Number of Nodes.
    Name of each file is OTN_NEID.json

    otnNeid : OTN NE id
    NEName : NE name
    PortName : Port Name
    PortRate
    signalType : Signal type assigned on port
    primaryState : Primary state. Valid Values - IS-NR, IS-ANR, OOS-AU, OOS-MA, OOS-AUMA
    secondaryState : Secondary state. Valid Values - ACT, AINS, BUSY, CP, CPMP, CPMPE, DSBLD, FAF, LPBK, MDLT, MP, NOIMP, PMD, PSI, SDEE, SGEO, STBYH, STBYS, TRM, UAS, WRK, ANR, FLT, MEA, MT, UEQ
    portNumber : Port number in shelf/slot/port format
    cardName : Card Name
    Frequency : Frequency on port.Format - NNNN.XXX (e.g. 9400.000,9400.625).
    cardMode
    transmissionMode
    phaseEncoding
    encoding
    waveShape
    userLabel
    portIndex
    BaseLineReason_OPT
    BaseLineReason_OPR
    BaseLineValue_OPT
    BaseLineValue_OPR
    BaseLineTime_OPT
    BaseLineTime_OPR
    transmitPower
    receivePower
    lldpRemotePeers: [
    {
    EnabledCap: Enabled capabilities,
    SysName: System Name,
    ChassisID: Chassis ID,
    ChassisIDSubType: Chassis ID Subtype,
    SysCap: Supported capabilities,
    PortID: Port ID,
    PortIDSubType: Port Id Subtype,
    SysDesc: System Description,
    DestinatioMAC: Destination MAC address,
    PortDesc: Port Description,
    }


    Return type
  • NptAdapterPhysicalPortResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /oms1350/data/otn/networkinventory/physicalports REST call for getting the inventory details using the response of above REST call: /OTNE_1-19/data_extraction/npt/inventory/physicalports/42.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "NPT", "objectType": "physicalPorts", "objectScope": null, "responseStatus": "SUCCESS", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/42.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/44.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/46.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/48.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/50.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/52.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/54.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/56.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/58.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/62.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/64.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/66.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/68.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/82.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/84.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/148.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/150.json ] } Response with inventory details using the above HTTP URL: http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/physicalports/42.json { "response": { "physicalPorts": [ { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"10AN400-11-3-1", "PortRate":"OS", "signalType":"100GbE", "primaryState":"OOS-AUMA", "secondaryState":"Supported Entity Service Exists,Supporting Entity Outage", "portNumber":"11/3/1", "cardName":"10AN400", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":null, "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-1-5-C1", "PortRate":"OS", "signalType":"OTU2", "primaryState":"OOS-AU", "secondaryState":"Supporting Entity Outage", "portNumber":"1/5/2", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"17105408", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-1-6-C1", "PortRate":"OS", "signalType":"OTU2", "primaryState":"OOS-AU", "secondaryState":"AINS,Supporting Entity Outage", "portNumber":"1/6/2", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"17170944", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-10-9-C21", "PortRate":"OS", "signalType":"100GbE", "primaryState":"OOS-AU", "secondaryState":"AINS,Supported Entity Service Exists,Supporting Entity Outage", "portNumber":"10/9/12", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":null, "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-3-3-C1", "PortRate":"OS", "signalType":"FC800", "primaryState":"OOS-AU", "secondaryState":"Supporting Entity Outage", "portNumber":"3/3/2", "cardName":"S13X100R", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"50528768", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-4-11-C32", "PortRate":"OS", "signalType":"OTU4", "primaryState":"OOS-AU", "secondaryState":"Supporting Entity Outage", "portNumber":"4/11/14", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"67833344", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-8-4-C1", "PortRate":"OS", "signalType":"OTU2", "primaryState":"OOS-AU", "secondaryState":"Supporting Entity Outage", "portNumber":"8/4/2", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"134480384", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] }, { "otnNeid":"42", "NEName":"10.41.55.222", "PortName":"S13X100-8-5-C1", "PortRate":"OS", "signalType":"OTU2", "primaryState":"OOS-AU", "secondaryState":"Supporting Entity Outage", "portNumber":"8/5/2", "cardName":"S13X100E", "Frequency":null, "cardMode":null, "transmissionMode":null, "phaseEncoding":null, "encoding":null, "waveShape":null, "userLabel":null, "portIndex":"134545920", "BaseLineReason_OPT":null, "BaseLineReason_OPR":null, "BaseLineValue_OPT":null, "BaseLineValue_OPR":null, "BaseLineTime_OPT":null, "BaseLineTime_OPR":null, "transmitPower":null, "receivePower":null, "lldpRemotePeers":[ ] } ] }, "responseHeader": { "originatorApp": "1350OMS", "objectType": "PhysicalPorts", "objectScope": "port", "responseStatus": "SUCCESS", "errorCode": "", "errorReason": "", "errorParams": [] } }

    External Docs
    See Also :

    Operation

    post /data/otn/Connection/pluggableModule
    To Get the pluggable module type for the port specified in input object OtnEndPointPluggableModuleReq (getPluggableModuleType : /data/otn/Connection/pluggableModule)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connReq OtnEndPointPluggableModuleReq ---

    Return type
  • OtnPluggableModuleResponse
  • Responses

    Response Messages

    Schema

    200success OtnPluggableModuleResponse
    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/otn/Connection/pluggableModule Payload: {"portName":"MDL-1-1-1-1","port_AdditionalInfo":{"neId":67,"neName":"KM-Node1#OCS","portName":"MDL-1-1-1-1","label":"MDL-1-1-1-1","portid":201529,"cardName":"10XANY10G","portGrpMode":"PWRSV","rate":"ODU2"},"neName":"KM-Node1#OCS","servicerate":"ODU2"}

    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
    {"plugModule":"UNPLUGGED"}

    External Docs
    See Also :
  • getEligiblePorts : /data/otn/connection/connectionTP

  • Operation

    post /data/otn/ioo/pmdata
    retrieves PM data (getPmInfo : /data/otn/ioo/pmdata)
    to get PM data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req Nbi IOO Pm Request ---

    Return type
  • NbiPmFtpResponseData
  • Responses

    Response Messages

    Schema

    200success NbiPmFtpResponseData
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/connection/timeSlots
    to get available timeslots for unterminated connection (getPortTimeslots : /data/otn/connection/timeSlots)

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    neId required ---
    nprNodeId optional ---
    rate required ---
    port optional ---
    containerRate required ---
    tpName required ---
    showAllTimeslots optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/timeSlots?neId=64&rate=ODU3&tpName=MDL-1-1-9-2&containerRate=ODU2

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "items": [ { "className": "timeSlots", "key": "2/timeSlots", "id": 2, "timeSlot": 2, "availability": "Available", "odujNum": "ODU3ODU2-1-1-9-2-2" }, { "className": "timeSlots", "key": "3/timeSlots", "id": 3, "timeSlot": 3, "availability": "Available", "odujNum": "ODU3ODU2-1-1-9-2-3" }, { "className": "timeSlots", "key": "4/timeSlots", "id": 4, "timeSlot": 4, "availability": "Available", "odujNum": "ODU3ODU2-1-1-9-2-4" }, { "className": "timeSlots", "key": "5/timeSlots", "id": 5, "timeSlot": 5, "availability": "Available", "odujNum": "ODU3ODU2-1-1-9-2-5" }, { "className": "timeSlots", "key": "6/timeSlots", "id": 6, "timeSlot": 6, "availability": "Available", "odujNum": "ODU3ODU2-1-1-9-2-6" } ], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/{id}/primary
    to get primary connection ID specified by new ID (getPrimaryConnIdById : /data/otn/connections/{id}/primary)
    returns primary connection Id specified by new Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/296/primary

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [ ], "errcde": null, "errorParams": null, "nextTasks": null, "items": [ { "className": "trail", "id": "296", "key": "trail/296", "guiLabel": "112SCX10-ODU4-1", "vsClientState": "VSCS_NOT_APPLICABLE", "vsClientId": -1, "connectionType": "trail", "receivedDate": "2015-09-14T02:53:16Z", "orderId": "475", "groupOrderId": "295", "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV", "groupOrderName": "g-112SCX10-ODU4-1", "connectionAlias": "112SCX10-ODU4-1", "orderStep": "CST_IMPLEMENTATION_FAILED", "stepState": "SSTATE_FAILED", "orderType": "OT_ADD", "layerRate": "ODU4", "effectiveRate": "ODU4", "displayProtectionType": "DPT_UN_PROTECTED", "protectionRole": "PR_NA", "state": "CST_IMPLEMENTATION", "operationalState": "Enabled", "category": "CC_MANAGED_PLANE", "alarmEnabling": "Not Set", "alarmState": "Cleared", "alarmSeverity": "Cleared", "TCMEnabled": "TCM_STATUS_NONE", "TCMASAPEnabled": "TCM_STATUS_NONE", "nmlASAPName": "default ASAP", "frequency": "N/A", "orderNumber": "A397", "customerName": "None", "serviceState": "ServiceState_ON", "provisionableWavekey": "keyed", "a1NeName": "M-Node-1", "a1PortName": "112SCX10-7-2-L1-1", "z1NeName": "M-Node-2", "z1PortName": "112SCX10-7-2-L1-1", "a1NodeName": "M-Node-1", "z1NodeName": "M-Node-2", "aNodeId": 9, "zNodeId": 4, "a2NodeId": 0, "z2NodeId": 0, "aPortLabel": "M-Node-1/112SCX10-7-2-L1-1", "zPortLabel": "M-Node-2/112SCX10-7-2-L1-1", "pm24hour": "StopFailed", "pm15min": "NotEnabled", "nprTlId": "-1", "sdhConnectionId": "-1", "sdhClientId": "-1", "isUsedInSdh": "false", "fdn": "11/296", "mismatchType": "NA", "clientRouteState": "NA", "createdBy": "CB_USER", "inconsistentMismatchType": "", "inconsistentAcknowledgedBy": "", "inconsistentEventDate": "", "inconsistentAckDate": "", "isL0CRRD": "false", "isCurrentRouteRD": "false", "aportLabel": "M-Node-1/112SCX10-7-2-L1-1", "zportLabel": "M-Node-2/112SCX10-7-2-L1-1", "tcmenabled": "TCM_STATUS_NONE", "tcmasapenabled": "TCM_STATUS_NONE" } ], "data": null, "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/details
    to get additional details about a connection. Specified by connection Id (getProtectionDetailsForConn : /data/otn/connections/{id}/details)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/protectedConnections/{id}/details
    to get additional details about a connection. Specified by connection Id (getProtectionDetailsForConn : /data/otn/protectedConnections/{id}/details)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/getRepeaterAndCommStatus
    to get Repeaters and port commissioning status for given physical connection ids (getRepeatersAndCommissioningStatus : /data/otn/connections/getRepeaterAndCommStatus)
    getRepeatersAndCommissioningStatus

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional e2eOverlayMap ---
    Query parameters

    Name

    IsRequired

    Description

    ids optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    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/otn/connections/{id}/verticalRoutingDisplay
    getRoutingDisplayDataForVerticalLayout (getRoutingDisplayDataForVerticalLayout : /data/otn/connections/{id}/verticalRoutingDisplay)
    getRoutingDisplayDataForVerticalLayout

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    connType required connType ---

    Return type
  • Array
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/switchStatus
    to get switch status of a given connection (getSwitchStatusById : /data/otn/connections/{id}/switchStatus)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/crossConnects/{sncId}/getTimeslots
    to get timeslots of a cross connects for specified nprNodeId (getTimeslotsById : /data/otn/crossConnects/{sncId}/getTimeslots)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    sncId required sncId can be retrieved from '/data/otn/nodes/{nprNodeId}/crossConnects' REST call as sncId ---

    Return type
  • XCInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/crossConnects/79/getTimeslots

    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
    { "reqCompletionStatus": 11, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "items": [{ "className": "crossConnect", "sncId": "79", "timeslots": "NA" }], "successfulCompletion": true, "failedCompletion": false }

    External Docs
    See Also :
  • listCrossConnectionsFromNode : /data/otn/nodes/{nprNodeId}/crossConnects

  • Operation

    get /data/otn/networkinventory/topologicalinks
    Retrieves a list of physical connections which have been deployed in the Network (getTopologicaLinks : /data/otn/networkinventory/topologicalinks)
    The data shall include Topological Links.Only connections in Order Step Commissioned shall be returned.The response contains the response status and HTTP URL where the inventory data files can be accessed.

    Note: Number of files= Number of nodes + 1
    The internal links in a NE is present with file name OTN_NEID.internal.json
    The interCompound links between NEs is present with file name interCompound.external.json
    Files will be updated every 5 hours by a cron job
    The inventory data files shall contain the attributes listed below for each connection:
    connectionName: 200 character string
    oduRate : Always Empty
    routeId : Always Empty
    demandName: Always Empty
    serverName: Always Empty
    oduName: Always Empty
    demandRate: Always Empty
    connectionState: Valid value - Commissioned
    comment: 255 Character String
    A1End
    NEName : NE TID
    PortName : Port ID of A1 end PTP
    PortRate : Rate of A1 end port
    channel: Always Empty
    Z1End
    NEName : NE TID
    PortName : Port ID of Z1 end PTP
    PortRate : Rate of Z1 end port
    channel: Always Empty
    A2End
    NEName : NE TID
    PortName : Port ID of A2 end PTP
    PortRate : Rate of A2 end port
    channel: Always Empty
    Z2End
    NEName : NE TID
    PortName : Port ID of Z2 end PTP
    PortRate : Rate of Z2 end port
    channel: Always Empty


    Return type
  • NptAdapterTopologicalLinksResponse
  • Responses

    Response Messages

    Schema

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

    REST call : /data/otn/networkinventory/topologicalinks REST call for getting the inventory details using the response of above REST call: OTNE_1-19/data_extraction/npt/inventory/topologicallinks/42.internal.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.
    • application/json
    Example Response Data
    Response for getting the list of HTTP URLs: { "responseHeader": { "originatorApp": "NPT", "objectType": "topologicallinks", "objectScope": null, "responseStatus": "SUCCESS", "errorCode": null, "errorReason": null, "errorParams": null }, "responseFiles": [ "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/42.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/44.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/46.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/48.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/50.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/52.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/54.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/56.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/58.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/62.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/64.internal.json", "http://135.250.203.134/OTNE_1-19/data_extraction/npt/inventory/topologicallinks/interCompound.external.json" ] } Response with inventory details using the above HTTP URL: { "response": { "topologicalLinks": [ { "connectionName":"21/AHPHG-1-2-DCM/21/AHPHG-1-2-DCM", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"AHPHG-1-2-DCM", "NEName":"10.41.55.222", "PortRate":"OTS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"AHPHG-1-2-DCM", "NEName":"10.41.55.222", "PortRate":"OTS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11QPA4-3-2-L1/21/SFD-25-1-9195", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11QPA4-3-2-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-25-1-9195", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11DPM12-4-2-L1/21/SFD-25-1-9205", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"SFD-25-1-9205", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"11DPM12-4-2-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"10.41.55.222/ALPHG-5-5-DCM/ALPHG-5-5-DCM", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"ALPHG-5-5-DCM", "NEName":"10.41.55.222", "PortRate":"OTS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"ALPHG-5-5-DCM", "NEName":"10.41.55.222", "PortRate":"OTS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11DPM12-5-2-L1/21/SFD-5-3-9200", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"SFD-5-3-9200", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"11DPM12-5-2-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11DPM12-8-2-L1/21/S13X100-8-4-C1", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11DPM12-8-2-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"S13X100-8-4-C1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/S13X100-8-4-L1/21/SFD-25-1-9305", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"S13X100-8-4-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-25-1-9305", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/S13X100-8-5-L1/21/SFD-25-1-9295", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"SFD-25-1-9295", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"S13X100-8-5-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11DPM12-8-3-L1/21/S13X100-8-5-C1", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11DPM12-8-3-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"S13X100-8-5-C1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11QPA4-9-5-L4/21/SFD-25-1-9595", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11QPA4-9-5-L4", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-25-1-9595", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/S2AD200-5-13-L1/21/SFD-5-15-9200", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"S2AD200-5-13-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-5-15-9200", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/130SNX10-4-7-L1/21/SFD-25-1-9395", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"130SNX10-4-7-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-25-1-9395", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11QPA4-7-2-L1/21/SFD-7-3-9200", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"SFD-7-3-9200", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"11QPA4-7-2-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11QPA4-9-5-L3/21/SFD-25-1-9605", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"SFD-25-1-9605", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"11QPA4-9-5-L3", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/D5X500-4-9-L1/21/S13X100-4-11-C32", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"S13X100-4-11-C32", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"D5X500-4-9-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/11DPM12-9-2-L2/21/S13X100-9-3-C2", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11DPM12-9-2-L2", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"S13X100-9-3-C2", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/4UC400-11-4-1/21/SFD-10-4-9190", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"4UC400-11-4-1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-10-4-9190", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"1025", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"11DPM8-10-3-C1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"OPS-10-2-B", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"10.41.55.222/S13X100-10-7-L1/SFD-10-8-9190", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"S13X100-10-7-L1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"SFD-10-8-9190", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } }, { "connectionName":"21/10AN400-11-3-1/21/OPS-9-6-A", "oduRate":"", "routeId":"", "demandName":"", "serverName":"", "oduName":"", "demandRate":"", "connectionState":"Commissioned", "comment":"", "A1End":{ "channel":"", "PortName":"10AN400-11-3-1", "NEName":"10.41.55.222", "PortRate":"OS" }, "A2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" }, "Z1End":{ "channel":"", "PortName":"OPS-9-6-A", "NEName":"10.41.55.222", "PortRate":"OS" }, "Z2End":{ "channel":"", "PortName":"", "NEName":"", "PortRate":"" } } ] }, "responseHeader": { "originatorApp": "1350OMS", "objectType": "PhyiscalToplogy/internal", "objectScope": "topology", "responseStatus": "SUCCESS", "errorCode": "", "errorReason": "", "errorParams": [] } }

    External Docs
    See Also :

    Operation

    get /data/otn/networkinventory/topologicalinks/ondemand
    Retrieves a list of physical connections which have been deployed in the Network (getTopologicaLinksOnDemand : /data/otn/networkinventory/topologicalinks/ondemand)
    The data shall include Topological Links.Only connections in Order Step Commissioned shall be returned.The response contains the response status and HTTP URL where the inventory data files can be accessed.

    The internal links in a NE is present with file name OTN_NEID.internal.json
    The interCompound links between NEs is present with file name interCompound.external.json
    The inventory data files shall contain the attributes listed below for each connection:
    connectionName: 200 character string
    oduRate : Always Empty
    routeId : Always Empty
    demandName: Always Empty
    serverName: Always Empty
    oduName: Always Empty
    demandRate: Always Empty
    connectionState: Valid value - Commissioned
    comment: 255 Character String
    A1End
    NEName : NE TID
    PortName : Port ID of A1 end PTP
    PortRate : Rate of A1 end port
    channel: Always Empty
    Z1End
    NEName : NE TID
    PortName : Port ID of Z1 end PTP
    PortRate : Rate of Z1 end port
    channel: Always Empty
    A2End
    NEName : NE TID
    PortName : Port ID of A2 end PTP
    PortRate : Rate of A2 end port
    channel: Always Empty
    Z2End
    NEName : NE TID
    PortName : Port ID of Z2 end PTP
    PortRate : Rate of Z2 end port
    channel: Always Empty


    Return type
  • NptAdapterTopologicalLinksResponse
  • Responses

    Response Messages

    Schema

    200success NptAdapterTopologicalLinksResponse
    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/otn/getunusedctpsforene
    Retrieves the available unused CTP names for ENE given physical port and layer rate (getUnusedCtpsForEne : /data/otn/getunusedctpsforene)
    The response contains list of unused ctps

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req NptGetCtpsForEneRequest ---

    Return type
  • NPTAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success NPTAdapterConnectionsResponse
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/system/version
    Returns OMS Software Version Details (getVersion : /data/otn/system/version)
    getVersion


    Return type
  • DeferredResult«Otn product information Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn product information Response»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /data/otn/connections/mismatch/{mismatchType}
    returns mismatch that is obtained from Mapping attributes needed for connection creation and serverside input for particulat mismatch type. SNC - Crossconnect mismatches, Params - Transmission Parameters mismatches ,NEDownload -Download Disabled mismatches, ASAP - ASAP mismatches (inconsistentConnectionList : /data/otn/connections/mismatch/{mismatchType})
    inconsistentConnectionList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    mismatchType required mismatchType:SNC,Params,NEDownload,ASAP ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/mismatch/SNC

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [ ], "errcde": null, "errorParams": null, "nextTasks": null, "items": [ { "className": "trail", "id": "297", "key": "trail/297", "guiLabel": "112SCX10-ODU4-1 OTU4#1", "vsClientState": "VSCS_NOT_APPLICABLE", "vsClientId": -1, "connectionType": "trail", "receivedDate": "2016-02-19T00:17:35Z", "orderId": "2492", "groupOrderId": "295", "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV", "groupOrderName": "g-112SCX10-ODU4-1", "connectionAlias": "112SCX10-ODU4-1 OTU4#1", "orderStep": "CST_IMPLEMENTATION_FAILED", "stepState": "SSTATE_FAILED", "orderType": "OT_DELETE", "layerRate": "OTU4", "effectiveRate": "OTU4", "displayProtectionType": "DPT_UN_PROTECTED", "protectionRole": "PR_NA", "state": "CST_IMPLEMENTATION", "operationalState": "Enabled", "category": "CC_MANAGED_PLANE", "alarmEnabling": "Not Set", "alarmState": "Cleared", "alarmSeverity": "Cleared", "TCMEnabled": "TCM_STATUS_NONE", "TCMASAPEnabled": "TCM_STATUS_NONE", "frequency": "9200.000", "orderNumber": "D1958", "customerName": "None", "serviceState": "ServiceState_ON", "provisionableWavekey": "keyed", "a1NeName": "M-Node-1", "a1PortName": "112SCX10-7-2-L1", "z1NeName": "M-Node-2", "z1PortName": "112SCX10-7-2-L1", "a1NodeName": "M-Node-1", "z1NodeName": "M-Node-2", "aNodeId": 34, "zNodeId": 10, "a2NodeId": 0, "z2NodeId": 0, "aPortLabel": "M-Node-1/112SCX10-7-2-L1", "zPortLabel": "M-Node-2/112SCX10-7-2-L1", "pm24hour": "StopFailed", "pm15min": "NotEnabled", "nprTlId": "-1", "sdhConnectionId": "-1", "sdhClientId": "-1", "isUsedInSdh": "false", "fdn": "11/297", "mismatchType": "NA", "clientRouteState": "NA", "createdBy": "CB_SYSTEM", "inconsistentMismatchType": "SNC", "inconsistentAcknowledgedBy": "", "inconsistentEventDate": "9 Nov 2015 00:08:26 GMT", "inconsistentAckDate": "", "isL0CRRD": "false", "isCurrentRouteRD": "false", "aportLabel": "M-Node-1/112SCX10-7-2-L1", "zportLabel": "M-Node-2/112SCX10-7-2-L1", "tcmenabled": "TCM_STATUS_NONE", "tcmasapenabled": "TCM_STATUS_NONE" } ], "data": null, "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/maintenance/ancestor
    to retrieve if olcs system parameter is enabled (isAncestorInMaintenance : /data/otn/olcState/maintenance/ancestor)
    isAncestorInMaintenance

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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/otn/Connection/ISNCInUserNAD
    isNCPartOfUsersNAD (isNCPartOfUsersNAD : /data/otn/Connection/ISNCInUserNAD)
    isNCPartOfUsersNAD

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    connid required ---
    connName optional ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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/otn/olcState/maintenance/selfOrAncestor
    to retrieve if olcs system parameter is enabled (isObjectInMaintenance : /data/otn/olcState/maintenance/selfOrAncestor)
    isObjectInMaintenance

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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/otn/olcState/sysParamEnabled
    to retrieve if olcs system parameter is enabled (isOlcSystemParameterEnabled : /data/otn/olcState/sysParamEnabled)
    isOlcSystemParameterEnabled


    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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/otn/connection/networkElement/{id}
    to get Network Element details by Id (item : /data/otn/connection/networkElement/{id})
    returns Network Element details by Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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/otn/connections/nes/{id}
    to get Network Element details by Id (item : /data/otn/connections/nes/{id})
    returns Network Element details by Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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/otn/nes/{id}
    to get Network Element details by Id (item : /data/otn/nes/{id})
    returns Network Element details by Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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/otn/networkElement/{id}
    to get Network Element details by Id (item : /data/otn/networkElement/{id})
    returns Network Element details by Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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/otn/networkElements/{id}
    to get Network Element details by Id (item : /data/otn/networkElements/{id})
    returns Network Element details by Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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/otn/connections/{id}/wlt/{dir}/ldPorts
    to get port details of all LD ports for given connection and direction (ldPortsList : /data/otn/connections/{id}/wlt/{dir}/ldPorts)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    dir required Direction:AZ,ZA ---

    Return type
  • Otn WLT LD Port Response
  • Responses

    Response Messages

    Schema

    200success Otn WLT LD Port Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/otn/connections/679/wlt/AZ/ldPorts

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { nextTasks: null, items: [{ id: 1, key: "ALPHG-1-17-LINE-9400.000/316699", className: "powerMeasurementPoint", guiLabel: "ALPHG-1-17-LINE-9400.000", neName: "PSS-32-NODE-A", portDirection: "Egress", powerMgmt: "Automatic", adjStatus: "Initial", adjResult: null, label: "powerMeasurementPoint", portId: 316699, portName: "ALPHG-1-17-LINE-9400.000", neId: 89, ptpId: 311103 }, { id: 2, key: "ALPHG-1-17-LINE-9400.000/325139", className: "powerMeasurementPoint", guiLabel: "ALPHG-1-17-LINE-9400.000", neName: "PSS-32-NODE-C", portDirection: "Ingress", powerMgmt: "Automatic", adjStatus: "Initial", adjResult: null, label: "powerMeasurementPoint", portId: 325139, portName: "ALPHG-1-17-LINE-9400.000", neId: 93, ptpId: 318615 }, { id: 3, key: "ALPHG-1-2-LINE-9400.000/321598", className: "powerMeasurementPoint", guiLabel: "ALPHG-1-2-LINE-9400.000", neName: "PSS-32-NODE-C", portDirection: "Egress", powerMgmt: "Automatic", adjStatus: "Initial", adjResult: null, label: "powerMeasurementPoint", portId: 321598, portName: "ALPHG-1-2-LINE-9400.000", neId: 93, ptpId: 318561 }, { id: 4, key: "ALPHG-1-17-LINE-9400.000/332305", className: "powerMeasurementPoint", guiLabel: "ALPHG-1-17-LINE-9400.000", neName: "PSS-32-NODE-B", portDirection: "Ingress", powerMgmt: "Automatic", adjStatus: "Initial", adjResult: null, label: "powerMeasurementPoint", portId: 332305, portName: "ALPHG-1-17-LINE-9400.000", neId: 91, ptpId: 325705 }], message: null, messageId: "", messageSeverity: "I", status: "SUCCESS" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/alarm/{id}
    To Retrieve alarm list for given connection ID (list : /data/otn/alarm/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can retrieved from '/data/otn/connections' REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/alarm/10

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "nodeName": "SRNode-1", "almraiseNature": "Primary", "className": "alarm", "nAlmSeverity": "Critical", "eRate": null, "connId": "-1", "id": "0", "key": "0/alarm", "eAlmNativeProbCause": "Card missing", "timeRaised": "2016-04-28T07:28:21Z", "eAlmSeverity": "Critical", "almDetails": "Equipment Failure", "almRaiseTime": "2016-04-28T07:28:21Z", "neUserLabel": "SRNode-1", "connectionRate": "Not_Applicable", "eSAStatus": "Service Affecting", "eAlmDetails": "Card missing", "eAlmProbCause": "Card missing", "nprNeId": "-1", "nAlmDetails": "Equipment Failure", "effectiveRate": "*", "nProbableCause": "Not Alarmed", "connectionName": "Not_Applicable", "tpNativeName": "SLOT-2-3", "sAStatusStr": null }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/networkElement
    returns Network Element list (list : /data/otn/connection/networkElement)
    to retrieve Network Element List

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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 :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connection/{id}/alarm
    To Retrieve alarm list for given connection ID (list : /data/otn/connection/{id}/alarm)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can retrieved from '/data/otn/connections' REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    data/otn/connection/10/alarm

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "nodeName": "SRNode-1", "almraiseNature": "Primary", "className": "alarm", "nAlmSeverity": "Critical", "eRate": null, "connId": "-1", "id": "0", "key": "0/alarm", "eAlmNativeProbCause": "Card missing", "timeRaised": "2016-04-28T07:28:21Z", "eAlmSeverity": "Critical", "almDetails": "Equipment Failure", "almRaiseTime": "2016-04-28T07:28:21Z", "neUserLabel": "SRNode-1", "connectionRate": "Not_Applicable", "eSAStatus": "Service Affecting", "eAlmDetails": "Card missing", "eAlmProbCause": "Card missing", "nprNeId": "-1", "nAlmDetails": "Equipment Failure", "effectiveRate": "*", "nProbableCause": "Not Alarmed", "connectionName": "Not_Applicable", "tpNativeName": "SLOT-2-3", "sAStatusStr": null }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/nes
    returns Network Element list (list : /data/otn/connections/nes)
    to retrieve Network Element List

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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 :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/{id}/alarms
    To Retrieve alarm list for given connection ID (list : /data/otn/connections/{id}/alarms)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can retrieved from '/data/otn/connections' REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/10/alarms

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "nodeName": "SRNode-1", "almraiseNature": "Primary", "className": "alarm", "nAlmSeverity": "Critical", "eRate": null, "connId": "-1", "id": "0", "key": "0/alarm", "eAlmNativeProbCause": "Card missing", "timeRaised": "2016-04-28T07:28:21Z", "eAlmSeverity": "Critical", "almDetails": "Equipment Failure", "almRaiseTime": "2016-04-28T07:28:21Z", "neUserLabel": "SRNode-1", "connectionRate": "Not_Applicable", "eSAStatus": "Service Affecting", "eAlmDetails": "Card missing", "eAlmProbCause": "Card missing", "nprNeId": "-1", "nAlmDetails": "Equipment Failure", "effectiveRate": "*", "nProbableCause": "Not Alarmed", "connectionName": "Not_Applicable", "tpNativeName": "SLOT-2-3", "sAStatusStr": null }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/alarms/all
    To Retrieve alarm list for given connection ID (list : /data/otn/connections/{id}/alarms/all)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can retrieved from '/data/otn/connections' REST call as 'id' ---

    Return type
  • AlarmInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/10/alarms/all

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "nodeName": "SRNode-1", "almraiseNature": "Primary", "className": "alarm", "nAlmSeverity": "Critical", "eRate": null, "connId": "-1", "id": "0", "key": "0/alarm", "eAlmNativeProbCause": "Card missing", "timeRaised": "2016-04-28T07:28:21Z", "eAlmSeverity": "Critical", "almDetails": "Equipment Failure", "almRaiseTime": "2016-04-28T07:28:21Z", "neUserLabel": "SRNode-1", "connectionRate": "Not_Applicable", "eSAStatus": "Service Affecting", "eAlmDetails": "Card missing", "eAlmProbCause": "Card missing", "nprNeId": "-1", "nAlmDetails": "Equipment Failure", "effectiveRate": "*", "nProbableCause": "Not Alarmed", "connectionName": "Not_Applicable", "tpNativeName": "SLOT-2-3", "sAStatusStr": null }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/wlt/{dir1}/{dir2}/{band}
    list (list : /data/otn/connections/{id}/wlt/{dir1}/{dir2}/{band})
    list

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    dir1 required Direction1: AZ/ZA ---
    dir2 required Direction2: Ingress/Egress ---
    band required Band: C/L ---
    Query parameters

    Name

    IsRequired

    Description

    isExport required ---

    Return type
  • Otn WLT OTS Response
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/wlt/{dir}
    lists power details at every physical ports of a given connection and direction (list : /data/otn/connections/{id}/wlt/{dir})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    dir required dir: AZ,ZA ---
    Query parameters

    Name

    IsRequired

    Description

    direction required ---
    isCurrentRoute optional ---
    band optional ---
    aPortName optional ---
    zPortName optional ---
    aNodeName optional ---
    zNodeName optional ---
    aNodeId optional ---
    zNodeId optional ---
    connectionName optional ---
    is3R optional ---
    sdhConnectionId optional ---
    protectionRole optional ---

    Return type
  • OtnWLTResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/679/wlt/ZA?isCurrentRoute=false

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { wltKey: "conn(679).OPD_ZA", channelPowerWorking: [{ xlabel: { ne: "PSS-32-NODE-B", portName: "11STMM10-1-12-L1", direction: "OUT", measurementType: "NA", powerMgmtType: "Automatic" }, measPower: "-8.95", minPower: "-9.94", maxPower: "-7.9399996", tpId: "331215", ptpId: "325687", tooltip: { measuredPower: "-8.95", expectedPower: "-8.94", expectedPowerDeviation: "1.0", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-B", portName: "CWR-1-15-CLS8-9400.000", direction: "IN", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-10.11", minPower: "-11.33", maxPower: "-6.33", tpId: "331826", ptpId: "325704", tooltip: { measuredPower: "-10.11", expectedPower: "-8.83", expectedPowerDeviation: "2.5", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-B", portName: "CWR-1-15-SIG-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-10.19", minPower: "-12.2", maxPower: "-7.2", tpId: "326620", ptpId: "325616", tooltip: { measuredPower: "-10.19", expectedPower: "-9.7", expectedPowerDeviation: "2.5", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-B", portName: "ALPHG-1-17-LINE-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-10.71", minPower: "-13.23", maxPower: "-8.23", tpId: "332305", ptpId: "325705", tooltip: { measuredPower: "-10.71", expectedPower: "-10.73", expectedPowerDeviation: "2.5", frequency: "9400.000", totalPower: null }, otdr: { aPort1: "PSS-32-NODE-B/ALPHG-1-17-LINE", zPort1: "PSS-32-NODE-C/ALPHG-1-2-SIG" }, isLD: true }, { xlabel: { ne: "SPAN-1", portName: "SPAN-1", direction: "SPAN-1", measurementType: "SPAN-1", powerMgmtType: "SPAN-1" }, measPower: null, minPower: null, maxPower: null, tpId: null, ptpId: null, tooltip: null, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-2-LINE-9400.000", direction: "IN", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-22.34", minPower: "-24.53", maxPower: "-16.710001", tpId: "321598", ptpId: "318561", tooltip: { measuredPower: "-22.34", expectedPower: "-20.62", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: { aPort1: "PSS-32-NODE-B/ALPHG-1-17-LINE", zPort1: "PSS-32-NODE-C/ALPHG-1-2-SIG" }, isLD: true }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-2-SIG-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "0.44", minPower: "-3.3400002", maxPower: "4.48", tpId: "323057", ptpId: "318594", tooltip: { measuredPower: "0.44", expectedPower: "0.57", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "CWR-1-4-SIG-9400.000", direction: "IN", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "0.01", minPower: "-3.5600002", maxPower: "4.26", tpId: "318769", ptpId: "318539", tooltip: { measuredPower: "0.01", expectedPower: "0.35", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "CWR-1-4-THRU-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-7.61", minPower: "-10.1", maxPower: "-5.1", tpId: "322161", ptpId: "318570", tooltip: { measuredPower: "-7.61", expectedPower: "-7.6", expectedPowerDeviation: "2.5", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-17-LINE-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-10.73", minPower: "-13.23", maxPower: "-8.23", tpId: "325139", ptpId: "318615", tooltip: { measuredPower: "-10.73", expectedPower: "-10.73", expectedPowerDeviation: "2.5", frequency: "9400.000", totalPower: null }, otdr: { aPort1: "PSS-32-NODE-C/ALPHG-1-17-LINE", zPort1: "PSS-32-NODE-A/ALPHG-1-17-SIG" }, isLD: true }, { xlabel: { ne: "SPAN-2", portName: "SPAN-2", direction: "SPAN-2", measurementType: "SPAN-2", powerMgmtType: "SPAN-2" }, measPower: null, minPower: null, maxPower: null, tpId: null, ptpId: null, tooltip: null, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "ALPHG-1-17-LINE-9400.000", direction: "IN", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-21.99", minPower: "-24.35", maxPower: "-16.53", tpId: "316699", ptpId: "311103", tooltip: { measuredPower: "-21.99", expectedPower: "-20.44", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: { aPort1: "PSS-32-NODE-C/ALPHG-1-17-LINE", zPort1: "PSS-32-NODE-A/ALPHG-1-17-SIG" }, isLD: true }, { xlabel: { ne: "PSS-32-NODE-A", portName: "ALPHG-1-17-SIG-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "0.2", minPower: "-3.3400002", maxPower: "4.48", tpId: "315924", ptpId: "311099", tooltip: { measuredPower: "0.2", expectedPower: "0.57", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "CWR-1-15-SIG-9400.000", direction: "IN", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "0.36", minPower: "-3.51", maxPower: "4.31", tpId: "315033", ptpId: "311162", tooltip: { measuredPower: "0.36", expectedPower: "0.4", expectedPowerDeviation: "3.91", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "CWR-1-15-CLS8-9400.000", direction: "OUT", measurementType: "WTD", powerMgmtType: "Automatic" }, measPower: "-11.85", minPower: "-17.5", maxPower: "-6.5", tpId: "311256", ptpId: "311056", tooltip: { measuredPower: "-11.85", expectedPower: "-12.0", expectedPowerDeviation: "5.5", frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "11STMM10-1-7-L1", direction: "IN", measurementType: "NA", powerMgmtType: "Automatic" }, measPower: "-12.31", minPower: null, maxPower: null, tpId: "317675", ptpId: "311137", tooltip: { measuredPower: "-12.31", expectedPower: null, expectedPowerDeviation: null, frequency: "9400.000", totalPower: null }, otdr: null, isLD: false }], totalPowerWorking: [{ xlabel: { ne: "PSS-32-NODE-B", portName: "11STMM10-1-12-L1", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "-8.93", minPower: null, maxPower: null, tpId: "325687", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-8.93" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-B", portName: "CWR-1-15-SIG", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "-9.18", minPower: null, maxPower: null, tpId: "325616", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-9.18" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-B", portName: "ALPHG-1-17-LINE", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "-10.2", minPower: null, maxPower: null, tpId: "325705", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-10.2" }, otdr: null, isLD: false }, { xlabel: { ne: "SPAN-1", portName: "SPAN-1", direction: "SPAN-1", measurementType: "SPAN-1", powerMgmtType: "SPAN-1" }, measPower: null, minPower: null, maxPower: null, tpId: null, ptpId: null, tooltip: null, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-2-LINE", direction: "IN", measurementType: "", powerMgmtType: "" }, measPower: "-20.14", minPower: null, maxPower: null, tpId: "318561", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-20.14" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-2-SIG", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "2.17", minPower: null, maxPower: null, tpId: "318594", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "2.17" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "CWR-1-4-SIG", direction: "IN", measurementType: "", powerMgmtType: "" }, measPower: "1.96", minPower: null, maxPower: null, tpId: "318539", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "1.96" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "CWR-1-4-THRU", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "-7.57", minPower: null, maxPower: null, tpId: "318570", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-7.57" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-C", portName: "ALPHG-1-17-LINE", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "-10.62", minPower: null, maxPower: null, tpId: "318615", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-10.62" }, otdr: null, isLD: false }, { xlabel: { ne: "SPAN-2", portName: "SPAN-2", direction: "SPAN-2", measurementType: "SPAN-2", powerMgmtType: "SPAN-2" }, measPower: null, minPower: null, maxPower: null, tpId: null, ptpId: null, tooltip: null, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "ALPHG-1-17-LINE", direction: "IN", measurementType: "", powerMgmtType: "" }, measPower: "-20.4", minPower: null, maxPower: null, tpId: "311103", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-20.4" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "ALPHG-1-17-SIG", direction: "OUT", measurementType: "", powerMgmtType: "" }, measPower: "1.62", minPower: null, maxPower: null, tpId: "311099", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "1.62" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "CWR-1-15-SIG", direction: "IN", measurementType: "", powerMgmtType: "" }, measPower: "1.48", minPower: null, maxPower: null, tpId: "311162", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "1.48" }, otdr: null, isLD: false }, { xlabel: { ne: "PSS-32-NODE-A", portName: "11STMM10-1-7-L1", direction: "IN", measurementType: "", powerMgmtType: "" }, measPower: "-12.31", minPower: null, maxPower: null, tpId: "311137", ptpId: null, tooltip: { measuredPower: null, expectedPower: null, expectedPowerDeviation: null, frequency: null, totalPower: "-12.31" }, otdr: null, isLD: false }], channelPowerProtected: [], totalPowerProtected: [], otnWLTDetails: { connectionName: "JAW-TOADM-MAN-THRU-3-13-12", frequency: "9400.000", aNeName: "PSS-32-NODE-A", aPortName: "11STMM10-1-7-L1", zNeName: "PSS-32-NODE-B", zPortName: "11STMM10-1-12-L1", connectionType: "Bidirectional", direction: "Z-A", connectionRate: "OTU2", orderNumber: "A999", connectionState: "Commissioned", routeState: "", wavekeyType: "", wavekey1: "", wavekey2: "", lastRefresh: "Thu Apr 27 05:44:14 EDT 2017" }, message: "", messageId: "", messageSeverity: "", status: "SUCCESS" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • modifyConnection : /data/otn/Connection/{id}

  • Operation

    get /data/otn/nes
    returns Network Element list (list : /data/otn/nes)
    to retrieve Network Element List

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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 :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/networkElement
    returns Network Element list (list : /data/otn/networkElement)
    to retrieve Network Element List

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/networkElement/

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "guiLabel": "130SCA1_Ene1", "neManagementType": "Unknown", "neModel": "BBOX_NE", "className": "networkElement", "neConfigDownload": "DownloadDisabled", "label": "130SCA1_Ene1", "neControllerName": "OTN_11_NPR", "neActivityState": "activitystate.15", "neControllerSwVersion": "R1.0", "neCommState": "Failed", "neSwVersion": "R1.0", "id": "98", "key": "130SCA1_Ene1/98", "neAdditionalInfo": null, "neControllerModel": "NPR" }, { "guiLabel": "EN-1", "neManagementType": "Unknown", "neModel": "BBOX_NE", "className": "networkElement", "neConfigDownload": "DownloadDisabled", "label": "EN-1", "neControllerName": "OTN_11_NPR", "neActivityState": "activitystate.15", "neControllerSwVersion": "R1.0", "neCommState": "Failed", "neSwVersion": "R1.0", "id": "126", "key": "EN-1/126", "neAdditionalInfo": null, "neControllerModel": "NPR" }, { "guiLabel": "siva3", "neManagementType": "ManagedViaSeparateEML", "neModel": "1830PSS_32", "className": "networkElement", "neConfigDownload": "DownloadDisabled", "label": "siva3", "neControllerName": "EML_1100_SNA", "neActivityState": "Backup", "neControllerSwVersion": "R1.0", "neCommState": "Failed", "neSwVersion": "R7.0", "id": "26", "key": "siva3/26", "neAdditionalInfo": null, "neControllerModel": "SNA" }], "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/networkElements
    returns Network Element list (list : /data/otn/networkElements)
    to retrieve Network Element List

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

    200success NetworkElementInventoryResponse
    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 :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/affectedConnections
    to get All Affected Connections details (listAffectedConnectionByFilters : /data/otn/connections/affectedConnections)

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---
    portId optional ---
    portLabel optional ---
    entity optional ---
    rate optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/affectedConnections

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [5] 0: { "className": "physicalLink" "id": "227" "key": "physicalLink/227" "guiLabel": "10.100.59.133:1-14-4--10.100.61.74:1-14-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:15:46Z" "orderId": "266" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.59.133:1-14-4--10.100.61.74:1-14-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV262" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-14-LINE" "z1NeName": "PSS32-100-61-74" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS32-100-61-74" "aNodeId": 26 "zNodeId": 28 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zPortLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "22" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/227" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zportLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 1: { "className": "physicalLink" "id": "229" "key": "physicalLink/229" "guiLabel": "10.100.59.133:1-17-4--10.100.59.134:1-17-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:15:59Z" "orderId": "268" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.59.133:1-17-4--10.100.59.134:1-17-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV264" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-17-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS-100-59.134" "aNodeId": 26 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "21" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/229" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 2: { "className": "physicalLink" "id": "231" "key": "physicalLink/231" "guiLabel": "10.100.61.74:1-17-4--10.100.59.134:1-14-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:16:12Z" "orderId": "270" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.61.74:1-17-4--10.100.59.134:1-14-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV266" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS32-100-61-74" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS32-100-61-74" "z1NodeName": "PSS-100-59.134" "aNodeId": 28 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "23" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/231" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 3: { "className": "physicalLink" "id": "216" "key": "physicalLink/216" "guiLabel": "NODE-A/SFD-1-4-9200/11DPM4M-1-7-L1/OS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:07:24Z" "orderId": "231" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "23/11DPM4M-1-7-L1/23/SFD-1-4-9200" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OS" "effectiveRate": "OS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "orderNumber": "DV228" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "NODE-A" "a1PortName": "SFD-1-4-9200" "z1NeName": "NODE-A" "z1PortName": "11DPM4M-1-7-L1" "a1NodeName": "NODE-A" "z1NodeName": "NODE-A" "aNodeId": 45 "zNodeId": 45 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE-A/SFD-1-4-9200" "zPortLabel": "NODE-A/11DPM4M-1-7-L1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/216" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE-A/SFD-1-4-9200" "zportLabel": "NODE-A/11DPM4M-1-7-L1" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 4: { "className": "physicalLink" "id": "5" "key": "physicalLink/5" "guiLabel": "NODE_1/112SCX10-2-5-L1/SFD-2-10-9210/OS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-03-31T08:56:31Z" "orderId": "5" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "1/112SCX10-2-5-L1/1/SFD-2-10-9210" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OS" "effectiveRate": "OS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "orderNumber": "DV5" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "112SCX10-2-5-L1" "z1NeName": "NODE_1" "z1PortName": "SFD-2-10-9210" "a1NodeName": "NODE_1" "z1NodeName": "NODE_1" "aNodeId": 3 "zNodeId": 3 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/112SCX10-2-5-L1" "zPortLabel": "NODE_1/SFD-2-10-9210" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/5" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/112SCX10-2-5-L1" "zportLabel": "NODE_1/SFD-2-10-9210" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • /data/otn/networkElement/

  • Operation

    get /data/otn/Connection/{id}
    to retrieve connection details for given connection ID (listConnectionById : /data/otn/Connection/{id})
    Note: id value is same as connid

    Query parameters

    Name

    IsRequired

    Description

    connid required ---
    orderNumber optional ---
    orderId optional ---
    nprId optional ---
    connName optional ---
    operation optional ---

    Return type
  • OtnTemplateInstance
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/Connection/457?connid=457

    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
    { "data": { "groups": [ { "groupname": "connectionParams", "paramList": [ { "name": "connectionname", "value": "10G_REG_20P_2 ODU2E#1", "type": "", "label": "" }, { "name": "connectionalias", "value": "10G_REG_20P_2 ODU2E#1", "type": "", "label": "" }, { "name": "customerName", "value": "None", "type": "", "label": "" }, { "name": "servicerate", "value": "ODU2E", "type": "", "label": "" }, { "name": "connectionid", "value": "457", "type": "", "label": "" }, { "name": "orderid", "value": "814", "type": "", "label": "" }, { "name": "ordernumber", "value": "A632", "type": "", "label": "" }, { "name": "connshape", "value": "8", "type": "", "label": "" }, { "name": "lopc", "value": "false", "type": "", "label": "" }, { "name": "protectiontype", "value": "9", "type": "", "label": "" }, { "name": "serviceratetype", "value": "Trail", "type": "", "label": "" }, { "name": "fromne1", "value": "KBHR9NODE1", "type": "", "label": "" }, { "name": "fromport1", "value": "ODU2E-3-2-2", "type": "", "label": "" }, { "name": "tone1", "value": "KBHR9NODE2", "type": "", "label": "" }, { "name": "toport1", "value": "ODU2E-3-2-2", "type": "", "label": "" }, { "name": "currentstate", "value": "9", "type": "", "label": "" }, { "name": "conncategory", "value": "ManagedPlane", "type": "", "label": "" }, { "name": "routing", "value": "4", "type": "", "label": "" }, { "name": "provisionwavekey", "value": "na", "type": "", "label": "" } ] }, { "groupname": "ASONParams", "paramList": [ { "name": "ASONRouted", "value": "false", "type": "", "label": "" } ] }, { "groupname": "assuranceParams", "paramList": [ { "name": "pm15min", "value": "false", "type": "", "label": "" }, { "name": "pmdata15", "value": "0", "type": "", "label": "" }, { "name": "direction15", "value": "0", "type": "", "label": "" }, { "name": "tpmonitor15", "value": "2", "type": "", "label": "" }, { "name": "reportinfo15", "value": "1", "type": "", "label": "" }, { "name": "pm24hr", "value": "true", "type": "", "label": "" }, { "name": "pmdata24", "value": "0", "type": "", "label": "" }, { "name": "direction24", "value": "0", "type": "", "label": "" }, { "name": "tpmonitor24", "value": "2", "type": "", "label": "" }, { "name": "reportinfo24", "value": "0", "type": "", "label": "" }, { "name": "alarmEnable", "value": "NOTSET", "type": "", "label": "" }, { "name": "alarmProfileName", "value": "", "type": "", "label": "" }, { "name": "autoInServiceTimer", "value": "", "type": "", "label": "" }, { "name": "autoInService", "value": "Disable", "type": "", "label": "" } ] }, { "groupname": "odukParams", "paramList": [ { "name": "odukAZSrcTrace", "value": "Use NE Value", "type": "", "label": "" }, { "name": "odukZASrcTrace", "value": "Use NE Value", "type": "", "label": "" }, { "name": "odukTraceMismatchDectMode", "value": "Use NE Value", "type": "", "label": "" }, { "name": "odukTraceMismatchAction", "value": "Use NE Value", "type": "", "label": "" }, { "name": "LOSPropagation", "value": "UseNEValue", "type": "", "label": "" }, { "name": "payloadType", "value": "Use NE Value", "type": "", "label": "" }, { "name": "PayloadTypeMismatchResponse", "value": "Use NE Value", "type": "", "label": "" } ] }, { "groupname": "protectionParams", "paramList": [ { "name": "clientprotectiontype", "value": "0", "type": "", "label": "" }, { "name": "clientholdofftime", "value": "0", "type": "", "label": "" }, { "name": "clientprotectedMethod", "value": "0", "type": "", "label": "" }, { "name": "clientprotectingMethod", "value": "0", "type": "", "label": "" }, { "name": "clientsignaldegrade", "value": "0", "type": "", "label": "" }, { "name": "clientrevertivemode", "value": "0", "type": "", "label": "" }, { "name": "nwkprotectiontype", "value": "0", "type": "", "label": "" }, { "name": "nwkholdofftime", "value": "0", "type": "", "label": "" }, { "name": "nwkprotectedMethod", "value": "0", "type": "", "label": "" }, { "name": "nwkprotectingMethod", "value": "0", "type": "", "label": "" }, { "name": "nwksignaldegrade", "value": "0", "type": "", "label": "" }, { "name": "nwkrevertivemode", "value": "0", "type": "", "label": "" } ] } ] }, "constraints": [ { "id": "24170000", "pk": "Link/Reuse/170000/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170000", "lccid": "170000", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 9, "dct": 0, "timeslot": "0.9", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "25170100", "pk": "Link/Reuse/170100/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170100", "lccid": "170100", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 10, "dct": 0, "timeslot": "0.10", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "26170200", "pk": "Link/Reuse/170200/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170200", "lccid": "170200", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 11, "dct": 0, "timeslot": "0.11", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "27170300", "pk": "Link/Reuse/170300/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170300", "lccid": "170300", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 12, "dct": 0, "timeslot": "0.12", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "28170400", "pk": "Link/Reuse/170400/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170400", "lccid": "170400", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 13, "dct": 0, "timeslot": "0.13", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "29170500", "pk": "Link/Reuse/170500/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170500", "lccid": "170500", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 14, "dct": 0, "timeslot": "0.14", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "30170600", "pk": "Link/Reuse/170600/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170600", "lccid": "170600", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 15, "dct": 0, "timeslot": "0.15", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" }, { "id": "31170700", "pk": "Link/Reuse/170700/KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "connid": "170700", "lccid": "170700", "name": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "type": "Link", "col4": "INCLUDE", "role": "Service", "aneid": 7, "aendName": "", "zneid": 14, "zendName": "", "lcnumber": 16, "dct": 0, "timeslot": "0.16", "servername": "KBHR9NODE1/ODU4-3-2-BP1 KBHR9NODE2/ODU4-3-2-BP1 236", "lcprotection": "PT_SILVER", "layerrate": "ODU0", "frequency": "", "routeid": null, "portname1": null, "portid1": null, "portname2": null, "portid2": null, "regenIndex": 0, "connectionAvailability": "", "objectType3R": false, "objectType": "Link" } ], "info": { "id": 457, "folderId": 814, "name": "", "folder": "", "owner": "", "lastmodified": "", "templateType": "Connection", "isPublished": false, "isPublishedL": "Yes" }, "txParamTableData": [ { "parameter": "PayloadTypeResp", "name": "PayloadTypeMismatchResponse", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Enable", "Disable" ], "maxlength": 0 }, "disabled": false }, { "parameter": "Payloadtype", "name": "payloadType", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": null, "disabled": false }, { "parameter": "SourceAZTTI", "name": "TrailTraceActualTx", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": { "options": null, "maxlength": 15 }, "disabled": false }, { "parameter": "SourceZATTI", "name": "TrailTraceExpectedRx", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": { "options": null, "maxlength": 15 }, "disabled": false }, { "parameter": "TTIMonitor", "name": "TrailTraceMonitor", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Source Enabled", "Disabled" ], "maxlength": 0 }, "disabled": false }, { "parameter": "TraceMismatchMonitor", "name": "TrailTraceEnablePoints", "value": "Enable End-points only", "currentValue": "Enable End-points only", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Enable End-points only", "Enable All", "Use NE Value" ], "maxlength": 0 }, "disabled": false }, { "parameter": "TTIMismatchConsequentAction", "name": "CAonTIM", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Enable", "Disable" ], "maxlength": 0 }, "disabled": false }, { "parameter": "BurstIntervalSDDetection", "name": "brstintvl", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "maxlength": 0 }, "disabled": false }, { "parameter": "BurstThresholdSDDetection", "name": "brstthr", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": null, "disabled": false } ], "discrepancies": [ { "parameter": "PayloadTypeResp", "name": "PayloadTypeMismatchResponse", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Enable", "Disable" ], "maxlength": 0 }, "disabled": false }, { "parameter": "Payloadtype", "name": "payloadType", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": null, "disabled": false }, { "parameter": "SourceAZTTI", "name": "TrailTraceActualTx", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": { "options": null, "maxlength": 15 }, "disabled": false }, { "parameter": "SourceZATTI", "name": "TrailTraceExpectedRx", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": { "options": null, "maxlength": 15 }, "disabled": false }, { "parameter": "TTIMonitor", "name": "TrailTraceMonitor", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Source Enabled", "Disabled" ], "maxlength": 0 }, "disabled": false }, { "parameter": "TraceMismatchMonitor", "name": "TrailTraceEnablePoints", "value": "Enable End-points only", "currentValue": "Enable End-points only", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Enable End-points only", "Enable All", "Use NE Value" ], "maxlength": 0 }, "disabled": false }, { "parameter": "TTIMismatchConsequentAction", "name": "CAonTIM", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "Enable", "Disable" ], "maxlength": 0 }, "disabled": false }, { "parameter": "BurstIntervalSDDetection", "name": "brstintvl", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "Enumeration", "editorArgs": { "options": [ "Use NE Value", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "maxlength": 0 }, "disabled": false }, { "parameter": "BurstThresholdSDDetection", "name": "brstthr", "value": "Use NE Value", "currentValue": "Use NE Value", "discA": "", "discZ": "", "type": "String", "editorArgs": null, "disabled": false } ], "modifyParamGroup": [ ] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    get /data/otn/nes/{nprNeId}/crossConnects
    to get all cross connects for specified nprNeId (listCrossConnectionsFromNe : /data/otn/nes/{nprNeId}/crossConnects)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNeId required nprNodeId can be retrieved from the REST call '/data/npr/{table}' (table=nes) as 'id' ---

    Return type
  • XCInventoryResponse
  • Responses

    Response Messages

    Schema

    200success XCInventoryResponse
    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 :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/nodes/{nprNodeId}/crossConnects
    to get all cross connects for specified nprNodeId (listCrossConnectionsFromNode : /data/otn/nodes/{nprNodeId}/crossConnects)
    Only cross connections with sncState of active shall be returned.
    Cross connections with sncState of local shall not be returned

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNodeId required nprNodeId can be retrieved from the REST call '/data/npr/{table}' (table=nodes) as 'id' ---
    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    portLabel optional ---

    Return type
  • XCInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/nodes/432/crossConnects

    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
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, items: [{ className: "crossConnect", id: "1360", key: "crossConnect/1360", guiLabel: "Site11-1/11QPA4-1-7-L2 Site3-1/11QPA4-4-6-L2 OTU2", sncId: "1360", orderId: "NA", nodeName: "SITE11-1", neName: "SITE11-1", a1PortName: "SFD-1-4-OMD-9200", z1PortName: "SFD-1-4-9200", a2PortName: "", z2PortName: "", xcState: "SncState_Active", xcRate: "OCH", xcShape: "CS_SIMPLE_BI", eventDateTime: "2016-01-18T07:32:19Z", fixedXC: "WdmInclude", connectionName: "", connectionAlias: "", connectionId: "0", sigType: "NA", timeslots: "NA", waveKeyConfig: "NA", azwaveKey1: "NA", azwaveKey2: "NA", zawaveKey1: "NA", zawaveKey2: "NA", azwaveKeyingPreference: "NA", zawaveKeyingPreference: "NA", switchMode: "NA", revertiveMode: "NA", waitToRestoreTime: "NA", azCIR: "NA", zaCIR: "NA", azEIR: "NA", zaEIR: "NA", azCBS: "NA", azEBS: "NA", zaCBS: "NA", zaEBS: "NA", committedBurstSize: "NA", committedInfoRate: "NA", excessBurstSize: "NA", excessInfoRate: "NA", azcommittedInfoRate: "NA", zacommittedInfoRate: "NA", azexcessInfoRate: "NA", zaexcessInfoRate: "NA", azcommittedBurstSize: "NA", azexcessBurstSize: "NA", zacommittedBurstSize: "NA", zaexcessBurstSize: "NA" }, { className: "crossConnect", id: "1361", key: "crossConnect/1361", guiLabel: "Site11-1/11QPA4-1-7-L1 SITE5-1/11QPA4-4-7-L2 OTU2", sncId: "1361", orderId: "NA", nodeName: "SITE11-1", neName: "SITE11-1", a1PortName: "SFD-1-5-OMD-9200", z1PortName: "SFD-1-5-9200", a2PortName: "", z2PortName: "", xcState: "SncState_Active", xcRate: "OCH", xcShape: "CS_SIMPLE_BI", eventDateTime: "2016-01-18T07:32:19Z", fixedXC: "WdmInclude", connectionName: "", connectionAlias: "", connectionId: "0", sigType: "NA", timeslots: "NA", waveKeyConfig: "NA", azwaveKey1: "NA", azwaveKey2: "NA", zawaveKey1: "NA", zawaveKey2: "NA", azwaveKeyingPreference: "NA", zawaveKeyingPreference: "NA", switchMode: "NA", revertiveMode: "NA", waitToRestoreTime: "NA", azCIR: "NA", zaCIR: "NA", azEIR: "NA", zaEIR: "NA", azCBS: "NA", azEBS: "NA", zaCBS: "NA", zaEBS: "NA", committedBurstSize: "NA", committedInfoRate: "NA", excessBurstSize: "NA", excessInfoRate: "NA", azcommittedInfoRate: "NA", zacommittedInfoRate: "NA", azexcessInfoRate: "NA", zaexcessInfoRate: "NA", azcommittedBurstSize: "NA", azexcessBurstSize: "NA", zacommittedBurstSize: "NA", zaexcessBurstSize: "NA" }], successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/{id}/endPoints/physicalPorts
    to get All End Points Details (listEndPointsDetailsById : /data/otn/connections/{id}/endPoints/physicalPorts)
    listEndPointsDetailsById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/physicalConns/{nprId}/endPoints/physicalPorts
    to get All End Points Details for Physical Connections (listEndPointsDetailsByNprId : /data/otn/physicalConns/{nprId}/endPoints/physicalPorts)
    listEndPointsDetailsByNprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId can be retrieved from the REST call '/data/npr/physicalConns' as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/nodes/{nodeId}/frequency
    to get frequency details for given Id/NodeId (listFrequency : /data/otn/connections/{id}/nodes/{nodeId}/frequency)
    returns frequency details for given Id/NodeId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from 'id' field of '/data/otn/connections' REST call ---
    nodeId required 1. Search for 'id' that is retrieved from previous step and then note down the value of 'a1NodeName' of same 'id' (rest call = /data/otn/connections). 2. By using rest call '/data/otn/networkElement/ search for guilabel with value which we got in step#1 (a1NodeName) and then get the 'nodeId' as Id. ---

    Return type
  • HashMap
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections/296/nodes/34/frequency

    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
    {"112SCX10-7-2-L1":"9200","SFD-7-8-9200":"9200"}

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • /data/otn/networkElement/

  • Operation

    get /data/otn/physicalConns/wavelengthUsage/networkWide
    Returns wavelenth usage for given OTNIds (listLCWavelengthUsageforPhysicalConnection : /data/otn/physicalConns/wavelengthUsage/networkWide)
    to get list of ots wavelength Usage for given OtnIds ;

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Responses

    Response Messages

    Schema

    200OK ---
    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/csv

    External Docs
    See Also :

    Operation

    get /data/otn/physicalConns/{connIds}/wavelengthUsage
    Returns wavelenth usage for given OTNIds (listLCWavelengthUsageforPhysicalConnection : /data/otn/physicalConns/{connIds}/wavelengthUsage)
    to get list of ots wavelength Usage for given OtnIds ;

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connIds required connIds ---

    Responses

    Response Messages

    Schema

    200OK ---
    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/csv

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{connId}/linkConnection
    Returns list of LinkConnections for the given connection Id (listLinkConnectionsFromConnection : /data/otn/connections/{connId}/linkConnection)
    to get list of LinkConnections for the given connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Query parameters

    Name

    IsRequired

    Description

    lcId optional ---
    lcRate optional ---
    containerRate optional ---
    encodingMode optional ---
    frequency optional ---
    spectrumWidth optional ---
    serviceRateFilter optional ---
    trailName optional ---
    rcLink optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connections/438/linkConnections

    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
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ a1NeName: "NODE001", timeslotklm: "0", lccid2: "0", lccid1: "4792000", a1NodeName: "NODE001", unitNum: "1", serverName: "", className: "RC_LinkConnection", availability: "2", serverId: "2888", frequency: "NA", z1NeId: "116", usedConnectionName: "NODE001/ALPHG-17-9-LINE NODE002/ALPHG-17-13-LINE OMS", dct1: "0", a1PortName: "ALPHG-17-9-LINE", linkConnectioName: "47920-", dct2: "0", z1NeName: "NODE002", layerRate: "40", z1PortName: "ALPHG-17-13-LINE", id: "47920", state: "LCS_IN_EFFECT", usedMask: "0", key: "RC_LinkConnection/47920", a1NeId: "112", sequenceNumber: "1", guiLabel: "", usedConnectionId: "2889", protectionType: "Unprotected", z1NodeName: "NODE002", channelGroup: "0", availStr: "Used-In-IE-IMP", myMask: "1", effectiveRate: "OMS", clientRate: "none" }], data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/loopbackConnection
    Returns list of loopback associated with all connections (listLoopback : /data/otn/connection/loopbackConnection)
    to get List of loopback associated with all connections

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/loopbackConnection

    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
    { "reqCompletionStatus": ? 0, "requestId": ? 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": ? 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [ { "nodeName": "PHN-1", "neId": "58", "tpId": "420439", "guiLabel": "73-INFRA OTU4#1", "connectionAlias": "73-INFRA OTU4#1", "className": "loopbackConnection", "connectionRate": "OTU4", "portAddress": "130SCA1-12-15-L1", "loopBackType": "Facility", "portId": "420439", "connectionId": "1952", "id": "1", "connectionName": "73-INFRA OTU4#1", "key": "1/loopbackConnection", "tpRate": "20" }, { "nodeName": "PHN-1", "neId": "58", "tpId": "420439", "guiLabel": "PHN-1/130SCA1-12-15-L1/SFD-12-14-9200", "connectionAlias": "PHN-1/130SCA1-12-15-L1/SFD-12-14-9200", "className": "loopbackConnection", "connectionRate": "OS", "portAddress": "130SCA1-12-15-L1", "loopBackType": "Facility", "portId": "420439", "connectionId": "1689", "id": "2", "connectionName": "PHN-1/130SCA1-12-15-L1/SFD-12-14-9200", "key": "2/loopbackConnection", "tpRate": "20" }, { "nodeName": "PHN-1", "neId": "58", "tpId": "420439", "guiLabel": "73-INFRA", "connectionAlias": "73-INFRA", "className": "loopbackConnection", "connectionRate": "ODU4", "portAddress": "130SCA1-12-15-L1", "loopBackType": "Facility", "portId": "420439", "connectionId": "1951", "id": "3", "connectionName": "73-INFRA", "key": "3/loopbackConnection", "tpRate": "20" } ], "data": null, "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • /data/otn/networkElement/
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/loopbackConnections
    Returns list of loopback associated with all connections (listLoopback : /data/otn/connections/loopbackConnections)
    to get List of loopback associated with all connections

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • /data/otn/networkElement/
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connection/loopbackConnection/{id}
    Returns list of loopback associated with all connections (listLoopbackConnsById : /data/otn/connection/loopbackConnection/{id})
    to get List of loopback associated with all connections

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • /data/otn/networkElement/
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections/loopbackConnections/{id}
    Returns list of loopback associated with all connections (listLoopbackConnsById : /data/otn/connections/loopbackConnections/{id})
    to get List of loopback associated with all connections

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • /data/otn/networkElement/
  • get : /data/npr/{table}

  • Operation

    get /data/otn/loopbackConnections/{id}
    Returns list of loopback associated with all connections (listLoopbackConnsById : /data/otn/loopbackConnections/{id})
    to get List of loopback associated with all connections

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • /data/otn/networkElement/
  • get : /data/npr/{table}

  • Operation

    get /data/otn/connections
    to get All Network connection details (listNetworkConnectionsByFilters : /data/otn/connections)
    returns All Network Connection information

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---
    toNprNodeId optional ---
    rate optional ---
    probableCauseId optional ---
    probableCauseLabel optional ---
    pendingConnState optional ---
    groupId optional ---
    linkBundleId optional ---
    linkBundleFilter optional ---
    lcRates optional ---
    wavekeyPair optional ---
    sdhConnectionId optional ---
    asapId optional ---
    connectionIdList optional ---
    isLBand optional ---
    linkUtilProfileName optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connections

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [3] 0: { "className": "physicalLink" "id": "227" "key": "physicalLink/227" "guiLabel": "10.100.59.133:1-14-4--10.100.61.74:1-14-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:15:46Z" "orderId": "266" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.59.133:1-14-4--10.100.61.74:1-14-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV262" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-14-LINE" "z1NeName": "PSS32-100-61-74" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS32-100-61-74" "aNodeId": 26 "zNodeId": 28 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zPortLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "22" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/227" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zportLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 1: { "className": "physicalLink" "id": "229" "key": "physicalLink/229" "guiLabel": "10.100.59.133:1-17-4--10.100.59.134:1-17-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:15:59Z" "orderId": "268" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.59.133:1-17-4--10.100.59.134:1-17-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV264" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-17-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS-100-59.134" "aNodeId": 26 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "21" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/229" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 2: { "className": "physicalLink" "id": "231" "key": "physicalLink/231" "guiLabel": "10.100.61.74:1-17-4--10.100.59.134:1-14-4" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "physicalLink" "receivedDate": "2016-04-11T11:16:12Z" "orderId": "270" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "10.100.61.74:1-17-4--10.100.59.134:1-14-4" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OTS" "effectiveRate": "OTS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "" "orderNumber": "DV266" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "PSS32-100-61-74" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS32-100-61-74" "z1NodeName": "PSS-100-59.134" "aNodeId": 28 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "23" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/231" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_NPR" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • retrieveWavekey : /data/otn/wavekeyPairs
  • /data/otn/networkElement/
  • get : /data/npr/aSAProfiles
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/path
    to get all service connection details (listPathsByFilters : /data/otn/connection/path)
    Please Note: Optional Query Parameters can be used for filtering

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---
    rate optional ---
    guiLabel optional ---
    connectionAlias optional ---
    a1NodeName optional ---
    z1NodeName optional ---
    effectiveRate optional ---
    operationalState optional ---
    olcState optional ---
    state optional ---
    stepState optional ---
    displayProtectionType optional ---
    npaUserLabel optional ---
    xXXX optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/path

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [2] 0: { "className": "path" "id": "249" "key": "path/249" "guiLabel": "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "path" "receivedDate": "2016-04-13T05:24:12Z" "orderId": "301" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "NODE_2/4DPA4-21-15-C3 NODE_1/4DPA4-21-15-C1 DSR" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "DSR" "effectiveRate": "FC400" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "orderNumber": "A284" "customerName": "None" "serviceState": "ServiceState_OFF" "provisionableWavekey": "N/A" "a1NeName": "NODE_2" "a1PortName": "4DPA4-21-15-C3" "z1NeName": "NODE_1" "z1PortName": "4DPA4-21-15-C1" "a1NodeName": "NODE_2" "z1NodeName": "NODE_1" "aNodeId": 5 "zNodeId": 3 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_2/4DPA4-21-15-C3" "zPortLabel": "NODE_1/4DPA4-21-15-C1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/249" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_2/4DPA4-21-15-C3" "zportLabel": "NODE_1/4DPA4-21-15-C1" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 1: { "className": "path" "id": "266" "key": "path/266" "guiLabel": "OpsbOdukSvc" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": 0 "connectionType": "path" "receivedDate": "2016-04-15T06:10:57Z" "orderId": "376" "groupOrderId": "265" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-OpsbOdukSvc" "connectionAlias": "OpsbOdukSvc" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "ODU4" "effectiveRate": "ODU4" "displayProtectionType": "DPT_OPSB" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "orderNumber": "A320" "customerName": "None" "serviceState": "ServiceState_OFF" "provisionableWavekey": "keyed" "a1NeName": "PSS-32-59.133" "a1PortName": "OPS-1-6-SIG" "z1NeName": "PSS-100-59.134" "z1PortName": "OPS-1-6-SIG" "a2NeName": "PSS-100-59.134" "a2PortName": "OPS-1-6-SIG" "z2NeName": "PSS-32-59.133" "z2PortName": "OPS-1-6-SIG" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS-100-59.134" "a2NodeName": "PSS-100-59.134" "z2NodeName": "PSS-32-59.133" "aNodeId": 26 "zNodeId": 27 "a2NodeId": 27 "z2NodeId": 26 "aPortLabel": "PSS-32-59.133/OPS-1-6-SIG" "zPortLabel": "PSS-100-59.134/OPS-1-6-SIG" "pm24hour": "Started" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/266" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_USER" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/OPS-1-6-SIG" "zportLabel": "PSS-100-59.134/OPS-1-6-SIG" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - - "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • /data/otn/networkElement/

  • Operation

    get /data/otn/connection/path/{id}
    to get service connection details specified by connection id (listPathsById : /data/otn/connection/path/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connection' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/path/429

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [1] 0: { "className": "physicalLink" "id": "1" "key": "physicalLink/1" "guiLabel": "NODE_1/SFD-1-2-9200/11DPM12-1-4-L1/OS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "physicalLink" "receivedDate": "2016-03-31T08:56:25Z" "orderId": "1" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "1/11DPM12-1-4-L1/1/SFD-1-2-9200" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OS" "effectiveRate": "OS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "DV1" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "SFD-1-2-9200" "z1NeName": "NODE_1" "z1PortName": "11DPM12-1-4-L1" "a1NodeName": "NODE_1" "z1NodeName": "NODE_1" "aNodeId": 3 "zNodeId": 3 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/SFD-1-2-9200" "zPortLabel": "NODE_1/11DPM12-1-4-L1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/1" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/SFD-1-2-9200" "zportLabel": "NODE_1/11DPM12-1-4-L1" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - - "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/protected
    to get all protected connection (infrastructure & service) details (listProtectedConnectionByFilters : /data/otn/connections/protected)
    Please Note: Optional Query Parameters can be used for filtering

    Query parameters

    Name

    IsRequired

    Description

    guiLabel optional ---
    connectionAlias optional ---
    a1NodeName optional ---
    z1NodeName optional ---
    effectiveRate optional ---
    olcState optional ---
    state optional ---
    stepState optional ---
    displayProtectionType optional ---
    npaUserLabel optional ---
    revertiveMode optional ---
    xXXX optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/protectedConnections
    to get all protected connection (infrastructure & service) details (listProtectedConnectionByFilters : /data/otn/protectedConnections)
    Please Note: Optional Query Parameters can be used for filtering

    Query parameters

    Name

    IsRequired

    Description

    guiLabel optional ---
    connectionAlias optional ---
    a1NodeName optional ---
    z1NodeName optional ---
    effectiveRate optional ---
    olcState optional ---
    state optional ---
    stepState optional ---
    displayProtectionType optional ---
    npaUserLabel optional ---
    revertiveMode optional ---
    xXXX optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/protected/{id}
    to get protected connection details specified by Id (listProtectedConnectionsById : /data/otn/connections/protected/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/protectedConnections/{id}
    to get protected connection details specified by Id (listProtectedConnectionsById : /data/otn/protectedConnections/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/protectionGroups
    to get a list of protection groups used in a connection. Specified by connection Id (listProtectionGroupsByConnId : /data/otn/connections/{id}/protectionGroups)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ProtectionGroupInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ProtectionGroupInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/protectedConnections/{id}/protectionGroups
    to get a list of protection groups used in a connection. Specified by connection Id (listProtectionGroupsByConnId : /data/otn/protectedConnections/{id}/protectionGroups)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections/protected' REST call with attribute name as 'id' ---

    Return type
  • ProtectionGroupInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ProtectionGroupInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/switchedConnections
    to get a list of switched connections used in a connection. Specified by scId (listSwitchedConnectionsByConnId : /data/otn/connections/switchedConnections)

    Query parameters

    Name

    IsRequired

    Description

    scId required ---
    connType required ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/trail
    to get all infrastructure connection details (listTrailsByFilters : /data/otn/connection/trail)
    Please Note: Optional Query Parameters can be used for filtering

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---
    rate optional ---
    guiLabel optional ---
    connectionAlias optional ---
    a1NodeName optional ---
    z1NodeName optional ---
    effectiveRate optional ---
    operationalState optional ---
    olcState optional ---
    state optional ---
    stepState optional ---
    displayProtectionType optional ---
    npaUserLabel optional ---
    xXXX optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/trail

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [9] 0: { "className": "trail" "id": "246" "key": "trail/246" "guiLabel": "NODE_1/4DPA4-21-15-L1 NODE_2/4DPA4-21-15-L2 OTU1" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-13T05:24:01Z" "orderId": "298" "groupOrderId": "248" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "connectionAlias": "NODE_1/4DPA4-21-15-L1 NODE_2/4DPA4-21-15-L2 OTU1" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OTU1" "effectiveRate": "OTU1" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A281" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "4DPA4-21-15-L1" "z1NeName": "NODE_2" "z1PortName": "4DPA4-21-15-L2" "a1NodeName": "NODE_1" "z1NodeName": "NODE_2" "aNodeId": 3 "zNodeId": 5 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/4DPA4-21-15-L1" "zPortLabel": "NODE_2/4DPA4-21-15-L2" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/246" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/4DPA4-21-15-L1" "zportLabel": "NODE_2/4DPA4-21-15-L2" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - 1: { "className": "trail" "id": "247" "key": "trail/247" "guiLabel": "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-13T05:24:06Z" "orderId": "299" "groupOrderId": "248" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "connectionAlias": "NODE_1/4DPA4-21-15-L1-1 NODE_2/4DPA4-21-15-L2-1 ODU1" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "ODU1" "effectiveRate": "ODU1" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A282" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "4DPA4-21-15-L1-1" "z1NeName": "NODE_2" "z1PortName": "4DPA4-21-15-L2-1" "a1NodeName": "NODE_1" "z1NodeName": "NODE_2" "aNodeId": 3 "zNodeId": 5 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/4DPA4-21-15-L1-1" "zPortLabel": "NODE_2/4DPA4-21-15-L2-1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/247" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/4DPA4-21-15-L1-1" "zportLabel": "NODE_2/4DPA4-21-15-L2-1" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - 2: { "className": "trail" "id": "147" "key": "trail/147" "guiLabel": "NODE_1/ALPHG-12-15-LINE NODE_2/ALPHG-12-15-LINE OMS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-01T06:50:48Z" "orderId": "141" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "NODE_1/ALPHG-12-15-LINE NODE_2/ALPHG-12-15-LINE OMS" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OMS" "effectiveRate": "OMS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A141" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "ALPHG-12-15-LINE" "z1NeName": "NODE_2" "z1PortName": "ALPHG-12-15-LINE" "a1NodeName": "NODE_1" "z1NodeName": "NODE_2" "aNodeId": 3 "zNodeId": 5 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/ALPHG-12-15-LINE" "zPortLabel": "NODE_2/ALPHG-12-15-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/147" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/ALPHG-12-15-LINE" "zportLabel": "NODE_2/ALPHG-12-15-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 3: { "className": "trail" "id": "267" "key": "trail/267" "guiLabel": "OpsbOdukSvc OTU4#1" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-15T06:10:57Z" "orderId": "377" "groupOrderId": "265" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-OpsbOdukSvc" "connectionAlias": "OpsbOdukSvc OTU4#1" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OTU4" "effectiveRate": "OTU4" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_SERVICE" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "9200.000" "orderNumber": "A322" "customerName": "None" "serviceState": "ServiceState_OFF" "provisionableWavekey": "keyed" "a1NeName": "PSS-32-59.133" "a1PortName": "130SCA1-1-2-L1" "z1NeName": "PSS32-100-61-74" "z1PortName": "130SNX10-1-2-L1" "a2NeName": "PSS32-100-61-74" "a2PortName": "130SNX10-1-4-L1" "z2NeName": "PSS-32-59.133" "z2PortName": "130SCA1-1-2-L1" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS32-100-61-74" "a2NodeName": "PSS32-100-61-74" "z2NodeName": "PSS-32-59.133" "aNodeId": 26 "zNodeId": 28 "a2NodeId": 28 "z2NodeId": 26 "aPortLabel": "PSS-32-59.133/130SCA1-1-2-L1" "zPortLabel": "PSS32-100-61-74/130SNX10-1-2-L1" "pm24hour": "Started" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/267" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/130SCA1-1-2-L1" "zportLabel": "PSS32-100-61-74/130SNX10-1-2-L1" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - 4: { "className": "trail" "id": "269" "key": "trail/269" "guiLabel": "OpsbOdukSvc OTU4#10" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-15T06:10:57Z" "orderId": "379" "groupOrderId": "265" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-OpsbOdukSvc" "connectionAlias": "OpsbOdukSvc OTU4#10" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OTU4" "effectiveRate": "OTU4" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_PROTECTION" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "9200.000" "orderNumber": "A324" "customerName": "None" "serviceState": "ServiceState_OFF" "provisionableWavekey": "keyed" "a1NeName": "PSS-32-59.133" "a1PortName": "130SCA1-1-4-L1" "z1NeName": "PSS-100-59.134" "z1PortName": "130SCA1-1-4-L1" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS-100-59.134" "aNodeId": 26 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/130SCA1-1-4-L1" "zPortLabel": "PSS-100-59.134/130SCA1-1-4-L1" "pm24hour": "Started" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/269" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/130SCA1-1-4-L1" "zportLabel": "PSS-100-59.134/130SCA1-1-4-L1" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - 5: { "className": "trail" "id": "268" "key": "trail/268" "guiLabel": "OpsbOdukSvc OTU4#2" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-15T06:10:57Z" "orderId": "378" "groupOrderId": "265" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "groupOrderName": "g-OpsbOdukSvc" "connectionAlias": "OpsbOdukSvc OTU4#2" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OTU4" "effectiveRate": "OTU4" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_SERVICE" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NONE" "TCMASAPEnabled": "TCM_STATUS_NONE" "nmlASAPName": "default ASAP" "frequency": "9200.000" "orderNumber": "A323" "customerName": "None" "serviceState": "ServiceState_OFF" "provisionableWavekey": "keyed" "a1NeName": "PSS32-100-61-74" "a1PortName": "130SNX10-1-2-L1" "z1NeName": "PSS-100-59.134" "z1PortName": "130SCA1-1-2-L1" "a2NeName": "PSS-100-59.134" "a2PortName": "130SCA1-1-2-L1" "z2NeName": "PSS32-100-61-74" "z2PortName": "130SNX10-1-4-L1" "a1NodeName": "PSS32-100-61-74" "z1NodeName": "PSS-100-59.134" "a2NodeName": "PSS-100-59.134" "z2NodeName": "PSS32-100-61-74" "aNodeId": 28 "zNodeId": 27 "a2NodeId": 27 "z2NodeId": 28 "aPortLabel": "PSS32-100-61-74/130SNX10-1-2-L1" "zPortLabel": "PSS-100-59.134/130SCA1-1-2-L1" "pm24hour": "Started" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/268" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS32-100-61-74/130SNX10-1-2-L1" "zportLabel": "PSS-100-59.134/130SCA1-1-2-L1" "tcmenabled": "TCM_STATUS_NONE" "tcmasapenabled": "TCM_STATUS_NONE" } - 6: { "className": "trail" "id": "228" "key": "trail/228" "guiLabel": "PSS-32-59.133/AHPHG-1-14-LINE PSS32-100-61-74/AHPHG-1-14-LINE OMS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-11T11:15:48Z" "orderId": "267" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "PSS-32-59.133/AHPHG-1-14-LINE PSS32-100-61-74/AHPHG-1-14-LINE OMS" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OMS" "effectiveRate": "OMS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A263" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-14-LINE" "z1NeName": "PSS32-100-61-74" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS32-100-61-74" "aNodeId": 26 "zNodeId": 28 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zPortLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/228" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-14-LINE" "zportLabel": "PSS32-100-61-74/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 7: { "className": "trail" "id": "230" "key": "trail/230" "guiLabel": "PSS-32-59.133/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-17-LINE OMS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-11T11:16:01Z" "orderId": "269" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "PSS-32-59.133/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-17-LINE OMS" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OMS" "effectiveRate": "OMS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A265" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "PSS-32-59.133" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-17-LINE" "a1NodeName": "PSS-32-59.133" "z1NodeName": "PSS-100-59.134" "aNodeId": 26 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/230" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS-32-59.133/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-17-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 8: { "className": "trail" "id": "232" "key": "trail/232" "guiLabel": "PSS32-100-61-74/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-14-LINE OMS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "trail" "receivedDate": "2016-04-11T11:16:14Z" "orderId": "271" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "PSS32-100-61-74/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-14-LINE OMS" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_ADD" "layerRate": "OMS" "effectiveRate": "OMS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_MANAGED_PLANE" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "A267" "customerName": "None" "serviceState": "ServiceState_ON" "provisionableWavekey": "N/A" "a1NeName": "PSS32-100-61-74" "a1PortName": "AHPHG-1-17-LINE" "z1NeName": "PSS-100-59.134" "z1PortName": "AHPHG-1-14-LINE" "a1NodeName": "PSS32-100-61-74" "z1NodeName": "PSS-100-59.134" "aNodeId": 28 "zNodeId": 27 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zPortLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/232" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM_NOTIF" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "PSS32-100-61-74/AHPHG-1-17-LINE" "zportLabel": "PSS-100-59.134/AHPHG-1-14-LINE" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - 9: { "TCMASAPEnabled": "TCM_STATUS_NA" "TCMEnabled": "TCM_STATUS_NA" "a1NeName": "PSS-10.41.55.158" "a1NodeAndPort": "PSS-10.41.55.158/11DPM12-1-10-L2-1" "a1NodeName": "PSS-10.41.55.158" "a1PortName": "11DPM12-1-10-L2-1" "a2NeName": "" "a2NodeId": 0 "a2PortId": 0 "aNodeId": 44 "aPortId": 254125 "aPortLabel": "PSS-10.41.55.158/11DPM12-1-10-L2-1" "alarmEnabling": "Not Set" "alarmSeverity": "Cleared" "alarmState": "Cleared" "allowAsonResources": "No" "aportLabel": "PSS-10.41.55.158/11DPM12-1-10-L2-1" "associatednprtlid": 0 "autoInService": "N/A" "autoInServiceTimer": "N/A" "category": "CC_MANAGED_PLANE" "className": "trail" "clientRouteState": "NA" "connectionAlias": "11DPM-Infra" "connectionDirection": "CD_BID" "connectionType": "trail" "containerType": "odu2" "createdBy": "CB_USER" "customerName": "" "displayProtectionType": "DPT_UN_PROTECTED" "effectiveRate": "ODU2" "encoding": "N/A" "endpoints": 2 "fdn": "1/1113" "frequency": "N/A" "groupOrderId": "1112" "groupOrderName": "g-11DPM-Infra" "groupOrderType": "GOT_CLNT_AND_SERVERS_PROV" "guiLabel": "11DPM-Infra" "id": "1113" "inconsistentAckDate": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentMismatchType": "" "is3rdPartyLink": "false" "isCurrentRouteRD": "false" "isEline": "No" "isL0CRRD": "false" "isOtdrSupported": "false" "isPMSupported": "Required" "isSlteSupported": "false" "isUsedInSdh": "false" "key": "trail/1113" "layerRate": "ODU2" "lineGranularity": 0 "linkUtilRatio": 0 "linkUtilThreshold": "30" "mismatchType": "NA" "nimEnabled": "N/A" "nmlASAPName": "default ASAP" "npaUserLabel": "" "npauserLabel": "" "nprTlId": "0" "olcState": "OlcState_InService" "operationalState": "Up" "orderId": "2819" "orderNumber": "A1555" "orderStep": "CST_IN_EFFECT" "orderType": "OT_ADD" "pm15min": "NotEnabled" "pm24hour": "Started" "protectionRole": "PR_NA" "provisionableWavekey": "unkeyManual" "receivedDate": "2019-08-20T13:39:46Z" "revertiveMode": "RevertiveMode_NA" "scId": "N/A" "sdhClientId": "-1" "sdhConnectionId": "-1" "serverAlmState": "Cleared" "serverConnId": 0 "serverConnectionCategory": "CC_NA" "serviceState": "ServiceState_ON" "singleFiberChannelPlan": "N/A" "spectrumWidth": "" "state": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "switchCapability": "0" "tcmasapenabled": "TCM_STATUS_NA" "tcmenabled": "TCM_STATUS_NA" "thirdPartyDesc": "" "thirdPartyName": "" "vsClientId": -1 "vsClientState": "VSCS_NOT_APPLICABLE" "z1NeName": "PSS-10.41.55.159" "z1NodeAndPort": "PSS-10.41.55.159/11DPM12-1-10-L2-1" "z1NodeName": "PSS-10.41.55.159" "z1PortName": "11DPM12-1-10-L2-1" "z2NeName": "" "z2NodeId": 0 "z2PortId": 0 "zNodeId": 43 "zPortId": 254526 "zPortLabel": "PSS-10.41.55.159/11DPM12-1-10-L2-1" "zportLabel": "PSS-10.41.55.159/11DPM12-1-10-L2-1" }- - "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • /data/otn/networkElement/

  • Operation

    get /data/otn/connection/trail/{id}
    to get infrastructure connection details specified by Id (listTrailsById : /data/otn/connection/trail/{id})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/trail/265

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "className": "physicalLink", "id": "265", "key": "physicalLink/265", "guiLabel": "siva3/SFD-1-2-9200/11QPE24-1-10-X1/OS", "vsClientState": "VSCS_NOT_APPLICABLE", "vsClientId": -1, "connectionType": "physicalLink", "receivedDate": "2015-09-07T05:50:02Z", "orderId": "420", "groupOrderId": "0", "groupOrderType": "GOT_NA", "connectionAlias": "10/11QPE24-1-10-X1/10/SFD-1-2-9200", "orderStep": "CST_IN_EFFECT", "stepState": "SSTATE_COMPLETED", "orderType": "OT_DISCOVERED", "layerRate": "OS", "effectiveRate": "OS", "displayProtectionType": "DPT_UN_PROTECTED", "protectionRole": "PR_NA", "state": "CST_IN_EFFECT", "operationalState": "Enabled", "category": "CC_NA", "alarmEnabling": "Not Set", "alarmState": "Cleared", "alarmSeverity": "Cleared", "TCMEnabled": "TCM_STATUS_NA", "TCMASAPEnabled": "TCM_STATUS_NA", "nmlASAPName": "default ASAP", "frequency": "N/A", "orderNumber": "DV356", "customerName": "None", "serviceState": "ServiceState_NA", "provisionableWavekey": "N/A", "a1NeName": "siva3", "a1PortName": "SFD-1-2-9200", "z1NeName": "siva3", "z1PortName": "11QPE24-1-10-X1", "a1NodeName": "siva3", "z1NodeName": "siva3", "aNodeId": 12, "zNodeId": 12, "a2NodeId": 0, "z2NodeId": 0, "aPortLabel": "siva3/SFD-1-2-9200", "zPortLabel": "siva3/11QPE24-1-10-X1", "pm24hour": "NotEnabled", "pm15min": "NotEnabled", "nprTlId": "-1", "sdhConnectionId": "-1", "sdhClientId": "-1", "isUsedInSdh": "false", "fdn": "11/265", "mismatchType": "NA", "clientRouteState": "NA", "createdBy": "CB_SYSTEM", "inconsistentMismatchType": "", "inconsistentAcknowledgedBy": "", "inconsistentEventDate": "", "inconsistentAckDate": "", "isL0CRRD": "false", "isCurrentRouteRD": "false", "tcmenabled": "TCM_STATUS_NA", "tcmasapenabled": "TCM_STATUS_NA", "aportLabel": "siva3/SFD-1-2-9200", "zportLabel": "siva3/11QPE24-1-10-X1" }], "data": null, "successfulCompletion": false, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/crossConnects/uncorrelated
    to get uncorrelated cross connections (listUncorrelatedCrossConnections : /data/otn/crossConnects/uncorrelated)
    returns uncorrelated cross connections

    Query parameters

    Name

    IsRequired

    Description

    wavekeyPair optional ---

    Return type
  • XCInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/crossConnects/uncorrelated

    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
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, items: [{ className: "crossConnect", id: "1", key: "crossConnect/1", guiLabel: "", sncId: "1", orderId: "NA", nodeName: "PSS32-100-55-55", neName: "PSS32-100-55-55", a1PortName: "OTUODU4-1-3-C1", z1PortName: "OTUODU4-1-3-L1-CH1", a2PortName: "", z2PortName: "", xcState: "SncState_Active", xcRate: "ODU4", xcShape: "CS_SIMPLE_BI", eventDateTime: "2016-03-16T11:18:47Z", fixedXC: "WdmExclude", connectionName: "", connectionAlias: "", connectionId: "0", sigType: "OTU4", timeslots: "NA", waveKeyConfig: "NA", azwaveKey1: "NA", azwaveKey2: "NA", zawaveKey1: "NA", zawaveKey2: "NA", azwaveKeyingPreference: "NA", zawaveKeyingPreference: "NA", switchMode: "NA", revertiveMode: "NA", waitToRestoreTime: "NA", azCIR: "NA", zaCIR: "NA", azEIR: "NA", zaEIR: "NA", azCBS: "NA", azEBS: "NA", zaCBS: "NA", zaEBS: "NA", committedBurstSize: "NA", committedInfoRate: "NA", excessBurstSize: "NA", excessInfoRate: "NA", xcWidth: "0", domain: "managed_plane", azcommittedInfoRate: "NA", zacommittedInfoRate: "NA", azexcessInfoRate: "NA", zaexcessInfoRate: "NA", azcommittedBurstSize: "NA", azexcessBurstSize: "NA", zacommittedBurstSize: "NA", zaexcessBurstSize: "NA", xcDomain: "managed_plane" }], successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • retrieveWavekey : /data/otn/wavekeyPairs

  • Operation

    get /data/otn/connection/usedPorts
    to get All usedPorts specified by neId/nprNeId/nprNodeId (listUsedPortConnectionByFilters : /data/otn/connection/usedPorts)
    returns all used Ports

    Query parameters

    Name

    IsRequired

    Description

    neId optional ---
    nprNeId optional ---
    nprNodeId optional ---
    portId optional ---
    portLabel optional ---
    rate optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/usedPorts

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "OCHT", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-B", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCHT", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "OCHT", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-SIG", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCHT", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "ODU4", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-L1-1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "ODU4", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "ODU4", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-C1-1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "ODU4", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "ODU4", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-C1-1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "ODU4", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "OCHT", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-A", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCHT", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "ODU4", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-L1-1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "ODU4", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "267", key: "trail/267", guiLabel: "OpsbOdukSvc OTU4#1", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "377", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_SERVICE", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A322", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS32-100-61-74", z1PortName: "130SNX10-1-2-L1", a2NeName: "PSS32-100-61-74", a2PortName: "130SNX10-1-4-L1", z2NeName: "PSS-32-59.133", z2PortName: "130SCA1-1-2-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", a2NodeName: "PSS32-100-61-74", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 28, a2NodeId: 28, z2NodeId: 26, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS32-100-61-74/130SNX10-1-2-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/267", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-14-LINE-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS32-100-61-74/130SNX10-1-2-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "267", key: "trail/267", guiLabel: "OpsbOdukSvc OTU4#1", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "377", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OTU4", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_SERVICE", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A322", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS32-100-61-74", z1PortName: "130SNX10-1-2-L1", a2NeName: "PSS32-100-61-74", a2PortName: "130SNX10-1-4-L1", z2NeName: "PSS-32-59.133", z2PortName: "130SCA1-1-2-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", a2NodeName: "PSS32-100-61-74", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 28, a2NodeId: 28, z2NodeId: 26, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS32-100-61-74/130SNX10-1-2-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/267", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS32-100-61-74/130SNX10-1-2-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "267", key: "trail/267", guiLabel: "OpsbOdukSvc OTU4#1", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "377", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_SERVICE", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A322", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS32-100-61-74", z1PortName: "130SNX10-1-2-L1", a2NeName: "PSS32-100-61-74", a2PortName: "130SNX10-1-4-L1", z2NeName: "PSS-32-59.133", z2PortName: "130SCA1-1-2-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", a2NodeName: "PSS32-100-61-74", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 28, a2NodeId: 28, z2NodeId: 26, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS32-100-61-74/130SNX10-1-2-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/267", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS32-100-61-74/130SNX10-1-2-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "267", key: "trail/267", guiLabel: "OpsbOdukSvc OTU4#1", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "377", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#1", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_SERVICE", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A322", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS32-100-61-74", z1PortName: "130SNX10-1-2-L1", a2NeName: "PSS32-100-61-74", a2PortName: "130SNX10-1-4-L1", z2NeName: "PSS-32-59.133", z2PortName: "130SCA1-1-2-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", a2NodeName: "PSS32-100-61-74", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 28, a2NodeId: 28, z2NodeId: 26, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS32-100-61-74/130SNX10-1-2-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/267", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "SFD-1-15-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS32-100-61-74/130SNX10-1-2-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "230", key: "trail/230", guiLabel: "PSS-32-59.133/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-17-LINE OMS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-11T11:16:01Z", orderId: "269", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/AHPHG-1-17-LINE PSS-100-59.134/AHPHG-1-17-LINE OMS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OMS", tpPrimaryRate: "OMS", effectiveRate: "OMS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A265", customerName: "None", serviceState: "ServiceState_ON", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "AHPHG-1-17-LINE", z1NeName: "PSS-100-59.134", z1PortName: "AHPHG-1-17-LINE", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/AHPHG-1-17-LINE", zPortLabel: "PSS-100-59.134/AHPHG-1-17-LINE", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/230", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-17-LINE", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OMS", aportLabel: "PSS-32-59.133/AHPHG-1-17-LINE", zportLabel: "PSS-100-59.134/AHPHG-1-17-LINE", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "trail", id: "269", key: "trail/269", guiLabel: "OpsbOdukSvc OTU4#10", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "379", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#10", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OTU4", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_PROTECTION", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A324", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-100-59.134", z1PortName: "130SCA1-1-4-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-100-59.134/130SCA1-1-4-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/269", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-100-59.134/130SCA1-1-4-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "269", key: "trail/269", guiLabel: "OpsbOdukSvc OTU4#10", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "379", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#10", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_PROTECTION", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A324", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-100-59.134", z1PortName: "130SCA1-1-4-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-100-59.134/130SCA1-1-4-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/269", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-100-59.134/130SCA1-1-4-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "269", key: "trail/269", guiLabel: "OpsbOdukSvc OTU4#10", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "379", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#10", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_PROTECTION", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A324", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-100-59.134", z1PortName: "130SCA1-1-4-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-100-59.134/130SCA1-1-4-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/269", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-17-LINE-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-100-59.134/130SCA1-1-4-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "269", key: "trail/269", guiLabel: "OpsbOdukSvc OTU4#10", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-15T06:10:57Z", orderId: "379", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc OTU4#10", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OTU4", tpPrimaryRate: "OCH", effectiveRate: "OTU4", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_PROTECTION", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "9200.000", orderNumber: "A324", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-100-59.134", z1PortName: "130SCA1-1-4-L1", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-100-59.134/130SCA1-1-4-L1", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/269", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "SFD-1-16-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-100-59.134/130SCA1-1-4-L1", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "trail", id: "228", key: "trail/228", guiLabel: "PSS-32-59.133/AHPHG-1-14-LINE PSS32-100-61-74/AHPHG-1-14-LINE OMS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "trail", receivedDate: "2016-04-11T11:15:48Z", orderId: "267", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/AHPHG-1-14-LINE PSS32-100-61-74/AHPHG-1-14-LINE OMS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OMS", tpPrimaryRate: "OMS", effectiveRate: "OMS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A263", customerName: "None", serviceState: "ServiceState_ON", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "AHPHG-1-14-LINE", z1NeName: "PSS32-100-61-74", z1PortName: "AHPHG-1-14-LINE", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", aNodeId: 26, zNodeId: 28, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/AHPHG-1-14-LINE", zPortLabel: "PSS32-100-61-74/AHPHG-1-14-LINE", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/228", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-14-LINE", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OMS", aportLabel: "PSS-32-59.133/AHPHG-1-14-LINE", zportLabel: "PSS32-100-61-74/AHPHG-1-14-LINE", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "183", key: "physicalLink/183", guiLabel: "PSS-32-59.133/130SCA1-1-4-L1/SFD-1-16-9200", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T08:58:40Z", orderId: "184", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/130SCA1-1-4-L1/SFD-1-16-9200", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "DV184", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-32-59.133", z1PortName: "SFD-1-16-9200", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-32-59.133/SFD-1-16-9200", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/183", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "SFD-1-16-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-32-59.133/SFD-1-16-9200", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "183", key: "physicalLink/183", guiLabel: "PSS-32-59.133/130SCA1-1-4-L1/SFD-1-16-9200", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T08:58:40Z", orderId: "184", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/130SCA1-1-4-L1/SFD-1-16-9200", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "DV184", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-L1", z1NeName: "PSS-32-59.133", z1PortName: "SFD-1-16-9200", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-L1", zPortLabel: "PSS-32-59.133/SFD-1-16-9200", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/183", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-4-L1", zportLabel: "PSS-32-59.133/SFD-1-16-9200", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "238", key: "physicalLink/238", guiLabel: "PSS-32-59.133/130SCA1-1-4-C1/OPS-1-6-B/OS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:16:32Z", orderId: "279", groupOrderId: "236", groupOrderType: "GOT_ONE_TO_MANY", groupOrderName: "49/OPS-1-6-SIG", connectionAlias: "PSS-32-59.133/130SCA1-1-4-C1/OPS-1-6-B/OS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A274", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-C1", z1NeName: "PSS-32-59.133", z1PortName: "OPS-1-6-B", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-C1", zPortLabel: "PSS-32-59.133/OPS-1-6-B", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/238", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-B", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-4-C1", zportLabel: "PSS-32-59.133/OPS-1-6-B", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "238", key: "physicalLink/238", guiLabel: "PSS-32-59.133/130SCA1-1-4-C1/OPS-1-6-B/OS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:16:32Z", orderId: "279", groupOrderId: "236", groupOrderType: "GOT_ONE_TO_MANY", groupOrderName: "49/OPS-1-6-SIG", connectionAlias: "PSS-32-59.133/130SCA1-1-4-C1/OPS-1-6-B/OS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A274", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-4-C1", z1NeName: "PSS-32-59.133", z1PortName: "OPS-1-6-B", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-4-C1", zPortLabel: "PSS-32-59.133/OPS-1-6-B", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/238", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-4-C1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-4-C1", zportLabel: "PSS-32-59.133/OPS-1-6-B", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "192", key: "physicalLink/192", guiLabel: "PSS-32-59.133/130SCA1-1-2-L1/SFD-1-15-9200", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T09:25:58Z", orderId: "194", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/130SCA1-1-2-L1/SFD-1-15-9200", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "DV194", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS-32-59.133", z1PortName: "SFD-1-15-9200", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS-32-59.133/SFD-1-15-9200", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/192", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "SFD-1-15-9200", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS-32-59.133/SFD-1-15-9200", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "192", key: "physicalLink/192", guiLabel: "PSS-32-59.133/130SCA1-1-2-L1/SFD-1-15-9200", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T09:25:58Z", orderId: "194", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "PSS-32-59.133/130SCA1-1-2-L1/SFD-1-15-9200", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "DV194", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-L1", z1NeName: "PSS-32-59.133", z1PortName: "SFD-1-15-9200", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-2-L1", zPortLabel: "PSS-32-59.133/SFD-1-15-9200", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/192", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM_NOTIF", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-L1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-2-L1", zportLabel: "PSS-32-59.133/SFD-1-15-9200", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "237", key: "physicalLink/237", guiLabel: "PSS-32-59.133/130SCA1-1-2-C1/OPS-1-6-A/OS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:16:32Z", orderId: "278", groupOrderId: "236", groupOrderType: "GOT_ONE_TO_MANY", groupOrderName: "49/OPS-1-6-SIG", connectionAlias: "PSS-32-59.133/130SCA1-1-2-C1/OPS-1-6-A/OS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A273", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-C1", z1NeName: "PSS-32-59.133", z1PortName: "OPS-1-6-A", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-2-C1", zPortLabel: "PSS-32-59.133/OPS-1-6-A", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/237", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-C1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTU4", aportLabel: "PSS-32-59.133/130SCA1-1-2-C1", zportLabel: "PSS-32-59.133/OPS-1-6-A", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "237", key: "physicalLink/237", guiLabel: "PSS-32-59.133/130SCA1-1-2-C1/OPS-1-6-A/OS", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:16:32Z", orderId: "278", groupOrderId: "236", groupOrderType: "GOT_ONE_TO_MANY", groupOrderName: "49/OPS-1-6-SIG", connectionAlias: "PSS-32-59.133/130SCA1-1-2-C1/OPS-1-6-A/OS", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "OS", tpPrimaryRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A273", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "130SCA1-1-2-C1", z1NeName: "PSS-32-59.133", z1PortName: "OPS-1-6-A", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 26, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/130SCA1-1-2-C1", zPortLabel: "PSS-32-59.133/OPS-1-6-A", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/237", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_SYSTEM", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-A", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCH", aportLabel: "PSS-32-59.133/130SCA1-1-2-C1", zportLabel: "PSS-32-59.133/OPS-1-6-A", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "229", key: "physicalLink/229", guiLabel: "10.100.59.133:1-17-4--10.100.59.134:1-17-4", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:15:59Z", orderId: "268", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "10.100.59.133:1-17-4--10.100.59.134:1-17-4", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OTS", tpPrimaryRate: "OTS", effectiveRate: "OTS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "", frequency: "N/A", orderNumber: "DV264", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "AHPHG-1-17-LINE", z1NeName: "PSS-100-59.134", z1PortName: "AHPHG-1-17-LINE", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", aNodeId: 26, zNodeId: 27, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/AHPHG-1-17-LINE", zPortLabel: "PSS-100-59.134/AHPHG-1-17-LINE", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "21", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/229", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_NPR", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-17-LINE", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTS", aportLabel: "PSS-32-59.133/AHPHG-1-17-LINE", zportLabel: "PSS-100-59.134/AHPHG-1-17-LINE", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }, { className: "physicalLink", id: "227", key: "physicalLink/227", guiLabel: "10.100.59.133:1-14-4--10.100.61.74:1-14-4", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-11T11:15:46Z", orderId: "266", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "10.100.59.133:1-14-4--10.100.61.74:1-14-4", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OTS", tpPrimaryRate: "OTS", effectiveRate: "OTS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", nmlASAPName: "", frequency: "N/A", orderNumber: "DV262", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "PSS-32-59.133", a1PortName: "AHPHG-1-14-LINE", z1NeName: "PSS32-100-61-74", z1PortName: "AHPHG-1-14-LINE", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS32-100-61-74", aNodeId: 26, zNodeId: 28, a2NodeId: 0, z2NodeId: 0, aPortLabel: "PSS-32-59.133/AHPHG-1-14-LINE", zPortLabel: "PSS32-100-61-74/AHPHG-1-14-LINE", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "22", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/227", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_NPR", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "AHPHG-1-14-LINE", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OTS", aportLabel: "PSS-32-59.133/AHPHG-1-14-LINE", zportLabel: "PSS32-100-61-74/AHPHG-1-14-LINE", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }], data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • /data/otn/networkElement/

  • Operation

    get /data/otn/connection/usedPorts/{id}
    to get Used Ports for given Id (listUsedPortConnectionById : /data/otn/connection/usedPorts/{id})
    returns used ports for given Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/usedPorts/439

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "OCHT", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-B", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCHT", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "OCHT", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "OPS-1-6-SIG", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "OCHT", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" }, { className: "path", id: "266", key: "path/266", guiLabel: "OpsbOdukSvc", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "path", receivedDate: "2016-04-15T06:10:57Z", orderId: "376", groupOrderId: "265", groupOrderType: "GOT_CLNT_AND_SERVERS_PROV", groupOrderName: "g-OpsbOdukSvc", connectionAlias: "OpsbOdukSvc", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_ADD", layerRate: "ODU4", tpPrimaryRate: "ODU4", effectiveRate: "ODU4", displayProtectionType: "DPT_OPSB", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_MANAGED_PLANE", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NONE", TCMASAPEnabled: "TCM_STATUS_NONE", nmlASAPName: "default ASAP", frequency: "N/A", orderNumber: "A320", customerName: "None", serviceState: "ServiceState_OFF", provisionableWavekey: "keyed", a1NeName: "PSS-32-59.133", a1PortName: "OPS-1-6-SIG", z1NeName: "PSS-100-59.134", z1PortName: "OPS-1-6-SIG", a2NeName: "PSS-100-59.134", a2PortName: "OPS-1-6-SIG", z2NeName: "PSS-32-59.133", z2PortName: "OPS-1-6-SIG", a1NodeName: "PSS-32-59.133", z1NodeName: "PSS-100-59.134", a2NodeName: "PSS-100-59.134", z2NodeName: "PSS-32-59.133", aNodeId: 26, zNodeId: 27, a2NodeId: 27, z2NodeId: 26, aPortLabel: "PSS-32-59.133/OPS-1-6-SIG", zPortLabel: "PSS-100-59.134/OPS-1-6-SIG", pm24hour: "Started", pm15min: "NotEnabled", nprTlId: "-1", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/266", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_USER", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", assignedPortAddress: "130SCA1-1-2-L1-1", assignedPortNeName: "PSS-32-59.133", isL0CRRD: "false", isCurrentRouteRD: "false", tpEffectiveRate: "ODU4", aportLabel: "PSS-32-59.133/OPS-1-6-SIG", zportLabel: "PSS-100-59.134/OPS-1-6-SIG", tcmenabled: "TCM_STATUS_NONE", tcmasapenabled: "TCM_STATUS_NONE" } data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/ports/{id}/loopback
    Loopbacks are tests that users can initiate to test a circuit or to isolate a failure by connecting test equipment to the system interface and to create the loopback at different points in the transmission path (loopbackAction : /data/otn/ports/{id}/loopback)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    portLoopbackType required ---
    loopbackCommandName required ---
    layerRateId required ---
    neId required ---
    tpDisplayLabel required ---
    neName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/ports/139865/loopback?loopbackCommandName=PerformFacilityLoopback&portLoopbackType=RELEASE&layerRateId=200&neId=62&tpDisplayLabel=11DPM12-2-8-C1&portId=139865

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "message": "Maintenance Operation for port on NE completed successfully", "messageId": "OH1044I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "PSS4-100.63.215/11DPM12-2-8-C1", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "5505868836474477", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • routingDisplayById : /data/otn/connection/{id}/routingDisplay
  • /data/otn/networkElement/

  • Operation

    post /data/otn/connections/{id}/manage
    For SNCP protected connection to do Lock out or Release or Force Main or Force Spare or Manual Spare or Manual Main operation for specified connection (manageConnection : /data/otn/connections/{id}/manage)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/1381/manage?orderNumber=A1999&orderId=2721&type=ConnSNCPLockout&connName=Create_OPSB-ODU2_Service_11QPA4

    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
    { "message": "operation completed for Create_OPSB-ODU2_Service_11QPA4", "messageId": "I18N_OPERATION_COMPLETION_1", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "Create_OPSB-ODU2_Service_11QPA4", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "907867083590099", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/Connection/bulkpm
    Modify PM is an action/operation performed on control plane or manage plane connections This enable(s)/Disable(s) PM Monitored points for NE, enum/flag change will be done in SNA DB to collect History PM from PM BINs. Bulk modify pm is applicable for a single connection or multiple connections selected by the user. (modifyBulkConnection : /data/otn/Connection/bulkpm)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required req BulkPMRequest ---
    body2 optional httpSession HttpSession ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    "1. Bulk modify PM on Connection" { "connectionname": "d5x500infra", "connectionalias": "d5x500infra", "customerName": "None", "servicerate": "100GbE", "connectionid": "8", "orderid": "15", "ordernumber": "A8", "connshape": "8", "lopc": "false", "Latency": "true", "protectiontype": "11", "serviceratetype": "Trail", "fromne1": "10.42.37.7", "fromport1": "OTU-1-11-1", "tone1": "10.42.37.8", "toport1": "OTU-1-7-1", "currentstate": "9", "conncategory": "ManagedPlane", "routing": "4", "provisionwavekey": "na", "allowAsonResources": "false", "lBandFreq": "false", "subsea": "false", "ASONRouted": "false", "pm15min": "true", "pmdata15": "0", "direction15": "0", "tpmonitor15": "1", "reportinfo15": "1", "pm24hr": "true", "pmdata24": "0", "direction24": "0", "tpmonitor24": "1", "reportinfo24": "0", "alarmEnable": "NOTSET", "alarmProfileName": "", "autoInServiceTimer": "", "autoInService": "Disable", "nimEnabled": "", "linkUtilThreshold": "", "odukAZSrcTrace": "Use NE Value", "odukZASrcTrace": "Use NE Value", "odukTraceMismatchDectMode": "Use NE Value", "odukTraceMismatchAction": "Use NE Value", "fec": "SDFEC-G2", "LOSPropagation": "UseNEValue", "polarization": "Use NE Value", "transmissionmode": "txmodeQPSK_Single", "phaseEncoding": "Absolute", "encoding": "QPSK", "waveShape": "Single", "portAdminStateTimer": "", "portAdminState": "IS", "clientprotectiontype": "0", "clientholdofftime": "0", "clientprotectedMethod": "0", "clientprotectingMethod": "0", "clientsignaldegrade": "0", "clientrevertivemode": "0", "nwkprotectiontype": "0", "nwkholdofftime": "0", "nwkprotectedMethod": "0", "nwkprotectingMethod": "0", "nwksignaldegrade": "0", "nwkrevertivemode": "0", "cirrate": "0", "cbs": "CBS16", "ebs": "CBS16", "trailrate": "OTU4", "a1osnr": "NOTSET", "a2osnr": "NOTSET", "z1osnr": "NOTSET", "z2osnr": "NOTSET", "a1sigosnr": "NOTSET", "z1sigosnr": "NOTSET", "eirrate": "0", "operation": "Bulk Modify PM" } "2. Bulk modify PM on Multiple Connections" { "connectionid": "8,9", "orderid": "15,16", "ordernumber": "A8,A9", "connectionName": "d5x500infra,d5x500infra ODU4:1", "pm15min": "true", "tpmonitor15": "1", "direction15": "0", "reportinfo15": "1", "pmdata15": "0", "pm24hr": "true", "tpmonitor24": "1", "direction24": "0", "reportinfo24": "0", "pmdata24": "0", "a1osnr": "NOTSET", "a2osnr": "NOTSET", "z1osnr": "NOTSET", "z2osnr": "NOTSET", "a1sigosnr": "NOTSET", "z1sigosnr": "NOTSET", "operation": "Bulk Modify PM" }

    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
    "1. Bulk modify PM on Connection" { "message": "Request for PM update is submitted. Please check Job status for individual connections.", "messageId": "I18N_MSG_MODIFYPM_UPDATION_SUCCESS", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": 8, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" } "2. Bulk modify PM on Multiple Connections" { "message": "Request for PM update is submitted. Please check Job status for individual connections.", "messageId": "I18N_MSG_MODIFYPM_UPDATION_SUCCESS", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "d5x500infra,d5x500infra ODU4:1", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/Connection/{id}
    To modify a connection specified by connection ID (modifyConnection : /data/otn/Connection/{id})
    connection ID can be retrieved from '/data/otn/connections' REST call

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnConnectionRequest ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    /otn/NBI/Connection/modifyASAP/358

    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
    { "message": "The ASAP value on the NE is same as User requested.", "messageId": "OH1126E", "messageSeverity": "E", "status": "FAILURE", "connectionName": "M-Node-1/11DPM12-7-12-L1/SFD-7-10-9210", "connectionId": 369, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "1378234564331358", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connection/modifyConnParameters/{connId}
    To set user modified connection parameters (modifyConnectionParameters : /data/otn/connection/modifyConnParameters/{connId})
    connection ID can be retrieved from '/data/otn/connections' REST call

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connection id can be retrieved as 'connId' from the REST call '/data/otn/connections' and user can modify the below parameters transmision parameters : Payload Type Mismatch Response, Payload Type,Source AZ trail trace, Source ZA trail trace, Trail trace mismatch detection mode,Trail trace mismatch monitoring, Trail trace consequent action, Burst Interval for SD Detection, Burst Threshold for SD Detection, APS Enabled Assurance Parameters : 15-Minute PM,24-Hour PM, TP Monitoring Selection,Direction, Report Information, PM Data Purge Policy for both 15-Minute PM and 24-Hour PMConnection Parameters : Connection Name ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required data: is the payload data which have modified JSON object List[Entry«string,Map«string,string»»] ---
    body2 optional httpSession HttpSession ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

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

    data/otn/connection/modifyConnParameters/{connId} payload : request 1 : { "transmissionParameters" : {"TrailTraceActualTx" :"Mumbai"}, "assuranceParameters" : {"pm15MinuteReportInfo":"CSV4Hr"}, "connectionParameters" : {"connectionName":"4shreyainfra01"} } request 2 : { "connectionParameters" : {"connectionName":"4shreyaInfra"} } request 3 : { "transmissionParameters" : {"TrailTraceActualTx" :"Chennai"}, "assuranceParameters" : {"pm15MinuteReportInfo":"CSV4Hr"} }

    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 : { "message": "Modify Order Parameters action for order A797 and connection 4shreyainfra01 completed successfully." "messageId": "OH1015I" "messageSeverity": "I" "status": "SUCCESS" "connectionName": "4shreyainfra01" "connectionId": 773 "orderNumber": "" "orderId": "" "orderStep": 0 "id": "940443618138568" "errorField": "" "errorValue": "" } response 2: { "message": "Modify Order Parameters action for order A797 and connection 4shreyaInfra completed successfully." "messageId": "OH1015I" "messageSeverity": "I" "status": "SUCCESS" "connectionName": "4shreyaInfra" "connectionId": 773 "orderNumber": "" "orderId": "" "orderStep": 0 "id": "1206572788788044" "errorField": "" "errorValue": "" } response 3: { "message": "Modify Order Parameters action for order A797 and connection 4shreyaInfra completed successfully." "messageId": "OH1015I" "messageSeverity": "I" "status": "SUCCESS" "connectionName": "4shreyaInfra" "connectionId": 773 "orderNumber": "" "orderId": "" "orderStep": 0 "id": "1206861357336482" "errorField": "" "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/rctemplates/modify
    modify an existing template (modifyRCTemplate : /data/otn/rctemplates/modify)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj RCTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/tcm/modifyTCM
    to modify Tandem Connection Monitoring(TCM) for given connection ID (modifyTCM : /data/otn/connections/{id}/tcm/modifyTCM)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from 'id' attribute of '/data/otn/connections' REST call ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required tcmReq TCMconnectionRequest ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/413/tcm/modifyTCM { "connectionName": "ODU4 LL", "connectionId": "413", "a1NodeName": "SRNode-1", "z1NodeName": "PHN-55.231", "a1PortName": "OTUODU4-1-1-39-1", "z1PortName": "OTUODU4-1-13-L1-CH1", "a2NodeName": "PHN-55.231", "z2NodeName": "SRNode-1", "a2PortName": "OTUODU4-1-13-L1-CH1", "z2PortName": "OTUODU4-1-1-39-1", "alarmEnabling": "Enabled", "profileName": "ODU4TCM", "pm15MinuteCollectionType": "Yes", "pm15MinuteMonitoringSelection": "TCM Termination", "pm15MinuteDirection": "Unidirectional", "pm15MinuteReportInfo": "CSV 2 Hr", "pm15MinuteDataPurgePolicy": "Keep PM Data upon Connection Deletion", "pm24HourCollectionType": "No", "pm24HourMonitoringSelection": "TCM Termination", "pm24HourDirection": "Unidirectional", "pm24HourReportInfo": "CSV 24 Hr", "pm24HourDataPurgePolicy": "Keep PM Data upon Connection Deletion" }

    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
    { "message": "Command Accepted", "messageId": "I18N_COMMAND_ACCEPTED", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/txtemplates/modify
    modify an existing template (modifyTXTemplate : /data/otn/txtemplates/modify)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj TXTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/autoaddprotection
    to add protection to Control Plane Connection specified by Connection ID (myaddprotection : /data/otn/connections/{id}/autoaddprotection)
    Please Note: supported only for L1,L0 connections ( except for few like GR and OPSA with CDC-F)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    actiontype required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connections/1033/autoaddprotection?orderNumber=A1450&orderId=2057&actiontype=addprotection&type=hard&connName=Test-ASON-1GbE

    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
    { "message": "Modify order to Commissioned action completed successfully for Order Number IR1466 and Connection Name Test-ASON-1GbE", "messageId": "OH1001I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "Test-ASON-1GbE", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": null, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/networkConnection/{id}
    to get Network connection for given Id (networkConnectionsById : /data/otn/connection/networkConnection/{id})
    returns Network Connection for given Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connection/networkConnection/439

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [1] 0: { "className": "physicalLink" "id": "1" "key": "physicalLink/1" "guiLabel": "NODE_1/SFD-1-2-9200/11DPM12-1-4-L1/OS" "vsClientState": "VSCS_NOT_APPLICABLE" "vsClientId": -1 "connectionType": "physicalLink" "receivedDate": "2016-03-31T08:56:25Z" "orderId": "1" "groupOrderId": "0" "groupOrderType": "GOT_NA" "connectionAlias": "1/11DPM12-1-4-L1/1/SFD-1-2-9200" "orderStep": "CST_IN_EFFECT" "stepState": "SSTATE_COMPLETED" "orderType": "OT_DISCOVERED" "layerRate": "OS" "effectiveRate": "OS" "displayProtectionType": "DPT_UN_PROTECTED" "protectionRole": "PR_NA" "state": "CST_IN_EFFECT" "operationalState": "Enabled" "category": "CC_NA" "alarmEnabling": "Not Set" "alarmState": "Cleared" "alarmSeverity": "Cleared" "TCMEnabled": "TCM_STATUS_NA" "TCMASAPEnabled": "TCM_STATUS_NA" "nmlASAPName": "default ASAP" "frequency": "N/A" "orderNumber": "DV1" "customerName": "None" "serviceState": "ServiceState_NA" "provisionableWavekey": "N/A" "a1NeName": "NODE_1" "a1PortName": "SFD-1-2-9200" "z1NeName": "NODE_1" "z1PortName": "11DPM12-1-4-L1" "a1NodeName": "NODE_1" "z1NodeName": "NODE_1" "aNodeId": 3 "zNodeId": 3 "a2NodeId": 0 "z2NodeId": 0 "aPortLabel": "NODE_1/SFD-1-2-9200" "zPortLabel": "NODE_1/11DPM12-1-4-L1" "pm24hour": "NotEnabled" "pm15min": "NotEnabled" "nprTlId": "-1" "sdhConnectionId": "-1" "sdhClientId": "-1" "isUsedInSdh": "false" "fdn": "20/1" "mismatchType": "NA" "clientRouteState": "NA" "createdBy": "CB_SYSTEM" "inconsistentMismatchType": "" "inconsistentAcknowledgedBy": "" "inconsistentEventDate": "" "inconsistentAckDate": "" "isL0CRRD": "false" "isCurrentRouteRD": "false" "aportLabel": "NODE_1/SFD-1-2-9200" "zportLabel": "NODE_1/11DPM12-1-4-L1" "tcmenabled": "TCM_STATUS_NA" "tcmasapenabled": "TCM_STATUS_NA" } - - "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections
    to get Network connection for given Id (networkConnectionsByIdInRequestBody : /data/otn/connections)
    returns Network Connection for given Id

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' String ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/nim
    To enable or disable Non-Intrusive Monitoring (nimConnection : /data/otn/connections/nim)
    It is a method for reporting defects and performance monitoring (PM) for intermediate services on non-terminated add-drop and through connections

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required req NIMConnectionRequest ---
    body2 optional httpSession HttpSession ---
    body3 optional locale Locale ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/1006/nim?orderNumber=A1494&orderId=1787&type=enable&connName=SITE11-1/11QPA4-8-8-C3-1Site12-1/11QPA4-8-8-C3-1 ODU2

    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
    { "message": "Enable NIM of SITE11-1/11QPA4-8-8-C3-1Site12-1/11QPA4-8-8-C3-1 is successful", "messageId": "I18N_COMMAND_ACCEPTED", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "SITE11-1/11QPA4-8-8-C3-1Site12-1/11QPA4-8-8-C3-1&ODU2", "connectionId": 1006, "orderNumber": "", "orderId": "", "orderStep": 0, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/ports/{id}/wlt/{dir}/{band}
    lists power details at every physical ports of a given connection ,direction and band (otsList : /data/otn/ports/{id}/wlt/{dir}/{band})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/Connection/{id}' REST call as aPortId/zPortId for a given connection ---
    dir required Direction: Ingress/Egress ---
    band required Band: C/L ---

    Return type
  • Otn WLT OTS Response
  • Responses

    Response Messages

    Schema

    200success Otn WLT OTS Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /oms1350/data/otn/ports/54161/wlt/Ingress/L

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { wltKey: "tp(54161).OPD_INGRESS", chanPowerList: [{ xlabel: { channelId: "10017", frequency: "", waveKey1: "", waveKey2: "" }, measPower: "-30.0", minPower: null, maxPower: null, channelAttr: "unprovisioned", tooltip: null, connectionId: "", connectionName: "" }, { xlabel: { channelId: "17", frequency: "", waveKey1: "", waveKey2: "" }, measPower: "-30.0", minPower: null, maxPower: null, channelAttr: "unprovisioned", tooltip: null, connectionId: "", connectionName: "" }], otnWLTChanDetails: { otsConnectionName: "PSS32-40.13.117/ASWG-1-3-LINEOUT PSS32-40.13.118/RA2P-1-2-LINEIN OMS", nearEndNEName: "PSS32-40.13.117", nearEndPortAIDA1: "ASWG-1-3-LINEOUT", nearEndPortAIDA2: "RA2P-1-2-LINEIN", farEndNEName: "PSS32-40.13.118", farEndPortAIDZ1: "RA2P-1-2-LINEIN", farEndPortAIDZ2: "ASWG-1-3-LINEOUT", interfaceDirection: "Unidirectional", connectionRate: "OMS", orderNumber: "A42", connectionState: "Commissioned", numberOfChannels: "88", numberOfChannelsProvisioned: "0", direction: "Ingress", pwrMgmtType: "", commissioningStatus: "NA", lastRefresh: "Fri Mar 02 12:53:44 IST 2018" }, message: "", messageId: "", messageSeverity: "", status: "SUCCESS" }

    External Docs
    See Also :
  • modifyConnection : /data/otn/Connection/{id}

  • Operation

    get /data/otn/connections/physicalLinks/ots
    Get a list of OTSs from a list of incident Nodes (otssByNprNodeIds : /data/otn/connections/physicalLinks/ots)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNodeIds required id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/snc/sync/{sncId}
    To perform path sync on given snc (pathSyncOnEntity : /data/otn/snc/sync/{sncId})
    pathSyncOnEntity

    Path parameters

    Name

    IsRequired

    Description

    Enum

    sncId required sncId ---

    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

    External Docs
    See Also :

    Operation

    post /data/otn/ports/{id}/protectionSwitch
    Manage Multiplex Section Protection (MSP)/Simple Network Management Protocol (SNCP) protection switching. (protectionSwitchingAction : /data/otn/ports/{id}/protectionSwitch)
    Please Note: This may disrupt traffic.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    pgCommandName required ---
    neId required ---
    neName required ---
    connectionId required ---
    switchReason required ---
    protectionGroupType required ---
    protectionGroupRef required ---
    protectionGroupId required ---
    protectionPortId required ---
    workingPortId required ---
    activePortId required ---
    activePortRef required ---
    westWorkingPortId required ---
    eastWorkingPortId required ---
    westWorkingPortNativeName required ---
    eastWorkingPortNativeName required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/ports/110532/protectionSwitch?pgCommandName=PGSNCPForceSpare&neId=6&neName=siva1&connectionId=1004&switchReason=SR_NO_REQUEST&protectionGroupType=PGT_SNCP_TYPE&protectionGroupRef=ODU1PTF-3-15-1&protectionGroupId=110532&protectionPortId=110442&workingPortId=110436&activePortId=110436&activePortRef=Working&westWorkingPortId=NA&eastWorkingPortId=NA&westWorkingPortNativeName=NA&eastWorkingPortNativeName=NA

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "message": "Protection Command Force switch to protection for ODU1PTF-3-15-1 on NE siva1 with connection ODU1Trail-Pro completed successfully", "messageId": "OH1041I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "id": "5517709222678764", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}
  • /data/otn/networkElement/

  • Operation

    post /data/otn/connections/{id}/reinstate
    reinstateConnection (reinstateConnection : /data/otn/connections/{id}/reinstate)
    reinstateConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • DeferredResult«Otn connection Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn connection Response»
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/otn/connections/loopback/release
    To release loopback (releaseLoopback : /data/otn/connections/loopback/release)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    neId required ---
    tpId required ---
    tpRate required ---
    tpNativeName required ---
    type required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/loopback/release?neId=96&tpId=305904&tpRate=20&tpNativeName=11QPA4-8-8-L3&type=Facility

    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
    { "message": "Maintenance Operation for port on NE completed successfully", "messageId": "OH1044I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "Site12-1/11QPA4-8-8-L3", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getEligiblePorts : /data/otn/connectionTP

  • Operation

    post /data/otn/connections/{id}/removeProtection
    to remove protection of connection specified by connection ID (removeProtection : /data/otn/connections/{id}/removeProtection)
    removes protection of a connection which is specified by connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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.
    • application/json

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/acknowledge
    To Acknowledge inconsistent connections (restoreInconsistentConnection : /data/otn/connections/{id}/acknowledge)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    connectionName required ---
    connectionAlias required ---
    orderId required ---
    ackType required ---
    userName required ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/297/acknowledge?connectionName=112SCX10-ODU4-1&connectionAlias=112SCX10-ODU4-1&orderId=2492&ackType=SNC&userName=alcatel

    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
    { "message": "AcknowledgeSuccess", "messageId": "AcknowledgeSuccess", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "112SCX10-ODU4-1", "connectionId": 297, "orderNumber": "", "orderId": "", "orderStep": 0, "id":"1232542343264323", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/restore
    To restore Inconsistent connections (restoreInconsistentConnection : /data/otn/connections/{id}/restore)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be retrieved from '/data/otn/connections' REST call as 'id' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/699/restore

    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
    { "message": "Restore of Tx Parameters Testing 01 is completed successfully", "messageId": "OH1072E", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "Tx Parameters Testing 01", "connectionId": 699, "orderNumber": "", "orderId": "", "orderStep": 0, "id":"5432554343344764", "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/Connection/switchData/{connId}
    to retrieve the switchData by connection ID (retrieveConnectionSwitchData : /data/otn/Connection/switchData/{connId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • Nbi switch Data Response
  • Responses

    Response Messages

    Schema

    200success Nbi switch Data Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/wlt/details
    retrieveDetails (retrieveDetails : /data/otn/connection/{id}/wlt/details)
    retrieveDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    oduNcId optional ---
    currentRouteIdList optional ---

    Return type
  • DeferredResult«Wlt2_DetailsResponse»
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /data/otn/connections/retrieveJobTask
    to retrieve the Job/Task by connection ID's or connection name's list (retrieveJobTaskByConnection : /data/otn/connections/retrieveJobTask)
    retrieveJobTaskByConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connectionInputList ConnectionInputList ---

    Return type
  • ComputeLatencyMeasurementResponse
  • Responses

    Response Messages

    Schema

    200success ComputeLatencyMeasurementResponse
    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/otn/connections/retrieveJobTask Request Payload: By ConnectionName { "connectionNameList":[ "11QPA4B-LL1 ODU2E:1 DSR:1" ] } By ConnectionId { "connectionIdList":[ "1894" ] }

    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
    /data/otn/connections/retrieveJobTask Output: { "reqCompletionStatus":0, "requestId":0, "clientName":null, "clientLocation":null, "clientUser":null, "sessionId":"", "mdcId":null, "sequenceNum":0, "moreToCome":false, "messages":[ ], "errcde":null, "errorParams":null, "message":"Success", "computeLatencyJobInfo":{ "1894":{ "jobId":5603, "taskId":5587, "requestId":null, "isValidUser":null } }, "failedCompletion":false, "successfulCompletion":false, "nadString":"", "timeout":0 }

    External Docs
    See Also :

    Operation

    get /data/otn/Connection/{connId}/lldpParameter
    to retrieve the LLDP Parameter by connection ID (retrieveLLDPParameterList : /data/otn/Connection/{connId}/lldpParameter)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • LLDPResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/Connection/1/lldpParameter

    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
    { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": [{ "tpId": "886057", "portName": "PSI-135.104.218.187/LCI2000-1-2-C10_1", "destMACAddress": "Nearest Bridge", "chassisID": "A0:F3:E4:81:FA:30", "portId": "69238784", "systemName": "7750-NK06U" }], "data": null, "successfulCompletion": false, "failedCompletion": false, "nadString": "", "timeout": 0 }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/retrieveLatency
    to retrieve the latencyMeasurement by connection ID's or connection name's list (retrieveLatencyMeasurementByConnection : /data/otn/connections/retrieveLatency)
    retrieveLatencyMeasurementByConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connectionInputList ConnectionInputList ---

    Return type
  • LatencyMeasurment Response
  • Responses

    Response Messages

    Schema

    200success LatencyMeasurment Response
    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/otn/connections/retrieveLatency Request Payload: By ConnectionName { "connectionNameList":[ "11QPA4B-LL1 ODU2E:1 DSR:1" ] } By ConnectionId { "connectionIdList":[ "1894" ] }

    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
    /data/otn/connections/retrieveLatency Output : { "identifier":"1", "items":[ { "connectionId":"1894", "connectionName":"11QPA4B-LL1 ODU2E:1 DSR:1", "actualLatencyWorking":"0.0", "actualLatencyProtection":"0.0", "latencyTimestamp":"1549523157", "latencyValue":"SUCCESS" } ], "status":"Success" }

    External Docs
    See Also :

    Operation

    get /data/otn/Notes
    To retrieve notes for particular connection (retrieveNoteList : /data/otn/Notes)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    fromtype required ---
    fieldId optional ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/notes
    To retrieve notes for particular connection (retrieveNoteList : /data/otn/notes)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    fromtype required ---
    fieldId optional ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/Connection/opsaData/{connId}
    to retrieve the OPSA attributes by connection ID (retrieveOpsaAttributes : /data/otn/Connection/opsaData/{connId})
    retrieveOpsaAttributes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • OpsaResponse
  • Responses

    Response Messages

    Schema

    200success OpsaResponse
    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/otn/psEvents
    To get Protection Switch Events (retrievePSE : /data/otn/psEvents)

    Query parameters

    Name

    IsRequired

    Description

    connectionId optional ---
    connectionName optional ---

    Return type
  • ProtectionSwitchListRsp
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/psEvents

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "items": [7] 0: { "pseId": "0000000149" "pseType": "SNCP" "switchReason": "RESTORED" "raiseTime": "2016-04-29T07:31:27Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10001" "key": "10001/psEvent" "guiLabel": "psEvent" } - 1: { "pseId": "0000000148" "pseType": "SNCP" "switchReason": "LOCKOUT" "raiseTime": "2016-04-29T07:30:57Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10002" "key": "10002/psEvent" "guiLabel": "psEvent" } - 2: { "pseId": "0000000147" "pseType": "SNCP" "switchReason": "RESTORED" "raiseTime": "2016-04-29T07:30:38Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10003" "key": "10003/psEvent" "guiLabel": "psEvent" } - 3: { "pseId": "0000000146" "pseType": "SNCP" "switchReason": "FORCED_SWITCH" "raiseTime": "2016-04-29T07:29:14Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-A" "toResource": "OPS-21-2-B" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10004" "key": "10004/psEvent" "guiLabel": "psEvent" } - 4: { "pseId": "0000000145" "pseType": "SNCP" "switchReason": "RESTORED" "raiseTime": "2016-04-29T07:29:06Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10005" "key": "10005/psEvent" "guiLabel": "psEvent" } - 5: { "pseId": "0000000144" "pseType": "SNCP" "switchReason": "LOCKOUT" "raiseTime": "2016-04-29T07:28:53Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10006" "key": "10006/psEvent" "guiLabel": "psEvent" } - 6: { "pseId": "0000000143" "pseType": "SNCP" "switchReason": "FORCED_SWITCH" "raiseTime": "2016-04-29T07:19:30Z" "neName": "PSS32-100.55.116" "groupName": "OPS-21-2-SIG" "layerRate": "OCHT" "category": "" "protectedResource": "OPS-21-2-SIG" "fromResource": "OPS-21-2-B" "toResource": "OPS-21-2-A" "acknowledgeTime": -1000 "acknowledgeUser": "" "ackStatus": "UNACKD" "connectionName": "OPSB_3Ended_130SCA1_3R_100GbE_Service" "connectionId": 13352 "className": "psEvent" "id": "10007" "key": "10007/psEvent" "guiLabel": "psEvent" } - - "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/jsonFile/{requestId}
    retrieveProvisionStatus (retrieveProvisionStatus : /data/otn/connections/jsonFile/{requestId})
    retrieveProvisionStatus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    requestId required requestId ---

    Return type
  • List[Entry«string,List«OTN Connection Provision Status»»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,List«OTN Connection Provision Status»»]
    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/otn/rcTemplate
    To retrieve routing constraint template (retrieveRCTemplate : /data/otn/rcTemplate)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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 :
  • listFrequency : /data/otn/connections/{id}/nodes/{nodeId}/frequency

  • Operation

    get /data/otn/RCTemplateDetails
    To retrieve template details for particular template (retrieveRCTemplateDetails : /data/otn/RCTemplateDetails)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    templatename required ---
    templateid optional ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/txTemplate
    To retrieve transmission parameters template (retrieveTXTemplate : /data/otn/txTemplate)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • listFrequency : /data/otn/connections/{id}/nodes/{nodeId}/frequency

  • Operation

    get /data/otn/txTemplateDetails
    To retrieve template details for particular template (retrieveTXTemplateDetails : /data/otn/txTemplateDetails)

    Query parameters

    Name

    IsRequired

    Description

    templatename required ---
    templateid optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/wavekeyPairs
    To retrieve wave key Pairs for particular frequency (retrieveWavekey : /data/otn/wavekeyPairs)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    frequency required ---
    fieldId optional ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/wavekeyPairs?frequency=9170.000

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "items": [113] 0: { "toneOverlap": "0" "waveKey1": "1276" "waveKey2": "1760" "waveKey1And2": "1276,1760" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1760" "key": "wavekeyPair/1276,1760" "guiLabel": "1276,1760" } - 1: { "toneOverlap": "0" "waveKey1": "1278" "waveKey2": "1762" "waveKey1And2": "1278,1762" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1278,1762" "key": "wavekeyPair/1278,1762" "guiLabel": "1278,1762" } - 2: { "toneOverlap": "0" "waveKey1": "1280" "waveKey2": "1764" "waveKey1And2": "1280,1764" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1280,1764" "key": "wavekeyPair/1280,1764" "guiLabel": "1280,1764" } - 3: { "toneOverlap": "0" "waveKey1": "1282" "waveKey2": "1766" "waveKey1And2": "1282,1766" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1282,1766" "key": "wavekeyPair/1282,1766" "guiLabel": "1282,1766" } - 4: { "toneOverlap": "0" "waveKey1": "1284" "waveKey2": "1768" "waveKey1And2": "1284,1768" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1284,1768" "key": "wavekeyPair/1284,1768" "guiLabel": "1284,1768" } - 5: { "toneOverlap": "0" "waveKey1": "1286" "waveKey2": "1770" "waveKey1And2": "1286,1770" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1286,1770" "key": "wavekeyPair/1286,1770" "guiLabel": "1286,1770" } - 6: { "toneOverlap": "0" "waveKey1": "1288" "waveKey2": "1772" "waveKey1And2": "1288,1772" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1288,1772" "key": "wavekeyPair/1288,1772" "guiLabel": "1288,1772" } - 7: { "toneOverlap": "0" "waveKey1": "1290" "waveKey2": "1774" "waveKey1And2": "1290,1774" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1290,1774" "key": "wavekeyPair/1290,1774" "guiLabel": "1290,1774" } - 8: { "toneOverlap": "1" "waveKey1": "1277" "waveKey2": "1767" "waveKey1And2": "1277,1767" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1277,1767" "key": "wavekeyPair/1277,1767" "guiLabel": "1277,1767" } - 9: { "toneOverlap": "1" "waveKey1": "1279" "waveKey2": "1769" "waveKey1And2": "1279,1769" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1279,1769" "key": "wavekeyPair/1279,1769" "guiLabel": "1279,1769" } - 10: { "toneOverlap": "1" "waveKey1": "1281" "waveKey2": "1761" "waveKey1And2": "1281,1761" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1281,1761" "key": "wavekeyPair/1281,1761" "guiLabel": "1281,1761" } - 11: { "toneOverlap": "1" "waveKey1": "1283" "waveKey2": "1763" "waveKey1And2": "1283,1763" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1283,1763" "key": "wavekeyPair/1283,1763" "guiLabel": "1283,1763" } - 12: { "toneOverlap": "1" "waveKey1": "1285" "waveKey2": "1765" "waveKey1And2": "1285,1765" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1285,1765" "key": "wavekeyPair/1285,1765" "guiLabel": "1285,1765" } - 13: { "toneOverlap": "1" "waveKey1": "1287" "waveKey2": "1773" "waveKey1And2": "1287,1773" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1287,1773" "key": "wavekeyPair/1287,1773" "guiLabel": "1287,1773" } - 14: { "toneOverlap": "1" "waveKey1": "1289" "waveKey2": "1771" "waveKey1And2": "1289,1771" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1289,1771" "key": "wavekeyPair/1289,1771" "guiLabel": "1289,1771" } - 15: { "toneOverlap": "2" "waveKey1": "1276" "waveKey2": "1762" "waveKey1And2": "1276,1762" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1762" "key": "wavekeyPair/1276,1762" "guiLabel": "1276,1762" } - 16: { "toneOverlap": "2" "waveKey1": "1276" "waveKey2": "1764" "waveKey1And2": "1276,1764" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1764" "key": "wavekeyPair/1276,1764" "guiLabel": "1276,1764" } - 17: { "toneOverlap": "2" "waveKey1": "1276" "waveKey2": "1766" "waveKey1And2": "1276,1766" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1766" "key": "wavekeyPair/1276,1766" "guiLabel": "1276,1766" } - 18: { "toneOverlap": "2" "waveKey1": "1276" "waveKey2": "1768" "waveKey1And2": "1276,1768" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1768" "key": "wavekeyPair/1276,1768" "guiLabel": "1276,1768" } - 19: { "toneOverlap": "2" "waveKey1": "1276" "waveKey2": "1770" "waveKey1And2": "1276,1770" "status": "WKS_AVAILABLE" "frequency": "9170.000" "fieldId": "" "className": "wavekeyPair" "id": "1276,1770" "key": "wavekeyPair/1276,1770" "guiLabel": "1276,1770" }

    External Docs
    See Also :
  • listFrequency : /data/otn/connections/{id}/nodes/{nodeId}/frequency

  • Operation

    get /data/otn/lineModeProfiles
    To retrieve line mode profiles for particular NE version (retrievelineModeProfilesDetails : /data/otn/lineModeProfiles)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    neversion optional ---
    neid optional ---

    Return type
  • WDM Response
  • Responses

    Response Messages

    Schema

    200success WDM Response
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/routingDisplay
    to get Routing Details for given connection ID (routingDisplayById : /data/otn/connection/{id}/routingDisplay)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/1/routingDisplay

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "reqCompletionStatus": 11, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "nextTasks": null, "items": null, "data": [{ "className": "NODE4_PHN", "id": "31", "key": "31/NODE4_PHN", "guiLabel": "NODE4_PHN", "NeId": "31", "NeName": "NODE4_PHN", "internalNeType": "1830PSS_32", "NeType": "Wdm1830PSS_32", "belongsToCompositeNode": "true", "compositeNodeName": "NODE4_PHN", "emlNeType": "Wdm1830PSS_32", "activityState": "AS_ACTSTATENA", "commsStatus": "CS_UP", "managementType": "NMT_DIRECT", "alarmSeverity": "AS_NOALARM", "configDownloadStatus": "CD_ENABLED", "swVersion": "R8.2", "nodeGridDim": "ND_2RowX3Col", "nprNeId": "11", "neModel": "1830PSS-PHN", "nprComponentNeId": "12", "connFrequency": "NA", "isOCS": "false", "isPHN": "true", "isCurrentRouteRD": "false", "isGMREEnabled": "true", "size": { "width": "105", "height": "130" }, "position": { "col": "0", "row": "0" }, "neName": "NODE4_PHN", "neId": "31", "neType": "Wdm1830PSS_32" }, { "className": "link", "id": "0", "key": "0/link", "guiLabel": "INTERNAL_LCC", "linkConnectionId": 0, "aNEId": 31, "zNEId": 31, "displayThickness": 2, "serverConnectionId": -1, "channelNum": 0, "connectionId": 1, "orderId": 1, "connectionAlias": "", "connectionName": "", "aPortName": "112SCX10-1-14-L1", "zPortName": "SFD-1-17-9190", "aPortId": "8388", "zPortId": "8383", "aNEName": "NODE4_PHN", "zNEName": "NODE4_PHN", "isInternal": "true", "isIndirect": "false", "srcActive": "NA", "sinkActive": "NA", "direction": "CD_BID", "leftArrowStyle": "NORMAL", "rightArrowStyle": "NORMAL", "displayStyle": "solid", "manualFault": "No", "jklmTimeSlot": "", "frequency": "", "serverConnectionTechnology": "NA", "effectiveRate": "NA", "lccId": "0", "serverIndirectPathId": "NA", "serverConnectionName": "NA", "lcUsage": "LCU_Idle", "linkState": "LCS_NA", "serverCommissioningStatus": "NA", "channelRate": "Wdm_LayerRate_default", "channelState": "LCS_UNUSED", "channelUsage": "LCU_NA", "operationalState": "LOS_Enabled", "displayLinkState": "DLS_UNPROTECTED", "orientation": "LCOT_NA", "lcpt": "LCPT_NA", "linkType": "INTERNAL_LCC", "isCurrentRouteRD": "false", "is3rdPartyLink": "false", "position": { "x": "0", "y": "0" } }, { "className": "physicalLink", "id": "1", "key": "1/physicalLink", "label": "NODE4_PHN/112SCX10-1-14-L1/SFD-1-17-9190/OS", "guiLabel": "NODE4_PHN/112SCX10-1-14-L1/SFD-1-17-9190/OS", "connectionId": "1", "vsClientState": "", "vsClientId": -1, "connectionType": "physicalLink", "receivedDate": "1461036989000", "orderId": "1", "groupOrderId": "", "groupOrderType": "", "groupOrderName": "", "connectionName": "NODE4_PHN/112SCX10-1-14-L1/SFD-1-17-9190/OS", "connectionAlias": "12/112SCX10-1-14-L1/12/SFD-1-17-9190", "orderStep": "CST_IN_EFFECT", "stepState": "SSTATE_COMPLETED", "orderType": "OT_DISCOVERED", "layerRate": "OS", "effectiveRate": "OTU4", "protectionType": "PT_SILVER", "displayProtectionType": "DPT_UN_PROTECTED", "protectionRole": "", "state": "CST_IN_EFFECT", "operationalState": "Enabled", "category": "CC_NA", "alarmEnabling": "Na", "alarmState": "Na", "alarmSeverity": "Na", "TCMEnabled": "TCM_STATUS_NA", "TCMASAPEnabled": "TCM_STATUS_NA", "frequency": "NA", "orderNumber": "DV1", "customerName": "None", "serviceState": "ServiceState_NA", "provisionableWavekey": "NA", "a1NeName": "NODE4_PHN", "a1PortName": "112SCX10-1-14-L1", "z1NeName": "NODE4_PHN", "z1PortName": "SFD-1-17-9190", "a2NeName": "", "a2PortName": "", "z2NeName": "", "z2PortName": "", "a1NodeName": "NODE4_PHN", "z1NodeName": "NODE4_PHN", "a2NodeName": "", "z2NodeName": "", "aNodeId": 31, "zNodeId": 31, "a2NodeId": -1, "z2NodeId": -1, "azConnectionEndPorts": [8388, 8383], "aPortLabel": "", "zPortLabel": "", "pm24hour": "NotEnabled", "pm15min": "NotEnabled", "hasRouteComponent": "false", "isOpticalRouteAvailable": "false", "hasOpticalLayer": "OL_NO", "hasUncommissionedServerPhysicalConnections": "HasUncommissionedServerPhysicalConnections_FALSE", "connectionDirection": "CD_BID", "TCMPMCollection15m": "TCMPM_CollectionDisabled", "TCMPMCollection24h": "TCMPM_CollectionDisabled", "commissioningStatus": "CommissioningStatus_NA", "isRD": "true", "nprTlId": "-1", "sdhConnectionId": "-1", "sdhClientId": "-1", "isUsedInSdh": "false", "fdn": "20/1", "mismatchType": "NA", "clientRouteState": "NA", "inconsistentMismatchType": "", "inconsistentAcknowledgedBy": "", "inconsistentEventDate": "", "inconsistentAckDate": "", "size": { "width": "70", "height": "50" }, "position": { "x": "20", "y": "20" }, "isL0": "false", "isL1": "false", "isL0CRRD": "false", "isCurrentRouteRD": "false", "trailConnectionIdL0CR": "", "tpEffectiveRate": "", "aportLabel": "", "zportLabel": "", "tcmenabled": "TCM_STATUS_NA", "tcmasapenabled": "TCM_STATUS_NA", "tcmpmcollection15m": "TCMPM_CollectionDisabled", "tcmpmcollection24h": "TCMPM_CollectionDisabled" }, { "className": "port", "id": "8388", "key": "8388/port", "guiLabel": "112SCX10-1-14-L1", "portId": "8388", "portName": "112SCX10-1-14-L1", "nativeName": "112SCX10-1-14-L1", "relativeName": "112SCX10-1-14-L1", "portLabel": "112SCX10-1-14-L1", "tpDisplayLabel": "112SCX10-1-14-L1", "portRate": "Wdm_LayerRate_OS", "layerRateId": "20", "portType": "PTP", "portAlarmState": "AS_CLEARED", "connId": -1, "physicalPortId": 8388, "isInternal": "false", "neId": "31", "neName": "NODE4_PHN", "neInterfaceName": "NODE4_PHN", "neType": "Wdm1830PSS_32", "neModel": "1830PSS_32", "neRelease": "R8.2", "isActive": "true", "asapStatus": "ASAPST_NA", "roleForExternalLink": "EL_NA", "ingressVlanId": "NA", "egressVlanId": "NA", "ingressSVlanId": "NA", "egressSVlanId": "NA", "signalType": "OTU4", "portSide": "LINE", "circuitPackName": "112SCX10", "operationalMode": "NA", "displayEdgeOnNe": "left", "directionality": "TD_BID", "has_loopback": "false", "portLoopbackType": "RELEASE", "has_matrixLoopbackForced": "false", "supportsTerminalLoopback": "true", "supportsMatrixLoopback": "false", "supportsLineLoopback": "false", "supportsFacilityLoopback": "true", "supportsForcedFacilityLoopback": "false", "supportsForcedTerminalLoopback": "false", "supportsForcedMatrixLoopback": "false", "supportsPayloadLoopback": "false", "ptpName": "112SCX10-1-14-L1", "pgExists": "false", "isCurrentRouteRD": "false", "tpAssociatedPorts": "", "position": { "col": "0", "row": "0" } }], "successfulCompletion": true, "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/routingDisplay
    to get Routing Details for given connection ID (routingDisplayById : /data/otn/connections/{id}/routingDisplay)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connections/{id}/routingDisplay_Amd
    to get Routing Details for given connection ID (routingDisplayById : /data/otn/connections/{id}/routingDisplay_Amd)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/rctemplates/saveas
    save a new template (saveAsRCTemplate : /data/otn/rctemplates/saveas)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj RCTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/txtemplates/saveas
    save as new template (saveAsTXTemplate : /data/otn/txtemplates/saveas)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required sendingObj TXTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/serverHierarchy
    to get server Hierarchy details for given connection Id (serverHierarchyById : /data/otn/connection/{id}/serverHierarchy)
    returns server hierarchy information for given connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/439/serverHierarchy

    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
    { reqCompletionStatus: 0, requestId: 0, clientName: null, clientLocation: null, clientUser: null, sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, nextTasks: null, items: [{ className: "physicalLink", id: "245", key: "physicalLink/245", guiLabel: "OTS-TEST", vsClientState: "VSCS_NOT_APPLICABLE", vsClientId: -1, connectionType: "physicalLink", receivedDate: "2016-04-13T04:58:07Z", orderId: "297", groupOrderId: "0", groupOrderType: "GOT_NA", connectionAlias: "OTS-TEST", orderStep: "CST_IN_EFFECT", stepState: "SSTATE_COMPLETED", orderType: "OT_DISCOVERED", layerRate: "OS", effectiveRate: "OS", displayProtectionType: "DPT_UN_PROTECTED", protectionRole: "PR_NA", state: "CST_IN_EFFECT", operationalState: "Enabled", category: "CC_NA", alarmEnabling: "Not Set", alarmState: "Cleared", alarmSeverity: "Cleared", TCMEnabled: "TCM_STATUS_NA", TCMASAPEnabled: "TCM_STATUS_NA", frequency: "N/A", orderNumber: "DV280", customerName: "None", serviceState: "ServiceState_NA", provisionableWavekey: "N/A", a1NeName: "NODE_1", a1PortName: "4DPA4-21-15-L1", z1NeName: "NODE_2", z1PortName: "4DPA4-21-15-L2", a1NodeName: "NODE_1", z1NodeName: "NODE_2", aNodeId: 3, zNodeId: 5, a2NodeId: 0, z2NodeId: 0, aPortLabel: "NODE_1/4DPA4-21-15-L1", zPortLabel: "NODE_2/4DPA4-21-15-L2", pm24hour: "NotEnabled", pm15min: "NotEnabled", nprTlId: "24", sdhConnectionId: "-1", sdhClientId: "-1", isUsedInSdh: "false", fdn: "20/245", mismatchType: "NA", clientRouteState: "NA", createdBy: "CB_NPR", inconsistentMismatchType: "", inconsistentAcknowledgedBy: "", inconsistentEventDate: "", inconsistentAckDate: "", isL0CRRD: "false", isCurrentRouteRD: "false", aportLabel: "NODE_1/4DPA4-21-15-L1", zportLabel: "NODE_2/4DPA4-21-15-L2", tcmenabled: "TCM_STATUS_NA", tcmasapenabled: "TCM_STATUS_NA" }], data: null, successfulCompletion: false, failedCompletion: false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/server
    to get server details for given connection Id (serversById : /data/otn/connection/{id}/server)
    returns server information for given connection Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/439/server

    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
    { "reqCompletionStatus": 0 "requestId": 0 "clientName": null "clientLocation": null "clientUser": null "sessionId": "" "mdcId": null "sequenceNum": 0 "moreToCome": false "messages": [0] "errcde": null "errorParams": null "nextTasks": null "items": [0] "data": null "successfulCompletion": false "failedCompletion": false }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/{id}/service
    To Enable or Disable Service State for specified Connection ID (serviceConnection : /data/otn/connections/{id}/service)
    Enables or Disables Service State for Specified Connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be obtained from '/data/otn/connections' REST call as id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---
    Query parameters

    Name

    IsRequired

    Description

    orderNumber required ---
    orderId required ---
    type required ---
    connName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    /oms1350/data/otn/connections/1719/service?orderNumber=A2548&orderId=3315&type=EnableServiceState&connName=Node_202_29/11DPM12-6-15-C2%20ENE-2/OTU1-PORT%20OTU1

    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
    { "message": "Modify Order Parameters action for order A2548 and connection Node_202_29/11DPM12-6-15-C2 ENE-2/OTU1-PORT OTU1 completed successfully.", "messageId": "OH1015I", "messageSeverity": "I", "status": "SUCCESS", "connectionName": "Node_202_29/11DPM12-6-15-C2 ENE-2/OTU1-PORT OTU1", "connectionId": -1, "orderNumber": "", "orderId": "", "orderStep": 0, "errorField": "", "errorValue": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connections/setLatency
    to set the latency on connections and its clients (setConnectionLatency : /data/otn/connections/setLatency)
    setConnectionLatency

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required connLatencyInfo ConnLatencySetReqResp ---

    Return type
  • ConnLatencySetReqResp
  • Responses

    Response Messages

    Schema

    200success ConnLatencySetReqResp
    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/otn/connections/setLatency { "connLatencyInfo": [{ "connectionId": 7, "latency": 9 },{ "connectionId": 3, "latency":2 }] }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    Response: { "connLatencyInfo": [{ "connectionId": 7, "latency": 9 }, { "connectionId": 3, "latency": 2 }], "status": "SUCCESS", "errorMessage": "" }

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/{id}
    to set olc state on particular entity other than connection (setOLCState : /data/otn/olcState/{id})
    Note: id value is same as connid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id is retrieved based on the type of entity. for connection /data/otn/connection , and for physicalConn /data/npr/Connection ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newValue required ---
    objectType required ---
    userLabel optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    post /data/otn/olcState/{id}
    to set olc state on particular entity other than connection (setOLCState : /data/otn/olcState/{id}_9)
    Note: id value is same as connid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id is retrieved based on the type of entity. for connection /data/otn/connection , and for physicalConn /data/npr/Connection ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newValue required ---
    objectType required ---
    userLabel optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    put /data/otn/connection/{id}/olcState
    to set olc state on particular connection (setOLCStateForConns : /data/otn/connection/{id}/olcState)
    Note: id value is same as connid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id is retrieved based on the type of entity. for connection /data/otn/connection , and for physicalConn /data/npr/Connection ---
    Query parameters

    Name

    IsRequired

    Description

    newValue required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    post /data/otn/connection/{id}/olcState
    to set olc state on particular connection (setOLCStateForConns : /data/otn/connection/{id}/olcState_1)
    Note: id value is same as connid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id is retrieved based on the type of entity. for connection /data/otn/connection , and for physicalConn /data/npr/Connection ---
    Query parameters

    Name

    IsRequired

    Description

    newValue required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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 :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • get : /data/npr/{table}

  • Operation

    put /data/otn/olcState
    to set OLC State for a list of entities (setOLCStateForEntityList : /data/otn/olcState)
    Note:

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req body contains the complete list of entities and its information OlcStateRequestList ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    post /data/otn/olcState
    to set OLC State for a list of entities (setOLCStateForEntityList : /data/otn/olcState_3)
    Note:

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req body contains the complete list of entities and its information OlcStateRequestList ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    put /data/otn/olcState/hierarchy
    to set the OLCState for object and its decendents. If the value is InService, it can be used to clear stale data from the OLCState DB (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/hierarchy)
    Note: Only works for objects currently in Maintenance. Avoid use of olcState/hierarchy (deprecated)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    post /data/otn/olcState/hierarchy
    to set the OLCState for object and its decendents. If the value is InService, it can be used to clear stale data from the OLCState DB (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/hierarchy_6)
    Note: Only works for objects currently in Maintenance. Avoid use of olcState/hierarchy (deprecated)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    put /data/otn/olcState/selfAndDescendents
    to set the OLCState for object and its decendents. If the value is InService, it can be used to clear stale data from the OLCState DB (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/selfAndDescendents)
    Note: Only works for objects currently in Maintenance. Avoid use of olcState/hierarchy (deprecated)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

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

    post /data/otn/olcState/selfAndDescendents
    to set the OLCState for object and its decendents. If the value is InService, it can be used to clear stale data from the OLCState DB (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/selfAndDescendents_7)
    Note: Only works for objects currently in Maintenance. Avoid use of olcState/hierarchy (deprecated)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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/otn/connections/{id}/tcm/createTCMInfo
    To get Tandem Connection Monitoring(TCM) create list for given connection id (showTCMCreatelist : /data/otn/connections/{id}/tcm/createTCMInfo)
    showTCMCreatelist REST call will be called while creating TCM connection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be retrieved as 'id' from the REST call '/data/otn/connections' ---

    Return type
  • OtnTCMCreateInfoResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connections/2730/tcm/createTCMInfo

    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
    { "connectionId": "2730" "connectionName": "11DPM-Y-Infra1" "level": "2" "position": "1" "fromPortId": null "toPortId": null "fromNE": null "toNE": null "profileName": "ODU2TCM" "alarmEnabling": "Enabled" "a1NodeName": "OTNBA-TEST-NODE-02" "a2NodeName": null "z1NodeName": "OTNBA-TEST-NODE-03" "z2NodeName": null "a1PortName": "11DPM12-4-3-L1-1" "z1PortName": "11DPM12-3-4-L2-1" "a2PortName": null "z2PortName": null "pm15MinuteCollectionType": "No" "pm24HourCollectionType": "No" "pm15MinuteMonitoringSelection": null "pm24HourMonitoringSelection": null "pm15MinuteDirection": null "pm24HourDirection": null "pm15MinuteReportInfo": "CSV 2 Hr" "pm24HourReportInfo": "CSV 24 Hr" "pm15MinuteDataPurgePolicy": "Keep PM Data upon Connection Deletion" "pm24HourDataPurgePolicy": "Keep PM Data upon Connection Deletion" "transParams": null }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections
  • createTCM : /data/otn/connections/{id}/tcm/createTCM

  • Operation

    get /data/otn/connections/{id}/tcm/showTCMTP/{source}
    To get Tandem Connection Monitoring(TCM) TP using the connection id (showTCMTP : /data/otn/connections/{id}/tcm/showTCMTP/{source})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required connection id can be retrieved as 'id' '/data/otn/connections' ---
    source required source: TCMTPListFromDB,TCMTPList,TCMTPListFromNE ---

    Return type
  • TCMTPListJSONResponse
  • Responses

    Response Messages

    Schema

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

    /oms1350/data/otn/connections/2730/tcm/showTCMTP/TCMTPList

    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
    { "message": "Command Accepted" "messageId": "I18N_COMMAND_ACCEPTED" "messageSeverity": "I" "status": "SUCCESS" "items": [0] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/networkslice/connections/{connectionId}/unassignSlice
    Unassign sliceId from a Connection (unAssignNetworkSliceFromConnection : /data/otn/networkslice/connections/{connectionId}/unassignSlice)
    unAssignNetworkSliceFromConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectionId required connectionId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req NetworkSliceReqResp ---

    Return type
  • NetworkSliceReqResp
  • Responses

    Response Messages

    Schema

    200success NetworkSliceReqResp
    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/otn/networkslice/connections/{connectionId}/unassignSlice --> /data/otn/networkslice/connections/62/unassignSlice { "sliceId" : "sliceName" }

    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: { "sliceId": "sliceName", "entityId": 62, "entityType": 1, "status": "SUCCESS", "errorMessage": null }

    External Docs
    See Also :

    Operation

    post /data/otn/connection/{connectIds}/asap
    updates Alarm Severity Assignment Profile(ASAP) for given connection ID (updateAsap : /data/otn/connection/{connectIds}/asap)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectIds required connectId can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnAsapConnectionRequest ---

    Return type
  • OtnAsapConnectionResponse
  • Responses

    Response Messages

    Schema

    200success OtnAsapConnectionResponse
    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/otn/connection/1908/asap {"asapName":"default ASAP","asapId":0}

    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": "0", "responseMessage": "", "responseList": null, "HTTPResponse": 200, "httpResponse": 200, "satus": true, "message": "" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    put /data/otn/olcState/fdn
    updateFdn (updateFdn : /data/otn/olcState/fdn)
    updateFdn

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/fdn
    updateFdn (updateFdn : /data/otn/olcState/fdn_4)
    updateFdn

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/fdnAndUserLabel
    updateFdnAndUserLabel (updateFdnAndUserLabel : /data/otn/olcState/fdnAndUserLabel)
    updateFdnAndUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/fdnAndUserLabel
    updateFdnAndUserLabel (updateFdnAndUserLabel : /data/otn/olcState/fdnAndUserLabel_5)
    updateFdnAndUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    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.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/trail/{connectionIds}/linkUtilization
    updates Link Utilization Threshold for given connection IDs (updateLinkUtilizationThreshold : /data/otn/trail/{connectionIds}/linkUtilization)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectionIds required connectId can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnUpdateLinkUtilizationThresholdRequest ---

    Return type
  • OtnUpdateLinkUtilizationThresholdResponse
  • Responses

    Response Messages

    Schema

    200success OtnUpdateLinkUtilizationThresholdResponse
    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

    /oms1350/data/otn/trail/1093/linkUtilization {"Tag":"updatelinkUtilProfile","id":"","linkUtilProfile":"LOW","trail_length":1,"trail_0_className":"lopc","trail_0_id":"1093","trail_0_key":"lopc/1093","trail_0_guiLabel":"VS-LL-1","trail_0_vsClientState":"VSCS_UNTERMINATED","trail_0_vsClientId":1095,"trail_0_connectionType":"lopc","trail_0_receivedDate":"2019-08-20T10:50:23Z","trail_0_orderId":"2749","trail_0_groupOrderId":"1092","trail_0_groupOrderType":"GOT_CLNT_AND_SERVERS_PROV","trail_0_groupOrderName":"g-VS-LL-1","trail_0_connectionAlias":"VS-LL-1","trail_0_orderStep":"CST_IN_EFFECT","trail_0_stepState":"SSTATE_COMPLETED","trail_0_orderType":"OT_ADD","trail_0_layerRate":"ODU4","trail_0_effectiveRate":"ODU4","trail_0_displayProtectionType":"DPT_UN_PROTECTED","trail_0_protectionRole":"PR_NA","trail_0_state":"CST_IN_EFFECT","trail_0_operationalState":"Down","trail_0_category":"CC_MANAGED_PLANE","trail_0_alarmEnabling":"Not Set","trail_0_alarmState":"Cleared","trail_0_alarmSeverity":"Cleared","trail_0_serverAlmState":"Major","trail_0_TCMEnabled":"TCM_STATUS_NA","trail_0_TCMASAPEnabled":"TCM_STATUS_NA","trail_0_nmlASAPName":"default ASAP","trail_0_frequency":"N/A","trail_0_orderNumber":"A1512","trail_0_customerName":"","trail_0_serviceState":"ServiceState_ON","trail_0_provisionableWavekey":"keyed","trail_0_a1NeName":"PSS-10.41.55.158","trail_0_a1PortName":"OTUODU4-5-7-L1","trail_0_z1NeName":"PSS-10.41.55.159","trail_0_z1PortName":"OTUODU4-4-7-L1","trail_0_a2NeName":"","trail_0_z2NeName":"","trail_0_a1NodeName":"PSS-10.41.55.158","trail_0_z1NodeName":"PSS-10.41.55.159","trail_0_aNodeId":44,"trail_0_zNodeId":43,"trail_0_a2NodeId":0,"trail_0_z2NodeId":0,"trail_0_aPortId":445905,"trail_0_zPortId":445674,"trail_0_a2PortId":0,"trail_0_z2PortId":0,"trail_0_aPortLabel":"PSS-10.41.55.158/OTUODU4-5-7-L1","trail_0_zPortLabel":"PSS-10.41.55.159/OTUODU4-4-7-L1","trail_0_a1NodeAndPort":"PSS-10.41.55.158/OTUODU4-5-7-L1","trail_0_z1NodeAndPort":"PSS-10.41.55.159/OTUODU4-4-7-L1","trail_0_pm24hour":"NotEnabled","trail_0_pm15min":"NotEnabled","trail_0_nimEnabled":"N/A","trail_0_linkUtilRatio":100,"trail_0_linkUtilThreshold":"55","trail_0_isPMSupported":"Required","trail_0_connectionDirection":"CD_BID","trail_0_is3rdPartyLink":"false","trail_0_thirdPartyName":"","trail_0_thirdPartyDesc":"","trail_0_nprTlId":"0","trail_0_sdhConnectionId":"-1","trail_0_sdhClientId":"-1","trail_0_isUsedInSdh":"false","trail_0_fdn":"1/1093","trail_0_mismatchType":"NA","trail_0_clientRouteState":"NA","trail_0_createdBy":"CB_USER","trail_0_endpoints":2,"trail_0_inconsistentMismatchType":"","trail_0_inconsistentAcknowledgedBy":"","trail_0_inconsistentEventDate":"","trail_0_inconsistentAckDate":"","trail_0_isL0CRRD":"false","trail_0_isCurrentRouteRD":"false","trail_0_serverConnId":0,"trail_0_serverConnectionCategory":"CC_NA","trail_0_isSlteSupported":"false","trail_0_isOtdrSupported":"false","trail_0_allowAsonResources":"No","trail_0_switchCapability":"0","trail_0_scId":"N/A","trail_0_associatednprtlid":0,"trail_0_encoding":"N/A","trail_0_autoInService":"N/A","trail_0_autoInServiceTimer":"N/A","trail_0_lineGranularity":0,"trail_0_containerType":"odu4","trail_0_singleFiberChannelPlan":"N/A","trail_0_olcState":"OlcState_InService","trail_0_npaUserLabel":"","trail_0_spectrumWidth":"","trail_0_revertiveMode":"RevertiveMode_NA","trail_0_isEline":"No","trail_0_aportLabel":"PSS-10.41.55.158/OTUODU4-5-7-L1","trail_0_zportLabel":"PSS-10.41.55.159/OTUODU4-4-7-L1","trail_0_tcmenabled":"TCM_STATUS_NA","trail_0_tcmasapenabled":"TCM_STATUS_NA","trail_0_npauserLabel":""}

    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":"0","responseMessage":"","responseList":null,"HTTPResponse":200,"httpResponse":200,"satus":true,"message":""}

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connection/renameConnection/
    To rename connection name or alias (updateNetworkConnectionNameAndAlias : /data/otn/connection/renameConnection/)
    Rename Connection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req RenameConnectionRequest ---
    Query parameters

    Name

    IsRequired

    Description

    isAutoGenConnName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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/otn/connection/renameConnection/{connId}
    To rename connection name or alias (updateNetworkConnectionNameAndAlias : /data/otn/connection/renameConnection/{connId})
    Rename Connection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req RenameConnectionRequest ---
    Query parameters

    Name

    IsRequired

    Description

    isAutoGenConnName optional ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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

    put /data/otn/olcState/userLabel
    to update the userLabel of olc state record (updateUserLabel : /data/otn/olcState/userLabel)
    ;

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

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

    post /data/otn/olcState/userLabel
    to update the userLabel of olc state record (updateUserLabel : /data/otn/olcState/userLabel_8)
    ;

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • application/xml
    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/otn/ports/{id}/wlt/{dir}/viewDetails
    to get optical power details for given connection & in given direction (viewDetails : /data/otn/ports/{id}/wlt/{dir}/viewDetails)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call as id ---
    dir required allowableValues: ZA,AZ ---

    Return type
  • OtnWltDetailsResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/ports/21/wlt/ZA/viewDetails

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { tpId: "21", ptpId: null, neId: "16", neName: "MRN-06-SITE2#OCS", portName: "OCH-1-1-43-1", ptpName: null, direction: "Z-A", channelId: "", frequency: "", tpRate: "20", expectedPower: "-0.3", expectedPowerDeviation: "-0.3", wavekey1: "", wavekey2: "", measuredPower: "WLTNoPower", connectionName: "", gain: null, minGain: null, maxGain: null, wtdType: "N/A", status: "SUCCESS", message: null, messageId: "", messageSeverity: "I" }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/port/wlt2/modifyDetails
    wlt2modifyPortDetails (wlt2modifyPortDetails : /data/otn/port/wlt2/modifyDetails)
    wlt2modifyPortDetails

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnWltDetailsRequest ---

    Return type
  • DeferredResult«Otn connection Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn connection Response»
    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/otn/connection/{id}/wlt2/currRouteLayout
    get layout for bidirection connection WLT display (wlt2retrieveCurrentRouteLayout : /data/otn/connection/{id}/wlt2/currRouteLayout)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    otuObjString required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    Query parameters

    Name

    IsRequired

    Description

    startingNe optional ---

    Return type
  • WLT Response
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/wlt2/layout
    get layout for bidirection connection WLT display (wlt2retrieveLayout : /data/otn/connection/{id}/wlt2/layout)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    Query parameters

    Name

    IsRequired

    Description

    startingNe optional ---
    oduNcId optional ---
    currentRouteIdList optional ---

    Return type
  • WLT Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/542/wlt2/layout

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { message: "", messageId: "", messageSeverity: "", status: "SUCCESS", connectionName: "112SDX11-INFRA", connectionId: 542, rate: "ODU4", isProtected: true, protectionType: "DPT_SNC_N", serviceAZ: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437075, tpName: "OCH-1-1-37-1", rate: "OS", tpShortName: "1/1/37-1", xfpName: "", cardName: "130SCUPH", direction: "IN", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "OUT", power: null }], ncName: "", ncId: -1 } }], serviceZA: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437075, tpName: "OCH-1-1-37-1", rate: "OS", tpShortName: "1/1/37-1", xfpName: "", cardName: "130SCUPH", direction: "OUT", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "IN", power: null }], ncName: "", ncId: -1 } }], protectAZ: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437067, tpName: "OCH-1-1-38-1", rate: "OS", tpShortName: "1/1/38-1", xfpName: "", cardName: "130SCUPC", direction: "IN", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "OUT", power: null }], ncName: "", ncId: -1 } }], protectZA: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437067, tpName: "OCH-1-1-38-1", rate: "OS", tpShortName: "1/1/38-1", xfpName: "", cardName: "130SCUPC", direction: "OUT", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "IN", power: null }], ncName: "", ncId: -1 } }] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/port/{id}/wlt2/viewDetails
    wlt2retrievePortDetails (wlt2retrievePortDetails : /data/otn/port/{id}/wlt2/viewDetails)
    wlt2retrievePortDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional ne Wlt2_SignalPathContainer ---

    Return type
  • DeferredResult«OtnWltDetailsResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnWltDetailsResponse»
    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/otn/connection/{id}/wlt2/power
    get power data for both AZ and ZA service connection of WLT display (wlt2retrievePower : /data/otn/connection/{id}/wlt2/power)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---

    Return type
  • WLT Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/542/wlt2/power

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Payload can be retrieved from /data/otn/connection/{id}/wlt2/layout { message: "", messageId: "", messageSeverity: "", status: "SUCCESS", connectionName: "112SDX11-INFRA", connectionId: 542, rate: "ODU4", isProtected: true, protectionType: "DPT_SNC_N", serviceAZ: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437075, tpName: "OCH-1-1-37-1", rate: "OS", tpShortName: "1/1/37-1", xfpName: "", cardName: "130SCUPH", direction: "IN", power: { hasMeasuredPower: false, measPower: null, expectedPowerMeasure: null, expectedPowerDeviation: null, hasTotalPower: false, totalPower: null, hasWavekeys: false, wavekey1: null, wavekey2: null, powerManagementType: "Manual", osnrValue: "", onsrValue: null } }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "OUT", power: { hasMeasuredPower: false, measPower: null, expectedPowerMeasure: null, expectedPowerDeviation: null, hasTotalPower: false, totalPower: null, hasWavekeys: false, wavekey1: null, wavekey2: null, powerManagementType: "", osnrValue: "", onsrValue: null } }], ncName: "", ncId: -1 } }], serviceZA: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437075, tpName: "OCH-1-1-37-1", rate: "OS", tpShortName: "1/1/37-1", xfpName: "", cardName: "130SCUPH", direction: "OUT", power: { hasMeasuredPower: false, measPower: null, expectedPowerMeasure: "0", expectedPowerDeviation: null, hasTotalPower: false, totalPower: null, hasWavekeys: false, wavekey1: null, wavekey2: null, powerManagementType: "Manual", osnrValue: "", onsrValue: null } }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "IN", power: { hasMeasuredPower: false, measPower: null, expectedPowerMeasure: null, expectedPowerDeviation: null, hasTotalPower: false, totalPower: null, hasWavekeys: false, wavekey1: null, wavekey2: null, powerManagementType: "", osnrValue: "", onsrValue: null } }], ncName: "", ncId: -1 } }], protectAZ: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437067, tpName: "OCH-1-1-38-1", rate: "OS", tpShortName: "1/1/38-1", xfpName: "", cardName: "130SCUPC", direction: "IN", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "OUT", power: null }], ncName: "", ncId: -1 } }], protectZA: [{ isLinkOTS: false, otu: null, isNE: true, ne: { neName: "Compound-node-02#OCS", neId: 47, neModel: "1830PSS", isBBOX: false, isCommunicating: true, frequency: "", tp: [{ tpId: 437067, tpName: "OCH-1-1-38-1", rate: "OS", tpShortName: "1/1/38-1", xfpName: "", cardName: "130SCUPC", direction: "OUT", power: null }, { tpId: 437038, tpName: "OCH-1-1-3-1", rate: "OS", tpShortName: "1/1/3-1", xfpName: "", cardName: "1XANY100G", direction: "IN", power: null }], ncName: "", ncId: -1 } }] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /data/otn/connection/{id}/wlt2/protected/power/{direction}
    get power data for either AZ or ZA protected connection WLT display (wlt2retrieveProtectedPower : /data/otn/connection/{id}/wlt2/protected/power/{direction})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id can be retrieved from '/data/otn/connections' REST call for specified connection as 'id' ---
    direction required Direction: AZ, ZA ---

    Return type
  • WLT Response
  • Responses

    Response Messages

    Schema

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

    /data/otn/connection/542/wlt2/protected/power/AZ PayLoad: { "message": "", "messageId": "", "messageSeverity": "", "status": "SUCCESS", "connectionName": "112SDX11-INFRA", "connectionId": 542, "rate": "ODU4", "isProtected": true, "protectionType": "DPT_SNC_N", "serviceAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "serviceZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }], "protectAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "protectZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -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.
    • */*
    Example Response Data
    { "message": "", "messageId": "", "messageSeverity": "", "status": "SUCCESS", "connectionName": "112SDX11-INFRA", "connectionId": 542, "rate": "ODU4", "isProtected": true, "protectionType": "DPT_SNC_N", "serviceAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "serviceZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }], "protectAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "IN", "power": { "hasMeasuredPower": false, "measPower": null, "expectedPowerMeasure": null, "expectedPowerDeviation": null, "hasTotalPower": false, "totalPower": null, "hasWavekeys": false, "wavekey1": null, "wavekey2": null, "powerManagementType": "Manual", "osnrValue": "", "onsrValue": null } }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": { "hasMeasuredPower": false, "measPower": null, "expectedPowerMeasure": null, "expectedPowerDeviation": null, "hasTotalPower": false, "totalPower": null, "hasWavekeys": false, "wavekey1": null, "wavekey2": null, "powerManagementType": "", "osnrValue": "", "onsrValue": null } }], "ncName": "", "ncId": -1 } }], "protectZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /data/otn/connection/{id}/wlt2/protected/power/{direction}
    wlt2retrieveProtectedPower (wlt2retrieveProtectedPower : /data/otn/connection/{id}/wlt2/protected/power/{direction}_2)
    wlt2retrieveProtectedPower

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    direction required direction ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional layout WLT Response ---

    Return type
  • DeferredResult«WLT Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«WLT Response»
    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/otn/connection/{id}/wlt2/service/power/{direction}
    wlt2retrieveServicePower (wlt2retrieveServicePower : /data/otn/connection/{id}/wlt2/service/power/{direction})
    wlt2retrieveServicePower

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    direction required direction ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional layout WLT Response ---

    Return type
  • DeferredResult«WLT Response»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«WLT Response»
    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

    /oms1350/data/otn/connection/542/wlt2/service/power/AZ PayLoad: { "message": "", "messageId": "", "messageSeverity": "", "status": "SUCCESS", "connectionName": "112SDX11-INFRA", "connectionId": 542, "rate": "ODU4", "isProtected": true, "protectionType": "DPT_SNC_N", "serviceAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "serviceZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }], "protectAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "protectZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -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.
    • */*
    Example Response Data
    { "message": "", "messageId": "", "messageSeverity": "", "status": "SUCCESS", "connectionName": "112SDX11-INFRA", "connectionId": 542, "rate": "ODU4", "isProtected": true, "protectionType": "DPT_SNC_N", "serviceAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "IN", "power": { "hasMeasuredPower": false, "measPower": null, "expectedPowerMeasure": null, "expectedPowerDeviation": null, "hasTotalPower": false, "totalPower": null, "hasWavekeys": false, "wavekey1": null, "wavekey2": null, "powerManagementType": "Manual", "osnrValue": "", "onsrValue": null } }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": { "hasMeasuredPower": false, "measPower": null, "expectedPowerMeasure": null, "expectedPowerDeviation": null, "hasTotalPower": false, "totalPower": null, "hasWavekeys": false, "wavekey1": null, "wavekey2": null, "powerManagementType": "", "osnrValue": "", "onsrValue": null } }], "ncName": "", "ncId": -1 } }], "serviceZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437075, "tpName": "OCH-1-1-37-1", "rate": "OS", "tpShortName": "1/1/37-1", "xfpName": "", "cardName": "130SCUPH", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }], "protectAZ": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "IN", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "OUT", "power": null }], "ncName": "", "ncId": -1 } }], "protectZA": [{ "isLinkOTS": false, "otu": null, "isNE": true, "ne": { "neName": "Compound-node-02#OCS", "neId": 47, "neModel": "1830PSS", "isBBOX": false, "isCommunicating": true, "frequency": "", "tp": [{ "tpId": 437067, "tpName": "OCH-1-1-38-1", "rate": "OS", "tpShortName": "1/1/38-1", "xfpName": "", "cardName": "130SCUPC", "direction": "OUT", "power": null }, { "tpId": 437038, "tpName": "OCH-1-1-3-1", "rate": "OS", "tpShortName": "1/1/3-1", "xfpName": "", "cardName": "1XANY100G", "direction": "IN", "power": null }], "ncName": "", "ncId": -1 } }] }

    External Docs
    See Also :

    AlarmInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks,unused field ---
    items array[HashMap«string,string»] HashMap«string,string» Retrieve the list of Alarms,attributes are sent as String in Name Value Pairs of a HashMap.

    Following fields are sent:
    1.severity : Valid Values - Major,Minor,Critical,Warning,Clear,Indeterminate

    2.node : Node name, Present in case of Elementary Alarm only

    3.alarmType : Type of Alarm,Valid Values - 1 for Elementary Alarm ,2 for Correlated Alarms

    4.fdnMapper : Fully distinguished Name,present in case of Elementary Alarms only

    5.ne : NE Name in a Compound Node,present in case of Elementary Alarms only

    6.alarmId : Valid Values - For Elementary Alarm EA_,Correlated Transmission Alarms CA_,Correlated Physical Alarms PHY_

    7.additionalInfo : ,,,,,,. Present in case of Elementary Alarm only

    8.id : Index of the Alarm in the List

    9.nativeProbCause : Native Probable Cause,present in case of Elementary Alarm only

    10.probCause : Probable Cause,present in case of Correlated Alarm only

    11.aid : Port/Slot in case of Elementary Alarm ,ConnectionName in case of Correlated Alarm

    12.timestamp : Alarm raise Time,Date and time in milliseconds

    13.objId : Indicates the corresponding Connection Id. For elementary alarms, this value will be 0 and for correlated alarms, the value will be the corresponding connection ID
    13.ackTime : Indicates time when Alarm was acknowledged/Unacknowledged.Value is NA for a new Alarm has never been Acked/Unacked. Date and time in milliseconds

    14.ackStatus : Indicates if an Alarm is Acknowledged/Not Acknowledged.

    15.ackUserName : Indicates the User who has Acknowledged/Unacknowledged the Alarm from AS GUI. Value is NA for a new Alarm which has never been Acked/Unacked.

    16.connectionType : Indicates the Connection Type in case of Correlated Alarms
    Valid Values - Path,Trail,Physical Connection,EML,Line Regenerator,NPA,Ethernet ERP,Ethernet Service,Ason Trail,External Physical Connection
    ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    AsonServerInfo

    Name

    Type

    Description

    Enum

    asonTccId Long long --- ---
    asonServerNcId Long long --- ---
    asonServerRole Integer integer --- ---
    asonUsedTimeslots String string --- ---

    BaseObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string ClassName ---
    id String string id ---
    key String string Key ---
    guiLabel String string GuiLabel ---
    parentId String string ParentId ---
    hasChildren String string HasChildren ---

    BasicNetworkElement

    Name

    Type

    Description

    Enum

    neId Long long --- ---
    neName String string --- ---
    neModel String string --- ---
    neSoftwareVersion String string --- ---
    nprNodeId Long long --- ---
    nprNodeName String string --- ---
    nprMEId Long long --- ---
    xosNeName String string --- ---
    id Long long --- ---

    BulkPMRequest

    Name

    Type

    Description

    Enum

    connectionid String string Connection id ---
    orderid String string Order id ---
    ordernumber String string Order number ---
    operation String string operation (Mandatory) [create, modifyroutepath , modifyroutetrail, addprotectionpath , addprotectiontrail, removeprotectionpath , removeprotectiontrail]
    pm15min String string PM15 min (Mandatory) [true, false]
    pmdata15 String string PM data 15 (Mandatory) [0(Keep PM Data upon Connection Deletion), 1 (Delete PM Data upon PM Stop), 2 (Delete PM Data upon Connection Deletion)]
    direction15 String string direction 15 (Mandatory) [0 (Unidirectional)]
    tpmonitor15 String string TP monitor 15 (Mandatory) [1(All) , 0(End Points only)]
    reportinfo15 String string report info15 (Mandatory) [1 (CSV 2 Hr), 0 (CSV 24Hr), 2 (No Report)]
    pm24hr String string PM 24 hr (Mandatory) [true, false]
    pmdata24 String string PM data 24(Mandatory) [0(Keep PM Data upon Connection Deletion), 1 (Delete PM Data upon PM Stop), 2 (Delete PM Data upon Connection Deletion)]
    direction24 String string direction 24(Mandatory) [0 (Unidirectional)]
    tpmonitor24 String string TP monitor 24(Mandatory) [1(All) , 0(End Points only)]
    reportinfo24 String string Report information 24(Mandatory) [0 (CSV 24Hr), 2 (No Report)]
    alarmEnable String string Alarm enable (Mandatory) [NOTSET, enable, disable]
    autoInService String string Auto in service (Mandatory) [enable, disable]
    autoInServiceTimer String string Auto in service timer (Mandatory) ---
    a1osnr String string A1 End OSNR Measurement [NOTSET, Enable, Disable]
    a2osnr String string A2 End OSNR Measurement [NOTSET, Enable, Disable]
    z1osnr String string Z1 End OSNR Measurement [NOTSET, Enable, Disable]
    z2osnr String string Z2 End OSNR Measurement [NOTSET, Enable, Disable]
    requestId Long long --- ---
    connectionName String string --- ---
    a1sigosnr String string A1 AHP AMP SIG Port OSNR Measurement [NOTSET, Enable, Disable]
    z1sigosnr String string Z1 AHP AMP SIG Port OSNR Measurement [NOTSET, Enable, Disable]

    Collection

    Name

    Type

    Description

    Enum

    ComputeLatencyJobInfo

    Name

    Type

    Description

    Enum

    jobId Long long --- ---
    taskId Long long --- ---
    requestId String string --- ---
    isValidUser Boolean boolean --- ---

    ComputeLatencyMeasurementResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    message String string --- ---
    computeLatencyJobInfo HashMap«long,ComputeLatencyJobInfo» HashMap«long,ComputeLatencyJobInfo» --- ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    ConnectionInputList

    Name

    Type

    Description

    Enum

    connectionIdList array[String] string --- ---
    connectionNameList array[String] string --- ---

    ConnectionInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    ConnectionObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    TCMEnabled String string --- ---
    TCMASAPEnabled String string --- ---
    aPortLabel String string --- ---
    zPortLabel String string --- ---
    TCMPMCollection15m String string --- ---
    TCMPMCollection24h String string --- ---
    isMainActiveL1CP String string --- ---
    isSpareActiveL1CP String string --- ---
    isAssignedPortOnNe Boolean boolean --- ---
    npaUserLabel String string --- ---
    lineModeProfile String string --- ---
    className String string ClassName ---
    id String string id ---
    key String string Key ---
    guiLabel String string GuiLabel ---
    parentId String string ParentId ---
    hasChildren String string HasChildren ---
    connectionId String string --- ---
    vsClientState String string --- ---
    vsClientId Long long --- ---
    connectionType String string --- ---
    receivedDate String string --- ---
    orderId String string --- ---
    groupOrderId String string --- ---
    groupOrderType String string --- ---
    groupOrderName String string --- ---
    connectionName String string --- ---
    omspConnectionName String string --- ---
    connectionAlias String string --- ---
    orderStep String string --- ---
    stepState String string --- ---
    orderType String string --- ---
    layerRate String string --- ---
    tpPrimaryRate String string --- ---
    effectiveRate String string --- ---
    protectionType String string --- ---
    displayProtectionType String string --- ---
    protectionRole String string --- ---
    state String string --- ---
    operationalState String string --- ---
    category String string --- ---
    alarmEnabling String string --- ---
    alarmState String string --- ---
    alarmSeverity String string --- ---
    serverAlmState String string --- ---
    nmlASAPName String string --- ---
    frequency String string --- ---
    orderNumber String string --- ---
    customerName String string --- ---
    serviceState String string --- ---
    provisionableWavekey String string --- ---
    a1NeName String string --- ---
    a1PortName String string --- ---
    z1NeName String string --- ---
    z1PortName String string --- ---
    a2NeName String string --- ---
    a2PortName String string --- ---
    z2NeName String string --- ---
    z2PortName String string --- ---
    a1NodeName String string --- ---
    z1NodeName String string --- ---
    a2NodeName String string --- ---
    z2NodeName String string --- ---
    aNodeId Long long --- ---
    zNodeId Long long --- ---
    a2NodeId Long long --- ---
    z2NodeId Long long --- ---
    aPortId Long long --- ---
    zPortId Long long --- ---
    a2PortId Long long --- ---
    z2PortId Long long --- ---
    azConnectionEndPorts array[Object] object --- ---
    a1NodeAndPort String string --- ---
    z1NodeAndPort String string --- ---
    a2NodeAndPort String string --- ---
    z2NodeAndPort String string --- ---
    pm24hour String string --- ---
    pm15min String string --- ---
    nimEnabled String string --- ---
    linkUtilProfile String string --- ---
    linkUtilRatio Long long --- ---
    linkUtilThreshold String string --- ---
    isPMSupported String string --- ---
    hasRouteComponent String string --- ---
    isOpticalRouteAvailable String string --- ---
    hasOpticalLayer String string --- ---
    hasUncommissionedServerPhysicalConnections String string --- ---
    connectionDirection String string --- ---
    commissioningStatus String string --- ---
    isRD String string --- ---
    is3rdPartyLink String string --- ---
    thirdPartyName String string --- ---
    thirdPartyDesc String string --- ---
    nprTlId String string --- ---
    sdhConnectionId String string --- ---
    sdhClientId String string --- ---
    isUsedInSdh String string --- ---
    fdn String string --- ---
    mismatchType String string --- ---
    clientRouteState String string --- ---
    createdBy String string --- ---
    mostRecentNote String string --- ---
    endpoints Integer integer --- ---
    inconsistentMismatchType String string --- ---
    inconsistentAcknowledgedBy String string --- ---
    inconsistentEventDate String string --- ---
    inconsistentAckDate String string --- ---
    size HashMap«string,string» HashMap«string,string» --- ---
    position HashMap«string,string» HashMap«string,string» --- ---
    assignedPortAddress String string --- ---
    assignedPortNeName String string --- ---
    isL0 String string --- ---
    isL1 String string --- ---
    isL0CRRD String string --- ---
    isCurrentRouteRD String string --- ---
    trailConnectionIdL0CR String string --- ---
    tpEffectiveRate String string --- ---
    timeSlots_numTotal String string --- ---
    timeSlots_numUsed String string --- ---
    timeSlots_numRsvd String string --- ---
    timeSlots_numFree String string --- ---
    timeSlots array[PayloadSlotObject] PayloadSlotObject --- ---
    serverConnId Long long --- ---
    serverConnectionCategory String string --- ---
    serverProtectionType String string --- ---
    serverConnectionRate String string --- ---
    portType String string --- ---
    edgeHoRelation String string --- ---
    portPrimaryState String string --- ---
    portSecondaryState String string --- ---
    connId Long long --- ---
    isSlteSupported String string --- ---
    isOtdrSupported String string --- ---
    allowAsonResources String string --- ---
    switchCapability String string --- ---
    scId String string --- ---
    band String string --- ---
    tsCount String string --- ---
    bandwidth String string --- ---
    gridtype String string --- ---
    associatednprtlid Integer integer --- ---
    protectionSummaryStatus String string --- ---
    inconsistentPgInfo String string --- ---
    aSwitchLocation String string --- ---
    aSwitchReason String string --- ---
    zSwitchLocation String string --- ---
    zSwitchReason String string --- ---
    networkHoldOffTime String string --- ---
    networkProtectedProtectionMethod String string --- ---
    networkProtectingProtectionMethod String string --- ---
    networkProtectionType String string --- ---
    networkReversionMode String string --- ---
    networkSignalDegrade String string --- ---
    networkWaitToRestoreTime String string --- ---
    networkSwitchMode String string --- ---
    clientHoldOffTime String string --- ---
    clientProtectedProtectionMethod String string --- ---
    clientProtectingProtectionMethod String string --- ---
    clientProtectionType String string --- ---
    clientReversionMode String string --- ---
    clientSignalDegrade String string --- ---
    clientWaitToRestoreTime String string --- ---
    clientSwitchMode String string --- ---
    encoding String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    omsClientId String string --- ---
    omsClientName String string --- ---
    lineGranularity Long long --- ---
    containerType String string --- ---
    opsaRevertiveMode String string --- ---
    opsaWaitToRestoreTime String string --- ---
    opsbRevertiveMode String string --- ---
    opsbWaitToRestoreTime String string --- ---
    baseLineValueOPT String string --- ---
    baseLineValueOPR String string --- ---
    transmitPower String string --- ---
    receivePower String string --- ---
    singleFiberChannelPlan String string --- ---
    olcState String string --- ---
    neModel String string --- ---
    switchableLayer String string --- ---
    externalEML String string --- ---
    spectrumWidth String string --- ---
    dmValue String string --- ---
    dmValueProtection String string --- ---
    dmTimestamp String string --- ---
    dmStatus String string --- ---
    revertiveMode String string --- ---
    isEline String string --- ---
    scheduledJobs String string --- ---
    lineModeProfileDescription String string --- ---
    mainActiveL1CP String string --- ---
    spareActiveL1CP String string --- ---
    lineModeProfileId String string --- ---

    Connections Response Header

    Name

    Type

    Description

    Enum

    originatorApp String string Originator App ---
    objectType String string Object Type ---
    objectScope String string Object Scope ---
    responseStatus String string Response Status ---
    fileGenerationTime String string File Generation Time ---
    errorCode String string Error Code ---
    errorReason String string Error Reason ---
    errorParams array[Map«string,string»] Map«string,string» Error Parameters ---

    ConnectionsResponseHeader

    Name

    Type

    Description

    Enum

    originatorApp String string Originator App ---
    objectType String string Object Type ---
    objectScope String string Object Scope ---
    responseStatus String string Response Status ---
    fileGenerationTime String string File Generation Time ---
    errorCode String string Error Code ---
    errorReason String string Error Reason ---
    errorParams array[Map«string,string»] Map«string,string» Error Parameters ---

    ConnLatencyInfo

    Name

    Type

    Description

    Enum

    connectionId Long long --- ---
    latency Long long --- ---

    ConnLatencySetReqResp

    Name

    Type

    Description

    Enum

    errorMessage String string --- ---
    connLatencyInfo array[ConnLatencyInfo] ConnLatencyInfo --- ---
    status String string --- ---

    CurrentRouteView

    Name

    Type

    Description

    Enum

    id Integer integer --- ---
    seqno Integer integer --- ---
    trailid Integer integer --- ---
    endToEndOtnTrailId Integer integer --- ---
    connectid Integer integer --- ---
    restype String string --- [ResourceType_main, ResourceType_mainSpare, ResourceType_none, ResourceType_spare, ResourceType_toBeReleased, ResourceType_legDependent, ResourceType_service, ResourceType_mainService, ResourceType_spareService, ResourceType_test]
    wdmfrequency String string --- ---
    timeslots String string --- ---
    mValue Integer integer --- ---
    aPortId Integer integer --- ---
    aportLabel String string --- ---
    zPortId Integer integer --- ---
    zportLabel String string --- ---
    otnMapper Integer integer --- ---
    wdmFrequency String string --- ---

    DeferredResult«Otn connection Response»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«Otn product information Response»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnSyncSwitchResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnWltDetailsResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«string»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«TPInventoryResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«WDM Response»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«WLT Response»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«Wlt2_DetailsResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    ElementaryAlarmInfo

    Name

    Type

    Description

    Enum

    tnAlrId String string --- ---
    neUserLabel String string --- ---
    neId Long long --- ---
    nprNodeId Long long --- ---
    nprNeId Long long --- ---
    nprNodeName String string --- ---
    tpNativeName String string --- ---
    eAlmProbCause String string --- ---
    eAlmProbCauseVal String string --- ---
    eAlmNativeProbCause String string --- ---
    eAlmRaiseTime Long long --- ---
    eAlmRaiseTimeStr String string --- ---
    eAlmSeverity Integer integer --- ---
    eSAStatus String string --- ---
    eAlmDetails String string --- ---
    eAsonSncName String string --- ---
    connId Long long --- ---
    nprTlid Long long --- ---
    crate Integer integer --- ---
    erate String string --- ---
    additionalInfo String string --- ---
    alarmRaiseNature String string --- ---
    thresholdValue String string --- ---
    monitorValue String string --- ---
    direction String string --- ---
    severityStr String string --- ---
    id Object object --- ---

    Entry«int,string»

    Name

    Type

    Description

    Enum

    key String string --- ---

    Entry«long,BasicNetworkElement»

    Name

    Type

    Description

    Enum

    key BasicNetworkElement BasicNetworkElement --- ---

    Entry«long,ElementaryAlarmInfo»

    Name

    Type

    Description

    Enum

    key ElementaryAlarmInfo ElementaryAlarmInfo --- ---

    Entry«long,List«AsonServerInfo»»

    Name

    Type

    Description

    Enum

    key array[AsonServerInfo] AsonServerInfo --- ---

    Entry«long,List«SlteLxDetails»»

    Name

    Type

    Description

    Enum

    key array[SlteLxDetails] SlteLxDetails --- ---

    Entry«long,long»

    Name

    Type

    Description

    Enum

    key Long long --- ---

    Entry«long,Network Connection»

    Name

    Type

    Description

    Enum

    key Network Connection Network Connection --- ---

    Entry«long,OduTrail»

    Name

    Type

    Description

    Enum

    key OduTrail OduTrail --- ---

    Entry«long,OtnPSEData»

    Name

    Type

    Description

    Enum

    key OtnPSEData OtnPSEData --- ---

    Entry«long,RouteComponent»

    Name

    Type

    Description

    Enum

    key RouteComponent RouteComponent --- ---

    Entry«long,RouteDetail»

    Name

    Type

    Description

    Enum

    key RouteDetail RouteDetail --- ---

    Entry«long,string»

    Name

    Type

    Description

    Enum

    key String string --- ---

    Entry«long,TP Data»

    Name

    Type

    Description

    Enum

    key TP Data TP Data --- ---

    Entry«string,int»

    Name

    Type

    Description

    Enum

    key Integer integer --- ---

    Entry«string,List«OTN Connection Provision Status»»

    Name

    Type

    Description

    Enum

    key array[OTN Connection Provision Status] OTN Connection Provision Status --- ---

    Entry«string,Map«string,string»»

    Name

    Type

    Description

    Enum

    key Object object --- ---

    Entry«string,Ptp2PtpRouteComponent»

    Name

    Type

    Description

    Enum

    key Ptp2PtpRouteComponent Ptp2PtpRouteComponent --- ---

    EPTAdapterInventoryReq

    Name

    Type

    Description

    Enum

    ntwkDataFileName String string --- ---
    operationType String string --- ---
    constraintType String string --- ---
    constraintIdList array[Long] long --- ---

    EPTAdapterInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    HashMap

    Name

    Type

    Description

    Enum

    HashMap«long,ComputeLatencyJobInfo»

    Name

    Type

    Description

    Enum

    HashMap«long,int»

    Name

    Type

    Description

    Enum

    HashMap«string,object»

    Name

    Type

    Description

    Enum

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    HaStatus

    Name

    Type

    Description

    Enum

    status String string --- ---

    HierarchicalConnectionDataJSON

    Name

    Type

    Description

    Enum

    name String string Name ---
    connId String string Connection Id ---
    alarmSeverity String string Alaram Severity ---
    children array[HierarchicalConnectionDataJSON] HierarchicalConnectionDataJSON -- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    InternalConnectionReq

    Name

    Type

    Description

    Enum

    vaPort String string For VA port Enum VA1 VA2 ; For mvac Port- Blank entry ---
    mvacPort String string MVAC Port: For MVAC card Enum G1 G2 ; For VA port - Blank Entry ---
    connectionName String string Connection Name-Blank ---
    serviceRate String string Service Rate: Rates which are specified for specific card.
    Ex: For 11QPA4: OC-192, STM-64, 10GbE, OTU2, FC1200, FC800, DDR
    ---
    tid String string Tid: nodeName of nodeId for which toPort and fromPort are retrieved ---
    fromport1 String string From Port-1 can be retrieved from '/data/npr/{table}' (table=wdmPorts) REST call as displayLabel
    For specific node can be filtered- Ex: '/data/npr/wdmPorts?nodeId=43'
    ---
    toport1 String string To Port-1 can be retrieved from '/data/npr/{table}' (table=wdmPorts) REST call as displayLabel
    For specific node can be filtered - Ex: '/data/npr/wdmPorts?nodeId=43'
    ---
    toport2 String string To Port-2: Blank ---
    crossRegenPort String string Cross Regeneration Port-Blank ---
    protectionPort String string Protection Port: Not Mandatory ---
    xhrConnectionType String string Connection Direction ---

    InternalConnectionRsp

    Name

    Type

    Description

    Enum

    message String string Message: completion or error message for request ---
    opStatus String string Operation Status-Status about Connection Creation: SUCCESS/ERROR ---
    connectionId String string Connection Id ---
    connectionName String string Connection Name ---
    failed String string Status about Connection Creation: SUCCESS/ERROR ---

    LatencyMeasurementData

    Name

    Type

    Description

    Enum

    connectionId String string --- ---
    connectionName String string --- ---
    actualLatencyWorking String string --- ---
    actualLatencyProtection String string --- ---
    latencyTimestamp String string --- ---
    latencyValue String string --- ---

    LatencyMeasurment Response

    Name

    Type

    Description

    Enum

    identifier String string Identifer attribute ---
    items array[LatencyMeasurementData] LatencyMeasurementData LatencyMeasurment Data ---
    status String string Status attribute ---

    LineModeProfileData

    Name

    Type

    Description

    Enum

    lineModeProfileId String string Specifies lineModeProfileId ---
    payloadRate String string payloadRate ---
    baudRate String string Specifies the baudRate ---
    encoding String string Specifies the encoding ---
    fecType String string Specifies fecType ---
    phasenc String string Specifies phasenc ---
    clotuType String string Specifies clotuType ---
    txShape String string Specifies txShape ---
    trackPolar String string Specifies trackPolar ---
    linemodedescription String string Specifies description ---
    linemodename String string Specifies name ---
    className String string Specifies the ClassName as 'lineModeProfile' ---
    id String string Specifies the id ---
    key String string Specifies the key ---
    guiLabel String string Specifies the gui label ---

    LLDPResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    Nbi IOO Pm Request

    Name

    Type

    Description

    Enum

    startDate String string --- ---
    endDate String string --- ---
    startBin String string --- ---
    endBin String string --- ---
    granularity String string --- ---
    neList array[String] string --- ---

    Nbi switch Data Response

    Name

    Type

    Description

    Enum

    message String string Message ---
    status String string Status ---
    invariantConnId String string Data ---
    connId String string ConnectionID ---
    listOfAsonIds Collection Collection List of Ason Id's ---

    NbiPmFtpResponseData

    Name

    Type

    Description

    Enum

    ok Boolean boolean --- ---
    id String string --- ---
    responseStatus String string --- ---
    responseMessage String string --- ---
    fileNameAndLocation String string --- ---

    Network Connection

    Name

    Type

    Description

    Enum

    SwitchCapability String string --- ---
    id Long long --- ---
    userLabel String string --- ---
    objectClass String string --- ---
    name String string --- ---
    alias String string --- ---
    a1TPData TP Data TP Data --- ---
    z1TPData TP Data TP Data --- ---
    a2TPData TP Data TP Data --- ---
    z2TPData TP Data TP Data --- ---
    componentId1 Long long --- ---
    componentId2 Long long --- ---
    connRate Integer integer --- ---
    shape Integer integer --- ---
    dir Integer integer --- ---
    objectType String string Object Type ---
    operState String string Operational state ---
    almState String string Alaram State ---
    serverAlmState String string Server Alaram State ---
    alarmProfileEnabled String string Alaram Profile Enabled ---
    connectionState Integer integer Connection State ---
    svcState Integer integer Service State ---
    almMonState Integer integer Alaram monitoring State ---
    connectionCategory Integer integer connection Category ---
    connectionType Integer integer connection Type ---
    protectionType Integer integer Protection Type ---
    displayProtectionType Integer integer Display Protection Type ---
    protectionRole Integer integer Protection Role ---
    nprTlId Long long NPR TL Id ---
    sdhConnectionId Long long SDH connection Id ---
    sdhClientId Long long SDH client Id ---
    customerName String string Customer Name ---
    isUsedInSdh Boolean boolean Used in SDH(True/False) ---
    tcmStatus Integer integer Tcm status ---
    tcmASAP String string Tcm ASAP ---
    effectiveRate String string Effective Rate ---
    createdBy Integer integer Created by ---
    omspTrailId Long long OMSP trail Id ---
    omspConnectionName String string OMSP connection Name ---
    wtocm String string WTOCM ---
    signalType String string Signal Type ---
    usedTimeSlot String string Used Time Slots ---
    containerType String string Container ---
    band String string band ---
    reservedBy Integer integer --- ---
    spectrumWidth Long long --- ---
    tsCount Integer integer --- ---
    totalRecordCount Integer integer Total Record Count ---
    thirdPartyDesc String string --- ---
    thirdPartyName String string --- ---
    orderId Long long Order Id ---
    orderNumber String string Order Number ---
    orderType Integer integer Order Type ---
    orderState Integer integer Order State ---
    orderStackId Long long Order Stack Id ---
    receivedDate Long long Order Recieved Date ---
    ncGroupId Long long NC Group Id ---
    ncGroupName String string NC Group Name ---
    ncGroupType Integer integer NC Group Type ---
    groupState Integer integer NC Group State ---
    groupEntityType Integer integer Group Entity Type ---
    groupClass Integer integer Group Class ---
    vsClientId Long long VS Client Id ---
    vsClientState Integer integer VS Client State ---
    asapId Long long ASAP Id ---
    connectionLevel Integer integer Connection Level ---
    extendedParams HashMap«string,object» HashMap«string,object» Extended Params ---
    connectionParams HashMap«string,string» HashMap«string,string» Connection Params ---
    inconsistentConnInfo Network Connection Mismatch Network Connection Mismatch Inconsistent Connectionn Information ---
    serverProtectionType String string --- ---
    serverConnectionCategory Integer integer --- ---
    serverConnId Long long --- ---
    serverConnectionRate String string --- ---
    allowAsonResources String string --- ---
    hasAsonResources String string --- ---
    lineGranularity Long long --- ---
    opsaRevertiveMode String string --- ---
    opsaWaitToRestoreTime String string --- ---
    singleFiberChannelPlan String string --- ---
    olcState String string --- ---
    externalEML String string --- ---
    notesText String string --- ---
    bandwidth String string --- ---
    gridtype String string --- ---
    freqOffset Integer integer --- ---
    associatednprtlid Integer integer AssociatedNprtlId ---
    dmValue String string --- ---
    dmValueProtection String string --- ---
    dmTimestamp String string --- ---
    dmStatus String string --- ---
    latency String string --- ---
    revertiveMode String string --- ---
    clientRevertiveMode String string --- ---
    sbnConnParamRevertiveMode String string --- ---
    isEline String string --- ---
    linkUtilThreshold String string --- ---
    profileId String string --- ---
    waveKeyType String string Wave Key Type ---
    waveKeyConfig String string Wabe Key Configuration ---
    isYProtected String string Y protected(True/False) ---
    frequencies String string Frequencies ---
    pm24h String string PM 24h ---
    pm15m String string PM 15m ---
    nimEnabled String string NIM Enabled ---
    linkUtilRatio Long long % Channel Utilization Ratio, (autocalculated) ---
    linkUtilProfile String string Link Utilization Profile ID ---
    clientRouteState String string client Route State ---
    encoding String string --- ---
    sbnConnParamScId String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    scheduledJobs String string --- ---
    switchCapability String string --- ---
    otdrSupported Long long --- ---
    slteSupported Long long --- ---
    networkRevertiveMode String string --- ---
    otnObjectName String string --- ---
    objectId Double double --- ---
    implementingClassName String string --- ---
    objectIdClass Class«object» Class«object» --- ---

    Network Connection Mismatch

    Name

    Type

    Description

    Enum

    eventDate Date DateTime Conntn Mismatch Event Date ---
    ackDate Date DateTime Acknowledgement Date ---
    acknowledgedBy String string Acknowledged by ---
    mismatchType String string Mismatch Type ---

    NetworkElementInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    NetworkSliceReqResp

    Name

    Type

    Description

    Enum

    sliceId String string --- ---
    entityId Long long --- ---
    entityType Integer integer --- ---
    status String string --- ---
    errorMessage String string --- ---

    NIMConnectionRequest

    Name

    Type

    Description

    Enum

    connectionid String string Connection id ---
    orderid String string Order id ---
    ordernumber String string Order number ---
    operation String string operation (Mandatory) [create, modifyroutepath , modifyroutetrail, addprotectionpath , addprotectiontrail, removeprotectionpath , removeprotectiontrail]
    connectionName String string Connection Name ---

    NoteData

    Name

    Type

    Description

    Enum

    note String string --- ---
    fromType String string --- ---
    fieldId String string --- ---
    createdDate String string --- ---
    userName String string --- ---
    notesDetailsId String string --- ---
    editNotes Boolean boolean --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

    NPT Adapter Connections Response

    Name

    Type

    Description

    Enum

    responseHeader ConnectionsResponseHeader ConnectionsResponseHeader Response Header ---
    responseFiles array[String] string Response Files ---

    NPTAdapterConnectionsResponse

    Name

    Type

    Description

    Enum

    responseHeader Connections Response Header Connections Response Header Response Header ---
    responseFiles array[String] string Response Files ---

    NPTadapterdemandsresponse

    Name

    Type

    Description

    Enum

    responseHeader ResponseHeader ResponseHeader Response header ---
    responseFiles array[String] string Demand files ---

    NptAdapterHoodukResponse

    Name

    Type

    Description

    Enum

    responseHeader ResponseHeader ResponseHeader responseHeader ---
    responseFiles array[String] string response files ---

    NptAdapterNeIdMapResponse

    Name

    Type

    Description

    Enum

    responseHeader Connections Response Header Connections Response Header Response Header ---
    NeIds array[NPTNeIdMapperEnh] NPTNeIdMapperEnh --- ---

    NptAdapterPhysicalPortResponse

    Name

    Type

    Description

    Enum

    responseHeader ResponseHeader ResponseHeader responseHeader ---
    responseFiles array[String] string response files ---

    NPTAdapterRoutesResponse

    Name

    Type

    Description

    Enum

    responseHeader ResponseHeader ResponseHeader Response Header ---
    responseFiles array[String] string --- ---

    NptAdapterTopologicalLinksResponse

    Name

    Type

    Description

    Enum

    responseHeader ResponseHeader ResponseHeader responseHeader ---
    responseFiles array[String] string response files ---

    NptGetCtpsForEneRequest

    Name

    Type

    Description

    Enum

    eneName String string --- ---
    ptpName String string --- ---
    layerRate String string --- ---

    NPTNeIdMapperEnh

    Name

    Type

    Description

    Enum

    NEName String string --- ---
    OTNNeId Long long --- ---
    NPRNodeId Long long --- ---
    NPRNeId Long long --- ---
    EMLNeId Long long --- ---
    EMLNeGroupId Long long --- ---

    OduTrail

    Name

    Type

    Description

    Enum

    aEnd String string --- ---
    aEndPortId Integer integer --- ---
    zEnd String string --- ---
    zEndPortId Integer integer --- ---
    _trailName String string --- ---
    _trailId Integer integer --- ---
    layerRate String string --- ---
    otnTrailId Integer integer --- ---
    trailList array[ServerTrail] ServerTrail --- ---

    OlcStateRequestList

    Name

    Type

    Description

    Enum

    items array[OlcStateRequestObject] OlcStateRequestObject --- ---

    OlcStateRequestObject

    Name

    Type

    Description

    Enum

    id String string --- ---
    olcState String string --- ---
    objectType String string --- ---
    fdn String string --- ---
    targetPageUrl String string --- ---
    targetDataUrl String string --- ---
    userLabel String string --- ---
    additionalInfo String string --- ---

    OLCStateUpdateResponse

    Name

    Type

    Description

    Enum

    responseStatus Integer integer --- ---
    response String string --- ---
    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    errorField String string --- ---
    errorValue String string --- ---
    operationLogMsg OtnI18nMessage OtnI18nMessage --- ---
    status String string --- ---
    reqCompletionStatus Integer integer --- ---

    OpsaResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    OTDR

    Name

    Type

    Description

    Enum

    aPort1 String string A Port ---
    zPort1 String string Z port ---

    Otn Channel Optical Power

    Name

    Type

    Description

    Enum

    isODUProtection Boolean boolean --- ---
    isActiveCurrentChannel Boolean boolean --- ---
    xlabel OTS X-label OTS X-label X- Label ---
    measPower String string Mean Power ---
    minPower String string Minimum Power ---
    maxPower String string Maximum Power ---
    channelAttr String string Channel Attributes ---
    tooltip OTSTooltip OTSTooltip OTS Tool Tip ---
    connectionId String string Connection ID ---
    connectionName String string Connection Name ---
    fromNeName String string --- ---
    toNeName String string --- ---

    OTN Connection Provision Status

    Name

    Type

    Description

    Enum

    connectionName String string --- ---
    connectionId String string --- ---
    responseStatus String string --- ---
    connectionType String string --- ---
    connectionStyle String string --- ---
    statusMessage String string --- ---

    Otn connection Response

    Name

    Type

    Description

    Enum

    message String string Message ( localized message) ---
    messageId String string Message Id (ID of the localized message) ---
    messageSeverity String string Message Severity (will be empty when status is success and E when there is a failure) ---
    status String string Status [SUCCESS, FAILURE, IN_PROGRESS]
    connectionName String string Connection Name ---
    connectionId Integer integer Connection Id (Here Connection Id represents the group Id) ---
    orderNumber String string Order Number (number prefixed by the ordertype like A for Add,D for delete, DV for Discovered, VD for DbDelete,R for Rearrange, RR for Rearrange with reinstate etcThese ordertype shall be prefixed with additional I if it is integrated operations) ---
    orderId String string Order Id ( unique number generated by sequence) ---
    orderStep Integer integer Order Step ---
    id String string Request Id (Identifier of the request) ---
    errorField String string Error Field ( shall be the name of the incorrect attribute) ---
    errorValue String string Error Value ( shall be the value of the incorrect attribute) ---

    Otn product information Response

    Name

    Type

    Description

    Enum

    version String string --- ---

    OTN routing constraints

    Name

    Type

    Description

    Enum

    id String string 1. Routing Constarints ID - For Linkconnection constraints,the REST call /data/otn/connections/networkConnections?rate={connectionRate)&nprNodeId={nodeId}, shall give the networkconnections.

    2. When the user wants a trail/link constraint,'/data/otn/connections/{id generated from networkconnection REST}/linkConnections?lcId={id generated from networkconnection REST}&lcRate=undefined&rcLink=RC&trailName={guiLabel from networkconnection REST}.'
    2.1 User shall get the lccid and the ID is a combination of {id generated from networkconnection REST call} and {lccid} generated from second call.

    3. For Trail,LOPC and Physicallink constraints, the ID is the constraint id generated from networkconnection REST.

    4. For 3R constraints, id is neId+port1id+port2id from REST oms1350/data/otn/connection/3RPorts?rate={connRate}&nprNodeId={nodeId}&neName={neName}
    ---
    pk String string 1. For createModifyConnection REST call:- Key(same as id attribute)

    2. For retrieveConnection REST call:- ObjectType+2.(Reuse or Remove or Add)+connid+serverName
    Example: ObjectType/2/connid/serverName
    ---
    connid String string createModifyConnection:- same as 'id' value
    retreiveConnection:- same as lccId
    ---
    lccid String string LC Componenet id - retrieved from 'lccid' attribute of the LinkConnection REST where applicable ---
    name String string Constraint name generated from Linkconnection REST for LC constraints and networkConnection REST for other cases ---
    type String string Type [Port, 3RPort, Trail, Logical Link, Node, Infrastructure, Physical Link, Link]
    col4 String string ConstraintType [Include/Exclude]
    role String string Role [Service, Protection]
    aneid Integer integer A NE Id - retrieved from 'a1NeId' attribute of the LinkConnection REST where applicable ---
    aendName String string A end Name - retrieved from 'a1NodeName' attribute of the constraint list REST ---
    zneid Integer integer Z NE id - retrieved from 'Z1NeId' attribute of the LinkConnection REST where applicable ---
    zendName String string Z end Name - retrieved from 'z1NodeName' attribute of the constraint list REST ---
    lcnumber Integer integer LC number - retrieved from 'unitNum' attribute of the LinkConnection REST where applicable ---
    dct Integer integer Direction Component - retrieved from 'dct' attribute of the LinkConnection REST where applicable ---
    timeslot String string Time slot - retrieved from 'timeslotklm' attribute of the LinkConnection REST where applicable ---
    servername String string Server Name - retrieved from 'serverName' attribute of the LinkConnection REST where applicable ---
    lcprotection String string LC protection - retrieved from 'protectionType' attribute of the LinkConnection REST where applicable ---
    layerrate String string Layer Rate - retrieved from 'layerRate' attribute of the LinkConnection REST where applicable and 'rate' attribute of the 3RPorts REST where applicable ---
    frequency String string Frequency - retrieved from 'Frequency' attribute of the LinkConnection REST where applicable ---
    routeid String string Route Id ---
    portname1 String string Port Name1 - retrieved from 'port1Name' attribute of 3R REST where applicable ---
    portid1 String string Port Id1 - retrieved from 'portid1' attribute of 3R REST where applicable ---
    portname2 String string port name 2 - retrieved from 'port2Name' attribute of 3R REST where applicable ---
    portid2 String string Port Id2 - retrieved from 'portid2' attribute of 3R REST where applicable ---
    nodeId String string nodeId - retrieved from 'nodeId' attribute of Node REST where applicable ---
    nodeName String string nodeName - retrieved from 'nodeName' attribute of Node REST where applicable ---
    regenIndex Integer integer Regeneration Index ---
    connectionAvailability String string --- ---
    frequencyWithOffset String string --- ---
    logicalLinkConnId String string logicalLinkConnId - optional parameter indicated the logical link id of a virtual server in the id parameter. This value is used to recover the link if virtual server is recreated ---
    serverId String string logicalLinkConnId - optional parameter indicated the logical link id of a virtual server in the id parameter. This value is used to recover the link if virtual server is recreated ---

    Otn WLT Adjust Request

    Name

    Type

    Description

    Enum

    connName String string Connection Name ---
    wltKey String string WLT key ---
    connId String string Connection ID ---
    direction String string Direction ---
    ldPorts array[WL Tracker LD Port] WL Tracker LD Port OTN WLT Ld ports list ---

    Otn WLT Channel Details

    Name

    Type

    Description

    Enum

    otsConnectionName String string OTS Connection Name ---
    nearEndNEName String string Near End NE name ---
    nearEndPortAIDA1 String string Near End Port Name-1 ---
    nearEndPortAIDA2 String string Near End Port Name-2 ---
    farEndNEName String string Far End NE name ---
    farEndPortAIDZ1 String string Far End Port Name-1 ---
    farEndPortAIDZ2 String string Far End Port Name-2 ---
    interfaceDirection String string Interface Direction ---
    connectionRate String string Connection Rate ---
    orderNumber String string Order Number ---
    connectionState String string Connection State ---
    numberOfChannels String string Number of Channels ---
    numberOfChannelsProvisioned String string Number of Channels Provisioned ---
    direction String string Direction ---
    pwrMgmtType String string Power Management Type ---
    commissioningStatus String string Commissioning Status ---
    lastRefresh String string Last Refresh ---
    lastRefreshMillis Long long Last Refresh in Milliseconds ---

    Otn WLT Details

    Name

    Type

    Description

    Enum

    connectionName String string Connection Name ---
    frequency String string Frequency ---
    aNeName String string A-end NE name ---
    aPortName String string A end Port Name ---
    zNeName String string Z end NE name ---
    zPortName String string Z end port name ---
    connectionType String string Connection Type ---
    direction String string Direction ---
    connectionRate String string Connection rate ---
    orderNumber String string Order Number ---
    connectionState String string Connection State ---
    routeState String string Route State ---
    wavekeyType String string Wave Key Type ---
    wavekey1 String string Wave key 1 ---
    wavekey2 String string Wave Key 2 ---
    azWavekey1 String string AZ wave Key1 ---
    azWavekey2 String string AZ wave key2 ---
    zaWavekey1 String string ZA wave key 1 ---
    zaWavekey2 String string ZA wave key 2 ---
    lastRefresh String string Last Refresh ---
    lastRefreshMillis Long long Last Refresh in Milliseconds ---

    Otn WLT LD Port Response

    Name

    Type

    Description

    Enum

    nextTasks array[String] string Next Tasks ---
    items array[WL Tracker LD Port] WL Tracker LD Port Otn WLT LD port list ---
    message String string Message ---
    messageId String string Message ID ---
    messageSeverity String string Message Severity ---
    status String string Status ---

    Otn WLT OTS Response

    Name

    Type

    Description

    Enum

    wltKey String string WLT Key ---
    chanPowerList array[Otn Channel Optical Power] Otn Channel Optical Power OTN Channel Power List ---
    otnWLTChanDetails Otn WLT Channel Details Otn WLT Channel Details OTN WLT channel Details ---
    message String string Message ---
    messageId String string Message ID ---
    messageSeverity String string Message Severity ---
    status String string Status ---

    Otn3RPort

    Name

    Type

    Description

    Enum

    port1id Long long --- ---
    port2id Long long --- ---
    className String string ClassName:shall be obtaind from '/data/npr/{table}'(table=nes) REST call as 'className' ---
    label String string label:available from fromport1_AdditionalInfo/toport1_AdditionalInfo in '/data/otn/Connection'(connectioncreation) REST request data example:11DPM12-4-14-C2 ---
    guiLabel String string GuiLabel:shall be obtaind from '/data/npr/{table}'(table=nes) REST call as 'guiLabel' ---
    key String string Key:shall be obtaind from '/data/npr/{table}' (table=nes) REST call as 'key' ---
    id Long long Id:shall be obtaind from '/data/npr/{table}' (table=nes) REST call as 'id' ---
    neId Long long NeId:available from fromport1_AdditionalInfo/toport1_AdditionalInfo in '/data/otn/Connection'(connectioncreation) REST request data as 'neId' ---
    neName String string NeName:available from fromport1_AdditionalInfo/toport1_AdditionalInfo in '/data/otn/Connection'(connectioncreation) REST request data as 'neName' ---
    port1Name String string Port1 Name ---
    port2Name String string Port2 Name ---
    rate String string Rate: ODU0-ODU4,ODU2E,ODU3E2,OTU1-OTU4,OTU2E,OTU3E,ODUflex,OCH,OMS,OTL4_4,OTU4X2,OMSBAND,OC192_STS192_RS_STM64,OC48_STS48_RS_STM16 ---
    band String string C,L ---
    port1Id Long long Port1 Id ---
    port2Id Long long Port2 Id ---

    Otn3RPortInventoryResponse

    Name

    Type

    Description

    Enum

    nextTasks array[String] string NextTasks:commandDeployer,RouteDisplay,Alarms ---
    items array[Otn3RPort] Otn3RPort OTN 3R-Port Details ---

    OtnAsapConnectionRequest

    Name

    Type

    Description

    Enum

    asapId String string ASAP Id ---
    asapName String string ASAP Name ---

    OtnAsapConnectionResponse

    Name

    Type

    Description

    Enum

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

    OtnConnectionPortTP

    Name

    Type

    Description

    Enum

    portid Long long --- ---
    className String string className can retrieved from '/data/otn/connection/connectionTP' REST call as 'className' -- Not Mandatory ---
    label String string label can retrieved from '/data/otn/connection/connectionTP' REST call as 'label' ---
    guiLabel String string guiLabel can retrieved from '/data/otn/connection/connectionTP' REST call as 'guiLabel' -- Not Mandatory ---
    key String string key can retrieved from '/data/otn/connection/connectionTP' REST call as 'key' -- Not Mandatory ---
    id Long long id can retrieved from '/data/otn/connection/connectionTP' REST call as 'id' -- Not Mandatory ---
    neId Long long neId can retrieved from '/data/otn/connection/connectionTP' REST call as 'neId' ---
    neName String string neName can retrieved from '/data/otn/connection/connectionTP' REST call as 'neName' ---
    neLabel String string neLabel can retrieved from '/data/otn/connection/connectionTP' REST call as 'neLabel' -- Not Mandatory ---
    neModel String string neModel can retrieved from '/data/otn/connection/connectionTP' REST call as 'neModel' -- Not Mandatory ---
    nodeName String string nodeName can retrieved from '/data/otn/connection/connectionTP' REST call as 'nodeName' -- Not Mandatory ---
    portName String string portName can retrieved from '/data/otn/connection/connectionTP' REST call as 'portName' ---
    rate String string rate can retrieved from '/data/otn/connection/connectionTP' REST call as 'rate' ---
    type String string type can retrieved from '/data/otn/connection/connectionTP' REST call as 'type' -- Not Mandatory ---
    cardName String string cardName can retrieved from '/data/otn/connection/connectionTP' REST call as 'cardName' ---
    availability String string availability can retrieved from '/data/otn/connection/connectionTP' REST call as 'availability' -- Not Mandatory ---
    frequency String string frequency can retrieved from '/data/otn/connection/connectionTP' REST call as 'frequency' -- Not Mandatory ---
    rxFrequency String string RxFrequency can retrieved from '/data/otn/connection/connectionTP' REST call as 'rxFrequency' -- Not Mandatory ---
    oprMode String string OprMode can retrieved from '/data/otn/connection/connectionTP' REST call as 'oprMode' -- Not Mandatory ---
    frequencyType String string FrequencyType can retrieved from '/data/otn/connection/connectionTP' REST call as 'frequencyType' -- Not Mandatory ---
    layerRate Integer integer layerRate can retrieved from '/data/otn/connection/connectionTP' REST call as 'layerRate' -- Not Mandatory ---
    direction Integer integer direction can retrieved from '/data/otn/connection/connectionTP' REST call as 'direction' -- Not Mandatory ---
    timeslot Integer integer timeslot can retrieved from '/data/otn/connection/connectionTP' REST call as 'timeslot' -- Not Mandatory ---
    alarmState Integer integer alarmState can retrieved from '/data/otn/connection/connectionTP' REST call as 'alarmState' -- Not Mandatory ---
    ptpId Long long ptpId can retrieved from '/data/otn/connection/connectionTP' REST call as 'ptpId' -- Not Mandatory ---
    ptpName String string ptpName can retrieved from '/data/otn/connection/connectionTP' REST call as 'ptpName' -- Not Mandatory ---
    ptpRate String string ptpRate can retrieved from '/data/otn/connection/connectionTP' REST call as 'ptpRate' -- Not Mandatory ---
    connectionId Long long connectionId can retrieved from '/data/otn/connection/connectionTP' REST call as 'connectionId' -- Not Mandatory ---
    connectionName String string connectionName can retrieved from '/data/otn/connection/connectionTP' REST call as 'connectionName' -- Not Mandatory ---
    connectionRate String string connectionRate can retrieved from '/data/otn/connection/connectionTP' REST call as 'connectionRate' -- Not Mandatory ---
    port String string Port can retrieved from '/data/otn/connection/connectionTP' REST call as 'port' -- Not Mandatory ---
    portGrpMode String string PortGrpMode can be retrieved from '/data/otn/connection/connectionTP' REST call as 'PortGrpMode' ---
    odukPort String string odukPort can be obtained as 'odukPort' from '/data/otn/connection/connectionTP' REST call -- Not Mandatory ---
    portId Long long portId can retrieved from '/data/otn/connection/connectionTP' REST call as 'portId' ---

    OtnConnectionPortTPInventoryResponse

    Name

    Type

    Description

    Enum

    nextTasks array[String] string NextTasks:CommandDeployer,RouteDisplay,Alarms ---
    items array[OtnConnectionPortTP] OtnConnectionPortTP Items:OTN connection PortTP details ---

    OtnConnectionRequest

    Name

    Type

    Description

    Enum

    encoding String string --- ---
    ASONRouted String string ASON Routed (Mandatory); True: Control Plane Connection(ASON), False: Managed Plane Connection; Enum True False ---
    Latency String string --- ---
    MRNTunnel String string MRN Tunnel(Mandatory); True: ASON-Logical Link Connection, False: for all other type of connections ; Enum True False ---
    ASONConnectionType String string ASON Connection Type(Mandatory) : noTunnel-Managed Plane Connection, UntermTunnel-Logical Link(ASON), TermTunnel-Control Plane Connection(ASON) Enum noTunnel UntermTunnel TermTunnel ---
    fromne1_AdditionalInfo HashMap«string,string» HashMap«string,string» --- ---
    transmissionmode String string --- ---
    LOSPropagation String string LOS Propagation (Mandatory) Enum AendOnly (A End Laser On) ZendOnly (Z End Laser On) BothAZ (Both A and Z End Laser On) NeitherAZ (Both A and Z End Laser Off) UseNEValue ---
    ssfDelayTimer String string --- ---
    ProvisionedBitRate String string --- ---
    ProvisionedBitRateDsr String string --- ---
    Odu4InterworkingMode String string --- ---
    PayloadTypeMismatchResponse String string --- ---
    mappingmode String string --- ---
    EncapsulationMode String string --- ---
    fromwkPort1XFP String string --- ---
    fromprotPort1XFP String string --- ---
    towkPort1XFP String string --- ---
    toprotPort1XFP String string --- ---
    otherFromprotPort1XFP String string --- ---
    otherToprotPort1XFP String string --- ---
    requestId Long long Request Id (unique id generated at random) (Mandatory) ---
    templateId Long long Id of the template used for connection creation (Optional However, It is mandatory for only createModifyConnectionBasedOnTemplate API payload which is fetched from the path:/data/otn/connectionTemplates/folders/{folderId}/templates) ---
    eventServerUrl String string Event Server URL ( /oms1350/events/otn/prov/jobEvent/{generatedrequestId} ) ---
    eventChannel String string Event Channel (Mandatory) ---
    connshape String string Connection Shape (Mandatory) [1 (ADD_DROP_A) , 2 (ADD_DROP_Z) , 5 (DOUBLE_ADD_DROP) , 8 (SIMPLE), 9 (DOUBLE_SIMPLE)]
    customerName String string Not mandatory ---
    connectionname String string Unique name for the Connection ---
    connectionalias String string Not mandatory ---
    serviceratetype String string Service Rate Type (Mandatory) [Ethernet, SONET, SDH, Optical, CBR, Data, Trail, SubrateEthernet]
    servicerate String string Service Rate (Mandatory) [[ODU0, ODU1, ODU2E, ODU2, ODU1f, ODU3, ODU4, OMS, OCH] (ServiceRate_Optical), [1GBE, 10GBE, 40GBE, 100GBE, 40GbeMLD, FE](ServiceRate_Ethernet), [STM-256, STM-64, STM-64MS, STM-16, STM-16MS, STM-4, STM-1](ServiceRate_SDH), [OC-768, OC-192, OC-48, OC-12, OC-3] (ServiceRate_SONET)]
    trailrate String string Trail Rate (Mandatory) [ODU0, ODU1, ODU2, ODU3, ODU4, ODU2E, ODU3E2, OTU1, OTU2, OTU3, OTU4, OTU2E, OTU3E, ODUflex, OCH, OMS, OTL4_4, OTU4X2, OTU4Half, OTU4Halfx5, OTSIGTunnel, OMSBAND, OC192_STS192_RS_STM64, OC48_STS48_RS_STM16]
    bandwidth String string --- ---
    cirrate String string Committed Information Rate (Mandatory) [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800, 850, 900, 950, 1000, 1500, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 5500, 6000, 6500, 7000, 7500, 8000, 8500, 9000, 9500, 10000]
    eirrate String string Error Information Rate (Mandatory) [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800, 850, 900, 950, 1000, 1500, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 5500, 6000, 6500, 7000, 7500, 8000, 8500, 9000, 9500, 10000]
    cbs String string Committfed Burst Size (Mandatory) [CBS16, CBS32, CBS64, CBS128, CBS256, CBS512, CBS1024, CBS2048, CBS4096, CBS8192, CBS16384]
    ebs String string Error Burst Size (Mandatory) [CBS16, CBS32, CBS64, CBS128, CBS256, CBS512, CBS1024, CBS2048, CBS4096, CBS8192, CBS16384]
    cevlan String string Carrier ethernet VLAN, a 100 character string.Note: user shall enter all, none, or a comma-separated list and/or range of values, e.g., '1,5,10-99' ---
    svlan String string Service VLAN [Integer from 1-4095]
    protectiontype String string Protection Type (9- unprotected/11- protected) (Mandatory) [9 , 11 ]
    fec String string Forward Error Correction (Mandatory) [UseNEValue, RSFEC, EFEC, EFEC2, AFEC, SDFEC, NOFEC]
    waveShape String string WaveShape (Mandatory) [Single, Super, Alien]
    phaseEncoding String string Phase Encoding (Mandatory) [Absolute, Differential]
    lineModeProfile String string Line Mode Profile [for OTSIG Tunnel] [1..x where x=4 in R19.9]
    lopc String string Logical Optical Physical Connection (Mandatory) [true, false]
    allowAsonResources String string Allow Ason Resources ;Default False [true, false]
    lBandFreq String string L Band Frequency ;Default False [true, false]
    subsea String string --- ---
    ntwSliceId String string Network Slice Id ,a 64 character string ---
    latencyConstraintPolicy String string LatencyConstraintPolicy [minLatency, maxTargetLatency]
    latencyValue String string Latency Value for latencyConstraintPolicy , true or false for minLatency and Integer value for maxTargetLatency ---
    createdByAson String string CreatedBy Ason ;Default System [system, user]
    restoration String string Restoration [norestore, SBR, GR]
    aendworkport String string A-end work port (Mandatory) [porta, portb]
    rollBack Boolean boolean --- ---
    omsProtectionMode String string Optical Impairment Routing [ None, Enforced, BestEffort]
    opticalImpairmentRouting String string Optical Impairment Routing [ 0, 1, 2]
    fromne1 String string Node name of From NE1 ,that can be retrieved from '/data/npr/nodes' as 'guiLabel' field (Mandatory) ---
    fromport1 String string Nativename of the From port1 in format (shelf)-(slot)-(port) (Mandatory) ---
    fromne2 String string Nodename of From NE2, that can be retrieved from '/data/npr/nodes' as 'guiLabel' field (Mandatory for connections with more than 2 endpoints eg. 4-ended connections) ---
    fromport2 String string Nativename of the From port2 in format (shelf)-(slot)-(port) (Mandatory for connections with more than 2 endpoints eg. 4-ended connections) ---
    tone1 String string To NE1,The node name can be retrieved from '/data/npr/nodes' from 'guiLabel' field (Mandatory) ---
    toport1 String string Nativename of the To port1 in format (shelf)-(slot)-(port) (Mandatory) ---
    tone2 String string To NE2,The node name can be retrieved from '/data/npr/nodes' from 'guiLabel' field (Mandatory for connections with more than 2 endpoints eg. 4-ended connections) ---
    toport2 String string Nativename of the To port2 in format (shelf)-(slot)-(port) (Mandatory for connections with more than 2 endpoints eg. 4-ended connections) ---
    fromPort1XFP String string From Port1 XFP - OCS NE's only.- Pluggable module.Please note that this need to be provided when the ports arent provisioned.Sample: SR12G7TU,SR10G155TU,FIXED,USER ---
    fromPort2XFP String string From Port1 XFP- OCS NE's only.- Pluggable module.Please note that this need to be provided when the ports arent provisioned.Sample: SR12G7TU,SR10G155TU,FIXED,USER ---
    toPort1XFP String string To Port2 XFP-OCS NE's only.- Pluggable module.Please note that this need to be provided when the ports arent provisioned.Sample: SR12G7TU,SR10G155TU,FIXED,USER ---
    toPort2XFP String string To Port2 XFP-OCS NE's only.- Pluggable module.Please note that this need to be provided when the ports arent provisioned.Sample: SR12G7TU,SR10G155TU,FIXED,USER ---
    otherFromPort1XFP String string From Port1 XFP - OCS NE's only.- Pluggable module (not managed in the current release by NFMT) only applicable if pluggable module is other.Please note that this need to be provided when the ports arent provisioned. ---
    otherFromPort2XFP String string From Port2 XFP- OCS NE's only.- Pluggable module (not managed in the current release by NFMT) only applicable if pluggable module is other.Please note that this need to be provided when the ports arent provisioned. ---
    otherToPort1XFP String string To Port1 XFP-OCS NE's only.- Pluggable module (not managed in the current release by NFMT) only applicable if pluggable module is other.Please note that this need to be provided when the ports arent provisioned. ---
    otherToPort2XFP String string To Port2 XFP-OCS NE's only.- Pluggable module (not managed in the current release by NFMT) only applicable if pluggable module is other.Please note that this need to be provided when the ports arent provisioned. ---
    fromporttype1 String string From Port 1 Type (Mandatory) [Terminated, UnTerminated]
    fromporttype2 String string From Port 2 Type(Mandatory) [Terminated, UnTerminated]
    toporttype1 String string To Port 1 Type (Mandatory) [Terminated, UnTerminated]
    toporttype2 String string To Port 2 Type (Mandatory) [Terminated, UnTerminated]
    tone1_AdditionalInfo HashMap HashMap --- ---
    fromport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP From Port1-- Additional information can be retrieved from 'data/otn/connectionTP/?popupFormFieldId=fromne1&objectType={objectType}&rate={rate}&showallports={showallports}&nodeName={nodeName}&nodeId={nodeId}&connectionType=ConnectionTP,
    where 'nodeId' is retrieved as 'id' NE name as 'neName' odukrate as 'rate' (Mandatory)
    ---
    fromport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP From Port2 -- Additional information can be retrieved from 'data/otn/connectionTP/?popupFormFieldId=fromne1&objectType={objectType}&rate={rate}&showallports={showallports}&nodeName={nodeName}&nodeId={nodeId}&connectionType=ConnectionTP,
    where 'nodeId' is retrieved as 'id' NE name as 'neName' odukrate as 'rate'
    ---
    toport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP To port1--Additional information can be retrieved from 'data/otn/connectionTP/?popupFormFieldId=fromne1&objectType={objectType}&rate={rate}&showallports={showallports}&nodeName={nodeName}&nodeId={nodeId}&connectionType=ConnectionTP,
    where 'nodeId' is retrieved as 'id' NE name as 'neName' odukrate as 'rate' toport1_AdditionalInfo
    ---
    toport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP To Port2--Additional information can be retrieved from 'data/otn/connectionTP/?popupFormFieldId=fromne1&objectType={objectType}&rate={rate}&showallports={showallports}&nodeName={nodeName}&nodeId={nodeId}&connectionType=ConnectionTP,
    where 'nodeId' is retrieved as 'id' NE name as 'neName' odukrate as 'rate'
    ---
    port1timeslot String string timeslots for port1 - with values seperated by comma ---
    port2timeslot String string timeslots for port2 - with values seperated by comma ---
    port3timeslot String string timeslots for port3 - with values seperated by comma ---
    port4timeslot String string timeslots for port4 - with values seperated by comma ---
    routing String string Routing (Mandatory) [0 (NA), 1 (automatic), 4(Manual), 5 (xc_based), 6 (order sensitive)]
    orderstep String string Order Step (Mandatory) [1 (Defined), 2 (Allocated), 8 (Implemented), 9 (Commissioned)]
    routedisplay String string true if integrated provisioning, false otherwise (Mandatory) [true, false]
    containerrate String string Container Rate (Mandatory) [NA, ODU0, ODU1, ODU2, ODU3, ODU4, ODU2e, ODU3e2, OPTSG, ODUflex, UseNeValue]
    lineRate String string Line / Server Rate ;Default OTU4 [OTU4, OTU4x2, OTU4Half, OTU4Halfx5]
    signalType String string Signal Type (Mandatory) [Default, 1GbE, 10GbE, 40GbE, 100GbE, 3GSDI, CBR2G5, CBR10G, CBR40G, DDR, DVBASI, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, HDSDI, OC-3, OC-12, OC-48, OC-192, OC-768, OCH, ODU0, ODU1, ODU2, ODU3, ODU4, ODU2E, ODU3E2, OMS, ODUflex, SDSDI, STM-1, STM-4, STM-16, STM-64, STM-256, STM-16MS, STM-64MS, OTU4x2, ODU4x2, OPTSG, 40GbeMLD, CBR10G3]
    clientSel String string The clientsel is computed from signaltype(signaltype is derived from 'serviceRate';When the porttype is unterminated, derive the signaltype from the AdditionalInfo's odukrate attribute) ;If the signaltype is 1GbE, the clientsel is 'GBEODU0' ; If signaltype is 10GbE, the clientsel is 'GBE10'+containerrate(inuppercase) ;If the signaltype is 100GbE, the clientsel is 'GBE100ODU4' ;If the signaltype contains ODU, replace that with OTU. ---
    a1ClientSel String string The A1 clientsel is computed from signaltype(signaltype is derived from 'serviceRate' ;When the porttype is unterminated, derive the signaltype from the AdditionalInfo's odukrate attribute) ;If the signaltype is 1GbE, the clientsel is 'GBEODU0' ; If signaltype is 10GbE, the clientsel is 'GBE10'+containerrate(inuppercase) ;If the signaltype is 100GbE, the clientsel is 'GBE100ODU4' ;If the signaltype contains ODU, replace that with OTU. ---
    z1ClientSel String string The Z1clientsel is computed from signaltype(signaltype is derived from 'serviceRate' ;When the porttype is unterminated, derive the signaltype from the AdditionalInfo's odukrate attribute) ;If the signaltype is 1GbE, the clientsel is 'GBEODU0' ; If signaltype is 10GbE, the clientsel is 'GBE10'+containerrate(inuppercase) ;If the signaltype is 100GbE, the clientsel is 'GBE100ODU4' ;If the signaltype contains ODU, replace that with OTU. ---
    a2ClientSel String string The A2 clientsel is computed from signaltype(signaltype is derived from 'serviceRate' ;When the porttype is unterminated, derive the signaltype from the AdditionalInfo's odukrate attribute) ;If the signaltype is 1GbE, the clientsel is 'GBEODU0' ; If signaltype is 10GbE, the clientsel is 'GBE10'+containerrate(inuppercase) ;If the signaltype is 100GbE, the clientsel is 'GBE100ODU4' ;If the signaltype contains ODU, replace that with OTU. ---
    z2ClientSel String string The Z2 clientsel is computed from signaltype(signaltype is derived from 'serviceRate' ;When the porttype is unterminated, derive the signaltype from the AdditionalInfo's odukrate attribute) ;If the signaltype is 1GbE, the clientsel is 'GBEODU0' ; If signaltype is 10GbE, the clientsel is 'GBE10'+containerrate(inuppercase) ;If the signaltype is 100GbE, the clientsel is 'GBE100ODU4' ;If the signaltype contains ODU, replace that with OTU. ---
    xmnActualBitRate String string XMN Actual Bit Rate (Mandatory) ---
    polarization String string Polarization Tracking [Use NE Values (default), Normal, Fast]
    odukAZSrcTrace String string 15 character string.shall only be set for a connection if for that connection rate and service type both the From NE and To NE support the parameter. ---
    odukZASrcTrace String string 15 character string.shall only be set for a connection if for that connection rate and service type both the From NE and To NE support the parameter. ---
    odukTraceMismatchDectMode String string ODUK trace mismatch Detect Mode (Mandatory) [UseNevalue, Sourceenabled, Destinationenabled, SourceandDestinationenabled, Disabled]
    odukTraceMismatchAction String string ODUK trace mismatch action (Mandatory) [UseNevalue, Enable, Disable]
    xmnAZClientClassificationMode String string XMN A-Z classification Mode [Port, Untagged, CE-VLAN ID, S-VLAN Tagged]
    xmnZAClientClassificationMode String string XMN Z-A classificationMode [Port, Untagged, CE-VLAN ID, S-VLAN Tagged]
    fecEnable String string FEC Enable (Mandatory) [UseNEValue, DISABLE, EFECI, EFECE, EFECB]
    asymInterwk String string Asymmetric interworking (Mandatory) [UseNEValue, Enable, Disable]
    encryptionState String string Encryption State (Mandatory) [UseNEValue, Enable, Disable]
    encryptionNextKey String string Encryption Next Key (Mandatory) [UseNEValue, Enable, Disable]
    encryptionWKAT String string Encryption WKAT ---
    encryptionSwitchOverToNextKey String string Encryption Switch over To next key [UseNEValue, Enable, Disable]
    payloadType String string Payload Type (Mandatory) [UseNEValue, ODUM, ODUMPT21, ASCBR, BSCBR, GFP, AMCC, OLDAMCC, 1000BASEX, CAMCC, 33]
    apsEnable String string APS Enable (Mandatory) [UseNEValue, Proprietary, Standard]
    ssmSupport String string SSM support (Mandatory) [UseNEValue, Disable, Enable]
    outQl String string Out Q1 (Mandatory) [UseNEValue, ACT, DNU, DUS, PRC, PRS, SEC, SSUA, SSUB, ST2, ST3, ST3E, STU, None]
    timeSlotL1 String string a & separated list of timeslots is required to be assigned to the logical time slot of the Line Port when a client port (for the 4DPA4 and PSS1MD4 circuit packs in FlexMux mode) is used as connection endpoint.The number of required selections in the Line Port Timeslot(s) field is based on the Signal Type of the Client Port.For OC3/STM1/FE - one selection, for OC12/STM4 - four selections, for OC48/STM16 - sixteen selections, for 1GbE - eight selections, for FC100 - seven selections, for FC200 - fourteen selections, for HDSDI - ten selections,for SDSDI or DVBASI - two selections are required. ---
    spectrumWidth String string Spectrum Width [50, 37.5, 62.5]
    txParamData array[OtnConnTxParams] OtnConnTxParams Trasmission param Data. Please refer the OTN Transmission Parameters link for supported transmission params and allowed values ---
    tcmLevel String string TCM Level (Mandatory) [notcm, level1, level2, level3, level4, level5, level6]
    waitForServerRestoration String string Wait for server Restoration (Mandatory) [true, false, na]
    preferredRestorationMode String string Preferred Restoration Mode (Mandatory) [norestore, SBR, GR]
    reversionMode String string Reversion Mode (Mandatory) [manual, auto, softauto]
    maxlatency String string Maximum Latency ---
    defaultsetuppriority String string The Default Setup Priority field is a text field that defaults to 5. Users can specify another value by clicking on the X and typing the preferred value. (Mandatory) ---
    defaultpriority String string The Default Priority field is text field that defaults to 4. Users can specify another value by clicking on the X and typing the preferred value. (Mandatory) ---
    includecolorprofile String string The color must be same color that is allocated to the link. Resource Coloring helps users to assign colors to links (such as TE links, physical/logical connections, trails, paths, or subnetwork connections (SNCs) in order to separate traffic and to identify unique routes that are used to upload and carry traffic. Users can choose different strategies to color-code their networks for ease of visibility. ---
    excludecolorprofile String string The color must be same color that is allocated to the link. Resource Coloring helps users to assign colors to links (such as TE links, physical/logical connections, trails, paths, or subnetwork connections (SNCs) in order to separate traffic and to identify unique routes that are used to upload and carry traffic. Users can choose different strategies to color-code their networks for ease of visibility. ---
    scId String string Switch Connection ID(Optional) [any string received in Private Tunnel Notif from GMRE]
    softRevertiveSncpMode String string --- ---
    softRevertiveSncpTimeout String string --- ---
    clientprotectiontype String string Client Protection type (Mandatory) [0 (none) , 1 (SNCNc) , 2 (SNCN) , 3 (SNCI)]
    clientSwitchMode String string Client switch mode (Mandatory) [uni, bi]
    clientholdofftime String string Client hold off time (Mandatory) [0, 20, 40, 60, 80, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900, 8000, 8100, 8200, 8300.8400, 8500, 8600, 8700, 8800, 8900, 9000, 9100, 9200, 9300, 9400, 9500, 9600, 9700, 9800, 9900, 10000]
    clientprotectedMethod String string Client Protected method (Mandatory) [0, 1(for ODUk)]
    clientprotectingMethod String string Client protecting method (Mandatory) [0, 1(for ODUk)]
    clientsignaldegrade String string Client signal degrade (Mandatory) [0 (Enable) , 1 (Disable)]
    clientwaittime String string Client wait time (Mandatory) [Integer from 1-15]
    clientrevertivemode String string client revertive mode (Mandatory) [0 (enable), 1(disable)]
    nwkprotectiontype String string Network protection type (Mandatory) [0(none), 2(SNCN), 3(SNCI)]
    nwkSwitchMode String string Network switch mode (Mandatory) [uni, bi]
    nwkholdofftime String string Network hold off time (Mandatory) [0, 20, 40, 60, 80, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900, 8000, 8100, 8200, 8300.8400, 8500, 8600, 8700, 8800, 8900, 9000, 9100, 9200, 9300, 9400, 9500, 9600, 9700, 9800, 9900, 10000]
    nwkprotectedMethod String string Network Protected Method (Mandatory) [0, 1(for ODUk)]
    nwkprotectingMethod String string Network protecting Method (Mandatory) [0, 1(for ODUk)]
    nwksignaldegrade String string network signal degrade (Mandatory) [0 (enable), 1(disable)]
    nwkwaittime String string network wait time (Mandatory) [Integer from 1-15]
    nwkrevertivemode String string network revertive mode (Mandatory) [0 (enable), 1(disable)]
    asonsubntwkprttype String string ASON sub network protected type (Mandatory) [SNCP, none]
    pm15min String string PM15 min (Mandatory) [true, false]
    pmdata15 String string PM data 15 (Mandatory) [0(Keep PM Data upon Connection Deletion), 1 (Delete PM Data upon PM Stop), 2 (Delete PM Data upon Connection Deletion)]
    direction15 String string direction 15 (Mandatory) [0 (Unidirectional)]
    tpmonitor15 String string TP monitor 15 (Mandatory) [1(All) , 0(End Points only)]
    reportinfo15 String string report info15 (Mandatory) [1 (CSV 2 Hr), 0 (CSV 24Hr), 2 (No Report)]
    pm24hr String string PM 24 hr (Mandatory) [true, false]
    pmdata24 String string PM data 24(Mandatory) [0(Keep PM Data upon Connection Deletion), 1 (Delete PM Data upon PM Stop), 2 (Delete PM Data upon Connection Deletion)]
    direction24 String string direction 24(Mandatory) [0 (Unidirectional)]
    tpmonitor24 String string TP monitor 24(Mandatory) [1(All) , 0(End Points only)]
    reportinfo24 String string Report information 24(Mandatory) [0 (CSV 24Hr), 2 (No Report)]
    nimEnabled String string NIM Enabled [true, false]
    linkUtilProfile String string Link Utilization Profile [LOW, HIGH, MEDIUM]
    alarmEnable String string Alarm enable (Mandatory) [NOTSET, enable, disable]
    autoInService String string Auto in service (Mandatory) [enable, disable]
    autoInServiceTimer String string Auto in service timer (Mandatory) ---
    a1osnr String string A1 End OSNR Measurement [NOTSET, Enable, Disable]
    a2osnr String string A2 End OSNR Measurement [NOTSET, Enable, Disable]
    z1osnr String string Z1 End OSNR Measurement [NOTSET, Enable, Disable]
    z2osnr String string Z2 End OSNR Measurement [NOTSET, Enable, Disable]
    a1sigosnr String string A1 AHP AMP SIG Port OSNR Measurement [NOTSET, Enable, Disable]
    z1sigosnr String string Z1 AHP AMP SIG Port OSNR Measurement [NOTSET, Enable, Disable]
    routingeffort String string Routing effort (Mandatory) [2 ( for Best) and 1 (for All)]
    routefrequency String string Route frequency - 2000 (if it does not along to DWDM or CWDM), > 9170 ( if it is DWDM freq), < 1611 (if it is CWDM freq) ---
    routefrequency2 String string --- ---
    ordersensitive String string order sensitive (Mandatory) [true, false]
    otnRoutingConstraints array[OTN routing constraints] OTN routing constraints OTN routing constraints ---
    wavekeyConfig String string Wave key configuration (Mandatory) ---
    wavekeytype String string Wave key type (Mandatory) [auto, manual]
    azwavekeypref String string AZ wave key preferred(Mandatory) [none, duplicate, noduplicate]
    zawavekeypref String string ZA wave key preferred(Mandatory) [none, duplicate, noduplicates]
    wavekeyassignment String string Wave key assignment (Mandatory) [system, user]
    azwavekeypair String string A and z wavekeys seperated by comma derived from /oms1350/data/otn/wavekeyPairs?frequency={frequency chosen in routeconstraints} &fieldId=azwavekey ---
    zawavekeypair String string Z and A wavekeys seperated by comma derived from /oms1350/data/otn/wavekeyPairs?frequency={frequency chosen in routeconstraints} &fieldId=zawavekey ---
    azwavekeyrekey String string AZ wave key re-key [NORekey, RekeywithDup, RekeyNoDup]
    zawavekeyrekey String string ZA wave key re-key [NORekey, RekeywithDup, RekeyNoDup]
    hassdx String string hasSDX (Mandatory) [yes, no]
    freq1 String string Frequency 1- applicable only for 112SDX11 card in ODU4 ---
    freq1azwavekeypair String string Frequency 1 AZ wavekey pair- applicable only for 112SDX11 card in ODU4 ---
    freq1zawavekeypair String string Frequency 1 ZA wavekey pair- applicable only for 112SDX11 card in ODU4 ---
    freq2 String string Frequency 2- applicable only for 112SDX11 card in ODU4 ---
    freq2azwavekeypair String string Frequency 2 AZ wave key pair- applicable only for 112SDX11 card in ODU4 ---
    freq2zawavekeypair String string Frequency 2 ZA wave key pair- applicable only for 112SDX11 card in ODU4 ---
    freq3 String string Frequency 3- applicable only for 112SDX11 card in ODU4 ---
    freq3azwavekeypair String string Frequency 3 AZ wavekey pair- applicable only for 112SDX11 card in ODU4 ---
    freq3zawavekeypair String string Frequency 3 ZA wavekey pair- applicable only for 112SDX11 card in ODU4 ---
    freq4 String string Frequency 4- applicable only for 112SDX11 card in ODU4 ---
    freq4azwavekeypair String string Frequency 4 AZ wave key pair- applicable only for 112SDX11 card in ODU4 ---
    freq4zawavekeypair String string Frequency 4 ZA wavekey pair- applicable only for 112SDX11 card in ODU4 ---
    allowUncommissioned String string Allow uncommissioned (Mandatory) [true, false]
    provisionwavekey String string Provision wave key (Mandatory) [keyed, unkeyed, unkeyAuto, unkeyManual, na]
    connectionid Long long Connection id ---
    orderid Long long Order id ---
    ordernumber String string Order number ---
    rearrange String string Re arrange (Mandatory) [hard, soft]
    reinstate String string Re instate (Mandatory) [none, reinstate]
    operation String string operation (Mandatory) [create, modifyroutepath , modifyroutetrail, addprotectionpath , addprotectiontrail, removeprotectionpath , removeprotectiontrail]
    hasopsb String string hasOPSB (Mandatory) [yes, no]
    fromaside String string From A side (Mandatory) [working, protection]
    asidefromne String string A side From NE name can be retrieved as 'guiLabel' from '/data/npr/nes' ---
    asidefromport String string A side from port nativename in format (shelf)-(slot)-(port) ---
    frombside String string From B side (Mandatory) [working, protection]
    bsidefromne String string B side from NE name can be retrieved as 'guiLabel' from '/data/npr/nes' ---
    bsidefromport String string B side from port nativename in format (shelf)-(slot)-(port) ---
    toaside String string To A side (Mandatory) [working, protection]
    asidetone String string A side to NE name can be retrieved as 'guiLabel' from '/data/npr/nes' ---
    asidetoport String string A side to port nativename in format (shelf)-(slot)-(port) ---
    tobside String string to B side (Mandatory) [working, protection]
    bsidetone String string B side to NE name can be retrieved as 'guiLabel' from '/data/npr/nes' ---
    bsidetoport String string B side to Port nativename in format (shelf)-(slot)-(port) ---
    opsbrevertivemode String string OPSB revertive mode (Mandatory) [Disabled, Enabled]
    opsbrestoretime String string OPSB restore time (Optional) [Integer from 1-360]
    asidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Addition information: A side from Port ---
    bsidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional Information: B side form Port ---
    asidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional information: A side to Port ---
    bsidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional Information: B side to port ---
    hasycable String string Has Y-cable (Mandatory) [yes, no]
    hasycable1 String string Has Y-cable 1 (Mandatory) [yes, no]
    ycablefromne String string Y cable from NE, the Node name can be retrieved as 'guiLabel' from '/data/npr/nodes' (Mandatory) ---
    ycablefromprotne String string Y cable from prot NE, the Node name can be retrieved as 'guiLabel' from '/data/npr/nodes' (Mandatory) ---
    ycablefromwkport String string Y cable form WK port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycablefromprotPort String string --- ---
    ycablefromprotPort1 String string --- ---
    ycabletone String string Y cable to NE,the Node name can be retrieved as 'guiLabel' from '/data/npr/nodes' (Mandatory) ---
    ycabletoprotne String string Y cable to prot NE,the Node name can be retrieved as 'guiLabel' from '/data/npr/nodes' (Mandatory) ---
    ycabletowkport String string Y cable to WK port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycabletoprotport String string Y cable to protected port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycabletoprotport1 String string Y cable to protected port1 - nativename of the port in format (shelf)-(slot)-(port) ---
    ycableswitchmode String string Y cable switch mode (Mandatory) [uni, bi]
    ycableprotectionmode String string Y cable protection mode (Mandatory) [Standard, Legacy]
    ycableholdofftime String string Y cable Hold Off Time (Mandatory) [0, 2, 4, 6, 8, 10, 20, ..., 10000]
    ycablerevertivemode String string Y cable revertive mode (Mandatory) [Disabled, Enabled]
    ycablerestoretime String string Y cable restore time (Mandatory) [Integer from 1-20]
    ycabletimeslot String string Y cable time slot (Mandatory) [Integer from 1-10]
    ycablesignaldegrade String string Y cable Signal Degrade [Disable, Enable]
    otherFromwkPort1XFP String string Y cable pluggable module for from WK port (not managed in the current release by NFMT) - nativename of the port in format (shelf)-(slot)-(port) ---
    otherTowkPort1XFP String string Y cable pluggable module for to WK port (not managed in the current release by NFMT)- nativename of the port in format (shelf)-(slot)-(port) ---
    ycablefromwkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional information:Y cable from WK port ---
    ycablefromprotPort_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional infromation: Y cable from protected port ---
    ycabletowkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional Information: Y cable to WK port ---
    ycabletoprotport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Addtional Information: Y cable to protected port ---
    ycabletoprotport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycablefromprotPort1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Additional infromation: Y cable from protected port ---
    opsaRevertiveMode String string Revertive Mode [disable, enable]
    opsaWaitToRestore String string Wait to Restore Time (min) [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
    hasopsa String string hasOPSA (Mandatory) [yes, no]
    serverAsonRouted String string --- ---
    encapsulationMode String string Encapsulation Mode (Mandatory) [UseNEValue, CBRLAN11.049 (CBRLAN11049), CBRLAN11.096 (CBRLAN11096), GFP-F, GFP-P]
    encodingMode String string Encoding (Mandatory) [8QAM, 16QAM, QPSK, SP-QPSK]
    fromne1__AdditionalInfo HashMap HashMap --- ---
    ycablefromwkPort1XFP String string Y cable pluggable module for from WK port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycablefromprotport1 String string Y cable from protected port1 - nativename of the port in format (shelf)-(slot)-(port) ---
    ycablefromprotPort1XFP String string Y cable pluggable module for from protected port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycabletowkPort1XFP String string Y cable pluggable module for to WK port - nativename of the port in format (shelf)-(slot)-(port) ---
    ycabletoprotPort1XFP String string Y cable pluggable module for to protected port - nativename of the port in format (shelf)-(slot)-(port) ---
    otherFromProtPort1XFP String string Y cable pluggable module for from protected port (not managed in the current release by NFMT)- nativename of the port in format (shelf)-(slot)-(port) ---
    otherToProtPort1XFP String string Y cable pluggable module for to protected port (not managed in the current release by NFMT) - nativename of the port in format (shelf)-(slot)-(port) ---
    latency String string Latency (Mandatory) [true, false]
    odu4InterworkingMode String string ODU4 interworking Mode (Mandatory) [UseNEValue, Enable, Disable]
    payloadTypeMismatchResponse String string Payload type mismatch response (Mandatory) [UseNEValue, Enable, Disable]
    provisionedBitRate String string Provisioned Bit Rate (Mandatory) [UseNEValue, 10.709(10709), 11.049(11049), 11.096(11096)]
    provisionedBitRateDsr String string Provisioned Bit Rate DSR (Mandatory) [UseNEValue, 1.485(1485), 1.4851.001(14851001)]
    transmissionMode String string Transmission Mode (Mandatory) [txmode8qamsingle(8QAM Single Channel), txmode8qamsuper(8QAM Super Channel), txmode16qamsingle(16QAM Single Channel), txmode16qamsuper(16QAM Super Channel), txmode8qamalien(8QAM Alien Channel), txmode16qamalien(16QAM Alien Channel)]
    mappingMode String string Mapping Mode (Mandatory) [UseNEValue, Async, BitSync]
    ycablefromprotport String string Y cable from protected port - nativename of the port in format (shelf)-(slot)-(port) ---
    routingtable array[OTN routing constraints] OTN routing constraints --- ---

    OtnConnTxParams

    Name

    Type

    Description

    Enum

    midCols array[String] string --- ---
    parameter String string Parameter label ---
    name String string Parameter Name ---
    value String string Parameter Value ---
    currentValue String string Current value ---
    discA String string Disc A ---
    discZ String string Disc Z ---
    type String string Type [String, Enumeration, Boolean]
    editorArgs OtnTxParamEditorArgs OtnTxParamEditorArgs Editor Arguments - has options for possible values, maxlength ---
    disabled Boolean boolean Disabled ---
    provisioningLayer String string --- ---

    OtnEndPointContextResponse

    Name

    Type

    Description

    Enum

    feclist array[String] string --- ---
    containerlist array[String] string --- ---
    signaltypelist array[String] string --- ---
    opsbflatlist array[String] string --- ---

    OtnEndPointInfo

    Name

    Type

    Description

    Enum

    label String string --- ---
    name String string --- ---
    type String string --- ---
    value String string --- ---

    OtnEndPointInfoGroup

    Name

    Type

    Description

    Enum

    paramList array[OtnEndPointInfo] OtnEndPointInfo --- ---
    groupname String string --- ---

    OtnEndPointPluggableModuleReq

    Name

    Type

    Description

    Enum

    port_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP Port Additional Info ---
    neName String string neName can be retrieved from '/data/otn/connection/connectionTP' as 'neName' ---
    portName String string portName can be retrieved from '/data/otn/connection/connectionTP' as 'portName' ---
    servicerate String string servicerate can be retrieved from '/data/otn/connection/connectionTP' as 'rate' ---

    OtnEndPointResponse

    Name

    Type

    Description

    Enum

    groups array[OtnEndPointInfoGroup] OtnEndPointInfoGroup --- ---
    txParamTableData array[OtnTxParamTableFormat] OtnTxParamTableFormat --- ---

    OTNError

    Name

    Type

    Description

    Enum

    errorMessageKey String string --- ---
    correctiveActionKey String string --- ---
    errorMsgParameters array[String] string --- ---
    correctiveActionParameters array[String] string --- ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageUnformatted String string Message Unformatted ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageType String string Message Type [Info, Warning, Error]
    messageId String string Message Id ---
    messageParams array[String] string Message Params ---
    messageTime Long long Message Time ---
    message String string Message ---

    OtnNPTProject

    Name

    Type

    Description

    Enum

    designName String string --- ---
    designId String string --- ---
    projectName String string --- ---
    projectId String string --- ---
    projectModifiedDate String string --- ---
    projectModifiedBy String string --- ---
    projectStatus String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

    OtnNPTProjectResponse

    Name

    Type

    Description

    Enum

    status Integer integer --- ---
    errorMessage String string --- ---
    nextTasks array[String] string --- ---
    items array[OtnNPTProject] OtnNPTProject --- ---

    OtnNPTRouteDetail

    Name

    Type

    Description

    Enum

    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    type String string --- ---
    rate String string --- ---
    fromNE String string --- ---
    fromPort String string --- ---
    toNE String string --- ---
    toPort String string --- ---
    fromNE2 String string --- ---
    fromPort2 String string --- ---
    toNE2 String string --- ---
    toPort2 String string --- ---
    serverLinkName String string --- ---
    frequency String string --- ---
    provisioned String string --- ---
    designId String string --- ---
    projectId String string --- ---
    routeId String string --- ---
    protectionType String string --- ---
    serverId String string --- ---

    OtnNPTRouteDetailResponse

    Name

    Type

    Description

    Enum

    status Integer integer --- ---
    errorMessage String string --- ---
    nextTasks array[String] string --- ---
    items array[OtnNPTRouteDetail] OtnNPTRouteDetail --- ---

    OtnNPTRouteID

    Name

    Type

    Description

    Enum

    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    routeId String string --- ---
    fromPort String string --- ---
    toPort String string --- ---
    availableFromPort String string --- ---
    availableToPort String string --- ---
    fromPort2 String string --- ---
    toPort2 String string --- ---
    fromNE String string --- ---
    toNE String string --- ---
    fromNE2 String string --- ---
    toNE2 String string --- ---
    oduName String string --- ---
    comment String string --- ---
    designID String string --- ---
    projectID String string --- ---

    OtnNPTRouteIDResponse

    Name

    Type

    Description

    Enum

    status Integer integer --- ---
    errorMessage String string --- ---
    nextTasks array[String] string --- ---
    items array[OtnNPTRouteID] OtnNPTRouteID --- ---

    OtnPluggableModuleResponse

    Name

    Type

    Description

    Enum

    plugModule String string Pluggable Module ---

    OtnPSEData

    Name

    Type

    Description

    Enum

    otnReliableTpId Long long --- ---
    nprComponentNeId Long long --- ---
    reliableTpInterfaceName String string --- ---
    reliablePtpName String string --- ---
    xosNeName String string --- ---
    reliableTpNativeName String string --- ---
    workingTpNativeName String string --- ---
    workingPtpName String string --- ---
    workingTpInterfaceName String string --- ---
    protectionTpNativeName String string --- ---
    protectionPtpName String string --- ---
    protectionTpInterfaceName String string --- ---
    activeUnit String string --- ---
    activeRoute String string --- ---
    asonTrailId Long long --- ---
    asonTrailUserLabel String string --- ---
    otnNcId Long long --- ---
    eventTime Long long --- ---
    switchReason String string --- ---
    requestFor String string --- ---
    activeCondition String string --- ---
    discrepancyMark Integer integer --- ---
    position String string --- ---
    routeMap array[Entry«string,int»] Entry«string,int» --- ---
    id Object object --- ---

    OtnSyncSwitchResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    message String string --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---

    OtnTCMCreateInfoResponse

    Name

    Type

    Description

    Enum

    connectionId String string Connection Id can be obtained from '/data/otn/connections' REST call as 'id' ---
    connectionName String string ConectionName can be obtained from '/data/otn/connections' REST call as 'guiLabel' ---
    level String string TCM level on Creation [notcm, 1, 2, 3, 4, 5, 6]
    position String string TCM Position Sequence [0, 1, 2]
    fromPortId String string From port Id ---
    toPortId String string To port ID ---
    fromNE String string 'FromNE' can be retrieved from '/data/npr/{table}' (table=nes) REST call as 'guiLabel' ---
    toNE String string 'ToNE'can be retrieved from '/data/npr/{table}' (table=nes) REST call as 'guiLabel' ---
    profileName String string Profile Name ---
    alarmEnabling String string Alarm enabling [Enabled, Disabled, notset]
    a1NodeName String string A1 end NodeName can be retrieved from '/data/npr/{table}' (table=nodes)REST call as 'guiLabel' ---
    a2NodeName String string A2 end NodeName can be retrieved from '/data/npr/{table}'(table=nodes) REST call as 'guiLabel' ---
    z1NodeName String string Z1 end NodeName'can be retrieved from '/data/npr/{table}'(table=nodes) REST call as 'guiLabel' ---
    z2NodeName String string Z2 end NodeName'can be retrieved from '/data/npr/{table}' (table=nodes) REST call as 'guiLabel' ---
    a1PortName String string Nativename of the A1Port in format shelf-slot-port ---
    z1PortName String string Nativename of the Z1Port in format shelf-slot-port ---
    a2PortName String string Nativename of the A2Port in format shelf-slot-port ---
    z2PortName String string Nativename of the Z2Port in format shelf-slot-port ---
    pm15MinuteCollectionType String string Performance Monitoring 15 Minutes Collection Type ---
    pm24HourCollectionType String string Performance Monitoring 24 Hour Collection Type ---
    pm15MinuteMonitoringSelection String string Perform monitoring 15 minutes Monitoring selection ---
    pm24HourMonitoringSelection String string Perform monitoring 24 Hour Monitoring selection ---
    pm15MinuteDirection String string Perform monitoring 15 minutes Direction [Unidirectional, null]
    pm24HourDirection String string Perform monitoring 24 Hour Monitoring selection [Unidirectional, null]
    pm15MinuteReportInfo String string Performance Monitoring 15 Minutes Report Type ---
    pm24HourReportInfo String string Performance Monitoring 24 Hour Report Type ---
    pm15MinuteDataPurgePolicy String string Performance Monitoring 15 Minutes Data Purge Policy ---
    pm24HourDataPurgePolicy String string Performance Monitoring 24 Hour Data Purge Policy ---
    transParams array[TransParams] TransParams Transmission Parameteres ---

    OtnTemplateGroups

    Name

    Type

    Description

    Enum

    groups array[OtnTemplateParameterGroup] OtnTemplateParameterGroup Otn Template Group ---

    OtnTemplateInfo

    Name

    Type

    Description

    Enum

    id Integer integer Connection ID ---
    folderId Integer integer Folder ID ---
    name String string Name ---
    folder String string Folder Name under which Service is created. Ex:/Best Practices/Service/SONET/Unprotected ---
    owner String string Owner [System, User]
    lastmodified String string Last Modified Date and Time ---
    templateType String string Template Type ---
    isPublished Boolean boolean Published-Boolean(True/False) ---

    OtnTemplateInstance

    Name

    Type

    Description

    Enum

    data OtnTemplateGroups OtnTemplateGroups contains all the connection related information ---
    constraints array[OTN routing constraints] OTN routing constraints contains information about the routing constraints of the connections ---
    info OtnTemplateInfo OtnTemplateInfo contains the template information by which connection is being created ---
    txParamTableData array[OtnConnTxParams] OtnConnTxParams contains information about the transmission parameters ---
    discrepancies array[OtnConnTxParams] OtnConnTxParams contains the discrepancy related information for transmission parameters ---
    modifyParamGroup array[OtnTransmissionParamsGroup] OtnTransmissionParamsGroup contains miscellaneous transmission parameters that can be modified. Example:FEC type , Transmission Mode, etc ---

    OtnTemplateParameter

    Name

    Type

    Description

    Enum

    name String string Specifies the name of the Parameter ---
    value String string Specifies the value of the Parameter ---
    type String string Specifies the Type of the Parameter ---
    label String string Specifies the Label of the Parameter ---
    className String string Specifies the ClassName of the Parameter ---

    OtnTemplateParameterGroup

    Name

    Type

    Description

    Enum

    groupname String string Group Name ---
    paramList array[OtnTemplateParameter] OtnTemplateParameter Specifies the Template Parameter List ---

    OtnTPOpticalPower

    Name

    Type

    Description

    Enum

    xlabel XLabel XLabel Xlabel ---
    measPower String string Mean Power ---
    minPower String string Minimum Power ---
    maxPower String string Max Power ---
    tpId String string Topological ID ---
    ptpId String string Physical Topological ID ---
    tooltip Tooltip Tooltip Tool Tip ---
    otdr OTDR OTDR lists OTDR ports(aport,zport) ---
    isLD Boolean boolean true: if given port is LD port, false: if given port is not LD port ---

    OtnTransmissionParamsGroup

    Name

    Type

    Description

    Enum

    paramList array[OtnTxParam] OtnTxParam --- ---
    groupname String string --- ---
    txParamList array[OtnTxParam] OtnTxParam Transimmision Params List ---
    groupName String string Group Name ---

    OtnTxParam

    Name

    Type

    Description

    Enum

    label String string Label of Transmission Parameter ---
    name String string Name of Transmission Parameter ---
    type String string Type of Transmission Parameter ---
    value String string Value of Transmission Parameter ---
    oldValue String string --- ---
    provisioningLayer String string --- ---

    OtnTxParamEditorArgs

    Name

    Type

    Description

    Enum

    options array[String] string Possible Values ---
    maxlength Integer integer Maximum Length ---

    OtnTxParamTableFormat

    Name

    Type

    Description

    Enum

    midCols array[String] string --- ---
    parameter String string --- ---
    name String string --- ---
    currentValue String string --- ---
    type String string --- ---
    editorArgs OtnTxParamEditorArgs OtnTxParamEditorArgs --- ---
    provisioningLayer String string --- ---

    OtnUpdateLinkUtilizationThresholdRequest

    Name

    Type

    Description

    Enum

    id String string otn Id ---
    linkUtilProfile String string Link Utilization Profile ---

    OtnUpdateLinkUtilizationThresholdResponse

    Name

    Type

    Description

    Enum

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

    OtnWltDetailsRequest

    Name

    Type

    Description

    Enum

    wltKey String string --- ---
    portId String string --- ---
    ptpId String string --- ---
    portName String string --- ---
    ptpName String string --- ---
    neId String string --- ---
    neName String string --- ---
    direction String string --- ---
    tpRate String string --- ---
    expectedPower String string --- ---
    expectedPowerDeviation String string --- ---
    maxGain String string --- ---
    minGain String string --- ---
    gain String string --- ---
    isCTPModify String string --- ---
    isPTPModify String string --- ---

    OtnWltDetailsResponse

    Name

    Type

    Description

    Enum

    tpId String string Topological Link ID ---
    ptpId String string Physical Termination Port ID ---
    neId String string Network Element ID ---
    neName String string Network Element Name ---
    portName String string Port Name ---
    ptpName String string Physcial Termination Port Name ---
    direction String string Direction: ZA/AZ ---
    channelId String string Channel ID ---
    frequency String string Frequency ---
    tpRate String string Topological Link Rate ---
    expectedPower String string Expected Power ---
    expectedPowerDeviation String string Expected Power Deviation ---
    wavekey1 String string WaveKey 1 ---
    wavekey2 String string Wave Key 2 ---
    measuredPower String string Measured Power ---
    connectionName String string Connection Name ---
    gain String string Gain ---
    minGain String string Minimum Gain ---
    maxGain String string Maximum Gain ---
    wtdType String string WTD type ---
    status String string Status ---
    message String string Success/Failure Message ---
    messageId String string Message Id ---
    messageSeverity String string Message severity ---

    OtnWLTResponse

    Name

    Type

    Description

    Enum

    wltKey String string WLT key ---
    channelPowerWorking array[OtnTPOpticalPower] OtnTPOpticalPower Channel Power details for Working Connection ---
    totalPowerWorking array[OtnTPOpticalPower] OtnTPOpticalPower Total Power details for Working Connection ---
    channelPowerProtected array[OtnTPOpticalPower] OtnTPOpticalPower Channel Power details for Protected Connection ---
    totalPowerProtected array[OtnTPOpticalPower] OtnTPOpticalPower Total Power details for Working Connection ---
    otnWLTDetails Otn WLT Details Otn WLT Details OTN WLT details ---
    message String string Message ---
    messageId String string Message Id ---
    messageSeverity String string Message Severity ---
    status String string Status ---

    OTS X-label

    Name

    Type

    Description

    Enum

    channelId String string Channel ID ---
    frequency String string Frequency ---
    waveKey1 String string Wave Key 1 ---
    waveKey2 String string Wave Key 2 ---

    OTSTooltip

    Name

    Type

    Description

    Enum

    measuredPower String string Measured Power ---
    expectedPower String string Expected Power ---
    expectedPowerDeviation String string Expected Power Deviation ---
    connectionName String string --- ---

    PayloadSlotObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string ClassName ---
    id String string id ---
    key String string Key ---
    guiLabel String string GuiLabel ---
    parentId String string ParentId ---
    hasChildren String string HasChildren ---
    state String string --- ---
    isCenterFrequencyForFlexGrid String string --- ---
    effRate String string --- ---
    objRef BaseObject BaseObject --- ---

    PGObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string ClassName ---
    id String string id ---
    key String string Key ---
    guiLabel String string GuiLabel ---
    parentId String string ParentId ---
    hasChildren String string HasChildren ---
    protectionGroupId String string --- ---
    activePortId String string --- ---
    workingPortId String string --- ---
    protectionPortId String string --- ---
    connectionId String string --- ---
    connectionGroupId String string --- ---
    neId String string --- ---
    neName String string --- ---
    neType String string --- ---
    neRelease String string --- ---
    sncId String string --- ---
    portRate String string --- ---
    protectionGroupRef String string --- ---
    activePortRef String string --- ---
    workingPortRef String string --- ---
    protectionPortRef String string --- ---
    protectionGroupType String string --- ---
    protectionGroupRate String string --- ---
    switchReasonString String string --- ---
    eastPortNativeName String string --- ---
    westPortNativeName String string --- ---
    eastWorkingPortId String string --- ---
    eastWorkingPortNativeName String string --- ---
    eastProtectionPortId String string --- ---
    eastProtectionPortNativeName String string --- ---
    eastActivePortId String string --- ---
    eastActivePortNativeName String string --- ---
    westWorkingPortId String string --- ---
    westWorkingPortNativeName String string --- ---
    westProtectionPortId String string --- ---
    westProtectionPortNativeName String string --- ---
    westActivePortId String string --- ---
    westActivePortNativeName String string --- ---
    supportsForcedSwitchRing String string --- ---
    supportsManualSwitchRing String string --- ---
    supportsLockoutProtSpan String string --- ---
    supportsForcedSwitchSpan String string --- ---
    supportsManualSwitchSpan String string --- ---
    supportsRelease String string --- ---
    supportsLockout String string --- ---
    supportsForceMain String string --- ---
    supportsForceSpare String string --- ---
    supportsManualMain String string --- ---
    supportsManualSpare String string --- ---
    supportsLockoutOfWorkChannelRing String string --- ---
    supportsReleaseLockoutOfWorkChannelRing String string --- ---
    switchReason String string --- ---
    eastSwitchReason String string --- ---
    westSwitchReason String string --- ---
    activePortDisplayLabel String string --- ---
    workingPortDisplayLabel String string --- ---
    protectionPortDisplayLabel String string --- ---
    pgCommandName String string --- ---
    isCurrentRouteRD String string --- ---
    position HashMap«string,string» HashMap«string,string» --- ---
    workingRoute array[String] string --- ---
    protectingRoute array[String] string --- ---
    connection ConnectionObject ConnectionObject --- ---
    sncTrailName String string --- ---
    locationWithinConnection String string --- ---
    activeLeg String string --- ---
    requestFor String string --- ---
    activeConditions String string --- ---
    nodeName String string --- ---
    inconsistentPgInfo String string --- ---

    PmCounterRequest

    Name

    Type

    Description

    Enum

    portId String string --- ---
    connectionId String string --- ---
    portRate String string --- ---

    ProtectionGroupInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    items array[PGObject] PGObject Items ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    ProtectionSwitchListRsp

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    items array[PseFmData] PseFmData List of Protection Switch Events FM data.Please refer PseFmData for supported PSE data ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---

    PseFmData

    Name

    Type

    Description

    Enum

    pseId String string Indicates the unique Id for the protection switch operation. ---
    pseType String string Indicates the type of protection switch. ---
    switchReason String string Indicates reason for the protection switch operation. ---
    raiseTime String string Indicates raise time for the protection switch operation. ---
    neName String string Ne Name can be retrieved as 'guiLabel' from the REST call '/data/npr/{table}' (table=nes) ---
    groupName String string Indicates group Name of the resource on which protection switch was performed. ---
    layerRate String string Indicates layer Rate of the connection on which protection switch is done. ---
    category String string Indicates category of the event,if any. ---
    protectedResource String string Indicates the protected resource used like 'OPS-shelf-slot-SIG' for OPSA connections. ---
    fromResource String string Indicates resource from which protection switch was done. ---
    toResource String string Indicates resource to which protection switch was done. ---
    acknowledgeTime Date DateTime Indicates time take to acknowledge the operation. ---
    acknowledgeUser String string Indicates the acknowledged user. ---
    ackStatus String string Indicates status of the acknowledgement. ---
    connectionName String string connection Name can be retrieved as 'guiLabel' from the REST call '/data/otn/connections' ---
    connectionId Integer integer ConnectionId can be retrieved as 'id' from the REST call '/data/otn/connections ---
    className String string Specifies the ClassName, for Protection switch Events the Classname is 'psEvent' ---
    id String string Specifies unique Id of the PS event. ---
    key String string Specifies unique key for the event as a combination of Id and ClassName in the format id/ClassName ---
    guiLabel String string Indicates guiLabel of the event.Here,the guiLabel is 'psEvent' ---

    Ptp2PtpRouteComponent

    Name

    Type

    Description

    Enum

    ptpLinkRouteComponent RouteComponent RouteComponent --- ---
    childRouteComponentIds array[Long] long --- ---
    ason Boolean boolean --- ---

    RCTemplateData

    Name

    Type

    Description

    Enum

    description String string --- ---
    fromType String string --- ---
    fieldId String string --- ---
    createdDate String string --- ---
    userName String string --- ---
    templatename String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

    RenameConnectionRequest

    Name

    Type

    Description

    Enum

    oldConnName String string --- ---
    newConnName String string --- ---
    newConnAlias String string --- ---
    newCustomerName String string --- ---
    connIds String string --- ---
    connIdNameMap array[Entry«int,string»] Entry«int,string» --- ---

    Response

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    nextTasks array[String] string Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} ---
    items array[Object] object Items ---
    data array[Object] object data ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    ResponseHeader

    Name

    Type

    Description

    Enum

    originatorApp String string Originator App ---
    objectType String string Object Type ---
    objectScope String string Object Scope ---
    responseStatus String string Response Status ---
    errorCode String string Error code ---
    errorReason String string Error Reason ---
    errorParams array[Map«string,string»] Map«string,string» Error params ---

    RetrieveCSVResponse

    Name

    Type

    Description

    Enum

    date String string --- ---
    action String string --- ---
    object String string --- ---
    user String string --- ---
    requestId String string --- ---

    RetrievePMSchedulerResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    eventChannel String string --- ---
    requestId String string --- ---
    portId String string --- ---

    RouteComponent

    Name

    Type

    Description

    Enum

    ANeId Long long --- ---
    ZNEid Long long --- ---
    effectiveRate String string --- ---
    isFakeLinkForCR Boolean boolean --- ---
    isAsonGMRElink Boolean boolean --- ---
    rcId Long long --- ---
    srcTP TP Data TP Data --- ---
    sinkTP TP Data TP Data --- ---
    rcType Integer integer --- ---
    nccomponentId Long long --- ---
    nccomponenttype Integer integer --- ---
    nccDirection Integer integer --- ---
    rcid Long long --- ---
    routeid Long long --- ---
    segmentid Long long --- ---
    segmentType Integer integer --- ---
    routeSequence Integer integer --- ---
    orientation Integer integer --- ---
    direction Integer integer --- ---
    routeProtectionType Integer integer --- ---
    snccid Long long --- ---
    sncid Long long --- ---
    sncState Integer integer --- ---
    lccid Long long --- ---
    serverId Long long --- ---
    serverName String string --- ---
    serverCategory Integer integer --- ---
    serverConnectionType Integer integer --- ---
    unitNum Integer integer --- ---
    lcRate Integer integer --- ---
    asontccid Long long --- ---
    asonTcName String string --- ---
    asonServerid Long long --- ---
    srcNeid Long long --- ---
    srcNeName String string --- ---
    srcNodeId Long long --- ---
    srcNodeName String string --- ---
    sinkNeid Long long --- ---
    sinkNeName String string --- ---
    sinkNodeId Long long --- ---
    sinkNodeName String string --- ---
    srcTpid Long long --- ---
    srcTpName String string --- ---
    srcTpDisplayLabel String string --- ---
    srcPtpName String string --- ---
    srcPtpDisplayLabel String string --- ---
    srcTpRate Integer integer --- ---
    sinkTpid Long long --- ---
    sinkTpName String string --- ---
    sinkTpDisplayLabel String string --- ---
    sinkPtpName String string --- ---
    sinkPtpDisplayLabel String string --- ---
    sinkPtpCardName String string --- ---
    srcPtpCardName String string --- ---
    sinkNeModel String string --- ---
    srcNeModel String string --- ---
    sinkNeVersion String string --- ---
    srcNeVersion String string --- ---
    sinkPtpRate Integer integer --- ---
    srcPtpRate Integer integer --- ---
    sinkTpRate Integer integer --- ---
    connectiontype String string --- ---
    frequency String string --- ---
    frequencyHierarchy String string --- ---
    connectionId Long long --- ---
    srcSubNeId Long long --- ---
    sinkSubNeId Long long --- ---
    srcPtpId Long long --- ---
    sinkPtpId Long long --- ---
    protectionHierarchy String string --- ---
    segmentIdHierarchy String string --- ---
    connectionHierarchy String string --- ---
    connectionRateHierarchy String string --- ---
    routeSequenceHierarchy String string --- ---
    linkActiveState String string --- ---
    sourceActive Boolean boolean --- ---
    sinkActive Boolean boolean --- ---
    sncType Integer integer --- ---
    sncUserLabel String string --- ---
    sncDiscrepancyMark Integer integer --- ---
    isFixedSnc Integer integer --- ---
    sncRate Integer integer --- ---
    effectiveRatee String string --- ---
    fakeLinkForCR Boolean boolean --- ---
    asonGMRElink Boolean boolean --- ---

    RouteDetail

    Name

    Type

    Description

    Enum

    routeType Integer integer --- ---
    routeId Long long --- ---
    connectionId Long long --- ---
    connectionName String string --- ---
    connectionShape Integer integer --- ---
    connectionDirection Integer integer --- ---
    connectionRate Integer integer --- ---
    effectiveRate String string --- ---
    connectionState Integer integer --- ---
    depth Integer integer --- ---
    segments array[RouteSegment] RouteSegment --- ---
    segmentsZA array[RouteSegment] RouteSegment --- ---
    segmentLoc HashMap«long,int» HashMap«long,int» --- ---
    segmentZALoc HashMap«long,int» HashMap«long,int» --- ---

    RouteSegment

    Name

    Type

    Description

    Enum

    segmentId Long long --- ---
    segType Integer integer --- ---
    main array[RouteComponent] RouteComponent --- ---
    second array[RouteComponent] RouteComponent --- ---

    ServerTrail

    Name

    Type

    Description

    Enum

    aEnd String string --- ---
    aEndPortId Integer integer --- ---
    zEnd String string --- ---
    zEndPortId Integer integer --- ---
    trailName String string --- ---
    trailId String string --- ---
    mainRoute array[CurrentRouteView] CurrentRouteView --- ---
    spareRoute array[CurrentRouteView] CurrentRouteView --- ---

    SlteLxDetails

    Name

    Type

    Description

    Enum

    connectionId Long long --- ---
    portUserlabel String string --- ---
    portLabel String string --- ---
    aportId Long long --- ---
    zportId Long long --- ---
    a2portId Long long --- ---
    z2portId Long long --- ---
    nodeId Long long --- ---
    direction Long long --- ---
    slteUserLabel String string --- ---

    StatsJson

    Name

    Type

    Description

    Enum

    chartDetails array[Map«string,object»] Map«string,object» --- ---

    TCMconnectionRequest

    Name

    Type

    Description

    Enum

    CAonTCMTIM String string CA on TCMTIM(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceMonitor String string TCM trail trace monitor(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceActualTx String string TCM trail trace actual Transmission(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceExpectedRx String string TCM trail trace expected receiver(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceActualDestTx String string TCM trail trace actual destination transmitter(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceExpectedDestRx String string TCM trail trace expected destination receiver(createTCM: Mandatory, modifyTCM: Not Required) ---
    TCMTrailTraceActualOsTx String string TCM trail trace actual OS transmitter(createTCM: Mandatory, modifyTCM: Not Required) ---
    CAonLTCDef String string CA on LTC def(createTCM: Mandatory, modifyTCM: Not Required) ---
    CAonTCMDef String string TCM AIS Consequent Action(createTCM: Mandatory, modifyTCM: Not Required) ---
    connectionId String string Connection ID ---
    connectionName String string Connection Name ---
    level String string Level(createTCM: Mandatory, modifyTCM: Not Required) ---
    position String string Position(createTCM: Mandatory, modifyTCM: Not Required) ---
    tcmEndPoints String string --- ---
    profileName String string Profile Name ---
    alarmEnabling String string Alarm Enabling ---
    a1NodeName String string A1 Node Name ---
    a2NodeName String string A2 Node Name ---
    z1NodeName String string Z1 Node Name ---
    z2NodeName String string Z2 Node Name ---
    a1PortName String string A1 Port Name ---
    z1PortName String string Z1 Port Name ---
    a2PortName String string A2 Port Name ---
    z2PortName String string Z2 Port Name ---
    pm15MinuteCollectionType String string PM 15 Minute Collection type ---
    pm24HourCollectionType String string PM 24 Hour collection type ---
    pm15MinuteReportInfo String string PM 15 Minute Report Information ---
    pm24HourReportInfo String string PM 24 Hour Report Information ---
    pm15MinuteDataPurgePolicy String string PM 15 minute data purge policy ---
    pm24HourDataPurgePolicy String string PM 24 Hour Data purge policy ---
    pm15MinuteMonitoringSelection String string PM 15 minute monitoring selection ---
    pm24HourMonitoringSelection String string PM 24 hour monitoring selecition ---
    pm15MinuteDirection String string PM 15 minute direction ---
    pm24HourDirection String string PM 24 hour direction ---

    TCMTPListInfo

    Name

    Type

    Description

    Enum

    TCMTrailTraceMonitor String string --- ---
    TCMTrailTraceActualTx String string --- ---
    TCMTrailTraceExpectedRx String string --- ---
    TCMTrailTraceActualDestTx String string --- ---
    TCMTrailTraceExpectedDestRx String string --- ---
    TCMTrailTraceActualOSTx String string --- ---
    TCMTrailTraceExpectedOSTx String string --- ---
    CAonTCMTIM String string --- ---
    CAonLTCDef String string --- ---
    TCMTTIStatus String string --- ---
    TCMIncomingSAPI String string --- ---
    TCMIncomingDAPI String string --- ---
    CAonTCMDef String string --- ---
    TCMbrstth String string --- ---
    TCMbrstintvl String string --- ---
    TCMMode String string --- ---
    TCMIncomingStatBits String string --- ---
    id Long long Id ---
    className String string Class name of the TCMPList Info ---
    guiLabel String string GuiLabel ---
    port String string Port where the TCM is created ---
    tcmTpInterfaceName String string TCMTP Interface Name ---
    ne String string Ne can be retrieved as 'guiLabel' from the REST call '/data/npr/{table}' (table=nes) ---
    asapName String string Asap Name ---
    tcmLayerRate String string TCM Layer rate ---
    positionalSequence String string TCM Positional Sequence [0, 1, 2]
    level String string TCM level on Creation [notcm, 1, 2, 3, 4, 5, 6]
    tcmRole String string Tcm Role ---
    connectionId Long long Connection Id can be obtained from '/data/otn/connections' REST call as 'id' ---
    connectionName String string ConectionName can be obtained from '/data/otn/connections' REST call as 'guiLabel' ---
    connectionRate String string Connection rate ---
    tcmTpId Long long TCM TP id ---
    ctpId Long long CTP Id ---

    TCMTPListJSONResponse

    Name

    Type

    Description

    Enum

    message String string Specifies the Response Message ---
    messageId String string Specifies the Message Id of the Response Message ---
    messageSeverity String string Message Severity I for Success,E for failure,W for In-Progress ---
    status String string Status of the Response Message [SUCCESS, FAILURE, IN_PROGRESS]
    items array[TCMTPListInfo] TCMTPListInfo List of TCM TP Information ---

    TimeSlotTuple

    Name

    Type

    Description

    Enum

    className String string Class Name ---
    key String string Key ---
    id Long long Id ---
    timeSlot Integer integer Time Slot ---
    availability String string Availability ---
    odujNum String string ODU-j Number ---

    Tooltip

    Name

    Type

    Description

    Enum

    measuredPower String string Measured Power ---
    expectedPower String string Expected Power ---
    expectedPowerDeviation String string Expected Power Deviation ---
    frequency String string Frequency ---
    totalPower String string Total Power ---

    TP Data

    Name

    Type

    Description

    Enum

    nwInterfaceType Integer integer --- ---
    isCapableOfPmMonitoringPort Boolean boolean --- ---
    isTerminalLoopbackSupportedTp Boolean boolean --- ---
    isFacilityLoopbackSupportedTp Boolean boolean --- ---
    hasLoopback Boolean boolean --- ---
    nodeId Long long Node Id ---
    nodeName String string Node Name ---
    neId Long long NE ID ---
    neName String string NE Name ---
    ptpId Long long Physical Topological Link Id ---
    ptpName String string Physical Topological link Name ---
    tpId Long long Topological Link Id ---
    tpName String string Topological Link Name ---
    tpDisplayLabel String string TP display Label ---
    ptpLayerRate Integer integer PTP layer Rate ---
    layerRate Integer integer Layer Rate ---
    tpType Integer integer TP Type ---
    effectiveRate String string Effective Rate ---
    frequency String string Frequency ---
    clientSel String string Client Port Selected ---
    xfpName String string OCS NE port Name ---
    displayEdgeOnNe String string Display Edge on NE ---
    directionality String string Directionality ---
    nbiInterfaceName String string NBI interface Name ---
    tpUserLabel String string TP User Label ---
    parentTpType Integer integer Parent TP type ---
    signalType String string Signal Type ---
    neModel String string NE Model ---
    neSoftwareVersion String string NE software Version ---
    almState String string --- ---
    baseLineValueOPT String string --- ---
    baseLineValueOPR String string --- ---
    transmitPower String string --- ---
    receivePower String string --- ---
    encoding String string Encoding ---
    waveShape String string Wave Shape ---
    primaryState String string --- ---
    secondaryState String string --- ---
    wtdUsageType String string --- ---
    wtdUsageTypeL String string --- ---
    ingressMeasType String string --- ---
    egressMeasType String string --- ---
    powerManagementType String string --- ---
    loopbackType String string --- ---
    phaseEncoding String string Phase Encoding ---
    bandwidth String string --- ---
    oduKPort String string ODU-k Port ---
    cardName String string --- ---
    cardMode String string --- ---
    cardInterworkingMode String string --- ---
    derivedNodeName String string Derived Node Name ---
    terminalLoopbackSupportedPort Boolean boolean --- ---
    facilityLoopbackSupportedPort Boolean boolean --- ---
    networkInterfaceType Integer integer Network Interface Type ---
    capableOfPmMonitoringPort Boolean boolean --- ---

    TpAsapProfileInfo

    Name

    Type

    Description

    Enum

    tpId Long long --- ---
    asapType String string --- ---

    TpComponentInfo

    Name

    Type

    Description

    Enum

    tpId Long long --- ---
    tpComponentRate String string --- ---
    layerRateId Integer integer --- ---
    effectiveRate String string --- ---
    availabilityState Integer integer --- ---

    TPInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    requestId Long long --- ---
    clientName String string --- ---
    mdcId String string --- ---
    sessionId String string --- ---
    timeout Long long --- ---
    nadString String string --- ---

    TransParams

    Name

    Type

    Description

    Enum

    azDestinationTrailTrace String string AZ Destination Trail Trace ---
    azSourceTrailTrace String string AZ Source Trail Trace ---
    zaDestinationTrailTrace String string ZA Destination Trail Trace ---
    zaSourceTrailTrace String string ZA Source Trail Trace ---
    operatorSpecificDestinationTrailTrace String string Operator Specific Destination Trail Trace ---
    lossOfTandemConnectionConsequentAction String string Loss of Tandem Connection Consequent Action ---
    trailTraceMismatchDetectionMode String string Trail Trace Mismatch Detection Mode ---
    trailTraceMismatchConsequentAction String string Trail Trace Mismatch Consequent Action ---

    TXTemplateData

    Name

    Type

    Description

    Enum

    description String string --- ---
    createdDate String string --- ---
    userName String string --- ---
    templatename String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    txParamData String string Trasmission param Data. Please refer the OTN Transmission Parameters link for supported transmission params and allowed values ---

    Void

    Name

    Type

    Description

    Enum

    WavekeyAssignmentData

    Name

    Type

    Description

    Enum

    toneOverlap String string Tone Overlap ---
    waveKey1 String string Specifies the WaveKey1 ---
    waveKey2 String string Specifies the WaveKey2 ---
    waveKey1And2 String string Specifies WaveKey1 and WaveKey2 ---
    status String string Specifies the WaveKey Status Example :WKS_AVAILABLE if available ---
    frequency String string --- ---
    fieldId String string --- ---
    className String string Specifies the ClassName as 'wavekeyPair' ---
    id String string Specifies the combination of Wavekey1,WaveKey2 ---
    key String string Specifies the combination of ClassName,id ---
    guiLabel String string Specifies the combination of Wavekey1,WaveKey2 ---

    WDM Response

    Name

    Type

    Description

    Enum

    timeout Long long --- ---
    reqCompletionStatus Integer integer --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    nadString String string --- ---
    requestId Long long --- ---
    clientName String string --- ---
    mdcId String string --- ---
    sessionId String string --- ---

    WL Tracker LD Port

    Name

    Type

    Description

    Enum

    id Long long ID ---
    key String string Key ---
    className String string Class Name ---
    guiLabel String string GUI Label ---
    neName String string NE Name ---
    portDirection String string Port Direction ---
    powerMgmt String string Power Management ---
    adjStatus String string Power Adjust Status ---
    adjResult String string Power Adjust Result ---
    label String string Label ---
    portId Long long Port ID ---
    portName String string Port Name ---
    neId Long long NE Id ---
    ptpId Long long Physical Topological Link ID ---

    WLT Response

    Name

    Type

    Description

    Enum

    connectionName String string --- ---
    connectionId Long long --- ---
    rate String string --- ---
    isProtected Boolean boolean --- ---
    protectionType String string --- ---
    isAsonRouted Boolean boolean --- ---
    serviceAZ array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    serviceZA array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    protectAZ array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    protectZA array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    message String string Message ---
    messageId String string Message ID ---
    messageSeverity String string Message Severity ---
    status String string Status ---

    Wlt2_DetailsResponse

    Name

    Type

    Description

    Enum

    otsDetails Otn WLT Channel Details Otn WLT Channel Details --- ---
    otukDetails Otn WLT Details Otn WLT Details --- ---
    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---

    Wlt2_SignalPathContainer

    Name

    Type

    Description

    Enum

    isLinkOTS Boolean boolean --- ---
    otu Wlt2_SignalPathOTU Wlt2_SignalPathOTU --- ---
    isNE Boolean boolean --- ---
    ne Wlt2_SignalPathNE Wlt2_SignalPathNE --- ---
    isCurrentRouteOCH Boolean boolean --- ---

    Wlt2_SignalPathNE

    Name

    Type

    Description

    Enum

    neName String string --- ---
    neId Long long --- ---
    neModel String string --- ---
    isBBOX Boolean boolean --- ---
    isCommunicating Boolean boolean --- ---
    frequency String string --- ---
    tp array[Wlt2_SignalPathTP] Wlt2_SignalPathTP --- ---
    ncName String string --- ---
    ncId Long long --- ---
    errorMsg String string --- ---

    Wlt2_SignalPathOTU

    Name

    Type

    Description

    Enum

    otuTrailId Long long --- ---
    connectionName String string --- ---
    rate String string --- ---
    isProtected Boolean boolean --- ---
    protectionType String string --- ---
    provisionableWavekey String string --- ---
    connectionCategory Integer integer --- ---
    otuStartingNe String string --- ---
    frequency String string --- ---
    band String string --- ---
    currentRouteIdList String string --- ---
    oduNcId Long long --- ---

    Wlt2_SignalPathPower

    Name

    Type

    Description

    Enum

    hasMeasuredPower Boolean boolean --- ---
    measPower String string --- ---
    expectedPowerMeasure String string --- ---
    expectedPowerDeviation String string --- ---
    hasTotalPower Boolean boolean --- ---
    totalPower String string --- ---
    hasTotalPowerL Boolean boolean --- ---
    totalPowerL String string --- ---
    hasWavekeys Boolean boolean --- ---
    wavekey1 String string --- ---
    wavekey2 String string --- ---
    powerManagementType String string --- ---
    osnrValue String string --- ---
    onsrValue String string --- ---
    gain String string --- ---
    channelId String string --- ---
    frequency String string --- ---

    Wlt2_SignalPathTP

    Name

    Type

    Description

    Enum

    isWtocmPowerMeasurementType Boolean boolean --- ---
    isWtocmPowerMeasurementTypeL Boolean boolean --- ---
    hasMeasurablePower Boolean boolean --- ---
    tpId Long long --- ---
    ctpId Long long --- ---
    tpName String string --- ---
    ctpName String string --- ---
    rate String string --- ---
    tpShortName String string --- ---
    xfpName String string --- ---
    cardName String string --- ---
    direction String string --- ---
    power Wlt2_SignalPathPower Wlt2_SignalPathPower --- ---
    nprTlId Long long --- ---
    wtdUsageType String string --- ---
    wtdUsageTypeL String string --- ---
    wtdMeasurementType String string --- ---
    powerManagementType String string --- ---
    minGain String string --- ---
    maxGain String string --- ---
    adjResult String string --- ---
    wtocmPowerMeasurementTypeL Boolean boolean --- ---
    wtocmPowerMeasurementType Boolean boolean --- ---

    XCInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    items array[XCObject] XCObject Items ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    XCObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    azCIR String string --- ---
    zaCIR String string --- ---
    azEIR String string --- ---
    zaEIR String string --- ---
    azCBS String string --- ---
    azEBS String string --- ---
    zaCBS String string --- ---
    zaEBS String string --- ---
    domain String string --- ---
    className String string ClassName ---
    id String string id ---
    key String string Key ---
    guiLabel String string GuiLabel ---
    parentId String string ParentId ---
    hasChildren String string HasChildren ---
    sncId String string SncId ---
    orderId String string OrderId ---
    nodeName String string nodeName ---
    neName String string neName ---
    a1PortName String string a1Portname ---
    z1PortName String string Z1PortName ---
    a2PortName String string a2PortName ---
    z2PortName String string Z2PortName ---
    xcState String string XcState ---
    xcRate String string xcRate ---
    xcShape String string xcshape ---
    eventDateTime String string EventDateTime ---
    fixedXC String string Fixed XC ---
    connectionName String string connection Name ---
    connectionAlias String string Connection Alias ---
    connectionId String string ConnectionId ---
    sigType String string signal Type ---
    timeslots String string time slots ---
    waveKeyConfig String string WaveKeyConfig ---
    azwaveKey1 String string azwaveKey1 ---
    azwaveKey2 String string azwavekey2 ---
    zawaveKey1 String string zawavekey1 ---
    zawaveKey2 String string ZwaveKey2 ---
    azwaveKeyingPreference String string azwaveKeyingPreference ---
    zawaveKeyingPreference String string zawaveKeyingPreference ---
    switchMode String string SwitchMode ---
    revertiveMode String string RevertiveMode ---
    waitToRestoreTime String string waitToRestoreTime ---
    committedBurstSize String string CommittedBurstSize ---
    committedInfoRate String string CommittedInfoRate ---
    excessBurstSize String string ExcessBurstSize ---
    excessInfoRate String string ExcessInfoRate ---
    xcWidth String string xcWidth ---
    opsaWaitToRestoreTime String string opsaWaitToRestoreTime ---
    opsaRevertiveMode String string opsaRevertiveMode ---
    neModel String string neModel ---
    cdrChannel String string cdrChannel ---
    xcDomain String string domain ---

    XLabel

    Name

    Type

    Description

    Enum

    ne String string Node Name ---
    portName String string Port Name ---
    direction String string Direction: IN, OUT ---
    measurementType String string Measurement Type ---
    powerMgmtType String string Power Management Type ---