Procore.Api.QualitySafetyActionPlansActionPlanTestRecords (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansActionPlanTestRecords.

Summary

Functions

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

List Action Plan Test Records List of all Action Plan Test Records

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

Delete Action Plan Test Record Deletes an Action Plan Test Record

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

View an Action Plan Test Record Returns the details of an Action Plan Test Record

rest_v10_projects_project_id_action_plans_plan_test_records_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_test_records_post_request, opts \\ [])

Create Action Plan Test Record Create an Action Plan Test Record Action Plan Test Records can have one of the following payload formats (checklist_id, form_id, generic_tool_id, meeting_id, submittal_log_id, observation_item_id, attachment) Attachment payloads must be a binary file or contain an attachment_id. A specific Action Plan Test Record Type can only leverage its corresponding format. *For instance, Checklist Test Records can only leverage checklist_id while Attachment/Photo Test Records can only leverage attachment.

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

List Recyled Action Plan Test Records List of all Recycled Action Plan Test Records

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

Show Recycled Action Plan Test Record Returns a Recycled Action Plan Test Record

Functions

Link to this function

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

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

List Action Plan Test Records List of all Action Plan Test Records

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
    • :"filters[plan_item_id]" ([integer()]): Return item(s) associated with the specified Action Plan Item ID(s).
    • :"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_id]"([integer()]): Return item(s) associated with the specified Action Plan ID(s) -:"filters[plan_test_record_request_id]"([integer()]): Return item(s) associated with the specified Action Plan Test Record Request ID(s). -:"filters[type]"([String.t]): Return item(s) associated with the specified Action Plan Test Record Types. -:"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 -:page(integer()): Page -:per_page(integer()): Elements per page -: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_plan_test_records_id_delete(connection, procore_company_id, project_id, id, opts \\ [])

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

Delete Action Plan Test Record Deletes an Action Plan Test 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.
  • id (integer()): Action Plan Test Record 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_test_records_id_get(connection, procore_company_id, project_id, id, opts \\ [])

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

View an Action Plan Test Record Returns the details of an Action Plan Test 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.
  • id (integer()): Action Plan Test Record ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_action_plans_plan_test_records_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_test_records_post_request, opts \\ [])

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

Create Action Plan Test Record Create an Action Plan Test Record Action Plan Test Records can have one of the following payload formats (checklist_id, form_id, generic_tool_id, meeting_id, submittal_log_id, observation_item_id, attachment) Attachment payloads must be a binary file or contain an attachment_id. A specific Action Plan Test Record Type can only leverage its corresponding format. *For instance, Checklist Test Records can only leverage checklist_id while Attachment/Photo Test Records can only leverage attachment.

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

Returns

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

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

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

List Recyled Action Plan Test Records List of all Recycled Action Plan Test Records

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
    • :"filters[plan_item_id]" ([integer()]): Return item(s) associated with the specified Action Plan Item ID(s).
    • :"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_id]"([integer()]): Return item(s) associated with the specified Action Plan ID(s) -:"filters[plan_test_record_request_id]"([integer()]): Return item(s) associated with the specified Action Plan Test Record Request ID(s). -:"filters[type]"([String.t]): Return item(s) associated with the specified Action Plan Test Record Type(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 -:page(integer()): Page -:per_page(integer()): Elements per page -: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_plan_test_records_id_get(connection, procore_company_id, project_id, id, opts \\ [])

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

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

Returns

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