POST /rest/v1.0/projects/{project_id}/prime_change_order_batches
Create a new Prime Change Order Batch.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
change_order_batch |
Object | Yes |
Change Order Batch object |
change_order_batch.file_version_ids[] |
Array | No |
File Versions to attach to the response |
change_order_batch.revised_substantial_completion_date |
String | No |
Revised substantial completion date |
change_order_batch.executed |
Boolean | No |
Whether or not the Change Order Batch is executed |
change_order_batch.image_ids[] |
Array | No |
Images to attach to the response |
change_order_batch.description |
String | No |
Description |
change_order_batch.revision |
Integer | No |
Revision Number |
change_order_batch.document_management_document_revision_ids[] |
Array | No |
PDM document to attach to the response |
change_order_batch.number |
String | No |
Number of the Change Order Batch |
change_order_batch.upload_ids[] |
Array | No |
Uploads to attach to the response |
change_order_batch.paid_date |
String | No |
Paid Date |
change_order_batch.status |
String | No |
Status |
change_order_batch.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
change_order_batch.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_batch.form_ids[] |
Array | No |
Forms to attach to the response |
change_order_batch.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_batch.contract_id |
Integer | Yes |
Unique identifier for the contract. |
change_order_batch.invoiced_date |
String | No |
Invoiced Date |
change_order_batch.signed_change_order_received_date |
String | No |
Signed Change Order Batch Received Date |
change_order_batch.signature_required |
Boolean | No |
Whether a signature will be required for this Change Order Batch |
change_order_batch.private |
Boolean | No |
Whether or not the Change Order Batch is private |
change_order_batch.title |
String | No |
Title of the Change Order Batch |
change_order_batch.schedule_impact_amount |
Integer | No |
Schedule impact in days |
change_order_batch.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.