Material parameters

Get material parameters

get

The API gives the ability to get all material parameters.

Authorizations
Query parameters
namestringOptional
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Responses
200Success
application/json
get
/api/public/material-parameters
GET /api/public/material-parameters HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
200Success
[
  {
    "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
    "name": "Color",
    "created_at": "2025-01-23T17:01:31.692Z"
  }
]

Create material parameter

post

The API gives the ability to create a parameter for material.

Authorizations
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
namestringRequired

Name of the material parameter

Example: Color
Responses
201Success
application/json
post
/api/public/material-parameters
POST /api/public/material-parameters HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "Color"
}
201Success
{
  "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
  "name": "Color",
  "created_at": "2025-01-23T17:01:31.692Z"
}

Update material parameter

patch

The API gives the ability to update an existing material parameter’s name.

Authorizations
Path parameters
parameter_idstring · UUIDRequired

Parameter ID

Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
namestringOptional

Name of the material parameter

Example: Color
Responses
200Success
application/json
patch
/api/public/material-parameters/{parameter_id}
PATCH /api/public/material-parameters/{parameter_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "Color"
}
200Success
{
  "message": "The operation was done successfully"
}
PreviousMaterial suppliersNextMaterial subcategories

Last updated