Procore.Api.QualitySafetyActionPlansCompanyActionPlanTemplates (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansCompanyActionPlanTemplates.

Summary

Functions

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

List of Company Action Plan Templates List of all Company Action Plan Templates

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

Delete a Company Action Plan Templates Delete a Company Action Plan Template

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

Show Company Action Plan Template Details of a single Company Action Plan Template

rest_v10_companies_company_id_action_plans_plan_templates_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_action_plans_plan_templates_id_patch_request, opts \\ [])

Update a Company Action Plan Template Update a Company Action Plan Template

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

Move Company Action Plan Template into "Published" Move Company Action Plan Template into "Published". This will set the status of the Company Action Plan Templates to "Published". Once in this state, further updates to the Company Action Plan Template will be denied.

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

Move Company Action Plan Template into "In Revision" Move Company Action Plan Template into "In Revision". This will set the status to "in_revision". Once in this state, the Company Action Plan Template is able to be updated.

rest_v10_companies_company_id_action_plans_plan_templates_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_action_plans_plan_templates_post_request, opts \\ [])

Create Company Action Plan Templates Create a Company Action Plan Template

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

List Recycled Company Action Plan Templates Returns a list of Recycled Company Action Plan Templates for a given company.

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

Show Recycled Company Action Plan Template Returns the specified Recycled Company Action Plan Template.

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

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

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

List of Company Action Plan Templates List of all Company Action Plan Templates

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

Delete a Company Action Plan Templates Delete a Company Action Plan Template

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

Show Company Action Plan Template Details of a single Company Action Plan Template

rest_v11_companies_company_id_action_plans_plan_templates_id_patch(connection, procore_company_id, company_id, id, rest_v11_companies_company_id_action_plans_plan_templates_id_patch_request, opts \\ [])

Update a Company Action Plan Template Update a Company Action Plan Template

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

Move Company Action Plan Template into "Published" Move Company Action Plan Template into "Published". This will set the status of the Company Action Plan Templates to "Published". Once in this state, further updates to the Company Action Plan Template will be denied.

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

Move Company Action Plan Template into "In Revision" Move Company Action Plan Template into "In Revision". This will set the status to "in_revision". Once in this state, the Company Action Plan Template is able to be updated.

rest_v11_companies_company_id_action_plans_plan_templates_post(connection, procore_company_id, company_id, rest_v11_companies_company_id_action_plans_plan_templates_post_request, opts \\ [])

Create Company Action Plan Templates Create a Company Action Plan Template

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

List Recycled Company Action Plan Templates Returns a list of Recycled Company Action Plan Templates for a given company.

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

Show Recycled Company Action Plan Template Returns the specified Recycled Company Action Plan Template.

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

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

Functions

Link to this function

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

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

List of Company Action Plan Templates List of all Company Action Plan Templates

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
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.
    • :"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_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 ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Delete a Company Action Plan Templates Delete a Company Action Plan Template

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 Template 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_templates_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Company Action Plan Template Details of a single Company Action Plan Template

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

Returns

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

rest_v10_companies_company_id_action_plans_plan_templates_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_action_plans_plan_templates_id_patch_request, opts \\ [])

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

Update a Company Action Plan Template Update a Company Action Plan Template

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

Returns

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

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

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

Move Company Action Plan Template into "Published" Move Company Action Plan Template into "Published". This will set the status of the Company Action Plan Templates to "Published". Once in this state, further updates to the Company Action Plan Template will be denied.

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 Template 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_templates_id_revise_post(connection, procore_company_id, company_id, id, opts \\ [])

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

Move Company Action Plan Template into "In Revision" Move Company Action Plan Template into "In Revision". This will set the status to "in_revision". Once in this state, the Company Action Plan Template 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.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Company Action Plan Template 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_templates_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_action_plans_plan_templates_post_request, opts \\ [])

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

Create Company Action Plan Templates Create a Company Action Plan Template

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

Returns

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

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

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

List Recycled Company Action Plan Templates Returns a list of Recycled Company Action Plan Templates for a given 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[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_at]"(String.t): Returns item(s) deleted within the specified ISO 8601 datetime range. -:"filters[deleted_by_id]"([integer()]): Return item(s) deleted by the specified User IDs -:"filters[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[type_id]"([String.t]): Return item(s) with a specific Action Plan Type ID or a range of Action Plan Type 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_recycle_bin_action_plans_plan_templates_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Recycled Company Action Plan Template Returns the specified Recycled Company Action Plan Template.

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

Returns

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

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

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

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

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

Returns

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

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

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

List of Company Action Plan Templates List of all Company Action Plan Templates

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
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.
    • :"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_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 ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Delete a Company Action Plan Templates Delete a Company Action Plan Template

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

Returns

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

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

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

Show Company Action Plan Template Details of a single Company Action Plan Template

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

Returns

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

rest_v11_companies_company_id_action_plans_plan_templates_id_patch(connection, procore_company_id, company_id, id, rest_v11_companies_company_id_action_plans_plan_templates_id_patch_request, opts \\ [])

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

Update a Company Action Plan Template Update a Company Action Plan Template

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

Returns

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

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

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

Move Company Action Plan Template into "Published" Move Company Action Plan Template into "Published". This will set the status of the Company Action Plan Templates to "Published". Once in this state, further updates to the Company Action Plan Template will be denied.

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

Returns

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

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

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

Move Company Action Plan Template into "In Revision" Move Company Action Plan Template into "In Revision". This will set the status to "in_revision". Once in this state, the Company Action Plan Template 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.
  • company_id (integer()): Unique identifier for the company.
  • id (integer()): Company Action Plan Template ID
  • opts (keyword): Optional parameters

Returns

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

rest_v11_companies_company_id_action_plans_plan_templates_post(connection, procore_company_id, company_id, rest_v11_companies_company_id_action_plans_plan_templates_post_request, opts \\ [])

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

Create Company Action Plan Templates Create a Company Action Plan Template

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

Returns

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

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

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

List Recycled Company Action Plan Templates Returns a list of Recycled Company Action Plan Templates for a given 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[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_at]"(String.t): Returns item(s) deleted within the specified ISO 8601 datetime range. -:"filters[deleted_by_id]"([integer()]): Return item(s) deleted by the specified User IDs -:"filters[id]"([integer()]): Return item(s) with the specified IDs. -:"filters[type_id]"([String.t]): Return item(s) with a specific Action Plan Type ID or a range of Action Plan Type 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_v11_companies_company_id_recycle_bin_action_plans_plan_templates_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Recycled Company Action Plan Template Returns the specified Recycled Company Action Plan Template.

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

Returns

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

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

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

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

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

Returns

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