Attribute

Manage custom attributes, which are free custom fields used to describe details linked to an entity.
You can create, update, delete, and search for attributes with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/attribute/index

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

Request Body

Parameters for searching attributes

object

name

string

Example

{
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "name": "Room Size"
}

Responses

200

List of attributes

Array<object>

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

{
  "attribute_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Room Size",
  "description": "The room size",
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "entity_type": "WORK_ENVIRONMENT",
  "unit_of_measure_id": "M3",
  "value": 50
}

Example

{
  "attribute_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Room Size",
  "description": "The room size",
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "entity_type": "WORK_ENVIRONMENT",
  "unit_of_measure_id": "M3",
  "value": "50"
}

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/attribute/view/{id}

Retrieve a single attribute by its unique ID.

Path Parameters

id

required

string

The ID of the attribute to retrieve

Responses

200

Attribute found

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

Example

{
  "attribute_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Room Size",
  "description": "The room size",
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "entity_type": "WORK_ENVIRONMENT",
  "unit_of_measure_id": "M3",
  "value": "50"
}

404

Attribute not found

create

POST

/v2/attribute/create

Create a new attribute for an entity.

Request Body ^required

The attribute to create

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

Example

{
  "name": "Room Size",
  "description": "The room size",
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "entity_type": "WORK_ENVIRONMENT",
  "unit_of_measure_id": "M3",
  "value": "50"
}

Responses

201

Attribute created successfully

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

Example

{
  "attribute_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Room Size",
  "description": "The room size",
  "entity_id": "569bc3c7-ead1-41e8-85ab-fdccf7085c5f",
  "entity_type": "WORK_ENVIRONMENT",
  "unit_of_measure_id": "M3",
  "value": "50"
}

update

PUT

/v2/attribute/update/{id}

Update an existing attribute by its unique ID.

Path Parameters

id

required

string

The ID of the attribute to update

Request Body ^required

The updated attribute

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

Example

{
  "name": "Updated Room Size",
  "value": "60"
}

Responses

200

Attribute updated successfully

object

attribute_id

required

The ID of the attribute

string

name

required

The name of the attribute

string

description

The description of the attribute

string

entity_id

required

The ID of the entity the attribute is associated with

string

entity_type

required

The type of the entity the attribute is associated with

string

unit_of_measure_id

required

The ID of the unit of measure associated with the attribute

string

value

required

The value of the attribute

string

Example

{
  "attribute_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Updated Room Size",
  "value": "60"
}

404

Attribute not found

delete

DELETE

/v2/attribute/delete/{id}

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

Path Parameters

id

required

string

The ID of the attribute to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Attribute 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