Carbon

Assembly Component Mapping

The assembly component mapping resource.

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

List assembly component mappings

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

Retrieve a assembly component mapping

Fetch a single assembly component mapping by filtering on `id`.

Query parameters

idstring

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

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

Create a assembly component mapping

Create a new assembly component mapping.

Body parameters

modelUploadIdstringrequired

References modelUpload.id

geometryHashstringrequired
itemIdstringrequired

References item.id

confidencestringrequired
companyIdstringrequired

References company.id

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

Update a assembly component mapping

Update an existing assembly component mapping, matched on `id`.

Body parameters

modelUploadIdstringrequired

References modelUpload.id

geometryHashstringrequired
itemIdstringrequired

References item.id

confidencestringrequired
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/assemblyComponentMapping
curl --request PATCH \
  --url 'https://rest.carbon.ms/assemblyComponentMapping?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",
  "geometryHash": "string",
  "itemId": "xyz789",
  "confidence": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/assemblyComponentMapping

Delete a assembly component mapping

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

Query parameters

idstring

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

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