Procore.Api.ProjectManagementModelsBIMFileExtractions (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementModelsBIMFileExtractions.

Summary

Functions

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

List BIM File Extractions Return a list of all BIM File Extractions A BIM File Extraction can fail for several reasons. When it does, the errors attribute contains a list of errors encountered while processing the model. The following table lists the possible error codes and types. #### Error Types | Code | Type | |------|------------------------| | 1 | Undefined | | 2 | NetworkErr | | 3 | ServerErr | | 4 | JsonParseErr | | 5 | TokenExpiredErr | | 6 | FileOpenErr | | 7 | FileWriteErr | | 8 | FileCompressionErr | | 9 | FileUploadError | | 10 | ModelReadErr | | 11 | ModelFileSizeErr | | 12 | ModelExportErr | | 13 | ModelEmptyDBErr | | 14 | ModelViewpointErr | | 15 | ModelErr | | 16 | InvalidStatusError | | 17 | FileDecompressionErr | | 18 | UnsupportedFileFormat | | 19 | No3DGeometry | | 20 | InvalidInputError | | 21 | UnsupportedFileSource | | 22 | MeshNodeLimitError | | 23 | RateLimitExhausted | | 24 | ODAGenericError | | 25 | FileUploadFasError |

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

Show BIM File Extraction Return a single BIM File Extraction

Functions

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

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

List BIM File Extractions Return a list of all BIM File Extractions A BIM File Extraction can fail for several reasons. When it does, the errors attribute contains a list of errors encountered while processing the model. The following table lists the possible error codes and types. #### Error Types | Code | Type | |------|------------------------| | 1 | Undefined | | 2 | NetworkErr | | 3 | ServerErr | | 4 | JsonParseErr | | 5 | TokenExpiredErr | | 6 | FileOpenErr | | 7 | FileWriteErr | | 8 | FileCompressionErr | | 9 | FileUploadError | | 10 | ModelReadErr | | 11 | ModelFileSizeErr | | 12 | ModelExportErr | | 13 | ModelEmptyDBErr | | 14 | ModelViewpointErr | | 15 | ModelErr | | 16 | InvalidStatusError | | 17 | FileDecompressionErr | | 18 | UnsupportedFileFormat | | 19 | No3DGeometry | | 20 | InvalidInputError | | 21 | UnsupportedFileSource | | 22 | MeshNodeLimitError | | 23 | RateLimitExhausted | | 24 | ODAGenericError | | 25 | FileUploadFasError |

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
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[status]" (String.t): Filter item(s) with matching status
- :"filters[extraction_format]" ([String.t]): Filter item(s) with matching extraction format
- :"filters[bim_file_id]" ([integer()]): Return item(s) with the specified bim_file_id in bim_file_upload
- :"filters[bim_file_upload_id]" ([integer()]): Return item(s) with the specified bim_file_upload_id
- :"filters[file_version_id]" ([integer()]): Return item(s) with the specified file_version_id in bim_file_upload
- :"filters[document_upload_id]" ([String.t]): Return item(s) with the specified document_upload_id in bim_file_upload
- :"filters[document_revision_id]" ([String.t]): Return item(s) with the specified document_revision_id in bim_file_upload

Returns

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

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

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

Show BIM File Extraction Return a single BIM File Extraction

Parameters

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

Returns

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