Procore.Api.QualitySafetyActionPlansCompanyActionPlanTypes (procore_sdk v0.3.0)
API calls for all endpoints tagged QualitySafetyActionPlansCompanyActionPlanTypes.
Summary
Functions
List Company Action Plan Types List of all Company Action Plan Types for a Company
Delete Company Action Plan Type Delete an Company Action Plan Type
Show Company Action Plan Type Details of a Company Action Plan Type
Update Company Action Plan Type Update an Company Action Plan Type
Create a Company Action Plan Type Create a Company Action Plan Type for a Company
Functions
rest_v10_companies_company_id_action_plans_plan_types_get(connection, procore_company_id, company_id, opts \\ [])
@spec rest_v10_companies_company_id_action_plans_plan_types_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdActionPlansPlanTemplatesGet200ResponseInnerPlanType.t() ]} | {:error, Tesla.Env.t()}
List Company Action Plan Types List of all Company Action Plan Types for a Company
Parameters
connection(Procore.Connection): Connection to serverprocore_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- 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[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
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 serverprocore_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 IDopts(keyword): Optional parameters
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
rest_v10_companies_company_id_action_plans_plan_types_id_get(connection, procore_company_id, company_id, id, opts \\ [])
@spec rest_v10_companies_company_id_action_plans_plan_types_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdActionPlansPlanTemplatesGet200ResponseInnerPlanType.t()} | {:error, Tesla.Env.t()}
Show Company Action Plan Type Details of a Company Action Plan Type
Parameters
connection(Procore.Connection): Connection to serverprocore_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 IDopts(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdActionPlansPlanTemplatesGet200ResponseInnerPlanType.t}on success{:error, Tesla.Env.t}on failure
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 \\ [])
@spec rest_v10_companies_company_id_action_plans_plan_types_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdActionPlansPlanTypesIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdActionPlansPlanTemplatesGet200ResponseInnerPlanType.t()} | {:error, Tesla.Env.t()}
Update Company Action Plan Type Update an Company Action Plan Type
Parameters
connection(Procore.Connection): Connection to serverprocore_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 IDrest_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
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 \\ [])
@spec rest_v10_companies_company_id_action_plans_plan_types_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdActionPlansPlanTypesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdActionPlansPlanTemplatesGet200ResponseInnerPlanType.t()} | {:error, Tesla.Env.t()}
Create a Company Action Plan Type Create a Company Action Plan Type for a Company
Parameters
connection(Procore.Connection): Connection to serverprocore_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