EntityInfo

Manage entity info, which represents metadata or descriptive information for entities.
You can search for entity info with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/entity-info/index

Returns a paginated and filterable list of entity info.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching entity info

object

filter

object

entity_id

string

entity_type

string

entity_name

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "entity_name": "Main Project"
  },
  "per-page": 10,
  "page": 1,
  "sort": "entity_name"
}

Responses

200

List of entity info

Array<object>

object

entity_id

string

entity_type

string

entity_name

string

Example

{
  "entity_id": "ent-1",
  "entity_type": "PROJECT",
  "entity_name": "Main Project"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/entity-info/view/{id}

Retrieve an entity info by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity info to retrieve

Responses

200

Entity info found

object

entity_id

string

entity_type

string

entity_name

string

Example

{
  "entity_id": "ent-1",
  "entity_type": "PROJECT",
  "entity_name": "Main Project"
}

404

Entity info not found