List Entity

List entities. Entities are returned in no particular order.

GET /v1/entities

List Entity

cURL

curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/entities \
  --header 'Authorization: Bearer <token>'

200

{
  "entities": [
    {
      "displayName": "<string>",
      "primaryKeyType": {},
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "labels": [
        {}
      ],
      "owner": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize · object

The maximum number of entities to fetch.

pageToken · string

Token used for pagination.

filter · string

Filtering for entities, follows the lucene query string format for example 'name: "entities/abc"', see Entity type for available fields.

orderBy · string

Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: displayName:desc,createTime:asc

Response

200 - application/json

OK

entities · object[] · required

List of matching entities.

Show child attributes

nextPageToken · string

Token to fetch the next page, empty if no more pages.