Procore.Api.QualitySafetyIncidentsNearMisses (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsNearMisses.

Summary

Functions

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

List Near Misses Returns a list of Near Misses for a given project.

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

Destroy Near Miss Sends Near Miss to the recycle bin

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

Show Near Miss Returns specific Near Miss

rest_v10_projects_project_id_incidents_near_misses_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_near_misses_id_patch_request, opts \\ [])

Update Near Miss Update a Near Miss' attributes

rest_v10_projects_project_id_incidents_near_misses_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_near_misses_post_request, opts \\ [])

Create Near Miss Creates a Near Miss record.

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

List Recycled Near Misses Returns a list of Recycled Near Misses for a given project (or Incident, if incident_id is present).

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

Show Recycled Near Miss Returns a specific Recycled Near Miss

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

Retrieve Recycled Near Miss Retrieves a specific Recycled Near Miss from the recycle bin

Functions

Link to this function

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

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

List Near Misses Returns a list of Near Misses 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
    • :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Near Misses 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 - 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[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[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Destroy Near Miss Sends Near Miss 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()): Near Miss ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

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

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

Show Near Miss Returns specific Near Miss

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()): Near Miss ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

rest_v10_projects_project_id_incidents_near_misses_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_near_misses_id_patch_request, opts \\ [])

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

Update Near Miss Update a Near Miss' attributes

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()): Near Miss ID
  • rest_v10_projects_project_id_incidents_near_misses_id_patch_request (RestV10ProjectsProjectIdIncidentsNearMissesIdPatchRequest):
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

rest_v10_projects_project_id_incidents_near_misses_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_near_misses_post_request, opts \\ [])

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

Create Near Miss Creates a Near Miss record.

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_near_misses_post_request (RestV10ProjectsProjectIdIncidentsNearMissesPostRequest):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Recycled Near Misses Returns a list of Recycled Near Misses for a given project (or Incident, if incident_id is present).

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. When provided, the list will be scoped to only the Recycled Near Misses for a given Incident.
    • :"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[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[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
Link to this function

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

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

Show Recycled Near Miss Returns a specific Recycled Near Miss

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()): Near Miss ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

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

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

Retrieve Recycled Near Miss Retrieves a specific Recycled Near Miss from 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()): Near Miss ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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