Page History

geometry

Object Service

...

Object Service

...

Objects are the primary component of the project tree and it exists in two forms.

...

Deck of Cards

id	bimCreateObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optionalmandatory	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

POST

Card

label	Description

Creates a new object

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

title	JSON

{
  "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": {
      "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]}"
    }
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

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",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
      "logparentid": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "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]}"
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    }
  }
}

Anchor

	getFullObjectPropMesh
	getFullObjectPropMesh

...

Deck of Cards

id	bimGetFullObjectPropMesh

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

Optional query paramatersparameters

Name

Type

Default value

Description

revision

int

null ( current )

If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).

internal

boolean

false

false = return attributes in viewer format ( as seen in the portal ); true = return in different, internal server representation format.

children

boolean

false

false = return only properties of the object itself; true = return properties of the object and all its children

freeattributes

boolean

false

false = for each attribute return only name and value; true = return full definition for each object's attribute

disciplineId

Guid

null

Specifies the discipline ( layer ).

type

string

null

filter for requested element type. f.ex. if you use 'type=Wall', you will get a list of Walls, who are childs of the requested object_Id
this means, when you use

Code Block
{host}/v2/{slug}/objects/{objectId}?type=Column

you will get all Columns, who exist in the project

documentversion

int

0 (current)

If document version is specified and when document version is supported by object, e.g. actually only attachment can have document version,
then the call will get the result from the requested document version, otherwise return current object ( latest revision ).

To get free attributes of attachment for exact document version can be used freeattributes and documentversion

Code Block
{host}/v2/{slug}/objects/{objectId}?freeattributes=true&documentversion=1

In this case you will get free attributes of object for requested document version.

projectid

Guid

null

Specifies the project id.
Note:
This query parameter is mandatory in case when resource identification (object_id) represent the user.
If resource id represent user id and this query parameter is missing teh response will be not found.
Together with query parameter 'freeattributes' is possible to get detail info about user.

Code Block
{host}/v2/{slug}/objects/{objectId}?freeattributes=true&projectid={projectid}

The same query parameters must be used also in "PUT" version of this request.

shortinfo

boolean

false

true = return results without attributes and without localizedAttributeGroups ( query can be set on true just when object_id is ID of selection objects ).

Card

label	HTTP Method

GET

Card

label	Description

Gets the properties ( attributes ) of an object.

By using and combining the optional query parameters, the caller can shape the response to requested format ( see response for more description ).

If parameter is not used, its default value is used.

Note:

Following object-related api calls are now obsolete ( they are still supported, but will be removed eventually ), and should be replaced by using get object call with query parameters :

Obsolete call	Should be replaced by
GET /<teamslug>/objects/<object_id>/tree	GET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/internal	GET /<teamslug>/objects/<object_id>?internal=true
GET /<teamslug>/objects/<object_id>/properties/3	GET /<teamslug>/objects/<object_id>?children=true
GET /<teamslug>/objects/<object_id>/properties/8	GET /<teamslug>/objects/<object_id>?freeattributes=true

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response
lang	xml

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	In general, the response json has following format :

{
  "elementtyp": "<type_id>",
  "id": "<object_id>",
  "parent" : "<parent_id>",
  "type": "<type_name>",
  "layerid": "<discipline_id>",
  "attributes": {
    "<attribute_group_1": {
      "<property_name_1>": "<property_value>",
      "<property_name_2>": "<property_value>",
      "<property_name_3>": "<property_value>"
      ...
    },
    "<attribute_group_2": {
      "<property_name_1>": "<property_value>",
      "<property_name_2>": "<property_value>"
      ...
    },
    ....
  },
  "children" : []
}

if query parameter "children" is used, the property "children" will contain array of child objects in the same format as is the object itself.

Code Block

title	If query parameter "freeattributes" is used, the "property_value" contains full attribute definition in following format:

