Page History

Bimplus Windows Explorer related Services

...

Bimplus Windows Explorer related Services

...

Bimplus Windows Explorer is the Windows desktop application AEC professionals and BIM managers use to upload, manage and analyze building information on the Bimplus platform for use by all contributors to your construction project. For more information please see here

Anchor

	createObjectView
	createObjectView

Create a new objectview

Deck of Cards

id	bimCreateObjectView

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectlist

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
elementsId	mandatory	object	List of elements id
columnsList	mandatory	object	List of columns
tableName	mandatory	string	Name of the resource
columnName	optional	string	Name of the property
freeAttribId	optional	string(guid)	Id of the used free attribute

Card

label	HTTP Method

POST

Card

label	Description

Create a new objectview

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "elementsId": [
        "8506156B-F965-4D51-9DD1-01D0C300601E",
        "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
        "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
    ],
    "columnsList": [
        {
            "tableName": "general",
            "columnName": "Name",
            "freeAttribId": null
        },
        {
            "tableName": "general",
            "columnName": "Description",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Length",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Height",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "ElementTyp",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "DivisionID",
            "freeAttribId": null
        },
        {
            "tableName": "stringattrib",
            "columnName": "",
            "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
        },
        {
            "tableName": "doubleattrib",
            "columnName": "",
            "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
        }
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 201 CREATED

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "elementsId": [
        "8506156B-F965-4D51-9DD1-01D0C300601E",
        "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
        "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
    ],
    "columnsList": [
        {
            "tableName": "general",
            "columnName": "Name",
            "freeAttribId": null
        },
        {
            "tableName": "general",
            "columnName": "Description",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Length",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Height",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "ElementTyp",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "DivisionID",
            "freeAttribId": null
        },
        {
            "tableName": "stringattrib",
            "columnName": "",
            "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
        },
        {
            "tableName": "doubleattrib",
            "columnName": "",
            "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
        }
    ]
}

Anchor

	getObjectNavigatorList
	getObjectNavigatorList

Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"

Deck of Cards

id	bimGetObjectNavigatorList

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get the list of target objectviews which will be populated in the "Object Navigator List"

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 21
    },
    {
        "viewname": "onProjectElements_Room",
        "resourcenameid": "Category.ElementRoom",
        "iconid": "IconArchitectureRoom",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 22
    },
    {
        "viewname": "onProjectElements_Finish",
        "resourcenameid": "Category.ElementFinish",
        "iconid": "IconRoofLayer",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 23
    },
    {
        "viewname": "onProjectElements_Reinforcement",
        "resourcenameid": "Category.Reinforcement",
        "iconid": "IconReinforcement",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 24
    },
    {
        "viewname": "onProjectElements_Mesh",
        "resourcenameid": "Category.Mesh",
        "iconid": "IconMesh",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 25
    },
    {
        "viewname": "onProjectElements_Precast",
        "resourcenameid": "Category.PrecastElement",
        "iconid": "IconPrecastUnit",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 27
    },
    {
        "viewname": "onProjectElements_PrecastTimber",
        "resourcenameid": "Category.ElementPrecastTimber",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 28
    },
    {
        "viewname": "onProjectElements_MEP",
        "resourcenameid": "Category.ElementMEP",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 29
    },
    {
        "viewname": "onProjectElements_Plumbing",
        "resourcenameid": "Category.ElementPlumbing",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 30
    },
    {
        "viewname": "onProjectElements_Electricity",
        "resourcenameid": "Category.ElementElectricity",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 32
    },
    {
        "viewname": "onProjectElements_Mechanical",
        "resourcenameid": "Category.ElementMechanical",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 34
    },
    {
        "viewname": "onProjectElements_Construction",
        "resourcenameid": "Category.ElementConstruction",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 35
    },
    {
        "viewname": "onProjectElements_Terrain",
        "resourcenameid": "Category.ElementTerrain",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 36
    },
    {
        "viewname": "onProjectElements_Inventary",
        "resourcenameid": "Category.ElementInventary",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 37
    },
    {
        "viewname": "onProjectElements_Structural",
        "resourcenameid": "Category.ElementStructural",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 38
    },
    {
        "viewname": "onProjectElements_Clash",
        "resourcenameid": "Category.Collision",
        "iconid": "IconCollision",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Collision",
        "ordernr": 39
    },
    {
        "viewname": "onProjectIssues",
        "resourcenameid": "Category.Issue",
        "iconid": "IconIssue",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Issue",
        "ordernr": 41
    }
]

