Carbon

Assembly Unit

The assembly unit resource.

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

List assembly units

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

Retrieve a assembly unit

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

Query parameters

idstring

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

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

Create a assembly unit

Create a new assembly unit.

Body parameters

modelUploadIdstringrequired

References modelUpload.id

namestringrequired
componentNodeIdsarrayrequired
itemIdstring

References item.id

companyIdstringrequired

References company.id

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

Update a assembly unit

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

Body parameters

modelUploadIdstringrequired

References modelUpload.id

namestringrequired
componentNodeIdsarrayrequired
itemIdstring

References item.id

companyIdstringrequired

References company.id

sourceGroupIdstring
PATCHhttps://rest.carbon.ms/assemblyUnit
curl --request PATCH \
  --url 'https://rest.carbon.ms/assemblyUnit?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",
  "name": "Example",
  "componentNodeIds": [],
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "itemId": "xyz789"
}
DELETE/assemblyUnit

Delete a assembly unit

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

Query parameters

idstring

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

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