Carbon

Assembly Plan Job

The assembly plan job resource.

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

List assembly plan jobs

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

Retrieve a assembly plan job

Fetch a single assembly plan job by filtering on `id`.

Query parameters

idstring

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

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

Create a assembly plan job

Create a new assembly plan job.

Body parameters

modelUploadIdstringrequired

References modelUpload.id

kindstringrequired
statusmodelProcessingStatusrequired
planPathstring
statsobject
errorstring
companyIdstringrequired

References company.id

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

Update a assembly plan job

Update an existing assembly plan job, matched on `id`.

Body parameters

modelUploadIdstringrequired

References modelUpload.id

kindstringrequired
statusmodelProcessingStatusrequired
planPathstring
statsobject
errorstring
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/assemblyPlanJob
curl --request PATCH \
  --url 'https://rest.carbon.ms/assemblyPlanJob?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"modelUploadId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "modelUploadId": "xyz789",
  "kind": "string",
  "status": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "planPath": "string"
}
DELETE/assemblyPlanJob

Delete a assembly plan job

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

Query parameters

idstring

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

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