PATCH /rest/v1.0/projects/{project_id}/incidents/near_misses/{id}
Update a Near Miss' attributes
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Near Miss ID |
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 |
|---|---|---|---|
incident_id |
Integer | No |
Incident ID |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
near_miss |
Object | Yes | |
near_miss.affected_party_id |
Integer | No |
The ID of the Affected Person. This supports full and reference Users from the People endpoints. |
near_miss.description |
String | No |
Description of event in Rich Text format |
near_miss.harm_source_id |
Integer | No |
The ID of the Harm Source |
near_miss.work_activity_id |
Integer | No |
The ID of the Work Activity |
near_miss.managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
near_miss.affected_company_id |
Integer | No |
The ID of the Affected Company |
near_miss.affected_person_id |
Integer | No |
The ID of the Affected Person. This only supports full Users from the Users endpoints. |
near_miss.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. |
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.