Versions Compared

Old Version 21

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 22

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

Deck of Cards
idimportBCF_POST
Card
labelURL / Resource / JSON Structure

Resource: issues/bcf

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

Card
labelHTTP Method

POST

Card
labelDescription

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.

Card
labelRequest
Code Block
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
titleJSON
{
    "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"testuser@bimplus.net",
            "firstname": null"Test",
            "lastname": null"User",
            "companyfullname": "Test nullUser",
            ...
   "fullname": "",
    },
        "displaynamechanged": null"2015-11-03T09:11:56",
            "info": null,"changedBy": {
            "genderid": null"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "phoneWorkemail": null,"testuser@bimplus.net"
        },
        "phoneHomehash": null"",
        "attachmentType"   : "faxBcfZip": null,
           "sizeMB": "mobile": null0,29",
            "birthDateid": null,"0ce3125a-3af2-46b5-b885-5c850df0c4cd"
     },
       "addresscreatedIssueId": {[
        "bf609dae-06b2-42fa-a70b-d2b7ee446e8e",
        "street": ""e64160a9-a2f7-46e1-aa81-490b722c47b1",
                "streetNr": ""c0977ff7-b336-4a4f-b8e9-fbf406759a0c",
                "zip": "","19cb3e5a-79c0-4c32-a1fd-f8a0441a9dca"
                "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"
    ]
}

...

]
}

Anchor
importBCF_PUT
importBCF_PUT

Import BCF file - Update existing Bimplus issue structures
Deck of Cards
idbimImportBCF_PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/bcf

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

Card
labelHTTP Method
 PUT
Card
labelDescription
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.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorGreen
langxml
titleResponse
{
    "createdIssues": [

...

Import BCF file - Update existing Bimplus issue structures
Deck of Cards
idbimImportBCF_PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/bcf

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

Card
labelHTTP Method
 PUT
Card
labelDescription
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.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorGreen
langxml
titleResponse
{
    "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": "71e0ac3b1a7e7f92-fa498af9-e5404f06-ac2f8c96-8caff3dd72ed6f048e925843",
            "email": null,
            "firstname": null,
    },
        "lastname": null,{
            "companyid": null,
"f4e42068-333f-4528-baf8-634c463cbff4"
        },
       "fullname": "", {
            "displaynameid": null,
"38adacfc-19b2-4660-a671-9f4cc413582a"
        },
       "info": null, {
            "genderid": null,"61711135-558e-4c24-bed1-5476d5b74f2d"
        }
    "phoneWork": null],
    "bcfAttachment": {
        "phoneHomeobjectIds": null,[
            "fax": null,
c6b53b29-8efd-4069-a033-4b1b18604de8"
         ],
        "mobilefileName": null,
"BIM Validation - Architectural bcf_v1.bcfzip",
        "birthDatetype": null"application/octet-stream",
            "addresssize": {305784,
         "createdAt": "2015-11-03T09:11:56",
        "streetcreator": "",{
                "streetNrid": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
                "zipemail": "testuser@bimplus.net",
                "cityfirstname": "Test",
                "countrylastname": "User",
            "fullname": "Test }User",
            "preferedLanguage": null ...
        },
        "changed": "2015-11-03T09:11:56",
        "changedBy": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": null"testuser@bimplus.net"
        },
        "hash": "",
        "attachmentType" : "00000000-0000-0000-0000-000000000000BcfZip",
        "sizeMB": "0,29",
        "id": "000000000ce3125a-00003af2-000046b5-0000b885-0000000000005c850df0c4cd"
    },
    "createdIssueId": [
        "bf609dae-06b2-42fa-a70b-d2b7ee446e8e",
        "e64160a9-a2f7-46e1-aa81-490b722c47b1"
    ],
        "c0977ff7-b336-4a4f-b8e9-fbf406759a0c",
        "19cb3e5a-79c0-4c32-a1fd-f8a0441a9dca"
    ]
}

...