Create an Entity

post

/vision/api/entities

Creates an entity. The following properties are required in the request body:
  • name
  • lat
  • lng
  • useInDashboard
All other properties are optional. If you do not specify zoneId, the default zone ID (1) is used.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
  • Admin
  • Api

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
The entity details.
Show Source
Nested Schema : metaData
Type: object
Additional Properties Allowed
Show Source
Metadata for the entity.
Example:
type: dDevice
Nested Schema : additionalProperties
Type: object
Back to Top

Response

Supported Media Types

201 Response

The entity was created successfully.
Body ()
Root Schema : schema
Type: object
The response resource wrapper.
Show Source
Nested Schema : columns
Type: array
Information about the columns used to display the requested or updated content.
Show Source
Nested Schema : schema
Type: object
The entity details.
Show Source
Nested Schema : links
Type: array
Links related to the requested or updated content.
Show Source
Nested Schema : ColumnData
Type: object
The details of columns to use to show data in a table.
Show Source
Nested Schema : metaData
Type: object
Additional Properties Allowed
Show Source
Metadata for the entity.
Example:
type: dDevice
Nested Schema : additionalProperties
Type: object

400 Response

Bad Request. Usually due to providing an invalid value for a field.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

401 Response

Unauthorized Access
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

422 Response

Unprocessable Entity. Usually due to not providing a required field.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

500 Response

An internal server error occurred while accessing the database or performing a database operation.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source
Back to Top