Material

Manage materials, including registration, update, deletion, and advanced search.
Materials can be linked to offices, projects, and categories, and support metadata and filtering.

Version: 2.0.0
OpenAPI version: 3.0.0

Operations

index

POST

/v2/material/index

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

Request Body

Parameters for searching materials

object

filter

object

material_id

Primary key ID for the material

string format: uuid

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string format: uuid

tenant_id

Tenant ID

string format: uuid

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string format: json

nullable

office_name

Office name (read-only)

string

project_name

Project name (read-only)

string

project_type

Project type (read-only)

string

owned_active

Indicates if the material is actively owned (read-only)

boolean

parent_active

Indicates if the material’s parent is actively owned (read-only)

boolean

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": {
    "name": "Material 1",
    "material_type": "EQUIPMENT"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of materials

Array<object>

object

material_id

Primary key ID for the material

string format: uuid

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string format: uuid

tenant_id

Tenant ID

string format: uuid

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string format: json

nullable

office_name

Office name (read-only)

string

project_name

Project name (read-only)

string

project_type

Project type (read-only)

string

owned_active

Indicates if the material is actively owned (read-only)

boolean

parent_active

Indicates if the material’s parent is actively owned (read-only)

boolean

Example

{
  "material_id": "mat-1",
  "material_type": "EQUIPMENT",
  "name": "Material 1",
  "code": "MAT-001",
  "description": "Material for construction",
  "category": "Construction",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

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/material/create

Create a new material by providing the required details.

Request Body^required

Material object to be created

object

material_id

Primary key ID for the material

string

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string

tenant_id

Tenant ID

string

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string

nullable

Example

{
  "material_type": "EQUIPMENT",
  "name": "Material 2",
  "code": "MAT-002",
  "description": "Material for maintenance",
  "category": "Maintenance",
  "subtenant_id": "sub-2",
  "tenant_id": "ten-2"
}

Responses

201

Material created successfully

object

material_id

Primary key ID for the material

string

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string

tenant_id

Tenant ID

string

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string

nullable

Example

{
  "material_id": "mat-2",
  "material_type": "EQUIPMENT",
  "name": "Material 2",
  "code": "MAT-002",
  "description": "Material for maintenance",
  "category": "Maintenance",
  "subtenant_id": "sub-2",
  "tenant_id": "ten-2"
}

view

GET

/v2/material/view/{id}

Retrieve a material by its unique ID.

Path Parameters

required

string format: uuid

ID of the material to retrieve

Responses

200

Material found

object

material_id

Primary key ID for the material

string format: uuid

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string format: uuid

tenant_id

Tenant ID

string format: uuid

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string format: json

nullable

office_name

Office name (read-only)

string

project_name

Project name (read-only)

string

project_type

Project type (read-only)

string

owned_active

Indicates if the material is actively owned (read-only)

boolean

parent_active

Indicates if the material’s parent is actively owned (read-only)

boolean

Example

{
  "material_id": "mat-1",
  "material_type": "EQUIPMENT",
  "name": "Material 1",
  "code": "MAT-001",
  "description": "Material for construction",
  "category": "Construction",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

404

Material not found

delete

DELETE

/v2/material/delete/{id}

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

Path Parameters

required

string format: uuid

ID of the material to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Material 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/material/update/{id}

Update an existing material by its unique ID.

Path Parameters

required

string format: uuid

ID of the material to update

Request Body^required

Material object with updated data

object

material_id

Primary key ID for the material

string

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string

tenant_id

Tenant ID

string

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string

nullable

Example

{
  "description": "Updated description",
  "category": "Updated category"
}

Responses

200

Material updated successfully

object

material_id

Primary key ID for the material

string

material_type

Type of the material

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE PER

subtenant_id

Subtenant ID

string

tenant_id

Tenant ID

string

code

Optional code for the material

string

nullable

name

Name of the material

string

description

Optional description of the material

string

nullable

category

Optional category of the material

string

nullable

data

Additional data in JSON format

string

nullable

Example

{
  "material_id": "mat-1",
  "description": "Updated description",
  "category": "Updated category"
}

404

Material not found

Material

Operations

index

Request Body

Example

Responses

200

Example

Headers

create

Request Body required

Example

Responses

201

Example

view

Path Parameters

Responses

200

Example

404

delete

Path Parameters

Query Parameters

Responses

204

400

update

Path Parameters

Request Body required

Example

Responses

200

Example

404

Request Body^required

Request Body^required