Procore.Api.ProjectManagementProjectScheduleTasks (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementProjectScheduleTasks.

Summary

Functions

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

List tasks List existing tasks for the specified Project.

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

Delete task Delete the specified Task.

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

Show task Show detail on the specified Task.

rest_v10_tasks_id_patch(connection, procore_company_id, id, body14, opts \\ [])

Update task Update the specified Task.

rest_v10_tasks_post(connection, procore_company_id, body14, opts \\ [])

Create task Create a new Task associated with the specified Project.

rest_v10_tasks_sync_patch(connection, procore_company_id, project_id, rest_v10_tasks_sync_patch_request, opts \\ [])

Sync tasks This endpoint creates or updates a batch of tasks.

Functions

Link to this function

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

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

List tasks List existing tasks for the specified 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
    • :view (String.t): The compact view contains id, name, key, formatted_name, and task_name. The normal view contains the response shown below. The default view is normal.
    • :"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[row_number]" (integer()): Returns Tasks with a row_number matching the given value. This endpoint supports single values of row_number, a range of row_numbers (filters[row_number]=4...7) as well as multiple values (filters[row_number][]=5&filters[row_number][]=6). Exclude the filter to fetch all Tasks.
    • :"filters[query]" (String.t): Return item(s) containing search query

Returns

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

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

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

Delete task Delete the specified Task.

Parameters

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

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

Show task Show detail on the specified Task.

Parameters

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

Returns

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

rest_v10_tasks_id_patch(connection, procore_company_id, id, body14, opts \\ [])

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

Update task Update the specified Task.

Parameters

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

Returns

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

rest_v10_tasks_post(connection, procore_company_id, body14, opts \\ [])

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

Create task Create a new Task associated with the specified Project.

Parameters

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

Returns

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

rest_v10_tasks_sync_patch(connection, procore_company_id, project_id, rest_v10_tasks_sync_patch_request, opts \\ [])

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

Sync tasks This endpoint creates or updates a batch of tasks.

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_tasks_sync_patch_request (RestV10TasksSyncPatchRequest):
  • opts (keyword): Optional parameters

Returns

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