Jump to

• Request
• Response

Get Entities

get

/vision/api/v2/entities

Gets all entities that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

• Admin
• Operator
• Viewer
• Api

Request

Query Parameters

• filter: string
  URL-encoded JSON filter expression used to filter results (e.g., AND/OR conditions on fields).

  Example:

  {"and":[{"property":"<PropertyName>","value":"<PropertyValue>","operator":"like"}]}, encoded example = %7B%22and%22%3A%5B%7B%22property%22%3A%22%3CPropertyName%3E%22%2C%22value%22%3A%22%3CPropertyValue%3E%22%2C%22operator%22%3A%22like%22%7D%5D%7D

• limit: integer(int32)
  Minimum Value: 0

  Maximum number of items to return in the response (page size).

  Default Value: 100

  Example:

  25

• sort: string
  URL-encoded JSON array specifying sort order.

  Example:

  [{"property":"<PropertyName>","direction":"DESC"}], encoded example = %5B%7B%22property%22%3A%22%3CPropertyName%3E%22%2C%22direction%22%3A%22DESC%22%7D%5D

• start: integer(int32)
  Minimum Value: 1

  Index of the first item to return. Used with `limit` to paginate results.

  Default Value: 1

  Example:

  2

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ResourceWrapper28

Type: object

The response resource wrapper.

Show Source

• columns: array columns
  Information about the columns used to display the requested or updated content.
• content: object schema
  The layer details.
• links: array links
  Links related to the requested or updated content.

{
    "properties":{
        "content":{
            "$ref":"#/components/schemas/Layer"
        },
        "links":{
            "description":"Links related to the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "type":"array"
        },
        "columns":{
            "description":"Information about the columns used to display the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/ColumnData"
            },
            "type":"array"
        }
    },
    "description":"The response resource wrapper.",
    "type":"object"
}

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.

{
    "description":"Information about the columns used to display the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/ColumnData"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

The layer details.

Show Source

• id: integer (int64)
  The layer ID.

  Example: 123
• image: string
  The image to use for markers on the layer.

  Example: 2g.png
• name: string
  The layer name.

  Example: Point Data
• onByDefault: boolean
  Whether to display the layer when the map first loads (true) or not (false).

  Example: true
• sector: boolean
  Whether the layer is specific to a sector (true) or not (false).

  Example: false
• type: string
  The layer type.

  Example: point

{
    "properties":{
        "id":{
            "description":"The layer ID.",
            "example":123,
            "format":"int64",
            "type":"integer"
        },
        "name":{
            "description":"The layer name.",
            "example":"Point Data",
            "type":"string"
        },
        "type":{
            "description":"The layer type.",
            "example":"point",
            "type":"string"
        },
        "image":{
            "description":"The image to use for markers on the layer.",
            "example":"2g.png",
            "type":"string"
        },
        "sector":{
            "description":"Whether the layer is specific to a sector (<b>true</b>) or not (<b>false</b>).",
            "example":false,
            "type":"boolean"
        },
        "onByDefault":{
            "description":"Whether to display the layer when the map first loads (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        }
    },
    "description":"The layer details.",
    "type":"object"
}

Nested Schema : links

Type: array

Links related to the requested or updated content.

Show Source

• Array of: object Link
  The link details.

{
    "description":"Links related to the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "type":"array"
}

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

{
    "properties":{
        "id":{
            "description":"The column ID.",
            "example":130,
            "format":"int64",
            "type":"integer"
        },
        "entity":{
            "description":"The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the <b>Settings</b> UI.",
            "example":"Task",
            "type":"string"
        },
        "name":{
            "description":"The column name that appears in the header row.",
            "example":"Enabled",
            "type":"string"
        },
        "field":{
            "description":"The field to use for data in the column cells.",
            "example":"enabled",
            "type":"string"
        },
        "sortable":{
            "description":"Whether the column can be used to sort the table (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "width":{
            "description":"The default width, in pixels, of the column.",
            "example":50,
            "format":"int32",
            "type":"integer"
        },
        "tooltip":{
            "description":"The tooltip to display for the column.",
            "example":"Whether the task is enabled or disabled.",
            "type":"string"
        },
        "options":{
            "description":"Options for values in the column.",
            "example":"true,false",
            "type":"string"
        },
        "formatter":{
            "description":"The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like <b>true</b> to <b>True</b>.",
            "example":"CamelCaseFormatter",
            "type":"string"
        },
        "editor":{
            "description":"The editor to use for the column.",
            "example":"TaskEnabledEditor",
            "type":"string"
        },
        "maxWidth":{
            "description":"The maximum width for the column.",
            "example":80,
            "format":"int32",
            "type":"integer"
        },
        "minWidth":{
            "description":"The minimum width for the column.",
            "example":30,
            "format":"int32",
            "type":"integer"
        },
        "resizable":{
            "description":"Whether the column can be resized (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "selectable":{
            "description":"Whether the column can be selected (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "rerenderOnResize":{
            "description":"Whether the column should be rerendered when resized (<b>true</b>) or not (<b>false</b>).",
            "example":false,
            "type":"boolean"
        },
        "cssClass":{
            "description":"The CSS class for the column.",
            "example":"slick-header-column",
            "type":"string"
        },
        "defaultSortAsc":{
            "description":"Whether to sort the column in ascending order by default (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "focusable":{
            "description":"Whether the column is focusable (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "headerCssClass":{
            "description":"The CSS class for the column header.",
            "example":"slick-header-column",
            "type":"string"
        }
    },
    "description":"The details of columns to use to show data in a table.",
    "type":"object"
}

Nested Schema : Link

Type: object

The link details.

Show Source

• expects: object expects
  Additional Properties Allowed: additionalProperties

  Any 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

{
    "properties":{
        "rel":{
            "description":"The relationship between the linked object and the current object.",
            "example":"self",
            "type":"string"
        },
        "method":{
            "description":"The HTTP method used by the linked object.",
            "example":"GET",
            "type":"string"
        },
        "href":{
            "description":"The link reference.",
            "example":"https://example.com/layers",
            "type":"string"
        },
        "expects":{
            "additionalProperties":{
            },
            "description":"Any input expected by the link.",
            "example":"text",
            "type":"object"
        }
    },
    "description":"The link details.",
    "type":"object"
}

Nested Schema : expects

Type: object

Additional Properties Allowed

Show Source

{
    "additionalProperties":{
    },
    "description":"Any input expected by the link.",
    "example":"text",
    "type":"object"
}

Any input expected by the link.

Example:

text

401 Response

Unauthorized Access

Body ()

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

{
    "properties":{
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

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

• 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

{
    "properties":{
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

Back to Top