Procore.Api.CoreTasksTaskItems (procore_sdk v0.3.0)
API calls for all endpoints tagged CoreTasksTaskItems
.
Summary
Functions
List task items Returns a list of task items on a given project
Destroy task item Send a task item to the recycle bin.
Show task item Show detailed information for a specific task item
Update task item Update a task item's attributes
Create task item Creates a task item on a given project
Send unsent Task Items Sends email notifications for unsent Task Items.
Functions
rest_v10_task_items_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_task_items_get(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10TaskItemsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List task items Returns a list of task items on a given project
Parameters
connection
(Procore.Connection): Connection to serverprocore_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
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-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
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 serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Task Item IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_task_items_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_task_items_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10TaskItemsPost201Response.t()} | {:error, Tesla.Env.t()}
Show task item Show detailed information for a specific task item
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Task Item IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10TaskItemsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_task_items_id_patch(connection, procore_company_id, project_id, id, task_item, opts \\ [])
@spec rest_v10_task_items_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10TaskItemsPostRequestTaskItem.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10TaskItemsPost201Response.t()} | {:error, Tesla.Env.t()}
Update task item Update a task item's attributes
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Task Item IDtask_item
(Procore.Model.RestV10TaskItemsPostRequestTaskItem.t):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10TaskItemsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_task_items_post(connection, procore_company_id, project_id, rest_v10_task_items_post_request, opts \\ [])
@spec rest_v10_task_items_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10TaskItemsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10TaskItemsPost201Response.t()} | {:error, Tesla.Env.t()}
Create task item Creates a task item on a given project
Parameters
connection
(Procore.Connection): Connection to serverprocore_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
rest_v10_task_items_send_unsent_post(connection, procore_company_id, opts \\ [])
@spec rest_v10_task_items_send_unsent_post(Tesla.Env.client(), integer(), keyword()) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.TimecardEntry3ClockIn.t()]} | {:error, Tesla.Env.t()}
Send unsent Task Items Sends email notifications for unsent Task Items.
Parameters
connection
(Procore.Connection): Connection to serverprocore_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