Carbon

Change Order Action Task

The change order action task resource.

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

List change order action tasks

Retrieve a paginated list of change order action tasks. 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/changeOrderActionTask
curl --request GET \
  --url 'https://rest.carbon.ms/changeOrderActionTask?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "changeOrderId": "xyz789",
    "name": "Example",
    "status": "string",
    "notes": "string",
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/changeOrderActionTask

Retrieve a change order action task

Fetch a single change order action task by filtering on `id`.

Query parameters

idstring

Match on the change order action task's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/changeOrderActionTask
curl --request GET \
  --url 'https://rest.carbon.ms/changeOrderActionTask?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "name": "Example",
  "status": "string",
  "notes": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/changeOrderActionTask

Create a change order action task

Create a new change order action task.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

namestring
statuschangeOrderTaskStatusrequired
dueDatedate
completedDatedate
assigneestring

References user.id

notesobjectrequired
sortOrdernumberrequired
tagsarray
companyIdstringrequired

References company.id

actionTypeIdstring

References changeOrderRequiredAction.id

POSThttps://rest.carbon.ms/changeOrderActionTask
curl --request POST \
  --url https://rest.carbon.ms/changeOrderActionTask \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"changeOrderId":"xyz789","name":"Example","status":"string","notes":"string","sortOrder":0,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "name": "Example",
  "status": "string",
  "notes": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/changeOrderActionTask

Update a change order action task

Update an existing change order action task, matched on `id`.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

namestring
statuschangeOrderTaskStatusrequired
dueDatedate
completedDatedate
assigneestring

References user.id

notesobjectrequired
sortOrdernumberrequired
tagsarray
companyIdstringrequired

References company.id

actionTypeIdstring

References changeOrderRequiredAction.id

PATCHhttps://rest.carbon.ms/changeOrderActionTask
curl --request PATCH \
  --url 'https://rest.carbon.ms/changeOrderActionTask?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"changeOrderId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "name": "Example",
  "status": "string",
  "notes": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/changeOrderActionTask

Delete a change order action task

Delete a change order action task, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the change order action task to delete, e.g. `eq.{id}`.

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