Procore.Api.QualitySafetyActionPlansCompanyActionPlanTypes (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansCompanyActionPlanTypes.

Summary

Functions

Link to this function

rest_v10_companies_company_id_action_plans_plan_types_get(connection, procore_company_id, company_id, opts \\ [])

List Company Action Plan Types List of all Company Action Plan Types for a Company

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"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[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_companies_company_id_action_plans_plan_types_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

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

Delete Company Action Plan Type Delete an Company Action Plan Type

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Company Action Plan Type ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_action_plans_plan_types_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show Company Action Plan Type Details of a Company Action Plan Type

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Company Action Plan Type ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_action_plans_plan_types_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_action_plans_plan_types_id_patch_request, opts \\ [])

Update Company Action Plan Type Update an Company Action Plan Type

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Company Action Plan Type ID
  • rest_v10_companies_company_id_action_plans_plan_types_id_patch_request (RestV10CompaniesCompanyIdActionPlansPlanTypesIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_action_plans_plan_types_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_action_plans_plan_types_post_request, opts \\ [])

Create a Company Action Plan Type Create a Company Action Plan Type for a Company

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • rest_v10_companies_company_id_action_plans_plan_types_post_request (RestV10CompaniesCompanyIdActionPlansPlanTypesPostRequest):
  • opts (keyword): Optional parameters

Returns

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