Change Order Required Action

The change order required action resource.

Basehttps://rest.carbon.ms/changeOrderRequiredAction

GET/changeOrderRequiredAction

List change order required actions

Retrieve a paginated list of change order required actions. 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/changeOrderRequiredAction

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/changeOrderRequiredAction

Retrieve a change order required action

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/changeOrderRequiredAction

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/changeOrderRequiredAction

Create a change order required action

Create a new change order required action.

Body parameters

namestringrequired

activebooleanrequired

customFieldsobject

POSThttps://rest.carbon.ms/changeOrderRequiredAction

curl --request POST \
  --url https://rest.carbon.ms/changeOrderRequiredAction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","active":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/changeOrderRequiredAction

Update a change order required action

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

Body parameters

namestringrequired

activebooleanrequired

customFieldsobject

PATCHhttps://rest.carbon.ms/changeOrderRequiredAction

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/changeOrderRequiredAction

Delete a change order required action

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/changeOrderRequiredAction

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

204 No Content