POST /rest/v1.0/projects/{project_id}/incidents
Creates an Incident in a given project.
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 |
Whether or not Configurable validations from the Incident/Injury Configurable Field Set should be run (default: false). See (https://developers.procore.com/reference/configurable-field-sets#list-project-configurable-field-sets) for a list of Configurable validations enabled on this project. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
incident |
Object | Yes | |
incident.file_version_ids[] |
Array | No |
File Versions to attach to the response |
incident.contributing_condition_id |
Integer | No |
The ID of a Contributing Condition |
incident.description |
String | No |
Description of the Incident |
incident.distribution_member_ids[] |
Array | No |
An Array of the IDs of the Distribution Members |
incident.upload_uuids[] |
Array | No |
Array of uploaded file UUIDs. |
incident.image_ids[] |
Array | No |
Images to attach to the response |
incident.environmentals[] |
Array | No |
Associated Environmentals to create |
incident.environmentals[].description |
String | No |
Description of event in Rich Text format |
incident.environmentals[].quantity_unit_of_measure |
String | No |
Unit of measure for the "quantity" field Possible values:
|
incident.environmentals[].environmental_type_id |
Integer | No |
The ID of the Environmental Type |
incident.environmentals[].quantity_value |
Number | No |
Numeric portion of the "quantity" field |
incident.environmentals[].work_activity_id |
Integer | No |
The ID of the Work Activity |
incident.environmentals[].managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
incident.environmentals[].affected_company_id |
Integer | No |
The ID of the Affected Company |
incident.environmentals[].estimated_cost_impact |
Number | No |
Estimated cost impact of the record |
incident.environmentals[].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. |
|
incident.status |
String | No |
Status Possible values:
|
incident.time_unknown |
Boolean | No |
Indicates that the time of the Incident occurrence is unknown |
incident.event_date |
String | No |
Iso8601 datetime of Incident occurrence. If time is unknown, send in the date at 0:00 project time converted to UTC. |
incident.property_damages[] |
Array | No |
Associated Property Damages to create |
incident.property_damages[].description |
String | No |
Description of event in Rich Text format |
incident.property_damages[].responsible_company_id |
Integer | No |
The ID of the Responsible Company |
incident.property_damages[].work_activity_id |
Integer | No |
The ID of the Work Activity |
incident.property_damages[].managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
incident.property_damages[].affected_company_id |
Integer | No |
The ID of the Affected Company |
incident.property_damages[].estimated_cost_impact |
Number | No |
Estimated cost impact of the record |
incident.property_damages[].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. |
|
incident.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
incident.hazard_id |
Integer | No |
The ID of a Hazard |
incident.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. |
|
incident.location_id |
Integer | No |
The ID of a Location |
incident.witness_statements_attributes[] |
Array | No |
Associated Witness Statement to create |
incident.witness_statements_attributes[].statement |
String | No |
The account of the event by the witness in rich text form. |
incident.witness_statements_attributes[].witness_id |
Integer | No |
Witness ID |
incident.witness_statements_attributes[].date_received |
String | No |
Date that the Witness Statement was received. This assumes the dates provided are in the project timezone. |
incident.witness_statements_attributes[].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. |
|
incident.contributing_behavior_id |
Integer | No |
The ID of a Contributing Behavior |
incident.form_ids[] |
Array | No |
Forms to attach to the response |
incident.recordable |
Boolean | No |
Indicates whether an Incident is recordable |
incident.near_misses[] |
Array | No |
Associated Near Misses to create |
incident.near_misses[].affected_party_id |
Integer | No |
The ID of the Affected Person. This supports full and reference Users from the People endpoints. |
incident.near_misses[].description |
String | No |
Description of event in Rich Text format |
incident.near_misses[].harm_source_id |
Integer | No |
The ID of the Harm Source |
incident.near_misses[].work_activity_id |
Integer | No |
The ID of the Work Activity |
incident.near_misses[].managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
incident.near_misses[].affected_company_id |
Integer | No |
The ID of the Affected Company |
incident.near_misses[].affected_person_id |
Integer | No |
The ID of the Affected Person. This only supports full Users from the Users endpoints. |
incident.near_misses[].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. |
|
incident.private |
Boolean | No |
Indicates whether an Incident is private |
incident.title |
String | No |
Incident Title |
incident.injuries[] |
Array | No |
Associated Injuries to create |
incident.injuries[].treatment_facility |
String | No |
The name of the treatment facility |
incident.injuries[].description |
String | No |
Description of event in Rich Text format |
incident.injuries[].affliction_type_id |
Integer | No |
The ID of the Affliction Type. This cannot be cleared if there is an affected_body_part. |
incident.injuries[].work_days_transferred |
Integer | No |
The number of days transferred |
incident.injuries[].body_part_ids[] |
Array | No |
The IDs of body parts affected by the affliction. This requires an affliction_type to be set. |
incident.injuries[].body_diagram_type |
String | No |
Possible values:
|
incident.injuries[].harm_source_id |
Integer | No |
The ID of the Harm Source |
incident.injuries[].work_activity_id |
Integer | No |
The ID of the Work Activity |
incident.injuries[].affected_company_id |
Integer | No |
The ID of the Affected Company |
incident.injuries[].treatment_provider |
String | No |
The name of the treatment provider |
incident.injuries[].filing_type |
String | No |
Filing Type - The 'recordable' filing_type value is deprecated. When a filing type of 'recordable' is provided, the Possible values:
|
incident.injuries[].treatment_facility_address |
String | No |
The street address of the treatment facility |
incident.injuries[].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. |
|
incident.injuries[].work_days_restricted |
Integer | No |
The number of days on restricted work |
incident.injuries[].affected_party_id |
Integer | No |
The ID of the Affected Person. This supports full and reference Users from the People endpoints. |
incident.injuries[].recordable |
Boolean | No |
Represents whether the Injury record is recordable |
incident.injuries[].hospitalized_overnight |
Boolean | No |
Represents whether the injured person was hospitalized overnight |
incident.injuries[].work_days_absent |
Integer | No |
The number of days absent from work |
incident.injuries[].date_of_death |
String | No |
Date of death |
incident.injuries[].managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
incident.injuries[].treated_in_er |
Boolean | No |
Represents whether the injured person was treated in the ER |
incident.injuries[].affected_body_parts[] |
Array | No |
DEPRECATED - Use body_part_ids instead. The body parts affected by the affliction. This requires an affliction_type to be set. |
incident.injuries[].affected_person_id |
Integer | No |
The ID of the Affected Person. This only supports full Users from the Users endpoints. |
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.