...
BCF Service
...
This service is used for importing a BCF file into Bimplus topics. The necessary attributes & assets such as author, responsible, attachments, comments, view etc are handled and matched according to the Bimplus Topic. The user can also export a single, list of topics or all the topics inside a project into a BCF file. While exporting, the user can decide if he would like to avoid exporting attachments, comments etc via appropriate filters.
...
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| Resource: export/bcf
URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/export/bcf Example: https://api-stage.bimplus.net/v2/bimplus/issues/export/bcf |
| Card |
|---|
| Export a single or a list of Topics inside a project into a BCF file. The issues to be exported are provided in the request. The response contains an attachment_id using which the related BCF file can be downloaded.
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Green |
|---|
| title | Request |
|---|
| lang | xml |
|---|
| {
"issuesId": [
"5eae7fe7-1cad-4039-8b64-551caea8107a"
],
"bcfFileName": "BCF Export Test-Wall info wrong.bcfzip"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 201 CREATED
|
| Code Block |
|---|
| borderColor | Green |
|---|
| title | Response |
|---|
| lang | xml |
|---|
| {
"attachment_id": "1892ad0c-5301-4b82-928d-8265c214b1cd"
} |
|
|
| Anchor |
|---|
| exportBCFFilter |
|---|
| exportBCFFilter |
|---|
|
Use filters to determine what to export during the export of topics
While exporting all or a list of topics into BCF, the API gives a filter option to export or not to export comments, attachments, pins & hyperlinks.
Filter: ?attachments=false&comments=true&hyperlinks=false&pins=true
eg: https://api-stage.bimplus.net/v2/bimplus/issues/export/bcf?attachments=false Here everything will be exported except attachments.