Procore.Api.ProjectManagementModelsBIMModels (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementModelsBIMModels.

Summary

Functions

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

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

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

Delete BIM Model Delete a BIM Model from the system. A BIM Model with revisions cannot be deleted.

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

Show BIM Model Return a single BIM Model item.

rest_v10_bim_models_id_patch(connection, procore_company_id, id, body133, opts \\ [])

Update BIM Model Update a BIM Model item

rest_v10_bim_models_post(connection, procore_company_id, body132, opts \\ [])

Create BIM Model Create a BIM Model in a Project

Functions

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

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

List BIM Models Lists BIM Models 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 contains 'current_revision_id' instead of an embedded object 'current_revision' The default view is normal.
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[bim_file_id]" (integer()): Filter item(s) with matching BIM File ids
- :"filters[has_revisions]" (boolean()): Filter item(s) with or without revisions.
- :"filters[search]" (String.t): Filter item(s) with the matching search query. The search is performed on title.
- :sort (String.t): Sort item(s) by an attribute. The default sort is ascending. To sort in descending order, prepend the sort value with a hyphen character '-'

Returns

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

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

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

Delete BIM Model Delete a BIM Model from the system. A BIM Model with revisions cannot be deleted.

Parameters

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

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

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

Show BIM Model Return a single BIM Model item.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): BIM Model 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 contains 'current_revision_id' instead of an embedded object 'current_revision' The default view is normal.

Returns

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

rest_v10_bim_models_id_patch(connection, procore_company_id, id, body133, opts \\ [])

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

Update BIM Model Update a BIM Model item

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): BIM Model ID
body133 (Body133):
opts (keyword): Optional parameters

Returns

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

rest_v10_bim_models_post(connection, procore_company_id, body132, opts \\ [])

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

Create BIM Model Create a BIM Model in a Project

Parameters

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

Returns

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