Skip to end of metadata
Go to start of metadata

BCF Service


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

    POST

    Import all the topics from a BCF file into Bimplus Topics. This api call creates new topics in Bimplus database, it does not do the update. If issue defined in the bcf file already exists in Bimplus, the call fails with 409 Conflict.

    The necessary attributes & assets such as author, responsible, attachments, comments, view etc are handled and matched according to the Bimplus Topic.

    Headers
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
    Content-Type: multipart/form-data
    Status
    Status: 201 Created
    
    JSON
    {
        "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": "testuser@bimplus.net",
                "firstname": "Test",
                "lastname": "User",
                "fullname": "Test User",
                ...
            },
            "changed": "2015-11-03T09:11:56",
            "changedBy": {
                "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
                "email": "testuser@bimplus.net"
            },
            "hash": "",
            "attachmentType" : "BcfZip",
            "sizeMB": "0,29",
            "id": "0ce3125a-3af2-46b5-b885-5c850df0c4cd"
        },
        "createdIssueId": [
            "bf609dae-06b2-42fa-a70b-d2b7ee446e8e",
            "e64160a9-a2f7-46e1-aa81-490b722c47b1",
            "c0977ff7-b336-4a4f-b8e9-fbf406759a0c",
            "19cb3e5a-79c0-4c32-a1fd-f8a0441a9dca"
        ]
    }

    Import BCF file - Update existing Bimplus issue structures
      Resource: issues/bcf

      URLhttps://api-dev.bimplus.net/v2/<team_slug>/projects/<project_id>/issues/bcf

      Examplehttps://api-dev.bimplus.net/v2/jay-company/projects/c6b53b29-8efd-4069-a033-4b1b18604de8/issues/bcf

       PUT
      Import all the topics from a BCF file into Bimplus Topics. Topics existing in Bimplus will be updated, those that don't will be created. The necessary attributes & assets such as author, responsible, attachments, comments, view etc are handled and matched according to the Bimplus Topic.
      Headers
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
      Content-Type: multipart/form-data
      
      Status
      Status: 200 OK
      
      Response
      {
          "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": "testuser@bimplus.net",
                  "firstname": "Test",
                  "lastname": "User",
                  "fullname": "Test User",
                  ...
              },
              "changed": "2015-11-03T09:11:56",
              "changedBy": {
                  "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
                  "email": "testuser@bimplus.net"
              },
              "hash": "",
              "attachmentType" : "BcfZip",
              "sizeMB": "0,29",
              "id": "0ce3125a-3af2-46b5-b885-5c850df0c4cd"
          },
          "createdIssueId": [
              "bf609dae-06b2-42fa-a70b-d2b7ee446e8e",
              "e64160a9-a2f7-46e1-aa81-490b722c47b1"
          ],
          "updatedIssueId" : [
              "c0977ff7-b336-4a4f-b8e9-fbf406759a0c",
              "19cb3e5a-79c0-4c32-a1fd-f8a0441a9dca"
          ]
      }
      

      Export all the topics inside a project into a BCF file
        Resource: export/bcf

        URLhttps://api-dev.bimplus.net/v2/jay-company/projects/<project_id>/issues/export/bcf

        Examplehttps://api-dev.bimplus.net/v2/jay-company/projects/a23123b0-1973-4f5d-92a3-f786b3183901/issues/export/bcf

         GET
         Export all the topics inside a project into a BCF file. The response contains an attachment_id using which the related BCF file can be downloaded.
        Headers
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
        Content-Type: application/json
        
        Status
        Status: 200 OK
        
        JSON
        {
            "attachment_id": "34462f62-7c86-46cd-87fd-f33cc1b1dfd4"
        }

        Export a single or a list of Topics inside a project into a BCF file
          Resource: export/bcf

          URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/export/bcf

          Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/export/bcf

           POST
          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.
          Headers
          Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
          Content-Type: application/json
          
          Request
          {
              "issuesId": [
                  "5eae7fe7-1cad-4039-8b64-551caea8107a"
              ],
              "bcfFileName": "BCF Export Test-Wall info wrong.bcfzip"
          }
          Status
          Status: 201 CREATED
          
          Response
          {
              "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.

          • No labels