Procore.Api.QualitySafetyInspectionsChecklistComments (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsChecklistComments.

Summary

Functions

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

Show Checklist Comment Retrieves Checklist Comment in a specified Checklist.

rest_v10_checklist_lists_list_id_comments_post(connection, procore_company_id, list_id, checklist_comment_body, opts \\ [])

Create Checklist Comment Creates Checklist Comment in a specified Checklist

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

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

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

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

Functions

Link to this function

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

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

Show Checklist Comment Retrieves Checklist Comment 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()): Comment ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_comments_post(connection, procore_company_id, list_id, checklist_comment_body, opts \\ [])

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

Create Checklist Comment Creates Checklist Comment 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
  • checklist_comment_body (ChecklistCommentBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Checklist (Inspection) Comments Returns the Checklist Comments 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[item_id]" ([integer()]): Array of Checklist Item IDs. Return item(s) associated with the specified Checklist Item 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
    • :sort (String.t):

Returns

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

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

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

List Recycled Checklist (Inspection) Comments Returns the Checklist Comments from recycled 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[item_id]" ([integer()]): Array of Checklist Item IDs. Return item(s) associated with the specified Checklist Item 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
    • :sort (String.t):

Returns

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