{
  "id": "<attribute_id>",
  "name": "<attribute_name>",
  "group": "<attribute_group>",
  "type": "<attribute_value_type>",
  "isInternal": <true or false>,
  "value": "<attribute_value>"
}

Examples:

Code Block

title	GET /<teamslug>/objects/<objectid>

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element (default property set)": {
      "type": "Wall",
      "model": "Model A",
      "layer": "BuildingModel"
    },
    "general (default property set)": {
      "name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
      "description": "Ifc Imported Element",
      "ifcglobaluniqueid": "2H$2pBsuL7TgKZ59zSDw0D",
      "ifcelementtype": "IfcWallStandardCase"
    },
    "content": {
      "tag": "4820766",
      "objecttype": "Basic Wall:300_21_isolatie_208.5_spouwklein:4296143",
      "skipparentlocations": "False",
      "extrudeprofiletype": "RectangleProfile",
      "polyeder area": "25,851 m²",
      "polyeder volume": "2,036 m³",
      "xdim": 5160.00000000001,
      "ydim": 208.5
    }
  },
  ...
}

Code Block

title	GET /<teamslug>/objects/<object_id>?freeattributes=true

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element (default property set)": {
      "type": {
        "id": "a0e8ae2c-c869-4ec3-9019-25d3704be707",
        "name": "Type",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "Wall"
      },
      "model": {
        "id": "cd320d7b-7299-4abc-8409-c86e46fa45f9",
        "name": "Model",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "Model A"
      },
      "layer": {
        "id": "4812c68a-3f8d-40c1-b3f8-551a4102a406",
        "name": "Layer",
        "group": "Element (default Property set)",
        "subGroup": "Element",
        "type": "Guid",
        "value": "BuildingModel"
      }
    }
    ...
  }
}

Code Block

title	GET <teamslug>/objects/<object_id>?internal=true

{
  "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
  "id": "94f0289c-41b3-450f-9c04-0527ef9a1138",
  "parent": "8015e60e-f9c6-4544-a3e8-feadbfd154ba",
  "type": "Wall",
  "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6",
  "attributes": {
    "element": {
      "isparent": true,
      "nr": 4,
      "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
      "logparentid": "b1570b15-2786-4c22-baf0-94e07de69990",
      "divisionid": "1b6fa8ae-568a-4bc0-81b7-c6d282834a0c",
      "materialstring": "ISR_Isolatie",
      "matrix": {
        "values": [
          1,
          0,
          0,
          120,
          0,
          1,
          0,
          -228.5,
          0,
          0,
          1,
          -70,
          0,
          0,
          0,
          1
        ]
      },
      "articleid": "0583a9a7-3756-48b9-b836-63541bdf130e",
      "materialsurfaceid": "058578b6-6a32-48f5-ae4a-59dc452de287",
      "layerid": "0f106af0-a919-44c5-b211-15bd5ef620b6"
    },
    "general": {
      "name": "Basic Wall:300_21_isolatie_208.5_spouwklein:4820766",
      "description": "Ifc Imported Element",
      "isobjectvalid": true
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    },
    "objectlog": {
      "createdby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
      "created": "2016-01-28T10:51:04.843",
      "modifiedby": "e4d7ac3c-94f3-4507-9b8b-a1505225845c",
      "modified": "2016-01-28T10:51:04.843",
      "revision": 0
    },
    ...
  }
}

Anchor

	generateScene
	generateScene

...

Deck of Cards

id	bimGetBlobTree

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/geometries/meshblob

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

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

Optional query parameters

Name	Type	Default value	Description
elementTypeId	guid	null ( current )	filter for requested element type. Get objects just with specified element type id.

Card

label	HTTP Method

GET

Card

label	Description

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".

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,
    "objects": [
        {
            "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
            "parent": "00000000-0000-0000-0000-000000000000",
            "type": "Wall",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}

...

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 attributes
4 : include FACE_NORMAL
8 : with templates
16: mixed geometry

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 attributes
4 : include FACE_NORMAL
8 : with templates
16: mixed geometry

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"
                }
            }
        }
    ]
}

