Procore.Api.QualitySafetyInspectionsChecklistSections (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsChecklistSections.

Summary

Functions

rest_v10_checklist_lists_list_id_sections_id_delete(connection, procore_company_id, list_id, id, project_id, opts \\ [])

Delete Checklist Section This is a deprecated endpoint.

rest_v10_checklist_lists_list_id_sections_id_get(connection, procore_company_id, list_id, id, project_id, opts \\ [])

Show Checklist Section Retrieves Checklist Section in a specified Checklist.

rest_v10_checklist_lists_list_id_sections_id_patch(connection, procore_company_id, list_id, id, checklist_section_body, opts \\ [])

Update Checklist Section This is a deprecated endpoint.

rest_v10_checklist_lists_list_id_sections_post(connection, procore_company_id, list_id, checklist_section_body, opts \\ [])

Create Checklist Section This is a deprecated endpoint.

rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_patch(connection, procore_company_id, list_id, section_id, rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request, opts \\ [])

Toggle Checklist Section Not Applicable status Toggles Checklist Section Not Applicable status in a specified Checklist and Checklist Section.

rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put(connection, procore_company_id, list_id, section_id, rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request, opts \\ [])

Toggle Checklist Section Not Applicable status Toggles Checklist Section Not Applicable status in a specified Checklist and Checklist Section.

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

List Checklist (Inspection) Sections Returns the Checklist Sections from Checklists (Inspections) on the Project

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

List Recycled Checklist (Inspection) Sections Returns the Recycled Checklist Sections from Checklists (Inspections) on the Project

Functions

Link to this function

rest_v10_checklist_lists_list_id_sections_id_delete(connection, procore_company_id, list_id, id, project_id, opts \\ [])

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

Delete Checklist Section This is a deprecated endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • id (integer()): Checklist Section 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_checklist_lists_list_id_sections_id_get(connection, procore_company_id, list_id, id, project_id, opts \\ [])

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

Show Checklist Section Retrieves Checklist Section in a specified Checklist.

Parameters

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

Returns

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

rest_v10_checklist_lists_list_id_sections_id_patch(connection, procore_company_id, list_id, id, checklist_section_body, opts \\ [])

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

Update Checklist Section This is a deprecated endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • id (integer()): Checklist Section ID
  • checklist_section_body (ChecklistSectionBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_sections_post(connection, procore_company_id, list_id, checklist_section_body, opts \\ [])

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

Create Checklist Section This is a deprecated endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • checklist_section_body (ChecklistSectionBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_patch(connection, procore_company_id, list_id, section_id, rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request, opts \\ [])

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

Toggle Checklist Section Not Applicable status Toggles Checklist Section Not Applicable status in a specified Checklist and Checklist Section.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • section_id (integer()): Checklist Section ID
  • rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request (RestV10ChecklistListsListIdSectionsSectionIdToggleNotApplicablePutRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put(connection, procore_company_id, list_id, section_id, rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request, opts \\ [])

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

Toggle Checklist Section Not Applicable status Toggles Checklist Section Not Applicable status in a specified Checklist and Checklist Section.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • section_id (integer()): Checklist Section ID
  • rest_v10_checklist_lists_list_id_sections_section_id_toggle_not_applicable_put_request (RestV10ChecklistListsListIdSectionsSectionIdToggleNotApplicablePutRequest):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Checklist (Inspection) Sections Returns the Checklist Sections from Checklists (Inspections) on the 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
    • :"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 - 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[list_id]" ([integer()]): Return section(s) with the specified Checklist List IDs
    • :sort (String.t): Sort item(s) by the chosen param; check below for a list of options. The direction of sorting is ascending by default; for descending sort, insert the - symbol before the param.

Returns

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

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

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

List Recycled Checklist (Inspection) Sections Returns the Recycled Checklist Sections from Checklists (Inspections) on the 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
    • :"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 - 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[list_id]" ([integer()]): Return section(s) with the specified Checklist List IDs
    • :sort (String.t): Sort item(s) by the chosen param; check below for a list of options. The direction of sorting is ascending by default; for descending sort, insert the - symbol before the param.

Returns

  • {:ok, [%ChecklistSection1{}, ...]} on success
  • {:error, Tesla.Env.t} on failure