Procore.Api.ProjectManagementModelsBIMFiles (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementModelsBIMFiles.

Summary

Functions

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

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

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

Delete BIM File Delete a BIM File from the system. A BIM File can only be deleted if it is not associated with BIM Levels, Revisions, or Viewpoints or Coordination Issues.

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

Show BIM File Return a single BIM File item

rest_v10_bim_files_id_patch(connection, procore_company_id, id, body145, opts \\ [])

Update BIM File Updates a BIM File

rest_v10_bim_files_post(connection, procore_company_id, body144, opts \\ [])

Create BIM File Create a BIM File in a Project

Functions

Link to this function

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

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

List BIM Files Lists BIM Files 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
    • :view (String.t): The compact view contains only ids. The normal and extended view contains the response shown below. The default view is normal.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.

Returns

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

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

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

Delete BIM File Delete a BIM File from the system. A BIM File can only be deleted if it is not associated with BIM Levels, Revisions, or Viewpoints or Coordination Issues.

Parameters

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

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

Show BIM File Return a single BIM File item

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (String.t): BIM File ID.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :view (String.t): The compact view contains only ids. The normal and extended view contains the response shown below. The default view is normal.

Returns

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

rest_v10_bim_files_id_patch(connection, procore_company_id, id, body145, opts \\ [])

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

Update BIM File Updates a BIM File

Parameters

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

Returns

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

rest_v10_bim_files_post(connection, procore_company_id, body144, opts \\ [])

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

Create BIM File Create a BIM File in a Project

Parameters

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

Returns

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