Carbon

Item Inspection Document Assignment

The item inspection document assignment resource.

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

List item inspection document assignments

Retrieve a paginated list of item inspection document assignments. 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/itemInspectionDocumentAssignment
curl --request GET \
  --url 'https://rest.carbon.ms/itemInspectionDocumentAssignment?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "itemId": "xyz789",
    "usage": "string",
    "inspectionDocumentId": "xyz789",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/itemInspectionDocumentAssignment

Retrieve a item inspection document assignment

Fetch a single item inspection document assignment by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item inspection document assignment's `itemId`, e.g. `eq.{id}`.

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

Create a item inspection document assignment

Create a new item inspection document assignment.

Body parameters

inspectionDocumentIdstringrequired

References inspectionDocument.id

companyIdstringrequired

References company.id

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

Update a item inspection document assignment

Update an existing item inspection document assignment, matched on `itemId`.

Body parameters

inspectionDocumentIdstringrequired

References inspectionDocument.id

companyIdstringrequired

References company.id

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

Delete a item inspection document assignment

Delete a item inspection document assignment, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item inspection document assignment to delete, e.g. `eq.{id}`.

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