Operation
get /data/otn/connections/{id}/stats/bandwidthUtilization
get bandwidth use stats for given ots connection Id(s) (getBandwidthUseById : /data/otn/connections/{id}/stats/bandwidthUtilization)
returns bandwidth use data for given ots connection ID(s)
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | ids can be retrieved as 'id' from the REST call '/data/otn/connections/' | --- |
Return type
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
Operation
get /data/otn/connections/stats/bandwidthUtilization
get bandwidth use stats for given ots connection Id(s) (getBandwidthUseByIdAsQueryParam : /data/otn/connections/stats/bandwidthUtilization)
returns bandwidth use data for given ots connection ID(s)
Query parameters
Name |
IsRequired |
Description |
---|---|---|
id | required | ids can be retrieved as 'id' from the REST call '/data/otn/connections/' |
Return type
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
Operation
post /data/otn/connections/stats/bandwidthUtilization
get bandwidth use stats for given ots connection Id(s) (getBandwidthUseByIdAsRequestBody : /data/otn/connections/stats/bandwidthUtilization)
returns bandwidth use data for given ots connection ID(s)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | ids can be retrieved as 'id' from the REST call '/data/otn/connections/' | String |
--- |
Return type
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
BaseDataPointObject
Name |
Type |
Description |
Enum |
---|---|---|---|
label | String string |
--- | --- |
className | String string |
ClassName | --- |
id | String string |
id | --- |
key | String string |
Key | --- |
guiLabel | String string |
GuiLabel | --- |
parentId | String string |
ParentId | --- |
hasChildren | String string |
HasChildren | --- |
characteristic | Object object |
--- | --- |
group | Object object |
--- | --- |
datum | Object object |
--- | --- |
value | Object object |
--- | --- |
navigationData | Object object |
--- | --- |
nestedDataPoints | Object object |
--- | --- |
name | Object object |
--- | --- |
ConnectionStatsResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
reqCompletionStatus | Integer integer |
A value which indicates completion status of the request | --- |
requestId | Long long |
Id generated for the Request passed | --- |
clientName | String string |
Indicates name of the client | --- |
clientLocation | String string |
Indicates location of the client | --- |
clientUser | String string |
Indicates the client User | --- |
sessionId | String string |
Session Id of the event | --- |
mdcId | String string |
MDC Id,if any | --- |
sequenceNum | Integer integer |
Indicates the sequence Number generated for the response | --- |
moreToCome | Boolean boolean |
Indicates with true/false if more responses are to come | --- |
messages | array[OtnI18nMessage] OtnI18nMessage |
Response Messages,if any from the response like an Info,Warning etc | --- |
errcde | String string |
Indicates error code,if any error generated | --- |
errorParams | array[Object] object |
Indicates different error parameters,if any error generated | --- |
dataPoints | array[DataPoint] DataPoint |
dataPoints | --- |
hierarchicalDataPoints | array[HierarchicalDataPoint] HierarchicalDataPoint |
hierarchicalDataPoints | --- |
dataPointsByObjectId | array[Entry«object,List«BaseDataPointObject»»] Entry«object,List«BaseDataPointObject»» |
dataPointsByObjectId | --- |
invalidInputIds | array[Object] object |
--- | --- |
items | array[Object] object |
items | --- |
objectDetails | array[Entry«string,BaseObject»] Entry«string,BaseObject» |
--- | --- |
failedCompletion | Boolean boolean |
Indicates response completion failed with true/false | --- |
successfulCompletion | Boolean boolean |
Indicates successful response completion with true/false | --- |
timeout | Long long |
--- | --- |
nadString | String string |
--- | --- |
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 |
---|---|---|---|
messageTime | Long long |
Message Time | --- |
messageType | String string |
Message Type | [Info, Warning, Error] |
messageUnformatted | String string |
Message Unformatted | --- |
validPropertyResourceMessage | Boolean boolean |
--- | --- |
messageId | String string |
Message Id | --- |
messageParams | array[String] string |
Message Params | --- |
message | String string |
Message | --- |