Procore.Api.QualitySafetyIncidentsActions (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsActions.

Summary

Functions

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

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

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

Destroy Action Sends the specified Action to the Recycle Bin

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

Show Action Returns the specified Action

rest_v10_projects_project_id_incidents_actions_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_actions_id_patch_request, opts \\ [])

Update Action Updates the specified Action

rest_v10_projects_project_id_incidents_actions_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_actions_post_request, opts \\ [])

Create Action Creates an Action.

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

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

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

Show Recycled Action Returns a specific Recycled Action

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

Retrieve Recycled Action Retrieves a specific Recycled Action from the recycle bin

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

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

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

Show Recycled Action Returns a specific Recycled Action

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

Retrieve Recycled Action Retrieves a specific Recycled Action from the recycle bin

Functions

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

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

List Actions Returns a list of Actions 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 Actions 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[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[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure

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

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

Destroy Action Sends the specified Action 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()): Action ID
opts (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_actions_id_get(connection, procore_company_id, project_id, id, opts \\ [])

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

Show Action Returns the specified Action

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

Returns

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

rest_v10_projects_project_id_incidents_actions_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_actions_id_patch_request, opts \\ [])

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

Update Action Updates the specified Action

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()): Action ID
rest_v10_projects_project_id_incidents_actions_id_patch_request (RestV10ProjectsProjectIdIncidentsActionsIdPatchRequest):
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID
- :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.RestV11ProjectsProjectIdRecycleBinIncidentsActionsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_actions_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_actions_post_request, opts \\ [])

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

Create Action Creates an Action.

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_actions_post_request (RestV10ProjectsProjectIdIncidentsActionsPostRequest):
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.RestV11ProjectsProjectIdRecycleBinIncidentsActionsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

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

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

List Recycled Actions Returns a list of Recycled Actions 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 Actions 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[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[query]"(String.t): Return item(s) containing query -:sort(String.t): -:per_page(integer()): Elements per page -:page(integer()): Page ### Returns -, ...]}on success -` on failure

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

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

Show Recycled Action Returns a specific Recycled Action

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

Returns

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

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

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

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

Returns

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

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

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

List Recycled Actions Returns a list of Recycled Actions 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 Actions 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[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[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure

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

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

Show Recycled Action Returns a specific Recycled Action

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

Returns

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

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

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

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

Returns

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