Assembly Instruction Step Tool

The assembly instruction step tool resource.

Basehttps://rest.carbon.ms/assemblyInstructionStepTool

GET/assemblyInstructionStepTool

List assembly instruction step tools

Retrieve a paginated list of assembly instruction step tools. 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/assemblyInstructionStepTool

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

Response

[
  {
    "id": "abc123def456",
    "stepId": "xyz789",
    "itemId": "xyz789",
    "quantity": 10,
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/assemblyInstructionStepTool

Retrieve a assembly instruction step tool

Fetch a single assembly instruction step tool by filtering on `id`.

Query parameters

idstring

Match on the assembly instruction step tool's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/assemblyInstructionStepTool

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

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/assemblyInstructionStepTool

Create a assembly instruction step tool

Create a new assembly instruction step tool.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

itemIdstringrequired

References item.id

quantitynumberrequired

sortOrdernumberrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/assemblyInstructionStepTool

curl --request POST \
  --url https://rest.carbon.ms/assemblyInstructionStepTool \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"stepId":"xyz789","itemId":"xyz789","quantity":10,"sortOrder":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/assemblyInstructionStepTool

Update a assembly instruction step tool

Update an existing assembly instruction step tool, matched on `id`.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

itemIdstringrequired

References item.id

quantitynumberrequired

sortOrdernumberrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/assemblyInstructionStepTool

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

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/assemblyInstructionStepTool

Delete a assembly instruction step tool

Delete a assembly instruction step tool, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the assembly instruction step tool to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/assemblyInstructionStepTool

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

204 No Content