Page History

...

Section

Column

width	25%

Messaging Service

Column

width	25%

Log Service

Column

width	50%

BTW(Bim Team Work) related Service

Bimplus Windows Explorer related Services

Get the list of logical grouping of target objects which will be populated in the "Object Navigator" of BTW (Object Navigator list)
Get information about an "Object Navigator" item
Get the properties(column names) of the "Object List"
Get the required object's details from input object list reference of an "Object Navigator" item"
Get all the user hierarchies using the user & module information

...

Anchor

	btwService
	btwService

...

Bimplus Windows Explorer related

...

Services

...

Bimplus Teamworks 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

	getObjectNavigatorList
	getObjectNavigatorList

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

...

(Object Navigator list)

Deck of Cards

id	bimGetObjectNavigatorList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview

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

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

Card

label	Description

Get the list of target objects which will be populated in the "Object Navigator" of BTW.

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

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Room",
        "resourcenameid": "Category.ElementRoom",
        "iconid": "IconArchitectureRoom",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Finish",
        "resourcenameid": "Category.ElementFinish",
        "iconid": "IconRoofLayer",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Reinforcement",
        "resourcenameid": "Category.Reinforcement",
        "iconid": "IconReinforcement",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mesh",
        "resourcenameid": "Category.Mesh",
        "iconid": "IconMesh",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Precast",
        "resourcenameid": "Category.PrecastElement",
        "iconid": "IconPrecastUnit",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_PrecastTimber",
        "resourcenameid": "Category.ElementPrecastTimber",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_MEP",
        "resourcenameid": "Category.ElementMEP",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Plumbing",
        "resourcenameid": "Category.ElementPlumbing",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Electricity",
        "resourcenameid": "Category.ElementElectricity",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mechanical",
        "resourcenameid": "Category.ElementMechanical",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Construction",
        "resourcenameid": "Category.ElementConstruction",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Terrain",
        "resourcenameid": "Category.ElementTerrain",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Inventary",
        "resourcenameid": "Category.ElementInventary",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Structural",
        "resourcenameid": "Category.ElementStructural",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Clash",
        "resourcenameid": "Category.Collision",
        "iconid": "IconCollision",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Collision"
    },
    {
        "viewname": "onProjectIssues",
        "resourcenameid": "Category.Issue",
        "iconid": "IconIssue",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Issue"
    }
]

...

Anchor

	getDetailsFromObjectList
	getDetailsFromObjectList

Get the required object's details from input object list reference of an "Object Navigator" item

Deck of Cards

id	bimGetDetailsFromObjectList

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview/tablecontent

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

Example: https://api-stage.bimplus.net/v2/bimplus/objectview/tablecontent

JSON Structure:

Name	Mandatory / Optional	Type	Description
tablename	mandatory	string	Name of the table
elementsguidelementsId	mandatory	Listobject	List of object id's whose details has to be found
filterColumns	optional	object	The properties that could be used as filters

Card

label	Description

Get the required object's details from input object list reference of an "Object Navigator" item

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

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    }
]

Anchor

	getAllUserHierarchies
	getAllUserHierarchies

...

Deck of Cards

id	bimGetAllUserHierarchies

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/heirarchy/all

URL: https://api-stage.bimplus.net/v2/<team_slug>usersettings/heirarchy/all

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchy/all

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	Description

Get all the user hierarchies using the user & module information

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

{
    "moduleid": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
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
    }
]

"filterColumns":

[

"ObjectId",

"DivisionId",

"Name",

"Width",

"ElementTyp"

]

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 464

New Version 465

Key

Messaging Service

Log Service

Bimplus Windows Explorer related Services

Bimplus Windows Explorer related

Services

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

(Object Navigator list)

Get the required object's details from input object list reference of an "Object Navigator" item