POST /rest/v1.1/change_events
Create Change Event
Servers
- https://api.procore.com
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 |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
change_event |
Object | Yes | |
change_event.source |
String | No |
The Change Event source refers to the resource that was responsible for creating this Change Event. Valid values:
|
change_event.description |
String | No |
description |
change_event.number |
String | No |
number |
change_event.change_reason |
Object | No | |
change_event.change_reason.id |
Integer | No |
ID |
change_event.scope |
String | Yes |
Event Scope Valid values:
|
change_event.status |
Object | Yes | |
change_event.status.id |
Integer | No |
ID |
change_event.source_of_revenue_rom |
String | No |
Revenue ROM source for this Change Event Valid values:
|
change_event.external_data |
Object | No | |
change_event.external_data.origin_id |
String | No |
Origin ID |
change_event.external_data.origin_data |
String | No |
Origin data |
change_event.custom_field_%{custom_field_definition_id} |
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_event.prime_contract_for_estimates |
Object | No | |
change_event.prime_contract_for_estimates.id |
Integer | No |
Prime Contract ID |
change_event.title |
String | No |
title |
change_event.change_items[] |
Array | No |
Change Event Line Items |
change_event.change_items[].budget_impact |
Object | No | |
change_event.change_items[].budget_impact.source_of_budget_rom |
String | No |
source of budget rom Valid values:
|
change_event.change_items[].budget_impact.estimate |
Object | No | |
change_event.change_items[].budget_impact.estimate.calculation_strategy |
String | No |
the estimated budget impact calculation strategy Valid values:
|
change_event.change_items[].budget_impact.estimate.auto_balance |
Boolean | No |
indicates whether the Budget ROM should be automatically balanced |
change_event.change_items[].budget_impact.estimate.amount |
Number | No |
the estimated budget impact amount |
change_event.change_items[].budget_impact.estimate.quantity |
Number | No |
the estimated budget impact quantity |
change_event.change_items[].budget_impact.estimate.transfer |
Object | No | |
change_event.change_items[].budget_impact.estimate.transfer.amount |
Number | No |
the estimated budget rom transfer amount |
change_event.change_items[].budget_impact.estimate.transfer.from_wbs_code_id |
Integer | No |
the unique identifier for wbs code from which estimatd budget rom transfer will be balanced |
change_event.change_items[].budget_impact.estimate.unit_cost |
Number | No |
the estimated unit cost for budget impact |
change_event.change_items[].budget_impact.estimate.unit_of_measure |
String | No |
the unit of measure used |
change_event.change_items[].revenue_impact |
Object | No | |
change_event.change_items[].revenue_impact.estimate |
Object | No | |
change_event.change_items[].revenue_impact.estimate.calculation_strategy |
String | No |
revenue calculation strategy Valid values:
|
change_event.change_items[].revenue_impact.estimate.amount |
String | No |
estimated revenue amount |
change_event.change_items[].revenue_impact.estimate.quantity |
String | No |
estimated revenue quantity |
change_event.change_items[].revenue_impact.estimate.unit_cost |
String | No |
estimated unit cost |
change_event.change_items[].revenue_impact.estimate.unit_of_measure |
String | No |
unit of measure used |
change_event.change_items[].revenue_impact.source_of_revenue_rom |
String | No |
Revenue ROM source for this Change Item Valid values:
|
change_event.change_items[].description |
String | No |
Description |
change_event.change_items[].cost_impact |
Object | No | |
change_event.change_items[].cost_impact.contract |
Object | No | |
change_event.change_items[].cost_impact.contract.proposed |
Object | No |
the Proposed Contract associated to the Change Item |
change_event.change_items[].cost_impact.contract.proposed.id |
Integer | No |
ID |
change_event.change_items[].cost_impact.vendor |
Object | No | |
change_event.change_items[].cost_impact.vendor.proposed |
Object | No |
the Proposed Vendor associated to the Change Item |
change_event.change_items[].cost_impact.vendor.proposed.id |
Integer | No |
ID |
change_event.change_items[].cost_impact.estimate |
Object | No | |
change_event.change_items[].cost_impact.estimate.calculation_strategy |
String | No |
cost calculation strategy Valid values:
|
change_event.change_items[].cost_impact.estimate.amount |
Number | No |
estimated cost amount |
change_event.change_items[].cost_impact.estimate.quantity |
Number | No |
estimated cost quantity |
change_event.change_items[].cost_impact.estimate.unit_cost |
Number | No |
estimated unit cost |
change_event.change_items[].cost_impact.estimate.unit_of_measure |
String | No |
unit of measure used |
change_event.change_items[].budget_code |
Object | No |
the Budget Code associated to the Change Item. If one is not provided, the Change Event Line Item will be created with a 'None' Budget Code. |
change_event.change_items[].budget_code.id |
Integer | No |
ID |
change_event.event_origin |
Object | No | |
change_event.event_origin.origin_type |
String | No |
type of related event origin Valid values:
|
change_event.event_origin.origin_id |
Integer | No |
ID of related event origin |
change_event.change_type |
Object | No | |
change_event.change_type.id |
Integer | No |
ID |
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.