ESescape
Views

Create a view

Create a saved view for the organization.

post/views

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Request body

namestring required

The name of the view

target'ASSETS' | 'EVENTS' | 'INTEGRATIONS' | 'ISSUES' | 'LOCATIONS' | 'PROFILES' | 'SCANS' | 'TARGETS' required

The resource the view applies to

projectIdstring uuid

The project to scope the view to

filtersobject nullable

The filters of the view, in the shape of the target where-input

widgetsstring[]

The widget IDs of the view

columnsstring[]

The column IDs of the view

groupBystring[]

The group-by keys of the view

Example request

{
  "name": "My view",
  "projectId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

idstring uuid required

The view ID.

namestring required

The name of the view.

keystring nullable required

The managed view key, or null for user-created views.

target'ASSETS' | 'EVENTS' | 'INTEGRATIONS' | 'ISSUES' | 'LOCATIONS' | 'PROFILES' | 'SCANS' | 'TARGETS' required

The resource the view applies to.

orderinteger required

The position of the view in the list.

filtersobject nullable required

The stored filters of the view.

widgetsstring[] required

The stored widget IDs.

columnsstring[] required

The stored column IDs.

groupBystring[] required

The stored group-by keys.

Changes

No recorded changes to this operation across all 1 revision of this API.