Procore.Api.QualitySafetyInspectionsCompanyChecklistTemplates (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsCompanyChecklistTemplates.

Summary

Functions

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

List Company Checklist Templates Returns a collection of Company Checklist Templates for a specified Company.

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

Delete Company Checklist Template Delete a Company Checklist Template

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

Show Company Checklist Template Returns the details for a specified Company Checklist Template

rest_v10_companies_company_id_checklist_list_templates_id_patch(connection, procore_company_id, company_id, id, checklist_template_body, opts \\ [])

Update Company Checklist Template Updates a Company Checklist Template for a specified Company.

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

Remove Company Checklist Template Alternative Response Set Removes a Company Checklist Template's Alternative Response Set, returning the template to the default Response Set

rest_v10_companies_company_id_checklist_list_templates_id_use_alternative_response_set_patch(connection, procore_company_id, id, company_id, rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch_request, opts \\ [])

Add Company Checklist Template Alternative Response Set Sets a Company Checklist Template's Response Set to the specified Alternative Response Set.

rest_v10_companies_company_id_checklist_list_templates_post(connection, procore_company_id, company_id, checklist_template_body, opts \\ [])

Create Company Checklist Template Creates a Company Checklist Template for a specified Company.

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

List Recycled Company Checklist Templates Returns a list of all Recycled Checklist Templates for a given Company.

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

Show Recycled Company Checklist Template View the details of a Recycled Company Checklist Template

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

Restore a Recycled Company Checklist Template Restores the specified Recycled Company Checklist Template

Functions

Link to this function

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

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

List Company Checklist Templates Returns a collection of Company Checklist Templates for a specified 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
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[inspection_type_id]" ([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :"filters[trade_id]" (integer()): Trade ID
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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
    • :sort (String.t):
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

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

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

Delete Company Checklist Template Delete a Company Checklist 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 Checklist 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_checklist_list_templates_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Company Checklist Template Returns the details for a specified Company Checklist 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 Checklist Template ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_checklist_list_templates_id_patch(connection, procore_company_id, company_id, id, checklist_template_body, opts \\ [])

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

Update Company Checklist Template Updates a Company Checklist Template for a specified 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.
  • id (integer()): Company Checklist Template ID
  • checklist_template_body (ChecklistTemplateBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

Remove Company Checklist Template Alternative Response Set Removes a Company Checklist Template's Alternative Response Set, returning the template to the default Response Set

Parameters

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

Returns

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

rest_v10_companies_company_id_checklist_list_templates_id_use_alternative_response_set_patch(connection, procore_company_id, id, company_id, rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch_request, opts \\ [])

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

Add Company Checklist Template Alternative Response Set Sets a Company Checklist Template's Response Set to the specified Alternative Response Set.

Parameters

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

Returns

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

rest_v10_companies_company_id_checklist_list_templates_post(connection, procore_company_id, company_id, checklist_template_body, opts \\ [])

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

Create Company Checklist Template Creates a Company Checklist Template for a specified 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.
  • checklist_template_body (ChecklistTemplateBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Recycled Company Checklist Templates Returns a list of all Recycled Checklist 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

Returns

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

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

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

Show Recycled Company Checklist Template View the details of a Recycled Company Checklist 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 Checklist Template ID
  • opts (keyword): Optional parameters

Returns

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

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

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

Restore a Recycled Company Checklist Template Restores the specified Recycled Company Checklist 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 Checklist Template ID
  • opts (keyword): Optional parameters

Returns

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