Procore.Api.CoreTasksTaskItems (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreTasksTaskItems.

Summary

Functions

Link to this function

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

List task items Returns a list of task items on 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
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :"filters[assigned_id]" (String.t): Assigned ID
    • :"filters[created_at]" (Date.t): Return item(s) created 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[created_by_id]"([integer()]): Returns item(s) created by the specified User IDs. -:"filters[due_date]"(String.t): Returns item(s) due within the specified ISO 8601 datetime range. -:"filters[status]"([String.t]): Returns item(s) matching the specified status value. -:"filters[task_item_category_id]"(String.t): Returns item(s) matching the specified Task Item Category ID. -:"filters[id]"([integer()]): Return item(s) with the specified IDs. -:sort(String.t): Return item(s) with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

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

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

Destroy task item Send a task item to 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()): Task Item ID
  • opts (keyword): Optional parameters

Returns

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

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

Show task item Show detailed information for a specific task item

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

Returns

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

rest_v10_task_items_id_patch(connection, procore_company_id, project_id, id, task_item, opts \\ [])

Update task item Update a task item's attributes

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()): Task Item ID
  • task_item (Procore.Model.RestV10TaskItemsPostRequestTaskItem.t):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_task_items_post(connection, procore_company_id, project_id, rest_v10_task_items_post_request, opts \\ [])

Create task item Creates a task item on 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.
  • rest_v10_task_items_post_request (RestV10TaskItemsPostRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_task_items_send_unsent_post(connection, procore_company_id, opts \\ [])

Send unsent Task Items Sends email notifications for unsent Task Items.

Parameters

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

Returns

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