Operation

get /data/otn/connections/{id}/asonId
asonIdFromOtnConnectionId (asonIdFromOtnConnectionId : /data/otn/connections/{id}/asonId)
asonIdFromOtnConnectionId

Path parameters

Name

IsRequired

Description

Enum

id required id ---

Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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/connection/{id}/clientHierarchy/graph
    clientHierarchyGraphById (clientHierarchyGraphById : /data/otn/connection/{id}/clientHierarchy/graph)
    clientHierarchyGraphById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • HierarchicalConnectionDataJSON
  • Responses

    Response Messages

    Schema

    200success HierarchicalConnectionDataJSON
    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}/clientHierarchy/graph
    clientHierarchyGraphById (clientHierarchyGraphById : /data/otn/connections/{id}/clientHierarchy/graph)
    clientHierarchyGraphById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • HierarchicalConnectionDataJSON
  • Responses

    Response Messages

    Schema

    200success HierarchicalConnectionDataJSON
    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}/clientHierarchy
    clientHierarchysById (clientHierarchysById : /data/otn/connection/{id}/clientHierarchy)
    clientHierarchysById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    query 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 :

    Operation

    get /data/otn/connections/{id}/clientHierarchy
    clientHierarchysById (clientHierarchysById : /data/otn/connections/{id}/clientHierarchy)
    clientHierarchysById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    query 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 :

    Operation

    get /data/otn/physicalConns/{id}/clients
    clientsFromNprPhysicalConnection (clientsFromNprPhysicalConnection : /data/otn/physicalConns/{id}/clients)
    clientsFromNprPhysicalConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    query 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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/otn/connection/{id}/client
    clientssById (clientssById : /data/otn/connection/{id}/client)
    clientssById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/clients
    clientssById (clientssById : /data/otn/connections/{id}/clients)
    clientssById

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

    External Docs
    See Also :

    Operation

    get /data/otn/physicalConns/{nprId}/otnConnectionId
    connectionIdFromNprId (connectionIdFromNprId : /data/otn/physicalConns/{nprId}/otnConnectionId)
    connectionIdFromNprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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/physicalConns/{nprId}/otnConnectionIds
    connectionIdsFromNprIds (connectionIdsFromNprIds : /data/otn/physicalConns/{nprId}/otnConnectionIds)
    connectionIdsFromNprIds

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId ---

    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/physicalConns/otnConnectionIds
    connectionIdsFromNprIdsInRequestBody (connectionIdsFromNprIdsInRequestBody : /data/otn/physicalConns/otnConnectionIds)
    connectionIdsFromNprIdsInRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nprId 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 :

    Operation

    get /data/otn/connections/paths/{id}/structure
    connectionStructureFromId (connectionStructureFromId : /data/otn/connections/paths/{id}/structure)
    connectionStructureFromId

    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/connections/physicalLinks/{id}/structure
    connectionStructureFromId (connectionStructureFromId : /data/otn/connections/physicalLinks/{id}/structure)
    connectionStructureFromId

    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/connections/trails/{id}/structure
    connectionStructureFromId (connectionStructureFromId : /data/otn/connections/trails/{id}/structure)
    connectionStructureFromId

    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/connections/{id}/structure
    connectionStructureFromId (connectionStructureFromId : /data/otn/connections/{id}/structure)
    connectionStructureFromId

    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/physicalConns/{nprId}/structure
    connectionStructureFromNprId (connectionStructureFromNprId : /data/otn/physicalConns/{nprId}/structure)
    connectionStructureFromNprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId ---

    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}
    connectionsFromNprIds (connectionsFromNprIds : /data/otn/physicalConns/{nprId})
    connectionsFromNprIds

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId ---

    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 :

    Operation

    post /data/otn/physicalConns
    connectionsFromNprIdsAsRequestBody (connectionsFromNprIdsAsRequestBody : /data/otn/physicalConns)
    connectionsFromNprIdsAsRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nprId 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 :

    Operation

    get /data/otn/connection/lldp/{id}
    getConnectionLLDPParameterListById (getConnectionLLDPParameterListById : /data/otn/connection/lldp/{id})
    getConnectionLLDPParameterListById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/lldp/nename/{neName}/port/{portName}
    getConnectionLLDPParameterListByPort (getConnectionLLDPParameterListByPort : /data/otn/connection/lldp/nename/{neName}/port/{portName})
    getConnectionLLDPParameterListByPort

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---
    portName required portName ---

    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 :

    Operation

    get /data/otn/connections/{id}/primary
    getPrimaryConnIdById (getPrimaryConnIdById : /data/otn/connections/{id}/primary)
    getPrimaryConnIdById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/details
    getProtectionDetailsForConn (getProtectionDetailsForConn : /data/otn/connections/{id}/details)
    getProtectionDetailsForConn

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

    External Docs
    See Also :

    Operation

    get /data/otn/protectedConnections/{id}/details
    getProtectionDetailsForConn (getProtectionDetailsForConn : /data/otn/protectedConnections/{id}/details)
    getProtectionDetailsForConn

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/affectedConnection
    listAffectedConnectionByFilters (listAffectedConnectionByFilters : /data/otn/connection/affectedConnection)
    listAffectedConnectionByFilters

    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 ---
    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/affectedConnections
    listAffectedConnectionByFilters (listAffectedConnectionByFilters : /data/otn/connections/affectedConnections)
    listAffectedConnectionByFilters

    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 ---
    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/affectedConnection/{id}
    listAffectedConnectionById (listAffectedConnectionById : /data/otn/connection/affectedConnection/{id})
    listAffectedConnectionById

    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/connections/affectedConnections/{id}
    listAffectedConnectionById (listAffectedConnectionById : /data/otn/connections/affectedConnections/{id})
    listAffectedConnectionById

    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/connections/{id}/endPoints/physicalPorts
    listEndPointsDetailsById (listEndPointsDetailsById : /data/otn/connections/{id}/endPoints/physicalPorts)
    listEndPointsDetailsById

    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/physicalConns/{nprId}/endPoints/physicalPorts
    listEndPointsDetailsByNprId (listEndPointsDetailsByNprId : /data/otn/physicalConns/{nprId}/endPoints/physicalPorts)
    listEndPointsDetailsByNprId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprId required nprId ---

    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
    list_Frequency (listFrequency : /data/otn/connections/{id}/nodes/{nodeId}/frequency)
    list_Frequency

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    nodeId required nodeId ---

    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

    get /data/otn/connection/networkConnection
    listNetworkConnectionsByFilters (listNetworkConnectionsByFilters : /data/otn/connection/networkConnection)
    listNetworkConnectionsByFilters

    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 ---
    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
    listNetworkConnectionsByFilters (listNetworkConnectionsByFilters : /data/otn/connections)
    listNetworkConnectionsByFilters

    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 ---
    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/networkConnections
    listNetworkConnectionsByFilters (listNetworkConnectionsByFilters : /data/otn/connections/networkConnections)
    listNetworkConnectionsByFilters

    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 ---
    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/networkConnections
    listNetworkConnectionsByFilters (listNetworkConnectionsByFilters : /data/otn/networkConnections)
    listNetworkConnectionsByFilters

    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 ---
    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/path
    listPathsByFilters (listPathsByFilters : /data/otn/connection/path)
    listPathsByFilters

    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 ---
    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/paths
    listPathsByFilters (listPathsByFilters : /data/otn/connections/paths)
    listPathsByFilters

    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 ---
    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/paths
    listPathsByFilters (listPathsByFilters : /data/otn/paths)
    listPathsByFilters

    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 ---
    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/path/{id}
    listPathsById (listPathsById : /data/otn/connection/path/{id})
    listPathsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/paths/{id}
    listPathsById (listPathsById : /data/otn/connections/paths/{id})
    listPathsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/paths/{id}
    listPathsById (listPathsById : /data/otn/paths/{id})
    listPathsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/protected
    listProtectedConnectionByFilters (listProtectedConnectionByFilters : /data/otn/connections/protected)
    listProtectedConnectionByFilters

    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 :

    Operation

    get /data/otn/protectedConnections
    listProtectedConnectionByFilters (listProtectedConnectionByFilters : /data/otn/protectedConnections)
    listProtectedConnectionByFilters

    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 :

    Operation

    get /data/otn/connections/protected/{id}
    listProtectedConnectionsById (listProtectedConnectionsById : /data/otn/connections/protected/{id})
    listProtectedConnectionsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/protectedConnections/{id}
    listProtectedConnectionsById (listProtectedConnectionsById : /data/otn/protectedConnections/{id})
    listProtectedConnectionsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/protectionGroups
    listProtectionGroupsByConnId (listProtectionGroupsByConnId : /data/otn/connections/{id}/protectionGroups)
    listProtectionGroupsByConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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 :

    Operation

    get /data/otn/protectedConnections/{id}/protectionGroups
    listProtectionGroupsByConnId (listProtectionGroupsByConnId : /data/otn/protectedConnections/{id}/protectionGroups)
    listProtectionGroupsByConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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 :

    Operation

    get /data/otn/connections/switchedConnections
    listSwitchedConnectionsByConnId (listSwitchedConnectionsByConnId : /data/otn/connections/switchedConnections)
    listSwitchedConnectionsByConnId

    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 :

    Operation

    get /data/otn/connection/trail
    listTrailsByFilters (listTrailsByFilters : /data/otn/connection/trail)
    listTrailsByFilters

    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 ---
    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/trails
    listTrailsByFilters (listTrailsByFilters : /data/otn/connections/trails)
    listTrailsByFilters

    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 ---
    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/trails
    listTrailsByFilters (listTrailsByFilters : /data/otn/trails)
    listTrailsByFilters

    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 ---
    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/trail/{id}
    listTrailsById (listTrailsById : /data/otn/connection/trail/{id})
    listTrailsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/lopcs/{id}
    listTrailsById (listTrailsById : /data/otn/connections/lopcs/{id})
    listTrailsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/trails/{id}
    listTrailsById (listTrailsById : /data/otn/connections/trails/{id})
    listTrailsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/lopcs/{id}
    listTrailsById (listTrailsById : /data/otn/lopcs/{id})
    listTrailsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/trails/{id}
    listTrailsById (listTrailsById : /data/otn/trails/{id})
    listTrailsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/usedPorts
    listUsedPortConnectionByFilters (listUsedPortConnectionByFilters : /data/otn/connection/usedPorts)
    listUsedPortConnectionByFilters

    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 ---
    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/usedPorts
    listUsedPortConnectionByFilters (listUsedPortConnectionByFilters : /data/otn/connections/usedPorts)
    listUsedPortConnectionByFilters

    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 ---
    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/usedPorts/{id}
    listUsedPortConnectionById (listUsedPortConnectionById : /data/otn/connection/usedPorts/{id})
    listUsedPortConnectionById

    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/connections/usedPorts/{id}
    listUsedPortConnectionById (listUsedPortConnectionById : /data/otn/connections/usedPorts/{id})
    listUsedPortConnectionById

    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/connection/networkConnection/{id}
    networkConnectionsById (networkConnectionsById : /data/otn/connection/networkConnection/{id})
    networkConnectionsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/networkConnections/{id}
    networkConnectionsById (networkConnectionsById : /data/otn/connections/networkConnections/{id})
    networkConnectionsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}
    networkConnectionsById (networkConnectionsById : /data/otn/connections/{id})
    networkConnectionsById

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkConnections/{id}
    networkConnectionsById (networkConnectionsById : /data/otn/networkConnections/{id})
    networkConnectionsById

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

    External Docs
    See Also :

    Operation

    post /data/otn/connections
    networkConnectionsByIdInRequestBody (networkConnectionsByIdInRequestBody : /data/otn/connections)
    networkConnectionsByIdInRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional 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 :

    Operation

    post /data/otn/connections/networkConnections
    networkConnectionsByIdInRequestBody (networkConnectionsByIdInRequestBody : /data/otn/connections/networkConnections)
    networkConnectionsByIdInRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional 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 :

    Operation

    post /data/otn/networkConnections
    networkConnectionsByIdInRequestBody (networkConnectionsByIdInRequestBody : /data/otn/networkConnections)
    networkConnectionsByIdInRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional 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 :

    Operation

    get /data/otn/connections/physicalLinks/ots
    otssByNprNodeIds (otssByNprNodeIds : /data/otn/connections/physicalLinks/ots)
    otssByNprNodeIds

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNodeIds required nprNodeIds ---

    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 :

    Operation

    get /data/otn/connections/physicalLinks/{id}
    physicalLinkssById (physicalLinkssById : /data/otn/connections/physicalLinks/{id})
    physicalLinkssById

    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/physicalLinks/{id}
    physicalLinkssById (physicalLinkssById : /data/otn/physicalLinks/{id})
    physicalLinkssById

    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/connection/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/connection/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/paths/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/connections/paths/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/trails/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/connections/trails/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/connections/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/paths/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/paths/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/trails/{id}/serverHierarchy
    serverHierarchyById (serverHierarchyById : /data/otn/trails/{id}/serverHierarchy)
    serverHierarchyById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/{id}/serverHierarchy/graph
    serverHierarchyGraphById (serverHierarchyGraphById : /data/otn/connection/{id}/serverHierarchy/graph)
    serverHierarchyGraphById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • HierarchicalConnectionDataJSON
  • Responses

    Response Messages

    Schema

    200success HierarchicalConnectionDataJSON
    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}/serverHierarchy/graph
    serverHierarchyGraphById (serverHierarchyGraphById : /data/otn/connections/{id}/serverHierarchy/graph)
    serverHierarchyGraphById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • HierarchicalConnectionDataJSON
  • Responses

    Response Messages

    Schema

    200success HierarchicalConnectionDataJSON
    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}/server
    serversById (serversById : /data/otn/connection/{id}/server)
    serversById

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/{id}/servers
    serversById (serversById : /data/otn/connections/{id}/servers)
    serversById

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

    External Docs
    See Also :

    Operation

    get /data/otn/paths/{id}/servers
    serversById (serversById : /data/otn/paths/{id}/servers)
    serversById

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

    External Docs
    See Also :

    Operation

    get /data/otn/trails/{id}/servers
    serversById (serversById : /data/otn/trails/{id}/servers)
    serversById

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

    External Docs
    See Also :

    BaseObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---

    ConnectionInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    nextTasks array[String] string --- ---
    items array[Object] object --- ---
    data array[Object] object --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    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 --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---
    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 --- ---

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    HierarchicalConnectionDataJSON

    Name

    Type

    Description

    Enum

    name String string --- ---
    connId String string --- ---
    alarmSeverity String string --- ---
    children array[HierarchicalConnectionDataJSON] HierarchicalConnectionDataJSON --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageType String string --- [Info, Warning, Error]
    messageUnformatted String string --- ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageId String string --- ---
    messageParams array[String] string --- ---
    messageTime Long long --- ---
    message String string --- ---

    PayloadSlotObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---
    state String string --- ---
    isCenterFrequencyForFlexGrid String string --- ---
    effRate String string --- ---
    objRef BaseObject BaseObject --- ---

    PGObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---
    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 --- ---

    ProtectionGroupInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    items array[PGObject] PGObject --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---