Procore.Api.QualitySafetyActionPlansActionPlanItems (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansActionPlanItems.

Summary

Functions

List Action Plan Items Returns all Action Plan Items for a given Project

Move Action Plan Item within or across Sections Move Action Plan Item within or across Action Plan Sections.

List Recycled Action Plan Items Returns all Recycled Action Plan Items for a given Project

Show Recycled Action Plan Item Returns a Specific Recycled Action Plan Item for a given Project

Functions

Link to this function

rest_v10_projects_project_id_action_plans_plan_items_bulk_update_patch(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_items_bulk_update_patch_request, opts \\ [])

Bulk Update Action Plan Item Updates multiple Action Plan Items

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

Returns

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

rest_v10_projects_project_id_action_plans_plan_items_create_from_item_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_items_create_from_item_post_request, opts \\ [])

Create a copy of the Action Plan Item in the Item's Section. Create a copy of the Action Plan Item in the Item's Section.

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

Returns

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

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

List Action Plan Items Returns all Action Plan Items 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[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[plan_section_id]"([integer()]): Return item(s) associated with the specified Action Plan Section(s). -:"filters[plan_id]"([integer()]): Return item(s) associated with the specified Action Plan 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 -:"filters[query]"(String.t): Return item(s) containing search query -:"filters[due_at]"(DateTime.t): Return item(s) due within the specified date range. -:"filters[assignee_party_id_or_role_id]"([integer()]): Return item(s) associated with the specified Action Plan Assignee party ID(s) or role ID(s) -:"filters[attachment_id]"([integer()]): Return item(s) associated with the specified Action Plan reference attachment ID(s) -:"filters[drawing_revision_id]"([integer()]): Return item(s) associated with the specified Action Plan reference drawing revision ID(s) -:"filters[file_version_id]"([integer()]): Return item(s) associated with the specified Action Plan reference file version ID(s) -:"filters[plan_test_record_request_id]"([integer()]): Return item(s) associated with the specified Action Plan Test Record Request ID(s). -:"filters[specification_section_id]"([integer()]): Return item(s) associated with the specified Action Plan reference specification section id ID(s) -:"filters[verification_method_id]"([integer()]): Return item(s) associated with the specified Action Plan Assignee verification method ID(s) -:"filters[generic_tool_item_id]"([integer()]): Return item(s) associated with the specified Action Plan reference Generic Tool Item ID(s) -:"filters[form_id]"([integer()]): Return item(s) associated with the specified Action Plan reference Form ID(s) -:"filters[meeting_id]"([integer()]): Return item(s) associated with the specified Action Plan reference Meeting ID(s) -:"filters[observation_item_id]"([integer()]): Return item(s) associated with the specified Action Plan reference Observation Item ID(s) -:"filters[submittal_log_id]"([integer()]): Return item(s) associated with the specified Action Plan reference submittal log ID(s) -:"filters[record_checklist_template_id]"(integer()): Return item(s) with the specified checklist template id. -:"filters[record_generic_tool_id]"(integer()): Return item(s) with the specified Generic Tool ID. -:"filters[reference_type]"([String.t]): Return item(s) associated with the specified Action Plan reference type(s) -:"filters[status_id]"([integer()]): Array of Status IDs. A single Status ID is also accepted. ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Delete Action Plan Item Deletes an Action Plan Item

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 Item 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_plan_items_id_get(connection, procore_company_id, project_id, id, opts \\ [])

Show Action Plan Item Returns an Action Plan Item

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

Returns

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

rest_v10_projects_project_id_action_plans_plan_items_id_move_post(connection, procore_company_id, project_id, id, plan_section_id, opts \\ [])

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

Move Action Plan Item within or across Sections Move Action Plan Item within or across Action Plan Sections.

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 Item ID
  • plan_section_id (integer()): ID of the Action Plan Section the Item will move within or to
  • opts (keyword): Optional parameters
    • :next_plan_item_id (integer()): ID of the Action Plan Item that will follow the newly moved Item. When moving an Item to the last position of the Section, do not provide this parameter.

Returns

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

rest_v10_projects_project_id_action_plans_plan_items_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_action_plans_plan_items_id_patch_request, opts \\ [])

Update Action Plan Item Updates an Action Plan Item

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

Returns

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

rest_v10_projects_project_id_action_plans_plan_items_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_items_post_request, opts \\ [])

Create Action Plan Item Creates an Action Plan Item for a given Action Plan Section.

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

Returns

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

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

List Recycled Action Plan Items Returns all Recycled Action Plan Items 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[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[plan_section_id]"([integer()]): Return item(s) associated with the specified Action Plan Section(s). -:"filters[plan_id]"([integer()]): Return item(s) associated with the specified Action Plan 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 -:"filters[query]"(String.t): Return item(s) containing search query ### Returns -, ...]}on success -` on failure
Link to this function

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

Show Recycled Action Plan Item Returns a Specific Recycled Action Plan Item 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.
  • id (integer()): Action Plan Item ID
  • opts (keyword): Optional parameters

Returns

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