Carbon

Assembly Instruction

The assembly instruction resource.

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

List assembly instructions

Retrieve a paginated list of assembly instructions. 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/assemblyInstruction
curl --request GET \
  --url 'https://rest.carbon.ms/assemblyInstruction?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "modelUploadId": "xyz789",
    "status": "string",
    "version": 0,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/assemblyInstruction

Retrieve a assembly instruction

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/assemblyInstruction
curl --request GET \
  --url 'https://rest.carbon.ms/assemblyInstruction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "modelUploadId": "xyz789",
  "status": "string",
  "version": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/assemblyInstruction

Create a assembly instruction

Create a new assembly instruction.

Body parameters

namestringrequired
modelUploadIdstringrequired

References modelUpload.id

itemIdstring

References item.id

assemblyPlanJobIdstring

References assemblyPlanJob.id

statusassemblyInstructionStatusrequired
versionnumberrequired
publishedAttimestamp
settingsobject
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/assemblyInstruction
curl --request POST \
  --url https://rest.carbon.ms/assemblyInstruction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","modelUploadId":"xyz789","status":"string","version":0,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "modelUploadId": "xyz789",
  "status": "string",
  "version": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/assemblyInstruction

Update a assembly instruction

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

Body parameters

namestringrequired
modelUploadIdstringrequired

References modelUpload.id

itemIdstring

References item.id

assemblyPlanJobIdstring

References assemblyPlanJob.id

statusassemblyInstructionStatusrequired
versionnumberrequired
publishedAttimestamp
settingsobject
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/assemblyInstruction
curl --request PATCH \
  --url 'https://rest.carbon.ms/assemblyInstruction?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",
  "modelUploadId": "xyz789",
  "status": "string",
  "version": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/assemblyInstruction

Delete a assembly instruction

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

Query parameters

idstring

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

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