Validate Vision API Configuration

get

/vision/api/configCheck

Validates the Vision API configuration by checking that the general settings, columns, and entities are properly configured in the database. If the configuration is valid, the response body includes the details. If the configurations are not valid, the response contains an error message identifying the problem.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
  • Admin
  • Operator
  • Api

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ResourceWrapper49
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 : content
Match All
Show Source
Nested Schema : ColumnData
Type: object
The details of columns to use to show data in a table.
Show Source
Nested Schema : content-allOf[1]
Match All
The requested or updated content.
Show Source
Nested Schema : ConfigCheck
Type: object
Show Source
Nested Schema : columnData
Type: object
Additional Properties Allowed
Show Source
Nested Schema : deviceIds
Type: object
Additional Properties Allowed
Show Source
Nested Schema : eventSources
Type: object
Additional Properties Allowed
Show Source
Nested Schema : generalSettings
Type: object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object

401 Response

Unauthorized Access
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