Procore.Api.QualitySafetyIncidentsHazards (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsHazards.

Summary

Functions

rest_v10_companies_company_id_hazards_bulk_update_patch(connection, procore_company_id, company_id, rest_v10_companies_company_id_hazards_bulk_update_patch_request, opts \\ [])

Bulk Update Hazards Update multiple Hazards with one request.

rest_v10_companies_company_id_hazards_get(connection, procore_company_id, company_id, opts \\ [])

List Hazards Return a list of all active Hazards associated with a Company.

rest_v10_companies_company_id_hazards_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

Delete Hazard Deletes a Hazard. Note that Procore provided Hazards cannot be deleted.

rest_v10_companies_company_id_hazards_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show Hazard Returns the details for a specified Hazard.

rest_v10_companies_company_id_hazards_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_hazards_id_patch_request, opts \\ [])

Update Hazard Updates a Hazard. Note that Procore provided Hazards' names cannot be changed.

rest_v10_companies_company_id_hazards_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_hazards_post_request, opts \\ [])

Create Hazard Creates a Hazard with the specified name.

Functions

Link to this function

rest_v10_companies_company_id_hazards_bulk_update_patch(connection, procore_company_id, company_id, rest_v10_companies_company_id_hazards_bulk_update_patch_request, opts \\ [])

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

Bulk Update Hazards Update multiple Hazards with one request.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • rest_v10_companies_company_id_hazards_bulk_update_patch_request (RestV10CompaniesCompanyIdHazardsBulkUpdatePatchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Hazard1{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_hazards_get(connection, procore_company_id, company_id, opts \\ [])

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

List Hazards Return a list of all active Hazards associated with a Company.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"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
    • :all (boolean()): Both active and inactive Hazards

Returns

  • {:ok, [%Hazard1{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_hazards_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

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

Delete Hazard Deletes a Hazard. Note that Procore provided Hazards cannot be deleted.

Parameters

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

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_hazards_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Hazard Returns the details for a specified Hazard.

Parameters

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

Returns

  • {:ok, Procore.Model.Hazard1.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_hazards_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_hazards_id_patch_request, opts \\ [])

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

Update Hazard Updates a Hazard. Note that Procore provided Hazards' names cannot be changed.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Hazard ID
  • rest_v10_companies_company_id_hazards_id_patch_request (RestV10CompaniesCompanyIdHazardsIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.Hazard1.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_hazards_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_hazards_post_request, opts \\ [])

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

Create Hazard Creates a Hazard with the specified name.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • rest_v10_companies_company_id_hazards_post_request (RestV10CompaniesCompanyIdHazardsPostRequest):
  • opts (keyword): Optional parameters

Returns

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