Procore.Api.CoreTasksTaskItemComments (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreTasksTaskItemComments.

Summary

Functions

rest_v10_companies_company_id_projects_project_id_task_item_comments_get(connection, procore_company_id, company_id, project_id, opts \\ [])

List Task Item Comments Returns a list of comments associated with the project. Can be filtered by task_item_id and/or created_by_id.

rest_v10_companies_company_id_projects_project_id_task_item_comments_id_delete(connection, procore_company_id, company_id, project_id, id, opts \\ [])

Delete a task item comment Deletes the task item comment with ID supplied in path. Returns an empty body if successful.

rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch(connection, procore_company_id, company_id, project_id, id, rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch_request, opts \\ [])

Update a task item comment Updates the task item comment with ID supplied in path. Returns the updated comment.

rest_v10_companies_company_id_projects_project_id_task_item_comments_post(connection, procore_company_id, company_id, project_id, rest_v10_companies_company_id_projects_project_id_task_item_comments_post_request, opts \\ [])

Create a task item comment Create a new task item comment for a given task_item_id and created_by_id

Functions

Link to this function

rest_v10_companies_company_id_projects_project_id_task_item_comments_get(connection, procore_company_id, company_id, project_id, opts \\ [])

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

List Task Item Comments Returns a list of comments associated with the project. Can be filtered by task_item_id and/or created_by_id.

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.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :"filters[task_item_id]" (integer()): Filter by task_item_id to return comments for only that task_item
    • :"filters[created_by_id]" ([integer()]): Returns item(s) created by the specified User IDs.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_companies_company_id_projects_project_id_task_item_comments_id_delete(connection, procore_company_id, company_id, project_id, id, opts \\ [])

@spec rest_v10_companies_company_id_projects_project_id_task_item_comments_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPost403Response.t()}
  | {:error, Tesla.Env.t()}

Delete a task item comment Deletes the task item comment with ID supplied in path. Returns an empty body if successful.

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

Returns

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

rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch(connection, procore_company_id, company_id, project_id, id, rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch_request, opts \\ [])

@spec rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPost403Response.t()}
  | {:error, Tesla.Env.t()}

Update a task item comment Updates the task item comment with ID supplied in path. Returns the updated comment.

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.
  • project_id (integer()): Unique identifier for the project.
  • id (integer()): Task Item Comment ID
  • rest_v10_companies_company_id_projects_project_id_task_item_comments_id_patch_request (RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_projects_project_id_task_item_comments_post(connection, procore_company_id, company_id, project_id, rest_v10_companies_company_id_projects_project_id_task_item_comments_post_request, opts \\ [])

@spec rest_v10_companies_company_id_projects_project_id_task_item_comments_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPost403Response.t()}
  | {:error, Tesla.Env.t()}

Create a task item comment Create a new task item comment for a given task_item_id and created_by_id

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.
  • project_id (integer()): Unique identifier for the project.
  • rest_v10_companies_company_id_projects_project_id_task_item_comments_post_request (RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsGet200ResponseInner.t} on success
  • {:error, Tesla.Env.t} on failure