Procore.Api.CoreProjectProjectTools (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectProjectTools.

Summary

Functions

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

List project tools Returns all Tools available to the provided Project.

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

Update project tools Updates the order and active status of Project Tools.

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

List project tools Returns all Tools available to the provided Project.

Functions

Link to this function

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

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

List project tools Returns all Tools available to the provided 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
    • :"filters[is_active]" (boolean()): Retrieve active or inactive tools.
    • :for_mobile (boolean()): Filters tools that Procore's iOS and Android apps support.
    • :include_configurable_generic_tools (boolean()): Includes configurable custom tools in the for_mobile view.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

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

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

Update project tools Updates the order and active status of Project Tools.

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
    • :body (RestV10ProjectsProjectIdToolsPatchRequest):

Returns

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

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

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

List project tools Returns all Tools available to the provided 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

Returns

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