Entities

Let's add some description in this file, this can also be done directly from gitbook if needed.

List entities

get

List entities in the same workspace.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · min: 1Optional

Which page to fetch

Default: 1
pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30
statusstring · enumOptional

Entity status

Possible values:
sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:
sortOrderstring · enumOptional

Sort order

Default: ascPossible values:
Responses
200

Successful response

application/json
get
/entities
GET /rest/entities HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "status": "ACTIVE",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Get a single entity

get

Find an entity by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Id of the target entity

Responses
200

Successful response

application/json
get
/entities/{id}
GET /rest/entities/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "status": "ACTIVE",
  "createdAt": "text",
  "updatedAt": "text"
}
PreviousPoliciesNextRequests

Last updated