Procore.Api.QualitySafetyActionPlansActionPlans (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansActionPlans.

Summary

Functions

rest_v10_projects_project_id_action_plans_plans_create_from_template_post(connection, procore_company_id, project_id, plan_template_id, opts \\ [])

Create an Action Plan from a Plan Template. Create an Action Plan from a Plan Template. In addition to creating the plan itself, this action will also create sections, items, assignees, references and test record requests from the template.

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

List Action Plans List of all Action Plans

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

Delete Action Plan Delete an Action Plan

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

Show Action Plan Details of a single Action Plan

rest_v10_projects_project_id_action_plans_plans_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_action_plans_plans_id_patch_request, opts \\ [])

Update Action Plan Update an Action Plan

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

Move Action Plan into "In Progress" Move Action Plan into "In Progress". This will set the status of the Plan to "in_progress". Once in this state, only specific updates to the Plan are allowed.

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

Move Action Plan back into "Draft" Move Action Plan Back into "Draft". This will remove approver and receiver signatures from the Plan, and set the status to "draft". Once in this state, the Plan is able to be updated.

rest_v10_projects_project_id_action_plans_plans_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plans_post_request, opts \\ [])

Create Action Plan Create an Action Plan

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

List Recycled Action Plan Returns a list of Recycled Action Plans for a given project.

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

Show Recycled Action Plan Returns the specified Recycled Action Plan.

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

Restore Recycled Action Plan Restores the specified Action Plan from Recycle Bin.

Functions

Link to this function

rest_v10_projects_project_id_action_plans_plans_create_from_template_post(connection, procore_company_id, project_id, plan_template_id, opts \\ [])

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

Create an Action Plan from a Plan Template. Create an Action Plan from a Plan Template. In addition to creating the plan itself, this action will also create sections, items, assignees, references and test record requests from the template.

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.
  • plan_template_id (integer()): Action Plan Template ID
  • opts (keyword): Optional parameters

Returns

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

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

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

List Action Plans List of all Action Plans

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[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[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[include_sublocations]"(boolean()): Use together withfilters[location_id]-:"filters[location_id]"([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs. -:"filters[manager_id]"([integer()]): Return item(s) with a specific Manager ID or a range of Manager ID(s). -:"filters[plan_type_id]"([integer()]): Action Plan Type ID. Returns item(s) with the specified Action Plan Type ID(s). -:"filters[template_id]"([integer()]): Return Action Plan(s) associated with the specified Action Plan Template ID(s). -:"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 -:sort(String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Delete Action Plan Delete an Action Plan

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

Returns

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

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

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

Show Action Plan Details of a single Action Plan

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

Returns

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

rest_v10_projects_project_id_action_plans_plans_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_action_plans_plans_id_patch_request, opts \\ [])

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

Update Action Plan Update an Action Plan

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 Plan ID
  • rest_v10_projects_project_id_action_plans_plans_id_patch_request (RestV10ProjectsProjectIdActionPlansPlansIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

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

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

Move Action Plan into "In Progress" Move Action Plan into "In Progress". This will set the status of the Plan to "in_progress". Once in this state, only specific updates to the Plan are allowed.

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

Returns

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

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

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

Move Action Plan back into "Draft" Move Action Plan Back into "Draft". This will remove approver and receiver signatures from the Plan, and set the status to "draft". Once in this state, the Plan is able to be updated.

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

Returns

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

rest_v10_projects_project_id_action_plans_plans_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plans_post_request, opts \\ [])

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

Create Action Plan Create an Action Plan

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

Returns

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

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

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

List Recycled Action Plan Returns a list of Recycled Action Plans 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[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[deleted_by_id]"([integer()]): Return item(s) with a specific Deleted By ID or a range of Deleted By IDs. -:"filters[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[include_sublocations]"(boolean()): Use together withfilters[location_id]-:"filters[location_id]"([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs. -:"filters[manager_id]"([integer()]): Return item(s) with a specific Manager ID or a range of Manager ID(s). -:"filters[plan_type_id]"([integer()]): Action Plan Type ID. Returns item(s) with the specified Action Plan Type ID(s). -:"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 -:sort(String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Show Recycled Action Plan Returns the specified Recycled Action Plan.

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

Returns

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

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

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

Restore Recycled Action Plan Restores the specified Action Plan 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()): Action Plan ID
  • opts (keyword): Optional parameters

Returns

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