Maintenance Schedule

The maintenance schedule resource.

Basehttps://rest.carbon.ms/maintenanceSchedule

GET/maintenanceSchedule

List maintenance schedules

Retrieve a paginated list of maintenance schedules. 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/maintenanceSchedule

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "workCenterId": "xyz789",
    "frequency": "string",
    "priority": "string",
    "active": true,
    "companyId": "xyz789",
    "createdBy": "string"
  }
]

GET/maintenanceSchedule

Retrieve a maintenance schedule

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/maintenanceSchedule

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "workCenterId": "xyz789",
  "frequency": "string",
  "priority": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

POST/maintenanceSchedule

Create a maintenance schedule

Create a new maintenance schedule.

Body parameters

namestringrequired

descriptionstring

workCenterIdstringrequired

References workCenter.id

frequencymaintenanceFrequencyrequired

prioritymaintenanceDispatchPriorityrequired

estimatedDurationnumber

activebooleanrequired

lastGeneratedAttimestamp

nextDueAttimestamp

companyIdstringrequired

References company.id

mondaybooleanrequired

tuesdaybooleanrequired

wednesdaybooleanrequired

thursdaybooleanrequired

fridaybooleanrequired

saturdaybooleanrequired

sundaybooleanrequired

skipHolidaysbooleanrequired

locationIdstring

References location.id

procedureIdstring

References procedure.id

POSThttps://rest.carbon.ms/maintenanceSchedule

curl --request POST \
  --url https://rest.carbon.ms/maintenanceSchedule \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","workCenterId":"xyz789","frequency":"string","priority":"string","active":true,"companyId":"xyz789","monday":true,"tuesday":true,"wednesday":true,"thursday":true,"friday":true,"saturday":true,"sunday":true,"skipHolidays":true}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "workCenterId": "xyz789",
  "frequency": "string",
  "priority": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

PATCH/maintenanceSchedule

Update a maintenance schedule

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

Body parameters

namestringrequired

descriptionstring

workCenterIdstringrequired

References workCenter.id

frequencymaintenanceFrequencyrequired

prioritymaintenanceDispatchPriorityrequired

estimatedDurationnumber

activebooleanrequired

lastGeneratedAttimestamp

nextDueAttimestamp

companyIdstringrequired

References company.id

mondaybooleanrequired

tuesdaybooleanrequired

wednesdaybooleanrequired

thursdaybooleanrequired

fridaybooleanrequired

saturdaybooleanrequired

sundaybooleanrequired

skipHolidaysbooleanrequired

locationIdstring

References location.id

procedureIdstring

References procedure.id

PATCHhttps://rest.carbon.ms/maintenanceSchedule

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "workCenterId": "xyz789",
  "frequency": "string",
  "priority": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

DELETE/maintenanceSchedule

Delete a maintenance schedule

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/maintenanceSchedule

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

204 No Content