Get Entities for Dashboards
get
/vision/api/entities/usedInDashboard
Gets all entities that the requesting user has access to that can be used as sites for links in dashboards. These entities have the useInDashboard property set to true.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
- Admin
- Operator
- Viewer
- Api
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : ResourceWrapper16
Type:
object
The response resource wrapper.
Show Source
-
columns: array
columns
Information about the columns used to display the requested or updated content.
-
content: array
content
The requested or updated content.
-
links: array
links
Links related to the requested or updated content.
Nested Schema : columns
Type:
array
Information about the columns used to display the requested or updated content.
Show Source
-
Array of:
object ColumnData
The details of columns to use to show data in a table.
Nested Schema : content
Type:
array
The requested or updated content.
Show Source
-
Array of:
object EntityLayerPOJO
The details of an entity that can be used as a site for links in dashboards.
Nested Schema : links
Type:
array
Links related to the requested or updated content.
Show Source
-
Array of:
object Link
The link details.
Nested Schema : ColumnData
Type:
object
The details of columns to use to show data in a table.
Show Source
-
cssClass: string
The CSS class for the column.Example:
slick-header-column
-
defaultSortAsc: boolean
Whether to sort the column in ascending order by default (true) or not (false).Example:
true
-
editor: string
The editor to use for the column.Example:
TaskEnabledEditor
-
entity: string
The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.Example:
Task
-
field: string
The field to use for data in the column cells.Example:
enabled
-
focusable: boolean
Whether the column is focusable (true) or not (false).Example:
true
-
formatter: string
The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.Example:
CamelCaseFormatter
-
headerCssClass: string
The CSS class for the column header.Example:
slick-header-column
-
id: integer
(int64)
The column ID.Example:
130
-
maxWidth: integer
(int32)
The maximum width for the column.Example:
80
-
minWidth: integer
(int32)
The minimum width for the column.Example:
30
-
name: string
The column name, that appears in the header row.Example:
Enabled
-
options: string
Options for values in the column.Example:
true,false
-
rerenderOnResize: boolean
Whether the column should be rerendered when resized (true) or not (false).Example:
false
-
resizable: boolean
Whether the column can be resized (true) or not (false).Example:
true
-
selectable: boolean
Whether the column can be selected (true) or not (false).Example:
true
-
sortable: boolean
Whether the column can be used to sort the table (true) or not (false).Example:
true
-
tooltip: string
The tooltip to display for the column.Example:
Whether the task is enabled or disabled.
-
width: integer
(int32)
The default width, in pixels, of the column.Example:
50
Nested Schema : EntityLayerPOJO
Type:
object
The details of an entity that can be used as a site for links in dashboards.
Show Source
-
address: string
The entity address.Example:
2300 Oracle Way, Austin, TX 78741
-
displayName: string
The entity display name.Example:
Entity 123
-
id: integer
(int64)
The entity ID.Example:
123
-
ipAddress: string
The entity IPv4 address.Example:
192.0.2.1
-
ipV6Address: string
The entity IPv6 address.Example:
2001:db8:3333:4444:5555:6666:7777:8888
-
lat: number
(double)
The entity latitude.Example:
30.243128396829135
-
layers: object
layers
Layer information for the entity.
-
lng: number
(double)
The entity longitude.Example:
-97.72173882639726
-
metaData: object
metaData
Additional Properties Allowed: additionalPropertiesMetadata for the entity.
-
name: string
The entity name.Example:
entity123
-
useInDashboard: boolean
Whether the entity can be used as a site for links in dashboards (true) or not (false).Example:
true
-
zoneId: integer
(int64)
The entity zone ID.Example:
2300
Nested Schema : layers
Type:
object
Layer information for the entity.
Nested Schema : metaData
Type:
object
Additional Properties Allowed
Show Source
Metadata for the entity.
Example:
type: dDevice
Nested Schema : additionalProperties
Type:
object
Nested Schema : Link
Type:
object
The link details.
Show Source
-
expects: object
expects
Additional Properties Allowed: additionalPropertiesAny input expected by the link.
-
href: string
The link reference.Example:
https://example.com/layers
-
method: string
The HTTP method used by the linked object.Example:
GET
-
rel: string
The relationship between the linked object and the current object.Example:
self
Nested Schema : expects
Type:
object
Additional Properties Allowed
Show Source
Any input expected by the link.
Example:
text
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized Access
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
500 Response
An internal server error occurred while accessing the database or performing a database operation.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500