---
title: "Material Item"
url: "https://dev.4hse.com/api/materialitem"
---

# Material Item

A **MaterialItem** represents an individual item (or batch) of a material. For example, if the Material is “Safety Helmet Model X”, a MaterialItem is a specific helmet with its own serial number.

Belongs to a Material and to an office (via `subtenant_id` = office\_id). Can be subject to actions on the compliance schedule (ActionSubscription with `subscriber_type: PPE`).

Use this API to:

-   Register individual items or batches of a material type
-   Get the `material_item_id` needed to create compliance schedule entries or certificates
-   Browse items of a material (filter by `material_id`)

Supports historicization.

Version

2.0.0

OpenAPI version

3.0.0

## Authentication

[Section titled “ Authentication ”](#authentication)

### OAuth2

[Section titled “OAuth2 ”](#oauth2)

**Security scheme type:** oauth2

**Flow type:** password

**Token URL:** [https://auth.4hse.com/realms/4hse/protocol/openid-connect/token](https://auth.4hse.com/realms/4hse/protocol/openid-connect/token)

### AccessToken

[Section titled “AccessToken ”](#accesstoken)

**Security scheme type:** apiKey

**Query parameter name:** access-token

## Operations

[Section titled “Operations”](#operations)

### index

[Section titled “index”](#operation-indexMaterialItem-post)

POST

/v2/material-item/index

-   

Returns a paginated list of material items.

Most useful filters:

-   `material_id`: all items of a specific material type
-   `subtenant_id` (office\_id): all items in an office
-   `name`: search by name

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/materialitem/#oauth2)**
-   **[AccessToken](/api/materialitem/#accesstoken)**

#### Request Body

[Section titled “Request Body ”](#request-body)

Parameters for searching material items

Select media typeapplication/json

object

**filter**

object

**material\_item\_id**

Unique identifier. Used as `subscriber_id` (PPE) or `resource_id`.

string format: uuid

**material\_id**

string format: uuid

**code**

string

**name**

string

**description**

string

**serial**

string

**vendor**

string

**model**

string

**data**

object

**subtenant\_id**

string format: uuid

**tenant\_id**

string format: uuid

**office\_name**

Name of the office.

string

**project\_name**

Name of the project.

string

**project\_type**

string

Allowed values: safety template

**material\_item\_count**

Available quantity (initial quantity minus items assigned via certificates).

integer

**initial\_quantity**

Initial quantity of the item or batch.

integer

**owned\_active**

Whether this item is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

**per-page**

integer

default: 100 \>= 1

**page**

integer

default: 1 \>= 1

**sort**

string

Allowed values: code name serial office\_name project\_name

**history**

If true, includes historicized entries.

boolean

##### Example

```
{  "filter": {    "material_id": "2a3b4c5d-6e7f-8901-abcd-ef2345678901"  },  "per-page": 20,  "page": 1,  "sort": "name"}
```

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

List of material items

Select media typeapplication/json

Array<object>

object

**material\_item\_id**

Unique identifier. Used as `subscriber_id` (PPE) or `resource_id`.

string format: uuid

**material\_id**

string format: uuid

**code**

string

**name**

string

**description**

string

**serial**

string

**vendor**

string

**model**

string

**data**

object

**subtenant\_id**

string format: uuid

**tenant\_id**

string format: uuid

**office\_name**

Name of the office.

string

**project\_name**

Name of the project.

string

**project\_type**

string

Allowed values: safety template

**material\_item\_count**

Available quantity (initial quantity minus items assigned via certificates).

integer

**initial\_quantity**

Initial quantity of the item or batch.

integer

**owned\_active**

Whether this item is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

#### Headers

[Section titled “Headers ”](#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

[Section titled “create”](#operation-createMaterialItem-post)

POST

/v2/material-item/create

-   

Registers a new individual item or batch.

Requires `material_id`, `subtenant_id` (office\_id), `tenant_id` (project\_id), and `name`. The `material_item_id` is auto-generated if not provided.

The Material must already exist (created via the Material API).

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/materialitem/#oauth2)**
-   **[AccessToken](/api/materialitem/#accesstoken)**

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Material item to register

Select media typeapplication/json

object

**material\_item\_id**

Unique identifier. Auto-generated if not provided. Used as `subscriber_id` (with `subscriber_type: PPE`) in the compliance schedule and as `resource_id` in certificates.

string format: uuid

**material\_id**

required

The material type this item belongs to. Pass the `material_id` from the Material API.

string format: uuid

**code**

Identifier code.

string

<= 50 characters

**name**

required

Name of the item.

string

<= 255 characters

**description**

Optional description.

string

nullable

**serial**

Serial number.

string

<= 50 characters

**vendor**

Manufacturer.

string

<= 50 characters

**model**

Model name.

string

<= 50 characters

**data**

Additional structured data in JSON format (may include initial quantity).

object

**subtenant\_id**

required

The office this item belongs to. Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 201

[Section titled “201 ”](#201)

Material item registered successfully

Select media typeapplication/json

object

**material\_item\_id**

Unique identifier. Auto-generated if not provided. Used as `subscriber_id` (with `subscriber_type: PPE`) in the compliance schedule and as `resource_id` in certificates.

string format: uuid

**material\_id**

required

The material type this item belongs to. Pass the `material_id` from the Material API.

string format: uuid

**code**

Identifier code.

string

<= 50 characters

**name**

required

Name of the item.

string

<= 255 characters

**description**

Optional description.

string

nullable

**serial**

Serial number.

string

<= 50 characters

**vendor**

Manufacturer.

string

<= 50 characters

**model**

Model name.

string

<= 50 characters

**data**

Additional structured data in JSON format (may include initial quantity).

object

**subtenant\_id**

required

The office this item belongs to. Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

### view

[Section titled “view”](#operation-viewMaterialItem-get)

GET

/v2/material-item/view/{id}

-   

Retrieves a single material item by its ID.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/materialitem/#oauth2)**
-   **[AccessToken](/api/materialitem/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The material\_item\_id to retrieve.

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Material item found

Select media typeapplication/json

object

**material\_item\_id**

Unique identifier. Used as `subscriber_id` (PPE) or `resource_id`.

string format: uuid

**material\_id**

string format: uuid

**code**

string

**name**

string

**description**

string

**serial**

string

**vendor**

string

**model**

string

**data**

object

**subtenant\_id**

string format: uuid

**tenant\_id**

string format: uuid

**office\_name**

Name of the office.

string

**project\_name**

Name of the project.

string

**project\_type**

string

Allowed values: safety template

**material\_item\_count**

Available quantity (initial quantity minus items assigned via certificates).

integer

**initial\_quantity**

Initial quantity of the item or batch.

integer

**owned\_active**

Whether this item is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

##### 404

[Section titled “404 ”](#404)

Material item not found

### update

[Section titled “update”](#operation-updateMaterialItem-put)

PUT

/v2/material-item/update/{id}

-   

Updates an existing material item.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/materialitem/#oauth2)**
-   **[AccessToken](/api/materialitem/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The material\_item\_id to update.

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Fields to update

Select media typeapplication/json

object

**material\_item\_id**

Unique identifier. Auto-generated if not provided. Used as `subscriber_id` (with `subscriber_type: PPE`) in the compliance schedule and as `resource_id` in certificates.

string format: uuid

**material\_id**

required

The material type this item belongs to. Pass the `material_id` from the Material API.

string format: uuid

**code**

Identifier code.

string

<= 50 characters

**name**

required

Name of the item.

string

<= 255 characters

**description**

Optional description.

string

nullable

**serial**

Serial number.

string

<= 50 characters

**vendor**

Manufacturer.

string

<= 50 characters

**model**

Model name.

string

<= 50 characters

**data**

Additional structured data in JSON format (may include initial quantity).

object

**subtenant\_id**

required

The office this item belongs to. Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Material item updated successfully

Select media typeapplication/json

object

**material\_item\_id**

Unique identifier. Auto-generated if not provided. Used as `subscriber_id` (with `subscriber_type: PPE`) in the compliance schedule and as `resource_id` in certificates.

string format: uuid

**material\_id**

required

The material type this item belongs to. Pass the `material_id` from the Material API.

string format: uuid

**code**

Identifier code.

string

<= 50 characters

**name**

required

Name of the item.

string

<= 255 characters

**description**

Optional description.

string

nullable

**serial**

Serial number.

string

<= 50 characters

**vendor**

Manufacturer.

string

<= 50 characters

**model**

Model name.

string

<= 50 characters

**data**

Additional structured data in JSON format (may include initial quantity).

object

**subtenant\_id**

required

The office this item belongs to. Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

##### 404

[Section titled “404 ”](#404)

Material item not found

### delete

[Section titled “delete”](#operation-deleteMaterialItem-delete)

DELETE

/v2/material-item/delete/{id}

-   

Deletes a material item.

If `force=false` (default), the response lists child entities. If `force=true`, the item and all related entities are deleted.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/materialitem/#oauth2)**
-   **[AccessToken](/api/materialitem/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The material\_item\_id to delete.

#### Query Parameters

[Section titled “Query Parameters ”](#query-parameters)

**force**

boolean

If true, deletes the item and all child entities.

#### Responses

[Section titled “ Responses ”](#responses)

##### 204

[Section titled “204 ”](#204)

Material item deleted successfully

##### 400

[Section titled “400 ”](#400)

Preview of entities that would be deleted (returned when force=false)

This site is protected by reCAPTCHA and the Google [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms) apply.