BCF Service
- Import BCF file - Create new Bimplus issue structure
- Import BCF file - Update existing Bimplus issue structures
- Export all the topics inside a project into a BCF file
- Export a single or a list of Topics inside a project into a BCF file
- Use filters to determine what to export during the export of topics
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.
Import BCF file - Create new Bimplus issue structure
Import BCF file - Update existing Bimplus issue structures
URL: https://api-dev.bimplus.net/v2/<team_slug>/projects/<project_id>/issues/bcf
Example: https://api-dev.bimplus.net/v2/jay-company/projects/c6b53b29-8efd-4069-a033-4b1b18604de8/issues/bcf
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 200 OK
{
"createdIssues": [
{
"id": "1a7e7f92-8af9-4f06-8c96-6f048e925843"
},
{
"id": "f4e42068-333f-4528-baf8-634c463cbff4"
},
{
"id": "38adacfc-19b2-4660-a671-9f4cc413582a"
},
{
"id": "61711135-558e-4c24-bed1-5476d5b74f2d"
}
],
"bcfAttachment": {
"objectIds": [
"c6b53b29-8efd-4069-a033-4b1b18604de8"
],
"fileName": "BIM Validation - Architectural bcf_v1.bcfzip",
"type": "application/octet-stream",
"size": 305784,
"createdAt": "2015-11-03T09:11:56",
"creator": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null,
"firstname": null,
"lastname": null,
"company": null,
"fullname": "",
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"changed": "2015-11-03T09:11:56",
"changedBy": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null
},
"hash": "00000000-0000-0000-0000-000000000000",
"sizeMB": "0,29",
"id": "00000000-0000-0000-0000-000000000000"
},
"createdIssueId": [
"bf609dae-06b2-42fa-a70b-d2b7ee446e8e",
"e64160a9-a2f7-46e1-aa81-490b722c47b1",
"c0977ff7-b336-4a4f-b8e9-fbf406759a0c",
"19cb3e5a-79c0-4c32-a1fd-f8a0441a9dca"
]
}
Export all the topics inside a project into a BCF file
URL: https://api-dev.bimplus.net/v2/jay-company/projects/<project_id>/issues/export/bcf
Example: https://api-dev.bimplus.net/v2/jay-company/projects/a23123b0-1973-4f5d-92a3-f786b3183901/issues/export/bcf
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"attachment_id": "34462f62-7c86-46cd-87fd-f33cc1b1dfd4"
}
Export a single or a list of Topics inside a project into a BCF file
URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/export/bcf
Example: https://api-stage.bimplus.net/v2/bimplus/issues/export/bcf
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"issuesId": [
"5eae7fe7-1cad-4039-8b64-551caea8107a"
],
"bcfFileName": "BCF Export Test-Wall info wrong.bcfzip"
}
Status: 201 CREATED
{
"attachment_id": "1892ad0c-5301-4b82-928d-8265c214b1cd"
}
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.
