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/v3/services?name=ReST%20API%20Optical%20Service%23OCH

Response:

{
  "status": 0,
  "startRow": 0,
  "endRow": 4,
  "totalRows": 1,
  "data": [
    {
      "id": "4035-cd1302e6-164d-440f-a6ff-c9393969cf8b",
      "appId": null,
      "operationalState": null,
      "adminState": null,
      "neDeploymentState": null,
      "externalIds": [
        {
          "context": "OMS",
          "location": [
            "135.121.20.91",
            ""
          ],
          "id": "connection-ReST API Optical Service#OCH"
        }
      ],
      "name": "ReST API Optical Service#OCH",
      "serviceType": "OCH",
      "connectionState": "DISCONNECTED",
      "tenants": [
        {
          "id": "0",
          "tenantName": "admin",
          "contactName": null,
          "phoneNumber": null,
          "address": null
        }
      ],
      "topology": null,
      "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": "224-23492c62-e2bf-4683-a4a7-a35e2b19b49e",
          "appId": null,
          "operationalState": "DOWN",
          "adminState": "UP",
          "neDeploymentState": null,
          "externalIds": [
            {
              "context": "OMS",
              "location": [
                "135.121.20.91",
                ""
              ],
              "id": "CloudSim_183_003_PSS:130SNX10-1-12-L1-1@OCH@"
            }
          ],
          "neId": "37-78979225-9da9-466c-a72e-175c885b37f0",
          "neName": "CloudSim_183_003_PSS",
          "portId": "222-7782e973-5c83-464b-aeb8-7365d919534f",
          "serviceId": "4035-cd1302e6-164d-440f-a6ff-c9393969cf8b",
          "name": "130SNX10-1-12-L1-1",
          "innerTag": null,
          "outerTag": null,
          "siteServiceQosProfile": {
            "qosProfile": 0,
            "ingressOverrideQueues": null,
            "egressOverrideQueues": null,
            "ingressParam": null,
            "egressParam": null
          },
          "isHub": null,
          "@class": "com.alu.wsc.api.generated.v3.L2ServiceEndpoint"
        },
        {
          "id": "360-c3642e53-8699-4356-a900-c344ac3b9a70",
          "appId": null,
          "operationalState": "DOWN",
          "adminState": "UP",
          "neDeploymentState": null,
          "externalIds": [
            {
              "context": "OMS",
              "location": [
                "135.121.20.91",
                ""
              ],
              "id": "CloudSim_183_004_PSS:130SNX10-1-14-L1-1@OCH@"
            }
          ],
          "neId": "55-eb96cac6-c91e-48a5-83c2-c60647114070",
          "neName": "CloudSim_183_004_PSS",
          "portId": "358-dd501255-459f-4206-b5cc-b8e8bc097223",
          "serviceId": "4035-cd1302e6-164d-440f-a6ff-c9393969cf8b",
          "name": "130SNX10-1-14-L1-1",
          "innerTag": null,
          "outerTag": null,
          "siteServiceQosProfile": {
            "qosProfile": 0,
            "ingressOverrideQueues": null,
            "egressOverrideQueues": null,
            "ingressParam": null,
            "egressParam": null
          },
          "isHub": null,
          "@class": "com.alu.wsc.api.generated.v3.L2ServiceEndpoint"
        }
      ],
      "opticalServiceRoute": {
        "routes": []
      },
      "switchTab": null,
      "restoration": "None",
      "reversionMode": "auto",
      "protectionType": "UNPROTECTED",
      "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.v3.OpticalService"
    }
  ]
}