Procore.Api.QualitySafetyIncidentsIncidents (procore_sdk v0.3.0)

@spec rest_v10_projects_project_id_incidents_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.IncidentCompact.t()]}
  | {:error, Tesla.Env.t()}

List Incidents Returns a list of Incidents for a given project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Number of items returned per page (Min: 1, Max: 1000). Defaults to 1000 when parameter is not provided.
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated 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[event_date]"(Date.t): Returns item(s) with an event date within the specified ISO 8601 datetime range. -:"filters[location_id]"([integer()]): Return item(s) with the specified Location IDs. -:"filters[status]"([String.t]): Returns item(s) matching the specified status value. -:"filters[contributing_behavior_id]"([integer()]): Contributing Behavior ID. Returns item(s) with the specified Contributing Behavior ID. -:"filters[contributing_condition_id]"([integer()]): Contributing Condition ID. Returns item(s) with the specified Contributing Condition ID. -:"filters[hazard_id]"([integer()]): Hazard ID. Returns item(s) with the specified Hazard ID. -:"filters[time_unknown]"(boolean()): If true, returns item(s) where the time of Incident occurrence is unknown. -:"filters[recordable]"(boolean()): Return item(s) that are recordable. -:"filters[query]"(String.t): Return item(s) containing query. Searchable fields include Incident title, Creator, Witness Statement, Incident Action description, Incident Action Type, Contributing Behavior, Contributing Condition, Hazard, and Location. -:sort(String.t): ### Returns -, ...]}on success -` on failure

rest_v10_projects_project_id_incidents_id_delete(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_incidents_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Delete Incident Sends Incident to the Recycle Bin

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Incident ID
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_incidents_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.IncidentNormal.t()}
  | {:error, Tesla.Env.t()}

Show Incident Returns the specified Incident.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Incident ID
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.IncidentNormal.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_post_request, opts \\ [])

@spec rest_v10_projects_project_id_incidents_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdIncidentsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.IncidentNormal.t()}
  | {:error, Tesla.Env.t()}

Update Incident Updates the specified Incident.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Incident ID
rest_v10_projects_project_id_incidents_post_request (RestV10ProjectsProjectIdIncidentsPostRequest):
opts (keyword): Optional parameters
- :run_configurable_validations (boolean()): 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.

Returns

{:ok, Procore.Model.IncidentNormal.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_post_request, opts \\ [])

@spec rest_v10_projects_project_id_incidents_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdIncidentsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.IncidentNormal.t()}
  | {:error, Tesla.Env.t()}

Create Incident Creates an Incident in a given project.

Parameters

connection (Procore.Connection): Connection to server
procore_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_post_request (RestV10ProjectsProjectIdIncidentsPostRequest):
opts (keyword): Optional parameters
- :run_configurable_validations (boolean()): 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.

Returns

{:ok, Procore.Model.IncidentNormal.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_recycle_bin_incidents_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.IncidentCompact.t()]}
  | {:error, Tesla.Env.t()}

List Recycled Incidents Returns a list of Recycled Incidents for a given project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated 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[event_date]"(Date.t): Returns item(s) with an event date within the specified ISO 8601 datetime range. -:"filters[location_id]"([integer()]): Return item(s) with the specified Location IDs. -:"filters[status]"([String.t]): Returns item(s) matching the specified status value. -:"filters[contributing_behavior_id]"([integer()]): Contributing Behavior ID. Returns item(s) with the specified Contributing Behavior ID. -:"filters[contributing_condition_id]"([integer()]): Contributing Condition ID. Returns item(s) with the specified Contributing Condition ID. -:"filters[hazard_id]"([integer()]): Hazard ID. Returns item(s) with the specified Hazard ID. -:"filters[time_unknown]"(boolean()): If true, returns item(s) where the time of Incident occurrence is unknown. -:"filters[recordable]"(boolean()): Return item(s) that are recordable. -:"filters[query]"(String.t): Return item(s) containing query. Searchable fields include Incident title, Creator, Witness Statement, Incident Action description, Incident Action Type, Contributing Behavior, Contributing Condition, Hazard, and Location. -:sort(String.t): ### Returns -, ...]}on success -` on failure

rest_v10_projects_project_id_recycle_bin_incidents_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.IncidentNormal.t()}
  | {:error, Tesla.Env.t()}

Show Recycled Incident Returns the specified Recycled Incident.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Incident ID
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.IncidentNormal.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_recycle_bin_incidents_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_id_restore_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Retrieve Recycled Incident Retrieves the specified Incident from Recycle Bin.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Incident ID
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure