PATCH /rest/v1.0/projects/{project_id}/prime_change_orders/{id}
Update the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the Prime Change Order |
project_id |
Integer | Yes |
Unique identifier for the project. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
view |
String | No |
Specifies Which view (which attributes) of the resource is going to be present in the response. the extended view includes change events data, while the default view does not. Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
change_order |
Object | Yes |
Change Order object |
change_order.executed |
Boolean | No |
Whether or not the Change Order is executed |
change_order.change_order_change_reason_id |
Integer | No |
Unique identifier for the change reason. |
change_order.description |
String | No |
Description |
change_order.paid_date |
String | No |
Paid Date |
change_order.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
change_order.custom_field_%{custom_field_definition_id} |
Object | No |
Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries. |
change_order.designated_reviewer_id |
Integer | No |
Unique identifier for the designated reviewer. This field is only supported for single-tier projects. Behavior is undefined in multi-tier projects. |
change_order.invoiced_date |
String | No |
Invoiced Date |
change_order.title |
String | No |
Title of the Contract |
change_order.reference |
String | No |
Reference |
change_order.schedule_impact_amount |
Integer | No |
Schedule impact in days |
change_order.file_version_ids[] |
Array | No |
File Versions to attach to the response |
change_order.field_change |
Boolean | No |
Field Change |
change_order.image_ids[] |
Array | No |
Images to attach to the response |
change_order.revision |
Integer | No |
Revision Number |
change_order.number |
String | No |
Number of the Change Order |
change_order.upload_ids[] |
Array | No |
Uploads to attach to the response |
change_order.status |
String | No |
Status |
change_order.attachment_ids[] |
Array | No |
Existing attachments to preserve on the response |
change_order.batch_id |
Integer | No |
Unique identifier for a change order batch. |
change_order.location_id |
Integer | No |
Unique identifier for the location. |
change_order.form_ids[] |
Array | No |
Forms to attach to the response |
change_order.contract_id |
Integer | Yes |
Unique identifier for the contract. |
change_order.signed_change_order_received_date |
String | No |
Signed Change Order Received Date |
change_order.paid |
Boolean | No |
Whether or not the Commitment Change Order is paid |
change_order.signature_required |
Boolean | No |
Whether a signature will be required for this Change Order |
change_order.private |
Boolean | No |
Whether or not the Commitment Change Order is private |
change_order.received_from_id |
Integer | No |
Unique identifier for the received from entity. |
change_order.due_date |
String | No |
Due Date |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.