Job Material Step

The job material step resource.

Basehttps://rest.carbon.ms/jobMaterialStep

GET/jobMaterialStep

List job material steps

Retrieve a paginated list of job material steps. 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/jobMaterialStep

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

Response

[
  {
    "jobMaterialId": "xyz789",
    "jobOperationStepId": "xyz789"
  }
]

GET/jobMaterialStep

Retrieve a job material step

Fetch a single job material step by filtering on `jobMaterialId`.

Query parameters

jobMaterialIdstring

Match on the job material step's `jobMaterialId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/jobMaterialStep

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

Response

{
  "jobMaterialId": "xyz789",
  "jobOperationStepId": "xyz789"
}

POST/jobMaterialStep

Create a job material step

Create a new job material step.

POSThttps://rest.carbon.ms/jobMaterialStep

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

Response

{
  "jobMaterialId": "xyz789",
  "jobOperationStepId": "xyz789"
}

PATCH/jobMaterialStep

Update a job material step

Update an existing job material step, matched on `jobMaterialId`.

PATCHhttps://rest.carbon.ms/jobMaterialStep

curl --request PATCH \
  --url 'https://rest.carbon.ms/jobMaterialStep?jobMaterialId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "jobMaterialId": "xyz789",
  "jobOperationStepId": "xyz789"
}

DELETE/jobMaterialStep

Delete a job material step

Delete a job material step, matched on `jobMaterialId`. Returns 204 No Content.

Query parameters

jobMaterialIdstring

The `jobMaterialId` of the job material step to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/jobMaterialStep

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

204 No Content