PATCH /rest/v1.0/projects/{project_id}/incidents/injuries/{id}
Update an Injury's attributes
NOTE: The afflictions and affected_body_part keys are deprecated. Please disregard and use the affected_body_parts and affliction_type keys as documented below.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Injury 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 |
run_configurable_validations |
Boolean | No |
Whether or not Configurable validations from the 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 |
|---|---|---|---|
injury |
Object | Yes | |
injury.treatment_facility |
String | No |
The name of the treatment facility |
injury.description |
String | No |
Description of event in Rich Text format |
injury.affliction_type_id |
Integer | No |
The ID of the Affliction Type. This cannot be cleared if there is an affected_body_part. |
injury.work_days_transferred |
Integer | No |
The number of days transferred |
injury.body_part_ids[] |
Array | No |
The IDs of body parts affected by the affliction. This requires an affliction_type to be set. |
injury.body_diagram_type |
String | No |
Possible values:
|
injury.harm_source_id |
Integer | No |
The ID of the Harm Source |
injury.work_activity_id |
Integer | No |
The ID of the Work Activity |
injury.affected_company_id |
Integer | No |
The ID of the Affected Company |
injury.treatment_provider |
String | No |
The name of the treatment provider |
injury.filing_type |
String | No |
Filing Type - The 'recordable' filing_type value is deprecated. When a filing type of 'recordable' is provided, the Possible values:
|
injury.treatment_facility_address |
String | No |
The street address of the treatment facility |
injury.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. |
|
injury.work_days_restricted |
Integer | No |
The number of days on restricted work |
injury.affected_party_id |
Integer | No |
The ID of the Affected Person. This supports full and reference Users from the People endpoints. |
injury.recordable |
Boolean | No |
Represents whether the Injury record is recordable |
injury.hospitalized_overnight |
Boolean | No |
Represents whether the injured person was hospitalized overnight |
injury.work_days_absent |
Integer | No |
The number of days absent from work |
injury.date_of_death |
String | No |
Date of death |
injury.managed_equipment_id |
Integer | No |
The ID of the Managed Equipment |
injury.treated_in_er |
Boolean | No |
Represents whether the injured person was treated in the ER |
injury.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. |
injury.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.