Anchor

	getObjectNavigatorItem
	getObjectNavigatorItem

Get information about an "Object Navigator" item (objectview)

Deck of Cards

id	bimGetObjectNavigatorItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectviews/<objectview_name>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building

Card

label	HTTP Method

GET

Card

label	Description

Get information about a particular objectview

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": "21"
    }
]

Anchor

	getObjectListColumns
	getObjectListColumns

Get the properties of the object (objectview)

Deck of Cards

id	bimGetObjectListColumns

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectviews/<objectview_name>/properties

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>/properties

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building/properties

Card

label	HTTP Method

GET

Card

label	Description

Get the properties of a particular objectview

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "name": "ObjectID",
        "ordernr": 1,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Nr",
        "ordernr": 2,
        "datatype": "int",
        "isdefault": null,
        "categorynameid": "Category.General",
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Name",
        "ordernr": 3,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Name",
        "proporder": null,
        "converter": "Converter_PPName",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Description",
        "ordernr": 4,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Description",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Division",
        "ordernr": 6,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Model",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelType",
        "ordernr": 7,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Discipline",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTyp",
        "ordernr": 8,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Type",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Weight",
        "ordernr": 9,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Mass",
        "proporder": null,
        "converter": "Converter_Mass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Volume",
        "ordernr": 10,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Volume",
        "proporder": null,
        "converter": "Converter_Volume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Area",
        "ordernr": 11,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Area",
        "proporder": null,
        "converter": "Converter_Area",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Length",
        "ordernr": 12,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Length",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Width",
        "ordernr": 13,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Width",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

Anchor

	getDetailsFromObjectList
	getDetailsFromObjectList

Get the required object's(objectview's) details from input objectview list reference

Deck of Cards

id	bimGetDetailsFromObjectList

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectviews/content

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

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/content

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the resource/objectview
elementsguid	optional	object	List of object id's whose details has to be found
filter	optional	object	The properties that could be used as filters

Card

label	HTTP Method

POST

Card

label	Description

Get the required objectview's details from input object list reference

Card

label	Request

Code Block

borderColor	Green
titlelang	Headersxml
langtitle	xmlHeaders

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "name": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ],
    "filter": [
        "ObjectId",
        "DivisionId",
        "Name",
        "Width",
        "ElementTyp"
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    }
]

...

Anchor

	deleteObjectView
	deleteObjectView

Delete the object view

Deck of Cards

id	bimDeleteObjectView

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectviews/<objectview_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified user defined view(object view).

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Anchor

	createHierarchy
	createHierarchy

Create a new hierarchy

Deck of Cards

id	bimCreateHierarchy

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/hierarchies/<hierarchy_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/hierarchies/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Guid of the module
objectId	mandatory	string(guid)	Guid of the object type
userId	mandatory	string(guid)	Guid of the user
category	optional	string	Name of the category(default is "ObjectNavigator")
oneExtendedData	mandatory	object	Additional information
valueKey	mandatory	string	key name
valueName	mandatory	string	Value of the key
value	mandatory	string	Content of stored value
isDefault	optional	boolean	Whether it is the default value
dataSmallInt	optional	integer	Additional info about the value

Card

label	HTTP Method

POST

Card

label	Description

Create a new hierarchy

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "oneExtendedData": {
        "valueKey": "[onProjectElements_Building]onProjectElements_Building",
        "valueName": "test xxx",
        "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
        "isDefault": "0",
        "dataSmallInt": "1"
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "oneExtendedData": {
        "valueKey": "[onProjectElements_Building]onProjectElements_Building",
        "valueName": "test xxx",
        "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
        "isDefault": "0",
        "dataSmallInt": "1"
    }
}

Anchor

	createHierarchyList
	createHierarchyList

Create a list of hierarchies

Deck of Cards

id	bimCreateHierarchyList

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/hierarchies?$operation=createlist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=createlist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=createlist

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Guid of the module
objectId	mandatory	string(guid)	Guid of the object type
userId	mandatory	string(guid)	Guid of the user
category	optional	string	Name of the category(default is "ObjectNavigator")
oneExtendedData	mandatory	object	Additional information
valueKey	mandatory	string	key name
valueName	mandatory	string	Value of the key
value	mandatory	string	Content of stored value
isDefault	optional	boolean	Whether it is the default value
dataSmallInt	optional	integer	Additional info about the value