Anchor

	updateObjectgetGltf	updateObject

...

	getGltf

Get Geometry as binary Gltf

Deck of Cards

id	bimObjectUpdatebimGetGlb

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/objects/<object_

id>

id>/geometries/glb?chunk=1&topology=true

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/glb?chunk=1&topology=true

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cbdc701cd2-e3577490-43f644dc-aa3a-b45c26380f75JSON Structure:8b7e-bd697e1f72d5/geometries/glb?chunk=1&topology=true

Optional query parameters

Name	Mandatory / Optional	Type	Default valueType
parentchunkoptional	int	string null ( guiddiasabled)	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
If chunks are switched on, the geometry is divided into ~5MB blocks. The number of chunks is returned in the header using 'X-Total-Count'.
topology	boolean	false	If topology is enabled, the scene object contains additional topology nodes
levelOfDetail	int	1	switch geometry precision to 100 to reduce face count

Extension:

you can add an additional filter for disciplines (layer) by using
Url: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/glb

Card

label	HTTP Method

PUT GET

Card

label	Description

Update or replace a specified existing object with a new one

This API function returns geometry data based on root object <object_id> as binary gltf.

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	JSON	Status

Status: 200 OK



the response is no json!
it's a binary with mimetype "model/gltf-binary"
it can be saved as 'glb' file.

Anchor

	getComplexProperties
	getComplexProperties

Get the complex properties of the object

Deck of Cards

id	bimGetComplexProperties

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/objects/<object_id>/complexproperties?revision=<revisionNr>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/complexproperties?revision=<revisionNr>

Example: https://api-stage.bimplus.net/v2/bimplus/objects/dc701cd2-7490-44dc-8b7e-bd697e1f72d5/complexproperties?revision=2

Optional query parameters

Name	Type	Default value	Description
revision	int	null ( current )	If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).

Card

label	HTTP Method

GET

Card

label	Description

This API function returns structure of all complex properties for required 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

{
  "children":[{
  "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": {
      "namechildren":[{
          "Brickwallchildren":[],
          "isobjectvalidparent": true
"23240392-024d-4c05-bfc8-4d6eff6f7045",
      },
    "quantityname": {
"Object Layer Attributes #1",
          "widthtype":null,
  115
    },
    "geometrynumber": {2,
          "id":"dbf87493-6dad-4ee5-acba-115437accc68"
        },
        {
          "children":[],
          "parent":"23240392-024d-4c05-bfc8-4d6eff6f7045",
          "name":"Object Layer Attributes #0",
          "type":null,
          "number":2,
          "id":"d17b5c98-f0cf-4acb-9314-af3cb686fe3d"
        }
      ],
      "parent":"dc701cd2-7490-44dc-8b7e-bd697e1f72d5",
      "name":"Allplan Attributes",
      "type":null,
      "number":1,
      "id":"23240392-024d-4c05-bfc8-4d6eff6f7045"
    }
  ],
  "parent":"00000000-0000-0000-0000-000000000000",
  "name":null,
  "type":"Wall",
  "number":0,
  "id":"dc701cd2-7490-44dc-8b7e-bd697e1f72d5"
}

Anchor

	updateObject
	updateObject

Update the object

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

Code Block

title	JSON

{
  "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": {
      "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"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]}"
    }
  }
}

Card

label	Response

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",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
      "logparentid": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
      "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]}"
    },
    "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: 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",
        "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"
}

Anchor

	getCommentsOfObject
	getCommentsOfObject

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

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",
      "divisionid": "e7859a8f-4b7a-4263-8420-405d565377aa",
      "logparentid": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a"
    },
    "general": {
      "name": "Brickwall",
      "isobjectvalid": true
    },
    "quantity": {
      "width": 115
    },
    "geometry": {
        "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]}"
    },
    "elementstate": {
      "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
    }
  }
}

