Maintenance Dispatch Item

The maintenance dispatch item resource.

Basehttps://rest.carbon.ms/maintenanceDispatchItem

GET/maintenanceDispatchItem

List maintenance dispatch items

Retrieve a paginated list of maintenance dispatch items. 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/maintenanceDispatchItem

curl --request GET \
  --url 'https://rest.carbon.ms/maintenanceDispatchItem?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "maintenanceDispatchId": "xyz789",
    "itemId": "xyz789",
    "quantity": 10,
    "unitOfMeasureCode": "string",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/maintenanceDispatchItem

Retrieve a maintenance dispatch item

Fetch a single maintenance dispatch item by filtering on `id`.

Query parameters

idstring

Match on the maintenance dispatch item's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/maintenanceDispatchItem

curl --request GET \
  --url 'https://rest.carbon.ms/maintenanceDispatchItem?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "maintenanceDispatchId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/maintenanceDispatchItem

Create a maintenance dispatch item

Create a new maintenance dispatch item.

Body parameters

maintenanceDispatchIdstringrequired

References maintenanceDispatch.id

itemIdstringrequired

References item.id

quantitynumberrequired

unitOfMeasureCodestringrequired

unitCostnumber

totalCostnumber

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/maintenanceDispatchItem

curl --request POST \
  --url https://rest.carbon.ms/maintenanceDispatchItem \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"maintenanceDispatchId":"xyz789","itemId":"xyz789","quantity":10,"unitOfMeasureCode":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "maintenanceDispatchId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/maintenanceDispatchItem

Update a maintenance dispatch item

Update an existing maintenance dispatch item, matched on `id`.

Body parameters

maintenanceDispatchIdstringrequired

References maintenanceDispatch.id

itemIdstringrequired

References item.id

quantitynumberrequired

unitOfMeasureCodestringrequired

unitCostnumber

totalCostnumber

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/maintenanceDispatchItem

curl --request PATCH \
  --url 'https://rest.carbon.ms/maintenanceDispatchItem?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"maintenanceDispatchId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "maintenanceDispatchId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/maintenanceDispatchItem

Delete a maintenance dispatch item

Delete a maintenance dispatch item, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the maintenance dispatch item to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/maintenanceDispatchItem

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

204 No Content