Operation

get /data/otn/connections/{id}/stats/bandwidthUtilization
getBandwidthUseById (getBandwidthUseById : /data/otn/connections/{id}/stats/bandwidthUtilization)
getBandwidthUseById

Path parameters

Name

IsRequired

Description

Enum

id required id ---

Return type
  • ConnectionStatsResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionStatsResponse
    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/stats/bandwidthUtilization
    getBandwidthUseByIdAsQueryParam (getBandwidthUseByIdAsQueryParam : /data/otn/connections/stats/bandwidthUtilization)
    getBandwidthUseByIdAsQueryParam

    Query parameters

    Name

    IsRequired

    Description

    id required ---

    Return type
  • ConnectionStatsResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionStatsResponse
    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/stats/bandwidthUtilization
    getBandwidthUseByIdAsRequestBody (getBandwidthUseByIdAsRequestBody : /data/otn/connections/stats/bandwidthUtilization)
    getBandwidthUseByIdAsRequestBody

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional id String ---

    Return type
  • ConnectionStatsResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionStatsResponse
    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 :

    BaseDataPointObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---
    characteristic Object object --- ---
    group Object object --- ---
    datum Object object --- ---
    value Object object --- ---
    name Object object --- ---

    BaseObject

    Name

    Type

    Description

    Enum

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

    ConnectionStatsResponse

    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 --- ---
    dataPoints array[DataPoint] DataPoint --- ---
    dataPointsByObjectId array[Entry«object,List«BaseDataPointObject»»] Entry«object,List«BaseDataPointObject»» --- ---
    invalidInputIds array[Object] object --- ---
    items array[Object] object --- ---
    objectDetails array[Entry«string,BaseObject»] Entry«string,BaseObject» --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    DataPoint

    Name

    Type

    Description

    Enum

    characteristic Object object --- ---
    datum Object object --- ---
    group Object object --- ---
    value Object object --- ---

    Entry«object,List«BaseDataPointObject»»

    Name

    Type

    Description

    Enum

    key array[BaseDataPointObject] BaseDataPointObject --- ---

    Entry«string,BaseObject»

    Name

    Type

    Description

    Enum

    key BaseObject BaseObject --- ---

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