...

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"
    }
]

Anchor

	objCreateAttachment
	objCreateAttachment

Create a new attachment

...

in the object

Deck of Cards

id	bimCreateCommentForObjectbimObjCreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/cb96a9b17cf910cb-48c9e357-4d9743f6-8c9eaa3a-262476c1c6b2b45c26380f75/commentsattachmentsJSON Structure:

Card
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.

label	HTTP Method

POST

Card

label	Description

Create a new attachment in a object.

Card

label	Request

Card

label	Request

Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/jsonmultipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

lang

Code Block

borderColor

Red

xml	title	JSON

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

Content

------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

name and filename are mandatory saved as attachment's "name" and "filename" properties
classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
Content-Type is mandatory and is saved as attachment's property "type"

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",
   
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-0712-02T1311T10:26:18.8932853+00:0047:39",
       "authorcreator": {
         "id": "00000000e18941f4-0000a809-00002d01-0000d27d-000000000000cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "UnknownFirst Name",
         "lastname": "UserSecond Name",
         "company": "Best-Company",
         "fullname": "Unknown UserFirst Name Second Name",
         "displayname": "Unknown UserBest-Company",
        "info": ""},
        "genderchanged" : "2013-12-11T10:47:39",
        "phoneWorkchangedBy" : "",{
         "phoneHomeid": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "faxemail": "test@bimplus.net",
        "mobile": ""},
        "birthDatehash": "0000-00-0068a59c1f-1914-43b8-92fc-1cee4ad1c90c",
        "addressattachmentType" : {"Document",
     "classification" : "Report",
     "streettag" : "ABCDE",
     "sizeMB" : "0,21",
     "streetNrversion" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "ziprights" : "",
   {
         "cityupdate" : ""true,
            "countryshare" : ""true,
         "delete" : }true,
         "preferedLanguagedownload" : nulltrue
     },
       "id": "d258c9056cea110a-c8af88f4-446343ac-b0d89a00-ac09dbcfc255ebaf677be333"
}

Anchor

	getCommentsOfObjectobjGetAttachmentgetCommentsOfObject
	objGetAttachment

Get

...

the

...

attachment list from the object

Deck of Cards

id	bimGetAllCommentsOfObjectbimGetObjAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/cb96a9b17cf910cb-48c9e357-4d9743f6-8c9eaa3a-262476c1c6b2b45c26380f75/commentsattachments

Card

label	HTTP Method

GET

Card

label	Description

Get all the comments of 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

