Maintenance Dispatch Event

The maintenance dispatch event resource.

Basehttps://rest.carbon.ms/maintenanceDispatchEvent

GET/maintenanceDispatchEvent

List maintenance dispatch events

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

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

Response

[
  {
    "id": "abc123def456",
    "maintenanceDispatchId": "xyz789",
    "employeeId": "xyz789",
    "workCenterId": "xyz789",
    "startTime": "2026-01-01T00:00:00Z",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/maintenanceDispatchEvent

Retrieve a maintenance dispatch event

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/maintenanceDispatchEvent

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

Response

{
  "id": "abc123def456",
  "maintenanceDispatchId": "xyz789",
  "employeeId": "xyz789",
  "workCenterId": "xyz789",
  "startTime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/maintenanceDispatchEvent

Create a maintenance dispatch event

Create a new maintenance dispatch event.

Body parameters

maintenanceDispatchIdstringrequired

References maintenanceDispatch.id

employeeIdstringrequired

References user.id

workCenterIdstringrequired

References workCenter.id

startTimetimestamprequired

endTimetimestamp

notesstring

durationnumber

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/maintenanceDispatchEvent

curl --request POST \
  --url https://rest.carbon.ms/maintenanceDispatchEvent \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"maintenanceDispatchId":"xyz789","employeeId":"xyz789","workCenterId":"xyz789","startTime":"2026-01-01T00:00:00Z","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "maintenanceDispatchId": "xyz789",
  "employeeId": "xyz789",
  "workCenterId": "xyz789",
  "startTime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/maintenanceDispatchEvent

Update a maintenance dispatch event

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

Body parameters

maintenanceDispatchIdstringrequired

References maintenanceDispatch.id

employeeIdstringrequired

References user.id

workCenterIdstringrequired

References workCenter.id

startTimetimestamprequired

endTimetimestamp

notesstring

durationnumber

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/maintenanceDispatchEvent

curl --request PATCH \
  --url 'https://rest.carbon.ms/maintenanceDispatchEvent?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",
  "employeeId": "xyz789",
  "workCenterId": "xyz789",
  "startTime": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/maintenanceDispatchEvent

Delete a maintenance dispatch event

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/maintenanceDispatchEvent

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

204 No Content