Properties

Property endpoints provide access to relationship field values. They are used by the UI to populate dropdowns and to read the current value of a specific field on a record.

Get Property Value

Returns the current value of a specific property on an entity instance.

GET /api/{entity}/{id}/properties/{property}

Example — get the category of a product:

GET /api/product/AB-001/properties/category

Response (200 OK):

{ "id": 1, "name": "Electronics" }

---

Query Property Values

Returns the available options for a relationship property, with optional search and filtering. This is the endpoint the UI calls to populate dropdowns and autocomplete fields.

POST /api/{entity}/properties/{property}/query
Content-Type: application/json

Request Body

The request body extends the standard QueryRequest with additional fields:

{
  "searchTerm": "Elec",
  "mode": "CREATION",
  "paginationData": { "page": 0, "size": 10 },
  "queryCriteriaList": [],
  "dependeeFields": {
    "country": { "id": 5 }
  }
}

Field	Type	Description
searchTerm	string	Free-text search to filter options. Matches against the property entity's display format.
mode	enum	Context in which the dropdown is used: CREATION, EDITION, or QUERY. May affect which values are shown.
paginationData	Object	Pagination config. See Query.
queryCriteriaList	array	Additional filter criteria. See Query operators.
dependeeFields	Object	Values of fields that this property depends on (used with @DependsOn). Keys are field names, values are the current field objects.
extraParams	Object	Arbitrary extra parameters forwarded to custom property resolvers.

All fields are optional. An empty body {} returns all available options with the default sort.

Response

200 OK — a page of the relationship entity's records:

{
  "content": [
    { "id": 1, "name": "Electronics" },
    { "id": 2, "name": "Electro-household" }
  ],
  "totalElements": 2,
  "totalPages": 1,
  "size": 10,
  "number": 0
}

Access Control

Both property endpoints require the read authority for the entity. See RBAC.