Card

label	HTTP Method

POST

Card

label	Description

Create a new hierarchy

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "extendedDataList": [
        {
            "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 001",
            "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        },
        {
            "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 002",
            "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        }
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "extendedDataList": [
        {
            "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 001",
            "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        },
        {
            "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 002",
            "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        }
    ]
}

Anchor

	createCompleteHierarchy
	createCompleteHierarchy

Create a complete new hierarchy structure

Deck of Cards

id	bimCreateCompleteHierarchy

Card

default	true
label	URL / Resource / JSON Structure

Resource: services/applyhierarchy

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

Example: https://api-stage.bimplus.net/v2/bimplus/services/applyhierarchy

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	mandatory	string(guid)	Id of the project for which the structure will be created
userSettingId	mandatory	string(guid)	Id of the user settings required for the hierarchy definition
hierarchyDefinition	mandatory	string	Definition of the hierarchy
name	mandatory	string	Name of the hierarchy
description	optional	string	Description of the hierarchy
structureType	optional	string	Structure type
elementsId	optional	Array of strings(guid)	List of elements guid connected to the hierarchy structure

Card

label	HTTP Method

POST

Card

label	Description

Create a complete new hierarchy structure

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "runAsync": "false",
    "applyHierarchy": {
        "projectId": "01C52808-6561-47F6-833E-B62D05DA8A8E",
        "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I] tabAttribGeometry.Width[I][8807e401-6e3c-4536-88e1-e834d4de745d].Value",
        "name": "Navigator 1",
        "description": "Test for HierarchyNavigator",
        "structureType": "CostStructure",
        "elementsId": [
            "803312C0-26B6-49BE-A607-4319F1B32383",
            "51FEF0FA-437B-4410-B9BE-39B9E15D440F",
            "71D472FD-96A5-4174-8A5A-460DEB8E88E1"
        ]
    }
}

Card

label	Response

Code Block

borderColor	Green
titlelang	Statusxml
langtitle	xmlStatus

Status: 201 CREATED

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "applyHierarchy": {
        "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
        "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I]tabAttribGeometry.Width[I] [8807e401-6e3c-4536-88e1-e834d4de745d].Value",
        "name": "Navigator 1",
        "description": "Test for HierarchyNavigator",
        "structureType": "CostStructure",
        "elementsId": [
            "803312c0-26b6-49be-a607-4319f1b32383",
            "51fef0fa-437b-4410-b9be-39b9e15d440f",
            "71d472fd-96a5-4174-8a5a-460deb8e88e1"
        ],
        "result": {
            "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
            "parentId": "01c52808-6561-47f6-833e-b62d05da8a8e",
            "name": "Navigator 1",
            "description": "Test for HierarchyNavigator",
            "type": "CostStructure",
            "nr": 45,
            "color": 0,
            "id": "dd71620e-af8f-4496-88a5-cc2be1f1747d"
        }
    },
    "runAsync": false
}

Anchor

	getAllUserHierarchies
	getAllUserHierarchies

Get all the user hierarchies using the user & module information

Deck of Cards

id	bimGetAllUserHierarchies

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/heirarchieshierarchies?moduleId=xxx;userId=yyy;category=zzz

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchieshierarchies?moduleId=xxx;userId=yyy;category=zzz

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchieshierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleid	mandatory	guid	Id of the module
userid	mandatory	guid	Id of the user
category	optional	string	category name (default category is "ObjectNavigator")

Card

label	HTTP Method

GET

Card

label	Description

Get all the user hierarchies using the user & module information

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_MEP]",
        "valuename": "onProjectElements_MEP",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
        "datasmallint": 0,
        "revision": null
    }
]

Anchor

	getHierarchyDetails
	getHierarchyDetails

Get the details of a hierarchy

Deck of Cards

id	bimGetHierarchyDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/heirarchieshierarchies/hierarchy_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchieshierarchies/hierarchy_id>

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchieshierarchies/B39AD364-F049-42E3-A936-3FD2871EB4D4

Card

label	HTTP Method

GET

Card

label	Description

