Operation

get /data/otn/connection/networkElement/{id}
item (item : /data/otn/connection/networkElement/{id})
item

Path parameters

Name

IsRequired

Description

Enum

id required id ---
Query parameters

Name

IsRequired

Description

label optional ---

Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/nes/{id}
    item (item : /data/otn/connections/nes/{id})
    item

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/nes/{id}
    item (item : /data/otn/nes/{id})
    item

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkElement/{id}
    item (item : /data/otn/networkElement/{id})
    item

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkElements/{id}
    item (item : /data/otn/networkElements/{id})
    item

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connection/networkElement
    list (list : /data/otn/connection/networkElement)
    list

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/connections/nes
    list (list : /data/otn/connections/nes)
    list

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/nes
    list (list : /data/otn/nes)
    list

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkElement
    list (list : /data/otn/networkElement)
    list

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/networkElements
    list (list : /data/otn/networkElements)
    list

    Query parameters

    Name

    IsRequired

    Description

    label optional ---

    Return type
  • NetworkElementInventoryResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    NetworkElementInventoryResponse

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

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