Carbon

Material Type

The material type resource.

Basehttps://rest.carbon.ms/materialType
GET/materialType

List material types

Retrieve a paginated list of material types. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/materialType
curl --request GET \
  --url 'https://rest.carbon.ms/materialType?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "code": "string",
    "materialSubstanceId": "xyz789",
    "materialFormId": "xyz789",
    "companyId": "xyz789"
  }
]
GET/materialType

Retrieve a material type

Fetch a single material type by filtering on `id`.

Query parameters

idstring

Match on the material type's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/materialType
curl --request GET \
  --url 'https://rest.carbon.ms/materialType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "code": "string",
  "materialSubstanceId": "xyz789",
  "materialFormId": "xyz789",
  "companyId": "xyz789"
}
POST/materialType

Create a material type

Create a new material type.

Body parameters

namestringrequired
codestringrequired
materialSubstanceIdstringrequired

References materialSubstance.id

materialFormIdstringrequired

References materialForm.id

companyIdstring

References company.id

POSThttps://rest.carbon.ms/materialType
curl --request POST \
  --url https://rest.carbon.ms/materialType \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","code":"string","materialSubstanceId":"xyz789","materialFormId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "code": "string",
  "materialSubstanceId": "xyz789",
  "materialFormId": "xyz789",
  "companyId": "xyz789"
}
PATCH/materialType

Update a material type

Update an existing material type, matched on `id`.

Body parameters

namestringrequired
codestringrequired
materialSubstanceIdstringrequired

References materialSubstance.id

materialFormIdstringrequired

References materialForm.id

companyIdstring

References company.id

PATCHhttps://rest.carbon.ms/materialType
curl --request PATCH \
  --url 'https://rest.carbon.ms/materialType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "code": "string",
  "materialSubstanceId": "xyz789",
  "materialFormId": "xyz789",
  "companyId": "xyz789"
}
DELETE/materialType

Delete a material type

Delete a material type, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the material type to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/materialType
curl --request DELETE \
  --url 'https://rest.carbon.ms/materialType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content