[
     {
         "issueIdobjectIds": [
         "cb96a9b10d2ce2cc-48c93588-4d9745d6-8c9ea59a-262476c1c6b2f6b89ebed34e",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00 ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "modifiedAtcreatedAt": "2013-0712-03T1311T10:26:18+00:0047:39",
         "authorcreator": {
         "id": "00000000e18941f4-0000a809-00002d01-0000d27d-000000000000cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "UnknownFirst Name",
         "lastname": "UserSecond Name",
         "company": "Best-Company",
         "fullname": "Unknown UserFirst Name Second Name",
         "displayname": "Unknown UserBest-Company",
     },
     "infochanged" : "2013-12-11T10:47:39",
        "genderchangedBy" : "",{
         "phoneWorkid": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "phoneHomeemail": "test@bimplus.net",
     },
     "faxhash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
        "mobileattachmentType" : "Document",
        "birthDateclassification" : "0000-00-00Report",
     "tag"  : "addressABCDE": {,
     "sizeMB" : "0,21",
     "streetversion" : "1",
            "streetNrrelatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "ziprights" : "",
    {
         "cityupdate" : ""true,
            "countryshare" : ""true,
         "delete" : }true,
         "preferedLanguagedownload" : nulltrue
     },
         "id": "d258c9056cea110a-c8af88f4-446343ac-b0d89a00-ac09dbcfc255ebaf677be333"
    },
  ...
]

Anchor

	deleteCommentsOfObjectobjDeleteAttachmentdeleteCommentsOfObject
	objDeleteAttachment

Delete all the

...

attachments from the object

Deck of Cards

id	bimDeleteCommentOfObjectbimDeleteObjAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/commentsattachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/cb96a9b17cf910cb-48c9e357-4d9743f6-8c9eaa3a-262476c1c6b2b45c26380f75/commentsattachments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the comments from the issueattachments 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

	objCreateAttachmentobjCreateHyperlinkobjCreateAttachment
	objCreateHyperlink

Create a new

...

hyperlink for the object

Deck of Cards

id	bimObjCreateAttachmentbimObjCreateHyperlink

card

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments id>hyperlinks

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

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

JSON Structure:

label	HTTP Method

POST

Card

label	Description

Create a new attachment in a object.

Card

label	Request

Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

Code Block

title	Content

------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

name and filename are mandatory saved as attachment's "name" and "filename" properties
classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
Content-Type is mandatory and is saved as attachment's property "type"

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
type	optional	string	Hyperlink type. Could be either none - link to web site, or "Attachment" - link to download url

Card

label	HTTP Method

POST

Card

label	Description

Create a new hyperlink for the object.

Card

label	Request

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	StatusHeaders

StatusAuthorization: 201 Created BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Code Block

borderColor	Red
lang	xml
title	JSON

{
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstnamename": "FirstMy Namewebsite",
         "lastnameurl": "Second Name",
     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

{
    "companyorderNumber": "Best-Company"1,
         "fullnamename": "First Name Second NameMy website",
         "displaynameurl": "Best-Companyhttps://www.bimplus.net/",
     },
     "changed" "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 website2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
        "versionurl" : "1https://www.bimplus.net/",
        "relatedIdid" : "0d2ce2ccc46d1080-35880450-45d64f03-a59aaa4d-f6b89ebed34ea32300e018e9",
     "rights" :},
    {
         "updateorderNumber" : true2,
         "sharename" : true,
"My         "delete" : truesecond website",
         "downloadurl": : true"https://www-stage.bimplus.net/",
     }
     "id": "6cea110ae72e6ddd-88f463f4-43ac40a3-9a00b820-ebaf677be333a32300e14c31"
    }
]

Anchor

	createObjectScene	objGetAttachment	objGetAttachment

Get the attachment list from the object

...

id	bimGetObjAttachment

...

default	true
label	URL / Resource / JSON Structure

...

	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

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

[

"objectIds":

[

"id":

0d2ce2cc

1e9d3697-

3588

cde5-

45d6

4d67-

a59a

8998-

f6b89ebed34e

267edd4fe968",

],

fileName

type": "

TestFile.xml

Door",
            "

type

attributes":

"application/xml",

{
                "geometry": {
                    "

size

colorid":

211258

1,

"createdAt

          "template": "

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

5ad3b016-a9d8-4f8a-9e12-8919c411f076",
                    "

creator": {

matrix": [

"id":

"e18941f4-a809-2d01-d27d-cd251f2b6cb6",

"email": "test@bimplus.net"

1,

"firstname":

"First

Name",

"lastname":

"Second

Name"

0,

"company":

"Best-Company",

"fullname":

"First

Name

Second

Name"

0,

"displayname": "Best-Company",

},

"changed"

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

 75957.48,

"id":

"e18941f4-a809-2d01-d27d-cd251f2b6cb6",

"email": "test@bimplus.net"

0,

},

"hash":

"68a59c1f-1914-43b8-92fc-1cee4ad1c90c",

"attachmentType"

:

"Document",

"classification"

:

"Report"

0,

"tag" : "ABCDE",

"sizeMB"

:

"0,21",

"version"

:

"

"relatedId"

:

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

"rights"

:

{

"update"

:

true

17100,

"share"

:

true,

"delete"

:

true

0,

"download"

:

true

}

"id":

"6cea110a-88f4-43ac-9a00-ebaf677be333" }, ... ]

