Procore.Api.ProjectManagementModelsBIMPlans (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementModelsBIMPlans.

Summary

Functions

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

List BIM Plans Lists BIM Plans associated with the specified Project.

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

Delete BIM Plan Delete a BIM Plan from the system.

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

Show BIM Plan Return a single BIM Plan item.

rest_v10_bim_plans_id_patch(connection, procore_company_id, id, body130, opts \\ [])

Update BIM Plan Update a single BIM Plan item.

rest_v10_bim_plans_post(connection, procore_company_id, body129, opts \\ [])

Create BIM Plan Create a BIM Plan in a Project

Functions

Link to this function

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

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

List BIM Plans Lists BIM Plans 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.
  • 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 only ids. The extended view contains the response shown below. The normal view does not contain the attributes 'image', 'sheet_map_start', 'sheet_map_end', 'model_map_start' and 'model_map_end'. The default view is normal.
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[bim_level_id]" (integer()): Filter item(s) with matching BIM Level ids

Returns

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

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

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

Delete BIM Plan Delete a BIM Plan from the system.

Parameters

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

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

Show BIM Plan Return a single BIM Plan item.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): BIM Plan ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :view (String.t): The compact view contains only ids. The extended view contains the response shown below. The normal view does not contain the attributes 'image', 'sheet_map_start', 'sheet_map_end', 'model_map_start' and 'model_map_end'. The default view is normal.

Returns

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

rest_v10_bim_plans_id_patch(connection, procore_company_id, id, body130, opts \\ [])

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

Update BIM Plan Update a single BIM Plan item.

Parameters

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

Returns

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

rest_v10_bim_plans_post(connection, procore_company_id, body129, opts \\ [])

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

Create BIM Plan Create a BIM Plan in a Project

Parameters

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

Returns

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