Get Corresponding OCH Optical Service

GET OCH service that corresponds to ODU service created by NSP. OCH service name is same as CREATED ODU service name with #OCH appended. Reserved characters such as #, $, &, +, /, :, ;, =, ?, @, [, ] can be included in filter but need to be URI encoded.

GET https://<NSP Server>:8543/sdn/api/v4/services?name=ReST%20API%20Optical%20Service%23OCH

Response:

{
  "status": 0,
  "startRow": 0,
  "endRow": 4,
  "totalRows": 1,
  "data": [
    {
      "id": "4059-919c8f81-c552-4e24-abed-73b72c6f7370",
      "appId": null,
      "operationalState": null,
      "adminState": null,
      "neDeploymentState": null,
      "externalIds": [
        {
          "context": "NFM_T",
          "location": [
            "135.121.20.91",
            ""
          ],
          "id": "connection-ReST API Optical Service#OCH"
        }
      ],
      "name": "ReST API Optical Service#OCH",
      "serviceType": "OCH",
      "tenantIds": [
        "0"
      ],
      "objective": "COST",
      "bidirectional": "SYMMETRIC_LOOSE",
      "bw": null,
      "reverseBW": null,
      "maxLatency": 0,
      "maxCost": 0,
      "maxHops": 0,
      "lifeCycle": {
        "phase": "Deployment",
        "state": "DeploymentFailed",
        "reason": "OCH Layer deployment failed"
      },
      "templateId": null,
      "tunnelSelectionId": null,
      "pathProfileId": null,
      "groupId": null,
      "endpoints": [
        {
          "id": "371-73ce2019-d237-435b-bac2-5a1e28ae34ea",
          "appId": null,
          "operationalState": "DOWN",
          "adminState": "UP",
          "neDeploymentState": null,
          "externalIds": [
            {
              "context": "NFM_T",
              "location": [
                "135.121.20.91",
                ""
              ],
              "id": "CloudSim_183_004_PSS:130SNX10-1-14-L1-1@OCH@"
            }
          ],
          "neId": "66-74aea464-e49c-4d55-99b8-9edd0c297ce0",
          "neName": "CloudSim_183_004_PSS",
          "portId": "369-cd768236-e0a9-4425-8428-0965134d7a7b",
          "portName": "130SNX10-1-14-L1@OCH",
          "serviceId": "4059-919c8f81-c552-4e24-abed-73b72c6f7370",
          "name": "130SNX10-1-14-L1-1",
          "innerTag": null,
          "outerTag": null,
          "siteServiceQosProfile": {
            "qosProfile": 0,
            "ingressOverrideQueues": null,
            "egressOverrideQueues": null,
            "ingressParam": null,
            "egressParam": null
          },
          "isHub": null,
          "aggregateBw": 0,
          "@class": "com.alu.wsc.api.generated.v4.L2ServiceEndpoint"
        },
        {
          "id": "235-e45bd410-9a62-470e-a08e-a898c925d815",
          "appId": null,
          "operationalState": "DOWN",
          "adminState": "UP",
          "neDeploymentState": null,
          "externalIds": [
            {
              "context": "NFM_T",
              "location": [
                "135.121.20.91",
                ""
              ],
              "id": "CloudSim_183_003_PSS:130SNX10-1-12-L1-1@OCH@"
            }
          ],
          "neId": "51-858ac5d5-ec73-4d55-a25e-9e3b30222062",
          "neName": "CloudSim_183_003_PSS",
          "portId": "233-89e5369e-5127-4de1-b371-566125a5c24d",
          "portName": "130SNX10-1-12-L1@OCH",
          "serviceId": "4059-919c8f81-c552-4e24-abed-73b72c6f7370",
          "name": "130SNX10-1-12-L1-1",
          "innerTag": null,
          "outerTag": null,
          "siteServiceQosProfile": {
            "qosProfile": 0,
            "ingressOverrideQueues": null,
            "egressOverrideQueues": null,
            "ingressParam": null,
            "egressParam": null
          },
          "isHub": null,
          "aggregateBw": 0,
          "@class": "com.alu.wsc.api.generated.v4.L2ServiceEndpoint"
        }
      ],
      "opticalServiceRoute": {
        "routes": []
      },
      "switchTab": null,
      "restoration": "None",
      "reversionMode": "auto",
      "protectionType": "UNPROTECTED",
      "ochList": {
        "ochTrails": []
      },
      "routingState": "normal",
      "readyToRevert": true,
      "availableBw": 0,
      "lambda": 0,
      "facility": 1,
      "modulation": "SYSTEM_ASSIGNED",
      "phaseEncoding": "system_assigned",
      "waveshape": "system_assigned",
      "servicePlaneType": "managementPlane",
      "nfmtTypeOfService": "TRAIL",
      "@class": "com.alu.wsc.api.generated.v4.OpticalService"
    }
  ]
}