Change Order Affected Item

The change order affected item resource.

Basehttps://rest.carbon.ms/changeOrderAffectedItem

GET/changeOrderAffectedItem

List change order affected items

Retrieve a paginated list of change order affected 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/changeOrderAffectedItem

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

Response

[
  {
    "id": "abc123def456",
    "changeOrderId": "xyz789",
    "itemId": "xyz789",
    "sortOrder": 0,
    "changeType": "string",
    "supersessionMode": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/changeOrderAffectedItem

Retrieve a change order affected item

Fetch a single change order affected item by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/changeOrderAffectedItem

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

Response

{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "itemId": "xyz789",
  "sortOrder": 0,
  "changeType": "string",
  "supersessionMode": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/changeOrderAffectedItem

Create a change order affected item

Create a new change order affected item.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

itemIdstringrequired

References item.id

sortOrdernumberrequired

changeTypechangeOrderChangeTyperequired

draftMakeMethodIdstring

References makeMethod.id

baseMakeMethodIdstring

References makeMethod.id

supersessionModesupersessionModerequired

discontinuationDatedate

successorEffectivityDatedate

newItemIdstring

References item.id

changeSummaryobject

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/changeOrderAffectedItem

curl --request POST \
  --url https://rest.carbon.ms/changeOrderAffectedItem \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"changeOrderId":"xyz789","itemId":"xyz789","sortOrder":0,"changeType":"string","supersessionMode":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "itemId": "xyz789",
  "sortOrder": 0,
  "changeType": "string",
  "supersessionMode": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/changeOrderAffectedItem

Update a change order affected item

Update an existing change order affected item, matched on `id`.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

itemIdstringrequired

References item.id

sortOrdernumberrequired

changeTypechangeOrderChangeTyperequired

draftMakeMethodIdstring

References makeMethod.id

baseMakeMethodIdstring

References makeMethod.id

supersessionModesupersessionModerequired

discontinuationDatedate

successorEffectivityDatedate

newItemIdstring

References item.id

changeSummaryobject

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/changeOrderAffectedItem

curl --request PATCH \
  --url 'https://rest.carbon.ms/changeOrderAffectedItem?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",
  "itemId": "xyz789",
  "sortOrder": 0,
  "changeType": "string",
  "supersessionMode": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/changeOrderAffectedItem

Delete a change order affected item

Delete a change order affected item, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/changeOrderAffectedItem

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

204 No Content