...

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

...

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

...

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
type	optional	string	Hyperlink type. Could be either none - link to web site, or "Attachment" - link to download url

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"
}

...

Get the hyperlink list from the object

Deck of Cards

id	bimGetObjHyperlinks

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

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

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>hyperlinks id>

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	HTTP Method

GET

Card

label	Description

Get all the hyperlinks belonging to a specified object.

-43f6-aa3a-b45c26380f75

Card

label	ResponseHTTP Method

code DELETEborderColor

GreenStatus: 200 OK

Card

label

lang

xml

title

Status

Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	RedGreen
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"
    }
]

...

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

...

Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createCustomTableForObject
	createCustomTableForObject

Create a new custom table in the object

Deck of Cards

id	bimCreateCustomTableForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/customtables

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

Example: https://api-

...

...

...

...

...

...

...

262476c1c6b2/customtables

JSON Structure:

Name	Mandatory / Optional	Type	Description
relatedId	optional	string(guid)	The id of the object the custom table belongs to. Will be taken from request url.
name	optional	string	Custom table name
description	optional	string	Custom table description
id	will be ignored	string(guid)	The id of the custom table.
created	will be ignored	string (date)	Creation date of the custom table
createdBy	will be ignored	object	The user which created custom table
changed	will be ignored	string (date)	Modified date of the comment
changedBy	will be ignored	string (date)	The user which recently modified custom table
revision	optional	int (null=current)	Object revision. If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ).
dataTable	mandatory	object	A JSON string which includes data for custom table. An example template is specified below. Please remember, the server will process the dataTable information as a json string and hence the client has to take care on the information that is stored & retrieved.

Card

label	HTTP Method

POST

Card

label	Description

Create a new custom table 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

