Operation

post /data/otn/connections/{id}/abort
abortConnection (abortConnection : /data/otn/connections/{id}/abort)
abortConnection

Path parameters

Name

IsRequired

Description

Enum

id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/action
    actionConnection (actionConnection : /data/otn/connections/{id}/action)
    actionConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/notes/add
    addNewNote (addNewNote : /data/otn/notes/add)
    addNewNote

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Operation

    post /data/otn/connections/{id}/asap
    asapConnection (asapConnection : /data/otn/connections/{id}/asap)
    asapConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/autodetachclients
    autodetachclients (autodetachclients : /data/otn/connections/{id}/autodetachclients)
    autodetachclients

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/autoreattachclients
    autoreattachclients (autoreattachclients : /data/otn/connections/{id}/autoreattachclients)
    autoreattachclients

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/autoremoveprotection
    autoremoveprotection (autoremoveprotection : /data/otn/connections/{id}/autoremoveprotection)
    autoremoveprotection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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 ---
    actiontype required ---
    connName optional ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/cancel
    cancelConnection (cancelConnection : /data/otn/connections/{id}/cancel)
    cancelConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/computeLatency
    computeLatencyMeasurementByConnectionIds (computeLatencyMeasurementByConnectionIds : /data/otn/connections/computeLatency)
    computeLatencyMeasurementByConnectionIds

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional connectionInfo 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
    Produces
    This API 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/Connection/{id}/convertCurrentToNominal
    convertCurrentToNominal (convertCurrentToNominal : /data/otn/Connection/{id}/convertCurrentToNominal)
    convertCurrentToNominal

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/crossConnects/create
    createCrossConnection (createCrossConnection : /data/otn/crossConnects/create)
    createCrossConnection

    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/internallinks
    createInternalConnection (createInternalConnection : /data/otn/connections/internallinks)
    createInternalConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«InternalConnectionRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«InternalConnectionRsp»
    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/Connection
    createModifyConnection (createModifyConnection : /data/otn/Connection)
    createModifyConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/Connection/UsingTemplate
    createModifyConnectionBasedOnTemplate (createModifyConnectionBasedOnTemplate : /data/otn/Connection/UsingTemplate)
    createModifyConnectionBasedOnTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnConnectionRequest ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/useCSV
    createModifyConnectionUsingCSV (createModifyConnectionUsingCSV : /data/otn/connections/useCSV)
    createModifyConnectionUsingCSV

    Query parameters

    Name

    IsRequired

    Description

    name optional ---
    action optional ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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}/delete
    deleteConnection (deleteConnection : /data/otn/connections/{id}/delete)
    deleteConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/connection/delete
    deleteConnectionForAutomation (deleteConnectionForAutomation : /data/otn/connection/delete)
    deleteConnectionForAutomation

    Query parameters

    Name

    IsRequired

    Description

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/crossConnects/delete
    deleteCrossConnection (deleteCrossConnection : /data/otn/crossConnects/delete)
    deleteCrossConnection

    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/notes/delete
    deleteNote (deleteNote : /data/otn/notes/delete)
    deleteNote

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Operation

    post /data/otn/rcTemplate/deleterctemplate
    deleterctemplate (deleterctemplate : /data/otn/rcTemplate/deleterctemplate)
    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 :

    Operation

    post /data/otn/notes/edit
    editNote (editNote : /data/otn/notes/edit)
    editNote

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Operation

    post /data/otn/connections/getLatency
    getConnectionLatency (getConnectionLatency : /data/otn/connections/getLatency)
    getConnectionLatency

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional 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/NeDetails
    getNeDetails (getNeDetails : /data/otn/NeDetails)
    getNeDetails

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Name

    IsRequired

    Description

    neName required ---

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

    Path parameters

    Name

    IsRequired

    Description

    Enum

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

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

    Query parameters

    Name

    IsRequired

    Description

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

    Return type
  • DeferredResult«OtnTemplateInstance»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnTemplateInstance»
    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

    post /data/otn/connections/{id}/manage
    manageConnection (manageConnection : /data/otn/connections/{id}/manage)
    manageConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/Connection/bulkpm
    modifyBulkConnection (modifyBulkConnection : /data/otn/Connection/bulkpm)
    modifyBulkConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/Connection/{id}
    modifyConnection (modifyConnection : /data/otn/Connection/{id})
    modifyConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnConnectionRequest ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/connection/modifyConnParameters/{connId}
    modifyConnectionParameters (modifyConnectionParameters : /data/otn/connection/modifyConnParameters/{connId})
    modifyConnectionParameters

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req List[Entry«string,Map«string,string»»] ---
    body2 optional httpSession HttpSession ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/rctemplates/modify
    ModifyRCTemplate (modifyRCTemplate : /data/otn/rctemplates/modify)
    ModifyRCTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Operation

    post /data/otn/connections/{id}/move
    moveConnection (moveConnection : /data/otn/connections/{id}/move)
    moveConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/autoaddprotection
    myaddprotection (myaddprotection : /data/otn/connections/{id}/autoaddprotection)
    myaddprotection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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 ---
    actiontype required ---
    connName optional ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/nim
    nimConnection (nimConnection : /data/otn/connections/nim)
    nimConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/snc/sync/{sncId}
    pathSyncOnEntity (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/InsertNe
    performInsertNeAction (performInsertNeAction : /data/otn/InsertNe)
    performInsertNeAction

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Name

    IsRequired

    Description

    scriptExecutedFor required ---
    neName required ---
    neType required ---
    fromPortId required ---
    toPortId required ---
    connectionNameOfOSandOTS required ---
    oCSCrossConnect required ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/reconcileLayout
    performReconcileLayoutAction (performReconcileLayoutAction : /data/otn/reconcileLayout)
    performReconcileLayoutAction


    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/RemoveNe
    performRemoveNeAction (performRemoveNeAction : /data/otn/RemoveNe)
    performRemoveNeAction

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Name

    IsRequired

    Description

    scriptExecutedFor required ---
    neName required ---
    neType required ---
    connectionNameOfOSandOTS1 required ---
    connectionNameOfOSandOTS2 required ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/reinstate
    reinstateConnection (reinstateConnection : /data/otn/connections/{id}/reinstate)
    reinstateConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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
    releaseLoopback (releaseLoopback : /data/otn/connections/loopback/release)
    releaseLoopback

    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/removeProtection
    removeProtection (removeProtection : /data/otn/connections/{id}/removeProtection)
    removeProtection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/acknowledge
    restoreInconsistentConnection (restoreInconsistentConnection : /data/otn/connections/{id}/acknowledge)
    restoreInconsistentConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/{id}/restore
    restoreInconsistentConnection (restoreInconsistentConnection : /data/otn/connections/{id}/restore)
    restoreInconsistentConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/csvFile
    retrieveCSV (retrieveCSV : /data/otn/csvFile)
    retrieveCSV

    Query parameters

    Name

    IsRequired

    Description

    connectionId optional ---
    connectionName optional ---

    Return type
  • DeferredResult«RetrieveCSVResponseList»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«RetrieveCSVResponseList»
    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/switchData/{connId}
    retrieveConnectionSwitchData (retrieveConnectionSwitchData : /data/otn/Connection/switchData/{connId})
    retrieveConnectionSwitchData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • NbiSwitchDataResponse
  • Responses

    Response Messages

    Schema

    200success NbiSwitchDataResponse
    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/retrieveJobTask
    retrieveJobTaskByConnection (retrieveJobTaskByConnection : /data/otn/connections/retrieveJobTask)
    retrieveJobTaskByConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional 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
    Produces
    This API 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/{connId}/lldpParameter
    retrieveLLDPParameterList (retrieveLLDPParameterList : /data/otn/Connection/{connId}/lldpParameter)
    retrieveLLDPParameterList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • LLDPParamResponse
  • Responses

    Response Messages

    Schema

    200success LLDPParamResponse
    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/retrieveLatency
    retrieveLatencyMeasurementByConnection (retrieveLatencyMeasurementByConnection : /data/otn/connections/retrieveLatency)
    retrieveLatencyMeasurementByConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional connectionInputList ConnectionInputList ---

    Return type
  • LatencyMeasurmentResponse
  • Responses

    Response Messages

    Schema

    200success LatencyMeasurmentResponse
    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/Notes
    retrieveNoteList (retrieveNoteList : /data/otn/Notes)
    retrieveNoteList

    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
  • DeferredResult«NoteListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«NoteListRsp»
    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/notes
    retrieveNoteList (retrieveNoteList : /data/otn/notes)
    retrieveNoteList

    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
  • DeferredResult«NoteListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«NoteListRsp»
    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/opsaData/{connId}
    retrieveOpsaAttributes (retrieveOpsaAttributes : /data/otn/Connection/opsaData/{connId})
    retrieveOpsaAttributes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • OpsaParametersResponse
  • Responses

    Response Messages

    Schema

    200success OpsaParametersResponse
    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
    retrievePSE (retrievePSE : /data/otn/psEvents)
    retrievePSE

    Query parameters

    Name

    IsRequired

    Description

    connectionId optional ---
    connectionName optional ---

    Return type
  • DeferredResult«ProtectionSwitchListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«ProtectionSwitchListRsp»
    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/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«OtnConnectionInfo»»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,List«OtnConnectionInfo»»]
    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
    retrieveRCTemplate (retrieveRCTemplate : /data/otn/rcTemplate)
    retrieveRCTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • DeferredResult«RCTemplateInfoListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«RCTemplateInfoListRsp»
    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/RCTemplateDetails
    retrieveRCTemplateDetails (retrieveRCTemplateDetails : /data/otn/RCTemplateDetails)
    retrieveRCTemplateDetails

    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
  • DeferredResult«RCTemplateDetailListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«RCTemplateDetailListRsp»
    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/wavekeyPairs
    retrieveWavekey (retrieveWavekey : /data/otn/wavekeyPairs)
    retrieveWavekey

    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
  • DeferredResult«WavekeyAssignmentListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«WavekeyAssignmentListRsp»
    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/lineModeProfiles
    retrievelineModeProfilesDetails (retrievelineModeProfilesDetails : /data/otn/lineModeProfiles)
    retrievelineModeProfilesDetails

    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
  • DeferredResult«LineModeProfileListRsp»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«LineModeProfileListRsp»
    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

    post /data/otn/rctemplates/saveas
    SaveAsRCTemplate (saveAsRCTemplate : /data/otn/rctemplates/saveas)
    SaveAsRCTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Operation

    post /data/otn/connections/{id}/service
    serviceConnection (serviceConnection : /data/otn/connections/{id}/service)
    serviceConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required 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«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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/setLatency
    setConnectionLatency (setConnectionLatency : /data/otn/connections/setLatency)
    setConnectionLatency

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    post /data/otn/connection/{connectIds}/asap
    updateAsap (updateAsap : /data/otn/connection/{connectIds}/asap)
    updateAsap

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectIds required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnAsapConnectionRequest ---

    Return type
  • DeferredResult«OtnAsapConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnAsapConnectionResponse»
    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/path/{connectIds}/asap
    updateAsap (updateAsap : /data/otn/path/{connectIds}/asap)
    updateAsap

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectIds required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnAsapConnectionRequest ---

    Return type
  • DeferredResult«OtnAsapConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnAsapConnectionResponse»
    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/trail/{connectIds}/asap
    updateAsap (updateAsap : /data/otn/trail/{connectIds}/asap)
    updateAsap

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectIds required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnAsapConnectionRequest ---

    Return type
  • DeferredResult«OtnAsapConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnAsapConnectionResponse»
    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/asap/{asapId}/layerRate/{rate}
    updateAsapByLayerRate (updateAsapByLayerRate : /data/otn/asap/{asapId}/layerRate/{rate})
    updateAsapByLayerRate

    Path parameters

    Name

    IsRequired

    Description

    Enum

    asapId required asapId ---
    rate required rate ---

    Return type
  • DeferredResult«OtnAsapConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnAsapConnectionResponse»
    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/trail/{connectionIds}/linkUtilization
    updateLinkUtilizationThreshold (updateLinkUtilizationThreshold : /data/otn/trail/{connectionIds}/linkUtilization)
    updateLinkUtilizationThreshold

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connectionIds required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OtnUpdateLinkUtilizationThresholdRequest ---

    Return type
  • DeferredResult«OtnUpdateLinkUtilizationThresholdResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnUpdateLinkUtilizationThresholdResponse»
    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/connection/renameConnection/
    updateNetworkConnectionNameAndAlias (updateNetworkConnectionNameAndAlias : /data/otn/connection/renameConnection/)
    updateNetworkConnectionNameAndAlias

    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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}
    updateNetworkConnectionNameAndAlias (updateNetworkConnectionNameAndAlias : /data/otn/connection/renameConnection/{connId})
    updateNetworkConnectionNameAndAlias

    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
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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 :

    BulkPMRequest

    Name

    Type

    Description

    Enum

    connectionid String string --- ---
    orderid String string --- ---
    ordernumber String string --- ---
    operation String string --- ---
    pm15min String string --- ---
    pmdata15 String string --- ---
    direction15 String string --- ---
    tpmonitor15 String string --- ---
    reportinfo15 String string --- ---
    pm24hr String string --- ---
    pmdata24 String string --- ---
    direction24 String string --- ---
    tpmonitor24 String string --- ---
    reportinfo24 String string --- ---
    alarmEnable String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    a1osnr String string --- ---
    a2osnr String string --- ---
    z1osnr String string --- ---
    z2osnr String string --- ---
    requestId Long long --- ---
    connectionName String string --- ---
    a1sigosnr String string --- ---
    z1sigosnr String string --- ---

    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 --- ---
    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 --- ---
    message String string --- ---
    computeLatencyJobInfo HashMap«long,ComputeLatencyJobInfo» HashMap«long,ComputeLatencyJobInfo» --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    ConnectionInputList

    Name

    Type

    Description

    Enum

    connectionIdList array[String] string --- ---
    connectionNameList array[String] string --- ---

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

    DeferredResult«InternalConnectionRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«LineModeProfileListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«NoteListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnAsapConnectionResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnConnectionResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnSyncSwitchResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnTemplateInstance»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnUpdateLinkUtilizationThresholdResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«ProtectionSwitchListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«RCTemplateDetailListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«RCTemplateInfoListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«RetrieveCSVResponseList»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«WavekeyAssignmentListRsp»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    Entry«int,string»

    Name

    Type

    Description

    Enum

    key String string --- ---

    Entry«string,List«OtnConnectionInfo»»

    Name

    Type

    Description

    Enum

    key array[OtnConnectionInfo] OtnConnectionInfo --- ---

    Entry«string,Map«string,string»»

    Name

    Type

    Description

    Enum

    key Object object --- ---

    HashMap

    Name

    Type

    Description

    Enum

    HashMap«long,ComputeLatencyJobInfo»

    Name

    Type

    Description

    Enum

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    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 --- ---
    serviceRate String string --- ---
    tid String string --- ---
    fromport1 String string --- ---
    toport1 String string --- ---
    toport2 String string --- ---
    crossRegenPort String string --- ---
    protectionPort String string --- ---
    xhrConnectionType String string --- ---

    InternalConnectionRsp

    Name

    Type

    Description

    Enum

    message String string --- ---
    opStatus String string --- ---
    connectionId String string --- ---
    connectionName String string --- ---
    failed String string --- ---

    LatencyMeasurementData

    Name

    Type

    Description

    Enum

    connectionId String string --- ---
    connectionName String string --- ---
    actualLatencyWorking String string --- ---
    actualLatencyProtection String string --- ---
    latencyTimestamp String string --- ---
    latencyValue String string --- ---

    LatencyMeasurmentResponse

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[LatencyMeasurementData] LatencyMeasurementData --- ---
    status String string --- ---

    LineModeProfileData

    Name

    Type

    Description

    Enum

    lineModeProfileId String string --- ---
    payloadRate String string --- ---
    baudRate String string --- ---
    encoding String string --- ---
    fecType String string --- ---
    phasenc String string --- ---
    clotuType String string --- ---
    txShape String string --- ---
    trackPolar String string --- ---
    linemodedescription String string --- ---
    linemodename String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

    LineModeProfileListRsp

    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[LineModeProfileData] LineModeProfileData --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    LLDPParamResponse

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

    NbiSwitchDataResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    invariantConnId String string --- ---
    connId String string --- ---
    listOfAsonIds Collection Collection --- ---

    NIMConnectionRequest

    Name

    Type

    Description

    Enum

    connectionid String string --- ---
    orderid String string --- ---
    ordernumber String string --- ---
    operation String string --- ---
    connectionName String string --- ---

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

    NoteListRsp

    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[NoteData] NoteData --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    OpsaParametersResponse

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

    OtnAsapConnectionRequest

    Name

    Type

    Description

    Enum

    asapId String string --- ---
    asapName String string --- ---

    OtnAsapConnectionResponse

    Name

    Type

    Description

    Enum

    ok Boolean boolean --- ---
    responseMessage String string --- ---
    HTTPResponse Integer integer --- ---
    id String string --- ---
    responseList array[Object] object --- ---
    httpResponse Integer integer --- ---
    satus Boolean boolean --- ---
    message String string --- ---

    OtnConnectionInfo

    Name

    Type

    Description

    Enum

    connectionName String string --- ---
    connectionId String string --- ---
    responseStatus String string --- ---
    connectionType String string --- ---
    connectionStyle String string --- ---
    statusMessage String string --- ---

    OtnConnectionPortTP

    Name

    Type

    Description

    Enum

    portid Long long --- ---
    className String string --- ---
    label String string --- ---
    guiLabel String string --- ---
    key String string --- ---
    id Long long --- ---
    neId Long long --- ---
    neName String string --- ---
    neLabel String string --- ---
    neModel String string --- ---
    nodeName String string --- ---
    portName String string --- ---
    rate String string --- ---
    type String string --- ---
    cardName String string --- ---
    availability String string --- ---
    frequency String string --- ---
    rxFrequency String string --- ---
    oprMode String string --- ---
    frequencyType String string --- ---
    layerRate Integer integer --- ---
    direction Integer integer --- ---
    timeslot Integer integer --- ---
    alarmState Integer integer --- ---
    ptpId Long long --- ---
    ptpName String string --- ---
    ptpRate String string --- ---
    connectionId Long long --- ---
    connectionName String string --- ---
    connectionRate String string --- ---
    port String string --- ---
    portGrpMode String string --- ---
    odukPort String string --- ---
    portId Long long --- ---

    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 --- ---
    templateId Long long --- ---
    eventServerUrl String string --- ---
    eventChannel String string --- ---
    connshape String string --- ---
    customerName String string --- ---
    connectionname String string --- ---
    connectionalias String string --- ---
    serviceratetype String string --- ---
    servicerate String string --- ---
    trailrate String string --- ---
    bandwidth String string --- ---
    cirrate String string --- ---
    eirrate String string --- ---
    cbs String string --- ---
    ebs String string --- ---
    cevlan String string --- ---
    svlan String string --- ---
    protectiontype String string --- ---
    fec String string --- ---
    waveShape String string --- ---
    phaseEncoding String string --- ---
    lineModeProfile String string --- ---
    lopc String string --- ---
    allowAsonResources String string --- ---
    lBandFreq String string --- ---
    subsea String string --- ---
    ntwSliceId String string --- ---
    latencyConstraintPolicy String string --- ---
    latencyValue String string --- ---
    createdByAson String string --- ---
    restoration String string --- ---
    aendworkport String string --- ---
    rollBack Boolean boolean --- ---
    omsProtectionMode String string --- ---
    opticalImpairmentRouting String string --- ---
    fromne1 String string --- ---
    fromport1 String string --- ---
    fromne2 String string --- ---
    fromport2 String string --- ---
    tone1 String string --- ---
    toport1 String string --- ---
    tone2 String string --- ---
    toport2 String string --- ---
    fromPort1XFP String string --- ---
    fromPort2XFP String string --- ---
    toPort1XFP String string --- ---
    toPort2XFP String string --- ---
    otherFromPort1XFP String string --- ---
    otherFromPort2XFP String string --- ---
    otherToPort1XFP String string --- ---
    otherToPort2XFP String string --- ---
    fromporttype1 String string --- ---
    fromporttype2 String string --- ---
    toporttype1 String string --- ---
    toporttype2 String string --- ---
    tone1_AdditionalInfo HashMap HashMap --- ---
    fromport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    fromport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    toport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    toport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    port1timeslot String string --- ---
    port2timeslot String string --- ---
    port3timeslot String string --- ---
    port4timeslot String string --- ---
    routing String string --- ---
    orderstep String string --- ---
    routedisplay String string --- ---
    containerrate String string --- ---
    lineRate String string --- ---
    signalType String string --- ---
    clientSel String string --- ---
    a1ClientSel String string --- ---
    z1ClientSel String string --- ---
    a2ClientSel String string --- ---
    z2ClientSel String string --- ---
    xmnActualBitRate String string --- ---
    polarization String string --- ---
    odukAZSrcTrace String string --- ---
    odukZASrcTrace String string --- ---
    odukTraceMismatchDectMode String string --- ---
    odukTraceMismatchAction String string --- ---
    xmnAZClientClassificationMode String string --- ---
    xmnZAClientClassificationMode String string --- ---
    fecEnable String string --- ---
    asymInterwk String string --- ---
    encryptionState String string --- ---
    encryptionNextKey String string --- ---
    encryptionWKAT String string --- ---
    encryptionSwitchOverToNextKey String string --- ---
    payloadType String string --- ---
    apsEnable String string --- ---
    ssmSupport String string --- ---
    outQl String string --- ---
    timeSlotL1 String string --- ---
    spectrumWidth String string --- ---
    txParamData array[OtnConnTxParams] OtnConnTxParams --- ---
    tcmLevel String string --- ---
    waitForServerRestoration String string --- ---
    preferredRestorationMode String string --- ---
    reversionMode String string --- ---
    maxlatency String string --- ---
    defaultsetuppriority String string --- ---
    defaultpriority String string --- ---
    includecolorprofile String string --- ---
    excludecolorprofile String string --- ---
    scId String string --- ---
    softRevertiveSncpMode String string --- ---
    softRevertiveSncpTimeout String string --- ---
    clientprotectiontype String string --- ---
    clientSwitchMode String string --- ---
    clientholdofftime String string --- ---
    clientprotectedMethod String string --- ---
    clientprotectingMethod String string --- ---
    clientsignaldegrade String string --- ---
    clientwaittime String string --- ---
    clientrevertivemode String string --- ---
    nwkprotectiontype String string --- ---
    nwkSwitchMode String string --- ---
    nwkholdofftime String string --- ---
    nwkprotectedMethod String string --- ---
    nwkprotectingMethod String string --- ---
    nwksignaldegrade String string --- ---
    nwkwaittime String string --- ---
    nwkrevertivemode String string --- ---
    asonsubntwkprttype String string --- ---
    pm15min String string --- ---
    pmdata15 String string --- ---
    direction15 String string --- ---
    tpmonitor15 String string --- ---
    reportinfo15 String string --- ---
    pm24hr String string --- ---
    pmdata24 String string --- ---
    direction24 String string --- ---
    tpmonitor24 String string --- ---
    reportinfo24 String string --- ---
    nimEnabled String string --- ---
    linkUtilProfile String string --- ---
    alarmEnable String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    a1osnr String string --- ---
    a2osnr String string --- ---
    z1osnr String string --- ---
    z2osnr String string --- ---
    a1sigosnr String string --- ---
    z1sigosnr String string --- ---
    routingeffort String string --- ---
    routefrequency String string --- ---
    routefrequency2 String string --- ---
    ordersensitive String string --- ---
    otnRoutingConstraints array[OtnRoutingConstraints] OtnRoutingConstraints --- ---
    wavekeyConfig String string --- ---
    wavekeytype String string --- ---
    azwavekeypref String string --- ---
    zawavekeypref String string --- ---
    wavekeyassignment String string --- ---
    azwavekeypair String string --- ---
    zawavekeypair String string --- ---
    azwavekeyrekey String string --- ---
    zawavekeyrekey String string --- ---
    hassdx String string --- ---
    freq1 String string --- ---
    freq1azwavekeypair String string --- ---
    freq1zawavekeypair String string --- ---
    freq2 String string --- ---
    freq2azwavekeypair String string --- ---
    freq2zawavekeypair String string --- ---
    freq3 String string --- ---
    freq3azwavekeypair String string --- ---
    freq3zawavekeypair String string --- ---
    freq4 String string --- ---
    freq4azwavekeypair String string --- ---
    freq4zawavekeypair String string --- ---
    allowUncommissioned String string --- ---
    provisionwavekey String string --- ---
    connectionid Long long --- ---
    orderid Long long --- ---
    ordernumber String string --- ---
    rearrange String string --- ---
    reinstate String string --- ---
    operation String string --- ---
    hasopsb String string --- ---
    fromaside String string --- ---
    asidefromne String string --- ---
    asidefromport String string --- ---
    frombside String string --- ---
    bsidefromne String string --- ---
    bsidefromport String string --- ---
    toaside String string --- ---
    asidetone String string --- ---
    asidetoport String string --- ---
    tobside String string --- ---
    bsidetone String string --- ---
    bsidetoport String string --- ---
    opsbrevertivemode String string --- ---
    opsbrestoretime String string --- ---
    asidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    bsidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    asidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    bsidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    hasycable String string --- ---
    hasycable1 String string --- ---
    ycablefromne String string --- ---
    ycablefromprotne String string --- ---
    ycablefromwkport String string --- ---
    ycablefromprotPort String string --- ---
    ycablefromprotPort1 String string --- ---
    ycabletone String string --- ---
    ycabletoprotne String string --- ---
    ycabletowkport String string --- ---
    ycabletoprotport String string --- ---
    ycabletoprotport1 String string --- ---
    ycableswitchmode String string --- ---
    ycableprotectionmode String string --- ---
    ycableholdofftime String string --- ---
    ycablerevertivemode String string --- ---
    ycablerestoretime String string --- ---
    ycabletimeslot String string --- ---
    ycablesignaldegrade String string --- ---
    otherFromwkPort1XFP String string --- ---
    otherTowkPort1XFP String string --- ---
    ycablefromwkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycablefromprotPort_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletowkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletoprotport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletoprotport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycablefromprotPort1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    opsaRevertiveMode String string --- ---
    opsaWaitToRestore String string --- ---
    hasopsa String string --- ---
    serverAsonRouted String string --- ---
    encapsulationMode String string --- ---
    fromne1__AdditionalInfo HashMap HashMap --- ---
    encodingMode String string --- ---
    transmissionMode String string --- ---
    provisionedBitRate String string --- ---
    provisionedBitRateDsr String string --- ---
    odu4InterworkingMode String string --- ---
    payloadTypeMismatchResponse String string --- ---
    mappingMode String string --- ---
    routingtable array[OtnRoutingConstraints] OtnRoutingConstraints --- ---
    ycablefromprotport String string --- ---
    ycablefromwkPort1XFP String string --- ---
    ycablefromprotport1 String string --- ---
    ycablefromprotPort1XFP String string --- ---
    ycabletowkPort1XFP String string --- ---
    ycabletoprotPort1XFP String string --- ---
    otherFromProtPort1XFP String string --- ---
    otherToProtPort1XFP String string --- ---
    latency String string --- ---

    OtnConnectionResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---
    connectionName String string --- ---
    connectionId Integer integer --- ---
    orderNumber String string --- ---
    orderId String string --- ---
    orderStep Integer integer --- ---
    id String string --- ---
    errorField String string --- ---
    errorValue String string --- ---

    OtnConnTxParams

    Name

    Type

    Description

    Enum

    midCols array[String] string --- ---
    parameter String string --- ---
    name String string --- ---
    value String string --- ---
    currentValue String string --- ---
    discA String string --- ---
    discZ String string --- ---
    type String string --- ---
    editorArgs OtnTxParamEditorArgs OtnTxParamEditorArgs --- ---
    disabled Boolean boolean --- ---
    provisioningLayer String string --- ---

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

    OtnRoutingConstraints

    Name

    Type

    Description

    Enum

    id String string --- ---
    pk String string --- ---
    connid String string --- ---
    lccid String string --- ---
    name String string --- ---
    type String string --- ---
    col4 String string --- ---
    role String string --- ---
    aneid Integer integer --- ---
    aendName String string --- ---
    zneid Integer integer --- ---
    zendName String string --- ---
    lcnumber Integer integer --- ---
    dct Integer integer --- ---
    timeslot String string --- ---
    servername String string --- ---
    lcprotection String string --- ---
    layerrate String string --- ---
    frequency String string --- ---
    routeid String string --- ---
    portname1 String string --- ---
    portid1 String string --- ---
    portname2 String string --- ---
    portid2 String string --- ---
    nodeId String string --- ---
    nodeName String string --- ---
    regenIndex Integer integer --- ---
    connectionAvailability String string --- ---
    frequencyWithOffset String string --- ---
    logicalLinkConnId String string --- ---
    serverId String string --- ---

    OtnSyncSwitchResponse

    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 --- ---
    message String string --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    OtnTemplateGroups

    Name

    Type

    Description

    Enum

    groups array[OtnTemplateParameterGroup] OtnTemplateParameterGroup --- ---

    OtnTemplateInfo

    Name

    Type

    Description

    Enum

    id Integer integer --- ---
    folderId Integer integer --- ---
    name String string --- ---
    folder String string --- ---
    owner String string --- ---
    lastmodified String string --- ---
    templateType String string --- ---
    isPublished Boolean boolean --- ---

    OtnTemplateInstance

    Name

    Type

    Description

    Enum

    data OtnTemplateGroups OtnTemplateGroups --- ---
    constraints array[OtnRoutingConstraints] OtnRoutingConstraints --- ---
    info OtnTemplateInfo OtnTemplateInfo --- ---
    txParamTableData array[OtnConnTxParams] OtnConnTxParams --- ---
    discrepancies array[OtnConnTxParams] OtnConnTxParams --- ---
    modifyParamGroup array[OtnTransmissionParamsGroup] OtnTransmissionParamsGroup --- ---

    OtnTemplateParameter

    Name

    Type

    Description

    Enum

    name String string --- ---
    value String string --- ---
    type String string --- ---
    label String string --- ---
    className String string --- ---

    OtnTemplateParameterGroup

    Name

    Type

    Description

    Enum

    groupname String string --- ---
    paramList array[OtnTemplateParameter] OtnTemplateParameter --- ---

    OtnTransmissionParamsGroup

    Name

    Type

    Description

    Enum

    paramList array[OtnTxParam] OtnTxParam --- ---
    groupname String string --- ---
    txParamList array[OtnTxParam] OtnTxParam --- ---
    groupName String string --- ---

    OtnTxParam

    Name

    Type

    Description

    Enum

    label String string --- ---
    name String string --- ---
    type String string --- ---
    value String string --- ---
    oldValue String string --- ---
    provisioningLayer String string --- ---

    OtnTxParamEditorArgs

    Name

    Type

    Description

    Enum

    options array[String] string --- ---
    maxlength Integer integer --- ---

    OtnUpdateLinkUtilizationThresholdRequest

    Name

    Type

    Description

    Enum

    id String string --- ---
    linkUtilProfile String string --- ---

    OtnUpdateLinkUtilizationThresholdResponse

    Name

    Type

    Description

    Enum

    ok Boolean boolean --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---
    HTTPResponse Integer integer --- ---
    id String string --- ---
    httpResponse Integer integer --- ---
    satus Boolean boolean --- ---
    message String string --- ---

    ProtectionSwitchListRsp

    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[PseFmData] PseFmData --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    PseFmData

    Name

    Type

    Description

    Enum

    pseId String string --- ---
    pseType String string --- ---
    switchReason String string --- ---
    raiseTime String string --- ---
    neName String string --- ---
    groupName String string --- ---
    layerRate String string --- ---
    category String string --- ---
    protectedResource String string --- ---
    fromResource String string --- ---
    toResource String string --- ---
    acknowledgeTime Date DateTime --- ---
    acknowledgeUser String string --- ---
    ackStatus String string --- ---
    connectionName String string --- ---
    connectionId Integer integer --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

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

    RCTemplateDataDesign

    Name

    Type

    Description

    Enum

    description String string --- ---
    createdDate String string --- ---
    userName String string --- ---
    templatename String string --- ---
    className String string --- ---
    id String string --- ---
    guiLabel String string --- ---

    RCTemplateDetailListRsp

    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[RCTemplateData] RCTemplateData --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    RCTemplateInfoListRsp

    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[RCTemplateDataDesign] RCTemplateDataDesign --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    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» --- ---

    RetrieveCSVResponse

    Name

    Type

    Description

    Enum

    date String string --- ---
    action String string --- ---
    object String string --- ---
    user String string --- ---
    requestId String string --- ---

    RetrieveCSVResponseList

    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[RetrieveCSVResponse] RetrieveCSVResponse --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    WavekeyAssignmentData

    Name

    Type

    Description

    Enum

    toneOverlap String string --- ---
    waveKey1 String string --- ---
    waveKey2 String string --- ---
    waveKey1And2 String string --- ---
    status String string --- ---
    frequency String string --- ---
    fieldId String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---

    WavekeyAssignmentListRsp

    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[WavekeyAssignmentData] WavekeyAssignmentData --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---