Get information about a particular hierarchy

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "attribusersettingid": "b39ad364-f049-42e3-a936-3fd2871eb4d4",
    "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
    "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator",
    "isdefault": false,
    "valuekey": "[onProjectElements_Building]onProjectElements_Building",
    "valuename": "Hierarchie Nr.1",
    "value": "[I]Name[I]Length[F][0]<3000[2]>=215[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND[I]Width[F][0]<1000[2]>400[10]AND[11]AND[12]AND[13]AND[14]AND",
    "datasmallint": 1,
    "revision": null
}

Anchor

	getHierarchyList
	getHierarchyList

Get details about a list of hierarchies

Deck of Cards

id	bimGetHierarchyList

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/heirarchieshierarchies?$operation=getlist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchieshierarchies?$operation=getlist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchieshierarchies?$operation=getlist

JSON Structure:

Name	Mandatory / Optional	Type	Description
userSettingsListId	mandatory	object	List of hierarchy ids

Card

label	HTTP Method

GET

Card

label	Description

Get details about a list of hierarchies

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    }
]

Anchor

	deleteHierarchy
	deleteHierarchy

Delete the hierarchy

Deck of Cards

id	bimDeleteHierarchy

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/hierarchies/<hierarchy_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies/<hierarchy_id>

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specific hierarchy.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Anchor

	deleteHierarchyList
	deleteHierarchyList

Delete the list of hierarchies

Deck of Cards

id	bimDeleteHierarchyList

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/hierarchies?$operation=deletelist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=deletelist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=deletelist

JSON Structure:

Name	Mandatory / Optional	Type	Description
userSettingsListId	mandatory	object	List of hierarchy ids that has to be deleted

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the list of hierarchies as specified in the request

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Anchor

	deleteAllHierarchies
	deleteAllHierarchies

Delete all the hierarchies filtered by additional info

Deck of Cards

id	bimDeleteAllHierarchies

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/hierarchies?moduleId=xxx;userId=<yyy>;category=<name>;objectId=<zzz>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=<xxx>;userId=<yyy>;category=<name>;objectId=<zzz>

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator;objectId=1F15C447-E511-4FC1-940B-13639F973C52

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Id of the module
userId	mandatory	string(guid)	Id of the user
objectId	optional	string(guid)	Id of the object (default is "1F15C447-E511-4FC1-940B-13639F973C52")
Category	optional	string	Name of the category (default is "ObjectNavigator")

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes all the hierarchies filtered by additional info specified as query strings.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Card

label	Response

Code Block

borderColor	Green	title	Status
lang	xml

Status: 200 OK

...

Create a property setting

...

id	bimCreatePropertySetting

...

default	true
label	URL / Resource / JSON Structure

...

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

Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97

JSON Structure:

Name	Mandatory / Optional	Type	Description
attributes	mandatory	object	List of attributes

Card

label	HTTP Method

POST

Card

label	Description

Create a new property setting

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}


title	Status

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 CREATED

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

...

Get the property setting details

Deck of Cards

id	bimGetPropertySettingDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: propertysettings/<propertysetting_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/B39AD364-F049-42E3-A936-3FD2871EB4D4

Card

label	HTTP Method

GET

Card

label	Description

Get information about a particular property setting

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

...

Update the property setting

Deck of Cards

id	bimPropertySettingUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: propertysettings/<propertysetting_id>

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

Example: https://api-stage.bimplus.net/v2/bimpluspropertysettings/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure:

Name	Mandatory / Optional	Type	Description
attributes	mandatory	object	List of attributes

Card

label	HTTP Method

PUT

Card

label	Description

Update the property setting

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Delete the property setting

Deck of Cards

id	bimDeleteIssueListFromProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: propertysettings/<propertysetting_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the issues belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Bimplus Windows Explorer related Services

Bimplus Windows Explorer related Services

Create a new objectview

Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"

Get information about an "Object Navigator" item (objectview)

Get the properties of the object (objectview)

Get the required object's(objectview's) details from input objectview list reference

Delete the object view

Create a new hierarchy

Create a list of hierarchies

Create a complete new hierarchy structure

Get all the user hierarchies using the user & module information

Get the details of a hierarchy

Get details about a list of hierarchies

Delete the hierarchy

Delete the list of hierarchies

Delete all the hierarchies filtered by additional info

Create a property setting

Get the property setting details

Update the property setting

Delete the property setting