Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Export IFC Service

...

Export IFC Service

...

This service is used to export existing models inside a project to IFC files.


Anchor
createExportModelToIfc
createExportModelToIfc

Export model to IFC file
Deck of Cards
idbimCreateExportModelToIfc


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/model/<model_id>/exportasync

URLhttps://api-stage.bimplus.net/v2/ <team_slug>/projects/<project_id>/model/<model_id>/exportasync

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/model/4744b3a2-db5f-46d4-8da1-38d9cfe5aafa/exportasync

JSON Structure: no body is required

Optional query parameters: Used to refine the set of exported object from requested model

Name

Type

Default value

Description

revisionint 

When query parameter "revision=<Nr>" is defined, the API will export objects requested revision <Nr>, e.g.: to export second revision use "revision=2".
When revision is missing the most recent model revision will be exported.

fileDeleteint

When query parameter "fileDelete=1" is set, the temporary IFC file created by IFC export will not be deleted, otherwise temporary file is deleted.

emptyPropExportint
When query parameter "emptyPropExport=1" is set, the empty IFC element properties will be exported to ifc file.
When this parameter is missing or has different value empty IFC element properties will NOT be exported.
propSetExportint
When query parameter "propSetExport=1" is set, the custom project property set will be exported,
otherwise default project property set (IFC4 Advanced) will be exported.



Card
labelHTTP Method
 POST


Card
labelDescription
This API function creates new record to internal job list to asynchronously export required data to file in IFC format. Created record will be processed by export worker service automatically. Exported are always all elements from model.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 202 Accepted

When the same export request for the same user, model and project is already recored in queue, 
will be returned Status : 302 Redirect



Anchor
createExportSelectedElementsToIfc
createExportSelectedElementsToIfc

Export selected elements to IFC file
Deck of Cards
idbimCreateExportSelectedElementsToIfc


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: selections/<selection_id>/exportasync

URLhttps://api-stage.bimplus.net/v2/ <team_slug>/selections/<selection_id>/exportasync

Examplehttps://api-stage.bimplus.net/v2/bimplus/selections/F16623C4-BC16-4CBC-846C-B5959D445009/exportasync

JSON Structure: no body is required

Optional query parameters: Used to refine the set of exported object from requested model

Name

Type

Default value

Description

fileDeleteint

When query parameter "fileDelete=1" is set, the temporary IFC file created by IFC export will not be deleted, otherwise temporary file is deleted.

emptyPropExportint
When query parameter "emptyPropExport=1" is set, the empty IFC element properties will be exported to ifc file.
When this parameter is missing or has different value empty IFC element properties will NOT be exported.
propSetExportint
When query parameter "propSetExport=1" is set, the custom project property set will be exported,
otherwise default project property set (IFC4 Advanced) will be exported.



Card
labelHTTP Method
 POST


Card
labelDescription
This API function creates new record to internal job list to asynchronously export elements defined in selection to file in IFC format. Created record will be processed by export worker service automatically. Exported are always all elements defined in selection.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 202 Accepted

When the same export request for the same user, model and project is already recored in queue, 
will be returned Status : 302 Redirect