Properties

Each property value returned by the API is an object with the following fields:

Field	Description
_id	Unique identifier for this property value. Use it to delete a specific value.
type	The property name (matches the definition name, e.g. name, status).
string	String value. Present for string and text type properties.
number	Number value. Present for number type properties.
boolean	Boolean value. Present for boolean type properties.
date	Date value (YYYY-MM-DD). Present for date type properties.
datetime	Datetime value (ISO 8601). Present for datetime type properties.
reference	Referenced entity ID. Present for reference type properties.
filename	File name. Present for file type properties.
filesize	File size in bytes. Present for file type properties.
filetype	MIME type. Present for file type properties.
language	Language code (e.g. en, et). Present when the property definition has multilingual: true.
created	Object with at (ISO timestamp) and by (person entity ID) — who set this value and when.

TIP

Save the _id of property values you may want to update or delete later. Without it, you can only delete the property entirely or add new values alongside existing ones.

Example: Entity with Properties

{
  "_id": "507f1f77bcf86cd799439011",
  "name": [
    {
      "_id": "507f1f77bcf86cd799439022",
      "type": "name",
      "string": "Acme Corp",
      "created": { "at": "2024-01-15T10:30:00Z", "by": "507f1f77bcf86cd799439099" }
    }
  ],
  "status": [
    {
      "_id": "507f1f77bcf86cd799439033",
      "type": "status",
      "string": "active",
      "created": { "at": "2024-01-15T10:30:00Z", "by": "507f1f77bcf86cd799439099" }
    }
  ],
  "revenue": [
    {
      "_id": "507f1f77bcf86cd799439044",
      "type": "revenue",
      "number": 1500000,
      "created": { "at": "2024-01-20T08:00:00Z", "by": "507f1f77bcf86cd799439099" }
    }
  ]
}

Writing Properties

POST an array of property objects to create or update values:

[
  { "type": "name", "string": "Acme Corp" },
  { "type": "status", "string": "active" },
  { "type": "revenue", "number": 1500000 },
  { "type": "is_active", "boolean": true },
  { "type": "founded", "date": "1999-03-15" },
  { "type": "owner", "reference": "507f1f77bcf86cd799439099" }
]

Use the value field that matches the property type (string, number, boolean, date, datetime, reference).

Overwriting a Property Value

To overwrite a specific existing value rather than adding a new one, include its _id in the POST body:

[
  { "_id": "507f1f77bcf86cd799439033", "type": "status", "string": "inactive" }
]

This replaces the value of that exact property object. Without _id, a new value is always added alongside any existing ones.

Multi-Value Properties

When a property definition has list: true, multiple values can exist under the same property name. Each value is a separate property object with its own _id.

Adding a value — POST a new property object:

{ "type": "tag", "string": "priority" }

Removing a specific value — DELETE the property by its _id:

DELETE /api/{db}/property/{_id}

Multilingual Properties

When a property definition has multilingual: true, each language is a separate property object carrying a language code.

Reading — the API returns one object per language:

"description": [
  { "_id": "...", "type": "description", "string": "Overview", "language": "en" },
  { "_id": "...", "type": "description", "string": "Ülevaade", "language": "et" }
]

Writing — include the language field when POSTing:

[
  { "type": "description", "string": "Overview", "language": "en" },
  { "type": "description", "string": "Ülevaade", "language": "et" }
]