EntityConfig

Manage entity configurations, which represent custom settings or metadata for entities.
You can create, update, delete, and search for entity configs with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/entity-config/index

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

Request Body

Parameters for searching entity configs

object

filter

object

entity_config_id

string

key

string

entity_id

string

value

array

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": {
    "key": "custom_setting"
  },
  "per-page": 10,
  "page": 1,
  "sort": "key"
}

Responses

200

List of entity configs

Array<object>

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "entity_config_id": "cfg-1",
  "key": "custom_setting",
  "entity_id": "ent-1",
  "value": [
    "A",
    "B"
  ]
}

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

create

POST

/v2/entity-config/create

Create a new entity config by providing the required details.

Request Body ^required

Entity config object to be created

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "key": "custom_setting",
  "entity_id": "ent-1",
  "value": [
    "A",
    "B"
  ]
}

Responses

201

Entity config created successfully

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "entity_config_id": "cfg-2",
  "key": "custom_setting",
  "entity_id": "ent-1",
  "value": [
    "A",
    "B"
  ]
}

view

GET

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

Retrieve an entity config by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity config to retrieve

Responses

200

Entity config found

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "entity_config_id": "cfg-1",
  "key": "custom_setting",
  "entity_id": "ent-1",
  "value": [
    "A",
    "B"
  ]
}

404

Entity config not found

delete

DELETE

/v2/entity-config/delete/{id}

Delete an entity config by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the entity config to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Entity config deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/entity-config/update/{id}

Update an existing entity config by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity config to update

Request Body ^required

Entity config object with updated data

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "value": [
    "C",
    "D"
  ]
}

Responses

200

Entity config updated successfully

object

entity_config_id

string

key

string

entity_id

string

value

array

Example

{
  "entity_config_id": "cfg-1",
  "value": [
    "C",
    "D"
  ]
}

404

Entity config not found