Material Finish

The material finish resource.

Basehttps://rest.carbon.ms/materialFinish

GET/materialFinish

List material finishs

Retrieve a paginated list of material finishs. 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/materialFinish

curl --request GET \
  --url 'https://rest.carbon.ms/materialFinish?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "materialSubstanceId": "xyz789",
    "companyId": "xyz789"
  }
]

GET/materialFinish

Retrieve a material finish

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/materialFinish

curl --request GET \
  --url 'https://rest.carbon.ms/materialFinish?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "materialSubstanceId": "xyz789",
  "companyId": "xyz789"
}

POST/materialFinish

Create a material finish

Create a new material finish.

Body parameters

namestringrequired

materialSubstanceIdstringrequired

References materialSubstance.id

companyIdstring

References company.id

POSThttps://rest.carbon.ms/materialFinish

curl --request POST \
  --url https://rest.carbon.ms/materialFinish \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","materialSubstanceId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "materialSubstanceId": "xyz789",
  "companyId": "xyz789"
}

PATCH/materialFinish

Update a material finish

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

Body parameters

namestringrequired

materialSubstanceIdstringrequired

References materialSubstance.id

companyIdstring

References company.id

PATCHhttps://rest.carbon.ms/materialFinish

curl --request PATCH \
  --url 'https://rest.carbon.ms/materialFinish?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",
  "materialSubstanceId": "xyz789",
  "companyId": "xyz789"
}

DELETE/materialFinish

Delete a material finish

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/materialFinish

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

204 No Content