Procore.Api.ProjectManagementModelsBIMLevels (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementModelsBIMLevels.

Summary

Functions

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

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

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

Delete BIM Level Delete a BIM Level from the system. A BIM Level can only be deleted if it is not associated with published models.

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

Show BIM Level Return a single BIM Level item.

rest_v10_bim_levels_id_patch(connection, procore_company_id, id, body141, opts \\ [])

Update BIM Level Update a BIM Level item

rest_v10_bim_levels_post(connection, procore_company_id, body140, opts \\ [])

Create BIM Level Create a BIM Level in a Project

Functions

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

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

List BIM Levels Lists BIM Levels 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 'bim_file_id', 'location_id', and 'created_by_id' instead of embedded objects. 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[location_id]" ([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.
- :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, [%RestV10BimLevelsGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Delete BIM Level Delete a BIM Level from the system. A BIM Level can only be deleted if it is not associated with published models.

Parameters

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

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

Show BIM Level Return a single BIM Level item.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): BIM Level 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 'bim_file_id', 'location_id', and 'created_by_id' instead of embedded objects. The default view is normal.

Returns

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

rest_v10_bim_levels_id_patch(connection, procore_company_id, id, body141, opts \\ [])

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

Update BIM Level Update a BIM Level item

Parameters

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

Returns

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

rest_v10_bim_levels_post(connection, procore_company_id, body140, opts \\ [])

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

Create BIM Level Create a BIM Level in a Project

Parameters

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

Returns

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