Operation
post /data/otn/dashboard/createCustomDashboard/{dbName}createCustomDashboard (createCustomDashboard : /data/otn/dashboard/createCustomDashboard/{dbName})
createCustomDashboard
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| dbName | required | dbName | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| entityName | required | entityName |
| userName | required | userName |
| groupedProperty | required | groupedProperty |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
AsonResponse
|
| 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
get /data/otn/dashboard/getAllDashboards/{user_Name}getAllDashboards (getAllDashboards : /data/otn/dashboard/getAllDashboards/{user_Name})
getAllDashboards
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| userName | required | userName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
array[DashBoardNames]
|
| 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.
*/*
External Docs
See Also :
Operation
get /data/otn/dashboard/entitiesgetAllEligDBEntities (getAllEligDBEntities : /data/otn/dashboard/entities)
getAllEligDBEntities
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DashboardUIResponse
|
| 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.
*/*
External Docs
See Also :
Operation
get /data/otn/dashboard/getDashboardData/{dashboard_Name}getDashboardData (getDashboardData : /data/otn/dashboard/getDashboardData/{dashboard_Name})
getDashboardData
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| dashboardName | required | dashBoardName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
UIDashBoard
|
| 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.
*/*
External Docs
See Also :
Operation
get /data/otn/dashboard/getEntityDescription/{entity_id}getEntityDesc (getEntityDesc : /data/otn/dashboard/getEntityDescription/{entity_id})
getEntityDesc
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| entityId | required | entityName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DashboardUIResponse
|
| 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.
*/*
External Docs
See Also :
AsonResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| requestType | String string |
Type of Request | [Info, Warning, Error] |
| messagetag | String string |
Message Tag | --- |
| errorMsgData | array[String] string |
Error messages Data | --- |
| requestStatus | String string |
Status of the request | [Executing, Success, Failed, SuccessWithWarnings, PartiallyFailed, Removed, FailedForTimeout] |
| responseData | Object object |
--- | --- |
| dashboardRequestType | String string |
--- | [GetEntitiesForDashBoard, GetEntityDescription, CreateDashBoard, DeleteDashBoard, GetAllDashBoards, GetDashBoardData, GetAllDashBoardData, StartDashBoard, StopDashBoard] |
| entityListInfo | array[EntityInfo] EntityInfo |
--- | --- |
| beanDataList | array[BeanData] BeanData |
--- | --- |
| dashBoardInfoList | array[DashboardInfo] DashboardInfo |
--- | --- |
| statsData | StatsData StatsData |
--- | --- |
BeanData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| isCollection | Boolean boolean |
--- | --- |
| propertyfullName | String string |
--- | --- |
| theClass | Class«object» Class«object» |
--- | --- |
| genericClass | Class«object» Class«object» |
--- | --- |
| parentPropertyName | String string |
--- | --- |
| enumValues | array[String] string |
--- | --- |
| enumOrdinal | array[Entry«string,int»] Entry«string,int» |
--- | --- |
| collection | Boolean boolean |
--- | --- |
DashboardUIResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| entityDesc | array[UIGetEntityDescription] UIGetEntityDescription |
--- | --- |
| eligibleEntities | array[UIGetAllEligibleEntities] UIGetAllEligibleEntities |
--- | --- |
Entry«string,int»
Name |
Type |
Description |
Enum |
|---|---|---|---|
| key | Integer integer |
--- | --- |
UIDashBoard
Name |
Type |
Description |
Enum |
|---|---|---|---|
| longVal | Long long |
--- | --- |
| objVal | String string |
--- | --- |
| propertyName | String string |
--- | --- |
| statsName | String string |
--- | --- |
| statsList | array[UIDashBoard] UIDashBoard |
--- | --- |