Procore.Api.QualitySafetyInspectionsProjectChecklistTemplates (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsProjectChecklistTemplates.

Summary

Functions

rest_v10_projects_project_id_checklist_list_templates_create_from_company_template_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_list_templates_create_from_company_template_post_request, opts \\ [])

Create a Project Checklist Template from a Company Checklist Template Creates a Project Checklist Template from a Company Checklist Template. Sections and Items on the Company Template are copied to the Project Template and changes to these company level records, including the template itself, are synced down to the project level. You may not create more than 1 project template per company template.

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

List Project Checklist Templates Returns a list of all Inspection Checklist Templates for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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

Delete Project Checklist Template Deletes an Inspection Checklist Template.

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

Show Project Checklist Template Shows an Inspection Checklist Template.

rest_v10_projects_project_id_checklist_list_templates_id_patch(connection, procore_company_id, id, project_id, checklist_template_body, opts \\ [])

Update Project Checklist Template Updates an Inspection Checklist Template.

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

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

rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch_request, opts \\ [])

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

rest_v10_projects_project_id_checklist_list_templates_post(connection, procore_company_id, project_id, checklist_template_body, opts \\ [])

Create Project Checklist Template Creates a Project Inspection Template for a specified Project.

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

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

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

Show Recycled Checklist Template Shows a Recycled Checklist Template

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

Restore Recycled Checklist Template Restores the specified Checklist Template from the Recycle Bin.

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

List Project Checklist Templates Returns a list of all Inspection Checklist Templates for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Note: A User with read-only and above permissions to Inspections has access to this endpoint and the URL to individual templates on the web

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

Show Project Checklist Template Shows an Inspection Checklist Template. Note: A User with read-only and above permissions to Inspections has access to this endpoint and the URL to the template on the web

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

Restore Recycled Checklist Template Restores the specified Checklist Template from the Recycle Bin.

Functions

Link to this function

rest_v10_projects_project_id_checklist_list_templates_create_from_company_template_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_list_templates_create_from_company_template_post_request, opts \\ [])

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

Create a Project Checklist Template from a Company Checklist Template Creates a Project Checklist Template from a Company Checklist Template. Sections and Items on the Company Template are copied to the Project Template and changes to these company level records, including the template itself, are synced down to the project level. You may not create more than 1 project template per company template.

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

Returns

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

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

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

List Project Checklist Templates Returns a list of all Inspection Checklist Templates for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[inspection_type_id]" ([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.
    • :"filters[trade_ids]" ([integer()]): Array of Trade IDs. Returns item(s) with the specified Trade IDs.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :sort (String.t): Sorts the list of Checklist Templates on the attribute given. By default the list is in ascending order. Use '-attribute' to sort in descending order. Ex. 'sort=-trade'.

Returns

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

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

@spec rest_v10_projects_project_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 Project Checklist Template Deletes an Inspection Checklist Template.

Parameters

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

Returns

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

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

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

Show Project Checklist Template Shows an Inspection Checklist Template.

Parameters

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

Returns

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

rest_v10_projects_project_id_checklist_list_templates_id_patch(connection, procore_company_id, id, project_id, checklist_template_body, opts \\ [])

@spec rest_v10_projects_project_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.RestV10ProjectsProjectIdChecklistListTemplatesPost201Response.t()}
  | {:error, Tesla.Env.t()}

Update Project Checklist Template Updates an Inspection Checklist Template.

Parameters

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

Returns

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

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

@spec rest_v10_projects_project_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.RestV10ProjectsProjectIdChecklistListTemplatesPost201Response.t()}
  | {:error, Tesla.Env.t()}

Remove Alternative Response Set from Project Checklist Template Removes a Project 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()): Checklist Template ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch_request, opts \\ [])

@spec rest_v10_projects_project_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.RestV10ProjectsProjectIdChecklistListTemplatesIdUseAlternativeResponseSetPatch200Response.t()}
  | {:error, Tesla.Env.t()}

Add Alternative Response Set to Project Checklist Template Sets a Project 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.
  • project_id (integer()): Unique identifier for the project.
  • id (integer()): Checklist Template ID
  • rest_v10_projects_project_id_checklist_list_templates_id_use_alternative_response_set_patch_request (RestV10ProjectsProjectIdChecklistListTemplatesIdUseAlternativeResponseSetPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_checklist_list_templates_post(connection, procore_company_id, project_id, checklist_template_body, opts \\ [])

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

Create Project Checklist Template Creates a Project Inspection Template for a specified Project.

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.
  • checklist_template_body (ChecklistTemplateBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

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

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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

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

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

Show Recycled Checklist Template Shows a Recycled Checklist Template

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()): Checklist Template ID
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

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

@spec rest_v10_projects_project_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 Recycled Checklist Template Restores the specified Checklist Template from the Recycle Bin.

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

Returns

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

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

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

List Project Checklist Templates Returns a list of all Inspection Checklist Templates for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Note: A User with read-only and above permissions to Inspections has access to this endpoint and the URL to individual templates on the web

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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[inspection_type_id]" ([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.
    • :"filters[trade_ids]" ([integer()]): Array of Trade IDs. Returns item(s) with the specified Trade IDs.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :sort (String.t): Sorts the list of Checklist Templates on the attribute given. By default the list is in ascending order. Use '-attribute' to sort in descending order. Ex. 'sort=-trade'.

Returns

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

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

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

Show Project Checklist Template Shows an Inspection Checklist Template. Note: A User with read-only and above permissions to Inspections has access to this endpoint and the URL to the template on the web

Parameters

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

Returns

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

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

@spec rest_v11_projects_project_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 Recycled Checklist Template Restores the specified Checklist Template from the Recycle Bin.

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

Returns

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