Page History

...

Deck of Cards

id	bimGetObjectWithDiffProp

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/geometries/threejs/properties/{props}

where props is a binary sum of following possible values :
1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
2 : show also viewer attributesL
4 : include FACE_NORMAL
8 : with templates

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs/properties/{props}

Example: https://api-stage.bimplus.net/v2/bimplus/objects/a17ff78a-8b42-4523-9bf7-283e725e3e95/geometries/threejs/properties/7 (i.e 7 gives you a combination of objects as tree(1) + viewer attributes(2) + face normal(4))

Card

label	HTTP Method

GET

Card

label	Description

Get the different properties / structure (normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations.

url: /geometries/threejs/properties/{props}

where props is a binary sum of following possible values :
1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
2 : show also viewer attributesLattributes
4 : include FACE_NORMAL
8 : with templates

You can also combine different property numbers

eg: geometries/threejs/properties/5 should give both the show objects as tree(1) + add FACE_NORMAL in threeJs json(4)

geometries/threejs/properties/7 should give you a combination of objects as tree(1) + viewer attributes(2) + face normal(4)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "elementsCount": 1,
    "faceCount": 88,
    "viewbox": {
        "x": 21000,
        "y": 2850,
        "z": -19000,
        "width": 133,
        "height": 5700,
        "depth": 140
    },
    "colors": [
        4278190080
    ],
    "objects": [
        {
            "id": "a17ff78a-8b42-4523-9bf7-283e725e3e95",
            "type": "Column",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            0,
                            0,
                            4,
                            0,
                            3,
                            0,
                            7,
                            6,
                            5,
                            0,
                            8,
                            5,
                            6,
                            0,
                            9,
                            5,
                            8,
                            0,
                            10,
                            9,
                            8,
                            0,
                            13,
                            12,
                            11,
                            0,
                            16,
                            15,
                            14,
                            0,
                            17,
                            14,
                            15,
                            0,
                            18,
                            14,
                            17,
                            0,
                            19,
                            18,
                            17,
                            0,
                            7,
                            15,
                            6,
                            0,
                            16,
                            6,
                            15,
                            0,
                            7,
                            5,
                            15,
                            0,
                            17,
                            15,
                            5,
                            0,
                            17,
                            5,
                            19,
                            0,
                            9,
                            19,
                            5,
                            0,
                            2,
                            11,
                            1,
                            0,
                            2,
                            0,
                            11,
                            0,
                            13,
                            11,
                            0,
                            0,
                            13,
                            0,
                            12,
                            0,
                            4,
                            12,
                            0,
                            0,
                            4,
                            3,
                            12,
                            0,
                            20,
                            12,
                            3,
                            0,
                            18,
                            10,
                            14,
                            0,
                            8,
                            14,
                            10,
                            0,
                            8,
                            6,
                            14,
                            0,
                            16,
                            14,
                            6,
                            0,
                            0,
                            1,
                            21,
                            0,
                            21,
                            3,
                            0,
                            0,
                            1,
                            11,
                            22,
                            0,
                            22,
                            11,
                            12,
                            0,
                            12,
                            20,
                            23,
                            0,
                            3,
                            21,
                            23,
                            0,
                            23,
                            22,
                            12,
                            0,
                            23,
                            20,
                            3,
                            0,
                            26,
                            25,
                            24,
                            0,
                            24,
                            27,
                            26,
                            0,
                            25,
                            26,
                            28,
                            0,
                            31,
                            30,
                            29,
                            0,
                            32,
                            31,
                            29,
                            0,
                            35,
                            34,
                            33,
                            0,
                            32,
                            29,
                            36,
                            0,
                            38,
                            36,
                            37,
                            0,
                            36,
                            38,
                            32,
                            0,
                            39,
                            10,
                            18,
                            0,
                            24,
                            41,
                            40,
                            0,
                            42,
                            19,
                            9,
                            0,
                            43,
                            30,
                            37,
                            0,
                            36,
                            26,
                            27,
                            0,
                            37,
                            27,
                            43,
                            0,
                            27,
                            37,
                            36,
                            0,
                            26,
                            36,
                            29,
                            0,
                            30,
                            43,
                            28,
                            0,
                            29,
                            28,
                            26,
                            0,
                            28,
                            29,
                            30,
                            0,
                            24,
                            40,
                            43,
                            0,
                            43,
                            27,
                            24,
                            0,
                            33,
                            34,
                            39,
                            0,
                            39,
                            34,
                            44,
                            0,
                            45,
                            34,
                            35,
                            0,
                            38,
                            23,
                            21,
                            0,
                            21,
                            32,
                            38,
                            0,
                            21,
                            1,
                            31,
                            0,
                            31,
                            1,
                            22,
                            0,
                            31,
                            32,
                            21,
                            0,
                            45,
                            35,
                            25,
                            0,
                            24,
                            25,
                            35,
                            0,
                            41,
                            24,
                            35,
                            0,
                            33,
                            39,
                            18,
                            0,
                            42,
                            33,
                            18,
                            0,
                            18,
                            19,
                            42,
                            0,
                            45,
                            40,
                            44,
                            0,
                            44,
                            34,
                            45,
                            0,
                            44,
                            40,
                            41,
                            0,
                            35,
                            33,
                            42,
                            0,
                            41,
                            42,
                            44,
                            0,
                            42,
                            41,
                            35,
                            0,
                            38,
                            37,
                            22,
                            0,
                            31,
                            22,
                            37,
                            0,
                            22,
                            23,
                            38,
                            0,
                            37,
                            30,
                            31,
                            0,
                            44,
                            42,
                            9,
                            0,
                            39,
                            44,
                            9,
                            0,
                            9,
                            10,
                            39,
                            0,
                            45,
                            25,
                            28,
                            0,
                            40,
                            45,
                            28,
                            0,
                            28,
                            43,
                            40
                        ],
                        "vertices": [
                            21066.5,
                            0,
                            -18930,
                            21058,
                            0,
                            -18985.2,
                            21058,
                            0,
                            -18930,
                            21058,
                            0,
                            -19070,
                            21066.5,
                            0,
                            -19070,
                            20942,
                            0,
                            -18930,
                            20933.5,
                            0,
                            -19070,
                            20933.5,
                            0,
                            -18930,
                            20942,
                            0,
                            -19070,
                            20942,
                            0,
                            -18985.2,
                            20942,
                            0,
                            -19014.8,
                            21058,
                            5700,
                            -18930,
                            21066.5,
                            5700,
                            -19070,
                            21066.5,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19070,
                            20933.5,
                            5700,
                            -18930,
                            20933.5,
                            5700,
                            -19070,
                            20942,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19014.8,
                            20942,
                            5700,
                            -18985.2,
                            21058,
                            5700,
                            -19070,
                            21057.8,
                            0,
                            -19012.4,
                            21057.8,
                            5700,
                            -18987.6,
                            21057.8,
                            5700,
                            -19012.4,
                            20954,
                            5700,
                            -18997.2,
                            20954,
                            5700,
                            -19002.8,
                            21048.3,
                            5700,
                            -19003,
                            21048.3,
                            5700,
                            -18997,
                            21048.3,
                            0,
                            -19003,
                            21052.7,
                            0,
                            -19004.8,
                            21052.7,
                            0,
                            -18995.2,
                            21056,
                            0,
                            -18991.9,
                            21056,
                            0,
                            -19008.1,
                            20944,
                            5700,
                            -19008.1,
                            20945.5,
                            0,
                            -19006.3,
                            20947.3,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -18995.2,
                            21056,
                            5700,
                            -19008.1,
                            20942.9,
                            0,
                            -19010.2,
                            20951.7,
                            0,
                            -18997,
                            20949.4,
                            5700,
                            -18996.3,
                            20942.9,
                            5700,
                            -18989.8,
                            21048.3,
                            0,
                            -18997,
                            20945.5,
                            0,
                            -18993.7,
                            20949.4,
                            0,
                            -19003.7
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "general": {
                    "name": "B132",
                    "description": "Ifc Imported Element"
                },
                "element": {
                    "elementtyp": "Column",
                    "layer": "BuildingModel",
                    "model": "Structural model",
                    "material": "S 235"
                },
                "elementstate": {
                    "state": "Nothing Defined"
                },
                "allfreeattrib": {
                    "globalid": "26gojRHan8_9KtPcvJkUQf",
                    "skipparentlocations": "False",
                    "extrudeprofilename": "HEA140",
                    "extrudeprofiletype": "IShapeProfile",
                    "filletradius": "12",
                    "flangethickness": "8,5",
                    "overalldepth": "133",
                    "overallwidth": "140",
                    "webthickness": "5,5"
                }
            }
        }
    ]
}

