Operation

get /data/otn/retrieveLinkUtilDataForDashboard/{connType}
Get details of all LinkUtilization Report (getLinkUtilDataForPhysicalConnection : /data/otn/retrieveLinkUtilDataForDashboard/{connType})
getLinkUtilDataForPhysicalConnection

Path parameters

Name

IsRequired

Description

Enum

connType required connType ---

Return type
  • LinkUtilizationReport
  • Responses

    Response Messages

    Schema

    200success LinkUtilizationReport
    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/linkUtilProfile/{profileId}
    Get details of LinkUtilization Profile (getLinkUtilProfileById : /data/otn/linkUtilProfile/{profileId})
    getLinkUtilProfileById

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileId required profileId ---

    Return type
  • LinkUtilizationProfileDTO
  • Responses

    Response Messages

    Schema

    200success LinkUtilizationProfileDTO
    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/linkUtilProfile
    Get details of all LinkUtilization Profiles (getLinkUtilProfiles : /data/otn/linkUtilProfile)
    getLinkUtilProfiles


    Return type
  • LinkUtilizationProfileDTO
  • Responses

    Response Messages

    Schema

    200success LinkUtilizationProfileDTO
    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/linkUtilProfileForDeploy
    Get details of all LinkUtilization Profiles including 'None' (getLinkUtilProfilesForDeploy : /data/otn/linkUtilProfileForDeploy)
    getLinkUtilProfilesForDeploy


    Return type
  • LinkUtilizationProfileDTO
  • Responses

    Response Messages

    Schema

    200success LinkUtilizationProfileDTO
    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

    put /data/otn/linkUtilProfile/{profileId}
    Modify threshold value of a link utilization profile (updateLinkUtlizationProfile : /data/otn/linkUtilProfile/{profileId})
    updateLinkUtlizationProfile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileId required profileId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional linkUtilProfile LinkUtilizationProfileDTO ---

    Return type
  • LinkUtilOperationResponse
  • Responses

    Response Messages

    Schema

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

    LinkUtilizationProfileDTO

    Name

    Type

    Description

    Enum

    id Integer integer --- ---
    type String string --- ---
    name String string --- ---
    linkUtilThreshold Long long --- ---
    key String string --- ---
    className String string --- ---

    LinkUtilizationReport

    Name

    Type

    Description

    Enum

    totalConnections Integer integer --- ---
    profileName String string --- ---
    totalConnectionsOverThreshold Integer integer --- ---

    LinkUtilOperationResponse

    Name

    Type

    Description

    Enum

    ok Boolean boolean LinkUtilOperationResponse.ok=true if successful ---
    responseMessage String string Response message for the request ---