Carbon

Maintenance Schedule Item

The maintenance schedule item resource.

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

List maintenance schedule items

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

Retrieve a maintenance schedule item

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

Query parameters

idstring

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

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

Create a maintenance schedule item

Create a new maintenance schedule item.

Body parameters

maintenanceScheduleIdstringrequired

References maintenanceSchedule.id

itemIdstringrequired

References item.id

quantitynumberrequired
unitOfMeasureCodestringrequired
companyIdstringrequired

References company.id

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

Update a maintenance schedule item

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

Body parameters

maintenanceScheduleIdstringrequired

References maintenanceSchedule.id

itemIdstringrequired

References item.id

quantitynumberrequired
unitOfMeasureCodestringrequired
companyIdstringrequired

References company.id

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

Delete a maintenance schedule item

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

Query parameters

idstring

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

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