{
    "name": "Sample custom table",
    "description": "Sample custom table with all column types",
    "dataTable": {

...

Code Block

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

attributes

columns":

{

[
            { "name": "Int column", "

geometry

type":

{

 "Int32" },
            { "name": "DateTime column",

"colorid": 1

"type": "DateTime" },
            { "name": "String

"template

column", "type": "

5ad3b016-a9d8-4f8a-9e12-8919c411f076"

String" },
            { "name": "Double column", "type": "Double" },

"matrix":

[

       { "name": "Guid column", "type": "Guid" },

1,

 { "name": "Bool column", "type": "Boolean" }
        ],

0,

"rows": [

{ "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ]

0

},
            { "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ]

75957.48

},
            { "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ]

0

},
            { "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ]

0,

}
        ]
    },
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status:

201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Sample custom

1

table",
    "description": "Sample custom table with all column types",
    "relatedId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",

17100

"created": "2017-06-20T06:51:40.64",
    "createdBy": {
        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",

0,

"email": null
    },
    "changed": "2017-06-20T06:51:40.64",
    "changedBy": {

-1

"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "email": null
    },
    "revision": 0,

0,

"dataTable": {
        "columns": [
            { "name": "Int

-64025

column",

 "type": "Int32" },
            { "name": "DateTime column", "type":

0

"DateTime" },
            {

0

"name": "String column", "type": "String" },
            { "name": "Double column", "type":

0

"Double" },
            { "name": "Guid column", "type": "Guid" },

1

      { "name": "Bool column", "type": "Boolean" }
        ],
        "rows": [

}

     { "items": [

}

...

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)

...

1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    },
    "id": "2517e000-eb32-4487-be36-c5db90b9b943"
}

Anchor

	getCustomTablesOfObject
	getCustomTablesOfObject

Get all the custom tables of the object

Deck of Cards

id	bimGetAllCustomTablesOfObject

...

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

...

Create a new custom table in the object

Deck of Cards

id	bimCreateCustomTableForObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/customtables

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

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

Card
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.

label	HTTP Method

GET

Card

label	Description

Get all the custom tables 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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	HeadersStatus

AuthorizationStatus: BimPlus200 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
OK

Code Block

borderColor	Red
lang	xml
title	JSON

{[
    {
	    "name": "Sample custom table",
    	"description": "Sample custom table with all "textcolumn types",
	    "relatedId": "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": {
cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
	    "created": "2017-06-20T06:51:40.64",
	    "createdBy": {
	        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
	        "email": null
	    },
	    "changed": "2017-06-20T06:51:40.64",
	    "changedBy": {
        	"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
    	    "email": null
	    },
	    "revision": 0,
	    "dataTable": {
        	"columns": [
    	        { "idname": "Int column", "type": "00000000-0000-0000-0000-000000000000",
Int32" },
	            { "name": "DateTime column", "emailtype": "DateTime" },
	            { "firstnamename": "String column", "type": "UnknownString" },
        "lastname    	{ "name": "Double column", "type": "UserDouble" },
        	    { "companyname": "Guid column",
        "fullname"type": "Guid"Unknown User"},
    	        { "displaynamename": "UnknownBool Usercolumn",
        "infotype": "Boolean", }
	        "gender": ""],
        	"phoneWorkrows": "",[
    	    "phoneHome": "",
   { "items": [ 1, "2017-07-12T00:00:00", "fax": "",
   First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
	     "mobile": "",
      {  "birthDateitems": [ 2, "00002017-06-12T00:00-:00",
 "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true   "address": {
] },
        	    { "streetitems": [ 3, "2017-05-12T00:00:00",
 "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true       "streetNr": ""] },
    	        { "zipitems": [ 4, "2017-04-12T00:00:00",
 "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
	       "city": "", ]
    	},
         "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

...

	"id": "2517e000-eb32-4487-be36-c5db90b9b943"
	}
]

Anchor

	deleteCustomTablesOfObject
	deleteCustomTablesOfObject

Delete all the custom tables of the object

Deck of Cards

id	bimDeleteCustomTablesOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/customtables

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

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the custom tables 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

Anchor

	getReportsOfObject
	getReportsOfObject

Get reports

...

of the object

Deck of Cards

id	bimGetAllCommentsOfObjectbimGetReportsOfObject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/comments reports

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

_slug>/objects/<object_id>/reports

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

Optional query parameters

Name	Type	Default value	Description
version	int	null	If version is specified, then the call will get report's of object from the requested version, otherwise return all reports of objects.
action	string	null	If action is specified, then the call will get report's of object from the requested action, otherwise return all reports of objects. Now we have report just for action = Download_Document

Card

label	HTTP Method

GET

Card

label	Description

Get all the comments report 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

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": "",{
        "firstnameid": "Unknowncb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "lastnameuser": "User",
   {
     "company": "",
        "fullnameid": "Unknown User78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "displayname": "Unknown User",
        "infoemail": "test@email.com",
        "gender": ""},
        "phoneWorkcreated": "2010-08-02T10:08:14.069124",
        "phoneHomeversion": ""1,
        "faxaction": "Download_Document",
        "mobile": "",},
	{
        "birthDateid": "0000-00-00cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "addressuser": {
            "streetid": "98a94d0e-0d58-3f85-aafa-1e631c51b5d2",
            "streetNremail": "test8@email.com",
            "zip": ""},
            "citycreated": "",
            "country": ""
        }2010-08-02T10:08:14.069124",
        "preferedLanguageversion": null2,
    },
        "idaction": "d258c905-c8af-4463-b0d8-ac09dbcfc255Download_Document"
      }
]

...

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>/comments

Example: 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

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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 32

New Version Current

Key

Object Service

Get the complex properties of the object

Update the object

Create a new comment in the object

Get all the comments of the object

Create a new attachment

in the object

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

Get the attachment 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 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

Create a new custom table in the object

Get all the custom tables of the object

Delete the object

Create a new custom table in the object

Delete all the custom tables of the object

Get reports

of the object

Delete all the comments of the object

Selection Object