Procore.Api.QualitySafetyIncidentsInjuries (procore_sdk v0.3.0)
API calls for all endpoints tagged QualitySafetyIncidentsInjuries.
Summary
Functions
List Injuries Returns a list of Injuries for a given project. 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.
Destroy Injury Sends Injury to the recycle bin
Show Injury Returns a specific Injury 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.
Update Injury 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.
Create Injury Creates an Injury record. 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.
List Recycled Injuries Returns a list of Recycled Injuries for a given project (or Incident, if incident_id is present). 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.
Show Recycled Injury Returns a specific Recycled Injury 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.
Retrieve Recycled Injury Retrieves a specific Injury from the recycle bin
Functions
rest_v10_projects_project_id_incidents_injuries_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_incidents_injuries_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Injuries Returns a list of Injuries for a given project. 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.opts(keyword): Optional parameters:incident_id(integer()): Incident ID. When provided, the list will be scoped to only the Injuries for a given Incident.:page(integer()): Page:per_page(integer()): Elements per page:"filters[created_at]"(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[affected_company_id]"([integer()]): Array of Company IDs. Returns item(s) with the specified affected Company IDs. -:"filters[affected_party_id]"([integer()]): Array of Affected Party IDs. Returns item(s) with the specified Affected Party IDs. -:"filters[affected_person_id]"([integer()]): Array of Person IDs. Returns item(s) with the specified affected Person IDs. -:"filters[harm_source_id]"([integer()]): Array of Harm Source IDs. Returns item(s) with the specified Harm Source IDs. -:"filters[work_activity_id]"([integer()]): Array of Work Activity IDs. Returns item(s) with the specified Work Activity IDs. -:"filters[managed_equipment_id]"(integer()): Return item(s) with the specified Managed Equipment ID. -:"filters[recordable]"(boolean()): Return item(s) that are recordable. -:"filters[affected_body_part]"([String.t]): Return item(s) with any of the specified Affected Body Parts. -:"filters[affliction_type_id]"(integer()): Return item(s) with the specified Affliction Type IDs -:"filters[body_part_id]"([integer()]): Return item(s) with the specified Body Part IDs -:"filters[filing_type]"([String.t]): Return item(s) with the specified filing types. Therecordablefiling_type filter value is deprecated. -:"filters[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure
rest_v10_projects_project_id_incidents_injuries_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_incidents_injuries_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Destroy Injury Sends Injury to the recycle bin
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Injury IDopts(keyword): Optional parameters:incident_id(integer()): Incident ID
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
rest_v10_projects_project_id_incidents_injuries_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_incidents_injuries_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Injury Returns a specific Injury 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Injury IDopts(keyword): Optional parameters:incident_id(integer()): Incident ID
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t}on success{:error, Tesla.Env.t}on failure
rest_v10_projects_project_id_incidents_injuries_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_injuries_id_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_incidents_injuries_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update Injury 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Injury IDrest_v10_projects_project_id_incidents_injuries_id_patch_request(RestV10ProjectsProjectIdIncidentsInjuriesIdPatchRequest):opts(keyword): Optional parameters:incident_id(integer()): Incident ID:run_configurable_validations(boolean()): 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.
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t}on success{:error, Tesla.Env.t}on failure
rest_v10_projects_project_id_incidents_injuries_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_injuries_post_request, opts \\ [])
@spec rest_v10_projects_project_id_incidents_injuries_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create Injury Creates an Injury record. 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.rest_v10_projects_project_id_incidents_injuries_post_request(RestV10ProjectsProjectIdIncidentsInjuriesPostRequest):opts(keyword): Optional parameters:run_configurable_validations(boolean()): 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.
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t}on success{:error, Tesla.Env.t}on failure
rest_v10_projects_project_id_recycle_bin_incidents_injuries_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_incidents_injuries_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Recycled Injuries Returns a list of Recycled Injuries for a given project (or Incident, if incident_id is present). 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.opts(keyword): Optional parameters:incident_id(integer()): Incident ID. When provided, the list will be scoped to only the Recycled Injuries for a given Incident. 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.:"filters[created_at]"(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[affected_company_id]"([integer()]): Array of Company IDs. Returns item(s) with the specified affected Company IDs. -:"filters[affected_party_id]"([integer()]): Array of Affected Party IDs. Returns item(s) with the specified Affected Party IDs. -:"filters[affected_person_id]"([integer()]): Array of Person IDs. Returns item(s) with the specified affected Person IDs. -:"filters[harm_source_id]"([integer()]): Array of Harm Source IDs. Returns item(s) with the specified Harm Source IDs. -:"filters[work_activity_id]"([integer()]): Array of Work Activity IDs. Returns item(s) with the specified Work Activity IDs. -:"filters[managed_equipment_id]"(integer()): Return item(s) with the specified Managed Equipment ID. -:"filters[recordable]"(boolean()): Return item(s) that are recordable. -:"filters[affected_body_part]"([String.t]): Return item(s) with any of the specified Affected Body Parts. -:"filters[affliction_type_id]"([integer()]): Return item(s) with the specified Affliction Type IDs -:"filters[filing_type]"([String.t]): Return item(s) with the specified filing types. Therecordablefiling_type filter value is deprecated. -:"filters[query]"(String.t): Return item(s) containing query -:sort(String.t): -:page(integer()): Page -:per_page(integer()): Elements per page ### Returns -, ...]}on success -` on failure
rest_v10_projects_project_id_recycle_bin_incidents_injuries_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_incidents_injuries_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Recycled Injury Returns a specific Recycled Injury 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.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Injury IDopts(keyword): Optional parameters:incident_id(integer()): Incident ID
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdIncidentsInjuriesGet200ResponseInner.t}on success{:error, Tesla.Env.t}on failure
rest_v10_projects_project_id_recycle_bin_incidents_injuries_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_incidents_injuries_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Retrieve Recycled Injury Retrieves a specific Injury from the recycle bin
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Injury IDopts(keyword): Optional parameters:incident_id(integer()): Incident ID
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure