Procore.Api.QualitySafetyIncidentsAlerts (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsAlerts.

Summary

Functions

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

List Incident Alerts Returns a list of all Incident Alerts associated with a Project.

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

Show Incident Alert Returns the specified Incident Alert.

Functions

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

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

List Incident Alerts Returns a list of all Incident Alerts associated with a 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
- :incident_id (integer()): Incident ID
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[updated_at]" (Date.t): Return item(s) last updated 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[incident_id]" ([integer()]): Return item(s) with the specified Incident IDs.
- :"filters[injury_id]" ([integer()]): Return item(s) with the specified Injury IDs.
- :"filters[recipient_id]" ([integer()]): Return item(s) with the specified recipient (User) IDs
- :"filters[severity_level_id]" ([integer()]): Return item(s) with the specified Incident Severity Level IDs
- :"filters[triggered_by_id]" ([integer()]): Return item(s) with the specified triggered by (User) IDs
- :sort (String.t):

Returns

{:ok, [%RestV10ProjectsProjectIdIncidentsAlertsGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Show Incident Alert Returns the specified Incident Alert.

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 Alert ID
opts (keyword): Optional parameters

Returns

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