...

Deck of Cards

id	bimObjectUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	object	Children of the object

Card

label	HTTP Method

PUT

Card

label	Description

Update or replace a specified existing object with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

xml

Code Block

borderColor

Red

lang

title	JSON

{
    "parent" : "02dc3da7925f9e2d-600a8877-494d406b-9b2b9806-e72b74143062afb4246ed2e2",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": truefalse,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
             "divisionid": "ac21b9a1e7859a8f-88534b7a-46584263-9fbf8420-0cf62340bd18405d565377aa"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplangeometry": {
            "allplan_guidmesh": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,{\"Color\":4278255360,\"Vertices\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"FFaces\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Code Block

...

title	JSON

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "33c741c1-f03e-4c47-b072-de8637f8f340",
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element": {
      "isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1

...

Create a new comment in the object

Deck of Cards

id	bimCreateCommentForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example: https://api-stage.bimplus.net/v2//objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

Card

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "emaildivisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
        "firstnamelogparentid": "Unknown",de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "lastnamegeneral": "User",
  {
      "companyname": "Brickwall",
        "fullnameisobjectvalid": "Unknown User",
true
         "displayname": "Unknown User"},
        "infoquantity": "",{
        "genderwidth": "",115
        "phoneWork": ""},
        "phoneHomegeometry": "",{
        "faxmesh": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

...

{\"Color\":4278255360,\"Vertices\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"Faces\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    }
  }
}

Anchor

	createCommentForObject
	createCommentForObject

Create a new comment in the object

Deck of Cards

id	bimCreateCommentForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example

...

Get all the comments of the object

Deck of Cards

id	bimGetAllCommentsOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card

label	HTTP Method

GET

Card

label	Description

Get all the comments of a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

...

Delete all the comments of the object

Deck of Cards

id	bimDeleteCommentOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/commentsExample: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the comments from the issue.

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

Card

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified object.

Card

label	Request

Code Block

lang
borderColor	Green

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OKCreated

...

Code Block

...

borderColor

...

Red
lang	xml
title	JSON

{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",

Create a new attachment in the object

Deck of Cards

id	bimObjCreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment

Card

label	HTTP Method

POST

Card

label	Description

Create a new attachment in a object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

    {
        "objectIdsfullname": ["Unknown User",
        "displayname":    "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ]"Unknown User",
        "fileNameinfo": "Building_Plan.jpg",
        "typegender": "image/jpeg",
        "sizephoneWork": 211258"",
        "createdAtphoneHome": "2013-12-11T10:47:39",
        "creatorfax": {"",
        "idmobile": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "emailbirthDate": "test@bimplus.net0000-00-00",
        "firstnameaddress": "First Name",{
        "lastname": "Second Name",
        "company"street": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname"streetNr": "Best-Company",
        "info": "",
        "genderzip": "",
        "phoneWork": "",
        "phoneHomecity": "",
        "fax": "",
        "mobilecountry": "",
        "birthDate": "0000-00-00"},
        "addresspreferedLanguage": {null
    },
          "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...

"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Anchor

	getCommentsOfObject
	getCommentsOfObject

Get all the comments of

...

the object

Deck of Cards

id	bimGetObjAttachmentbimGetAllCommentsOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments id>/comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachmentsid>/comments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cbcb96a9b1-e35748c9-43f64d97-aa3a8c9e-b45c26380f75262476c1c6b2/attachmentscomments

Card

label	HTTP Method

GET

Card

label	Description

Get all the attachments belonging to comments of a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
      {
            "objectIdsissueId": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258"cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "createdAtmodifiedAt": "2013-1207-11T10:47:3903T13:26:18+00:00",
            "creatorauthor": {
        "id": "e18941f400000000-a8090000-2d010000-d27d0000-cd251f2b6cb6000000000000",
        "email": "test@bimplus.net",
        "firstname": "First NameUnknown",
        "lastname": "Second NameUser",
        "company": "Best-Company",
        "fullname": "First Name Second NameUnknown User",
        "displayname": "Best-CompanyUnknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
   null
    },
            "id": "6cea110ad258c905-88f4c8af-43ac4463-9a00b0d8-ebaf677be333ac09dbcfc255"
      }
]

Anchor

	objDeleteAttachmentdeleteCommentsOfObjectobjDeleteAttachment
	deleteCommentsOfObject

Delete all the

...

comments of the object

Deck of Cards

id	bimDeleteObjAttachmentbimDeleteCommentOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/attachments comments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachmentscomments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cbcb96a9b1-e35748c9-43f64d97-aa3a8c9e-b45c26380f75262476c1c6b2/attachmentscomments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified objectcomments from the issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	objCreateHyperlinkobjCreateAttachmentobjCreateHyperlink
	objCreateAttachment

Create a new

...

attachment in the object

Deck of Cards

id	bimObjCreateHyperlinkbimObjCreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks id>attachments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/hyperlinksid>attachments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinksattachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

id (guid) hyperlink

Name	Mandatory / Optional	Type	Description
orderNumberobjectIds	will be ignored	integerstring	The ordering number of the hyperlinkid of the project objects to which the file has to be attached
fileName	will be ignored	name	mandatory	string	Name of the hyperlink
url	mandatory	string	The actual url
the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project
createdAt		will be ignored	string	Id	Creation date of the	attachment
creator	will be ignored	object	The user who created the attachment

Card

label	HTTP Method

POST

Card

label	Description

Create a new hyperlink for the attachment in a object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "My website",
    "url": https://www.bimplus.net/
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

    {
    "orderNumber": 1,
    "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "nametype": "My website",
"image/jpeg",
        "size": 211258,
        "urlcreatedAt": "https://www.bimplus.net/",
2013-12-11T10:47:39",
        "creator": {
        "id": "e72e6ddde18941f4-63f4a809-40a32d01-b820d27d-a32300e14c31cd251f2b6cb6"
}

...

Get the hyperlink list from the object

Deck of Cards

id	bimGetObjHyperlinks

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>hyperlinks

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinks

Card

label	HTTP Method

GET

Card

label	Description

Get all the hyperlinks belonging to a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {,
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "orderNumberlastname": 1"Second Name",
        "namecompany": "My websiteBest-Company",
        "urlfullname": "https://www.bimplus.net/First Name Second Name",
        "iddisplayname": "c46d1080-0450-4f03-aa4d-a32300e018e9"
    }Best-Company",
    {
        "orderNumberinfo": 2"",
        "namegender": "",
        "phoneWork": "My second website",
        "phoneHome": "",
        "urlfax": "https://www-stage.bimplus.net/",
        "mobile": "",
        "idbirthDate": "e72e6ddd0000-63f4-40a3-b820-a32300e14c31"00-00",
    }
]

...

Capture/create an object view(scene) for sharing it with another user

A view of an object can be created similar to the Slideshow & Topics by updating the object (i.e PUT objects/<object_id>) This is similar to creating slides & the template for creating slides is present here

...

Improve the get model geometries performance using chunks & templates

The performance of the Get Geometry call can be improved by using templates & chunks.

Templates

...

    "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Anchor

	objGetAttachment
	objGetAttachment

Get the attachment list from the object

Deck of Cards

id	bimGetObjAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api-

...

stage.bimplus.net/v2/

...

<team_slug>/objects/<object_id>attachments

Example: https://api-

...

stage.bimplus.net/v2/

...

bimplus/objects/

...

7cf910cb-

...

e357-

...

43f6-

...

aa3a-

...

b45c26380f75/attachments

Card

label	HTTP Method

GET

Card

label	Description

Get all the attachments belonging to a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

...

Code Block

{ "id": "1e9d3697-cde5-4d67-8998-267edd4fe968",

type

objectIds":

"Door",

[
            "

attributes": {

0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "

geometry

fileName":

{

"Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "

colorid

createdAt":

1

"2013-12-11T10:47:39",
        "creator": {

template

id": "

5ad3b016

e18941f4-

a9d8

a809-

4f8a

2d01-

9e12

d27d-

8919c411f076

cd251f2b6cb6",
        "email": "test@bimplus.net",

matrix

firstname":

[

 "First Name",
        "lastname": "Second Name",

1

"company": "Best-Company",
        "fullname": "First Name Second Name",

0

"displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",

0

"phoneHome": "",
        "fax": "",
        "mobile": "",

75957.48

"birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier

0,

str.",
            "streetNr": "10",
            "zip": "81829",

0

"city": "München",
            "country": "Germany"
        },

1,

  "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Anchor

	objDeleteAttachment
	objDeleteAttachment

Delete all the attachments from the object

Deck of Cards

id	bimDeleteObjAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/attachments

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	objCreateHyperlink
	objCreateHyperlink

Create a new hyperlink for the object

Deck of Cards

id	bimObjCreateHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/hyperlinks

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinks

JSON Structure:

Name	Mandatory / Optional	Type	Description
orderNumber	will be ignored	integer	The ordering number of the hyperlink
name	mandatory	string	Name of the hyperlink
url	mandatory	string	The actual url
id	will be ignored	string (guid)	Id of the hyperlink

Card

label	HTTP Method

POST

Card

label	Description

Create a new hyperlink for the object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "My website",
    "url": https://www.bimplus.net/
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
}

Anchor

	objGetHyperlinks
	objGetHyperlinks

Get the hyperlink list from the object

Deck of Cards

id	bimGetObjHyperlinks

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>hyperlinks

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinks

Card

label	HTTP Method

GET

Card

label	Description

Get all the hyperlinks belonging to a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "orderNumber": 1,
        "name": "My website",
        "url": "https://www.bimplus.net/",
        "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
    },
    {
        "orderNumber": 2,
        "name": "My second website",
        "url": "https://www-stage.bimplus.net/",
        "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
    }
]

Anchor

	createObjectScene
	createObjectScene

Capture/create an object view(scene) for sharing it with another user

A view of an object can be created similar to the Slideshow & Topics by updating the object (i.e PUT objects/<object_id>) This is similar to creating slides & the template for creating slides is present here

Anchor

	chunk&templates
	chunk&templates

Improve the get model geometries performance using chunks & templates

The performance of the Get Geometry call can be improved by using templates & chunks.

Templates

Templates are geometry references which are generated if more than one object has same geometry information. Templates are automatically generated on Bimplus import.
Templates can be got for the whole project or per layer/discipline
eg: https://api-dev.bimplus.net/v2/jay-company/objects/25f38274-7158-436d-9356-f5c917ee44c9/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/templates/threejs --> Get all the templates under a particular discipline in a project
eg: https://api-dev.bimplus.net/v2/jay-company/objects/5cd37c77-d341-4ab2-9f0d-44467955b218/templates/threejs --> Get all the templates under a project where object_id is the project_id
Templates are referenced in the Get Geometry call
eg: https://api-dev.bimplus.net/v2/jay-company/objects/daf760d2-9fc2-4b89-907b-20df7fb62aeb/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/geometries/threejs/properties/8

Code Block

 {
            "id": "1e9d3697-cde5-4d67-8998-267edd4fe968",
            "type": "Door",
            "attributes": {
                "geometry": {
                    "colorid": 1,
                    "template": "5ad3b016-a9d8-4f8a-9e12-8919c411f076",
                    "matrix": [
                        1,
                        0,
                        0,
                        75957.48,
                        0,
                        0,
                        1,
                        17100,
                        0,
                        -1,
                        0,
                        -64025,
                        0,
                        0,
                        0,
                        1
                    ]
                }
            }

Chunks

Objects/geometry information can be got in chunks if the geometry data is more which the client can't handle.
Chunks can be used for the normal geometry call or templates call
eg: https://api-dev.bimplus.net/v2/jay-company/objects/daf760d2-9fc2-4b89-907b-20df7fb62aeb/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/geometries/threejs/properties/8?chunk=1&chunkSize=medium
eg: https://api-dev.bimplus.net/v2/jay-company/objects/25f38274-7158-436d-9356-f5c917ee44c9/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/templates/threejs?chunk=1&chunkSize=medium
Chunk has 4 variants
off = 0,
low = 1000000 (1 MB)
middle = 5000000 (5 MB)
high = 20000000 (20 MB)
The user will receive the "X-Total-Count: X" in the header. It means the number of chunks(the number of iterations the user have to make)
Please remember that always the first call of chunk_size will take some time (as the “object to chunk conversion” takes place during the first call)

Anchor

	deleteObject
	deleteObject

Delete the object

Deck of Cards

id	bimObjDelete

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:

17100, 0,

{
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

{
  "parent": "925f9e2d-8877-406b-9806-afb4246ed2e2",
  "type": "Wall",
  "attributes": {
    "element": {

...

"isparent": false,
      "nr": 0,
      "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",

...

"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa"
    },
    "general": {

...

"name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {

...

"width": 115
    },
    "geometry": {

...

Objects/geometry information can be got in chunks if the geometry data is more which the client can't handle.
Chunks can be used for the normal geometry call or templates call
eg: https://api-dev.bimplus.net/v2/jay-company/objects/daf760d2-9fc2-4b89-907b-20df7fb62aeb/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/geometries/threejs/properties/8?chunk=1&chunkSize=medium
eg: https://api-dev.bimplus.net/v2/jay-company/objects/25f38274-7158-436d-9356-f5c917ee44c9/disciplines/30114b52-bc05-47c1-80b5-c7d5485d5840/templates/threejs?chunk=1&chunkSize=medium
Chunk has 4 variants
off = 0,
low = 1000000 (1 MB)
middle = 5000000 (5 MB)
high = 20000000 (20 MB)
The user will receive the "X-Total-Count: X" in the header. It means the number of chunks(the number of iterations the user have to make)
Please remember that always the first call of chunk_size will take some time (as the “object to chunk conversion” takes place during the first call)

...

Delete the object

Deck of Cards

id	bimObjDelete

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

"mesh": "{\"Color\":4278255360,\"Vertices\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"Faces\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
    }
  }
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 17

New Version 18

Key

Create a new comment in the object

Create a new comment in the object

Get all the comments of the object

Delete all the comments of the object

Create a new attachment in the object

Get all the comments of

the object

Delete all the

comments of the object

Create a new

attachment in the object

Get the hyperlink list from the object

Capture/create an object view(scene) for sharing it with another user

Improve the get model geometries performance using chunks & templates

Get the attachment list from the object

Delete all the attachments from the object

Create a new hyperlink for the object

Get the hyperlink list from the object

Capture/create an object view(scene) for sharing it with another user

Improve the get model geometries performance using chunks & templates

Delete the object

Delete the object