Page History

...

Section

Column

width	25%

Messaging Service

Column

width	25%

Log Service

Column

width	50%

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

	getObjectNavigatorListcreateObjectView	getObjectNavigatorList

...

	createObjectView

Create a new objectview

Deck of Cards

id	bimGetObjectNavigatorListbimCreateObjectView

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview objectlist

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

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

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

GET POST

Card

label	Description

Get the list of target objectviews which will be populated in the "Object Navigator List" Create a new objectview

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

[
    {
        "viewnameelementsId": "onProjectElements_Building",[
        "resourcenameid": "Category.ElementBuilding8506156B-F965-4D51-9DD1-01D0C300601E",
        "iconid": "IconArchitectureWallCF9E6219-2962-4F21-B1DD-01DC4AB902E9",
        "sortcolumns": null,1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
    ],
    "projectfiltercolumnsList": null,[
        "objectname": "Element",{
        "ordernr": 21
    }"tableName": "general",
    {
        "viewnamecolumnName": "onProjectElements_RoomName",
            "resourcenameidfreeAttribId": "Category.ElementRoom",null
        "iconid": "IconArchitectureRoom"},
        {
   "sortcolumns": null,
        "projectfiltertableName": null"general",
            "objectnamecolumnName": "ElementDescription",
            "ordernrfreeAttribId": 22null
        },
    {
     {
   "viewname": "onProjectElements_Finish",
        "resourcenameidtableName": "Category.ElementFinishquantity",
            "iconidcolumnName": "IconRoofLayerLength",
            "sortcolumnsfreeAttribId": 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
title	Status
lang	xml

Status: 201 CREATED

Code Block

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

...

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
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
: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

Code Block

borderColor	Red
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": "NrObjectID",
        "ordernr": 21,
        "datatype": "intuniqueidentifier",
        "isdefault": null,
        "categorynameid": "Category.General"null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null"false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "NameNr",
        "ordernr": 32,
        "datatype": "nvarcharint",
        "isdefault": "true"null,
        "categorynameid": "Category.General",
        "resourcenameid": "Name"null,
        "proporder": null,
        "converter": "Converter_PPName"null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DescriptionName",
        "ordernr": 43,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "DescriptionName",
        "proporder": null,
        "converter": null,
        "browsable": null"Converter_PPName",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5browsable": null,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionDescription",
        "ordernr": 64,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.ModelDescription",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelTypeDivisionID",
        "ordernr": 75,
        "datatype": "uniqueidentifier",
        "isdefault": "true"null,
        "categorynameid": "Category.General"null,
        "resourcenameid": "Property.Discipline"null,
        "proporder": null,
        "converter": "Converter_ElementType"null,
        "browsable": null"false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTypDivision",
        "ordernr": 86,
        "datatype": "uniqueidentifiernvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "TypeProperty.Model",
        "proporder": null,
        "converter": "Converter_ElementType"null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "WeightModelType",
        "ordernr": 97,
        "datatype": "floatuniqueidentifier",
        "isdefault": null"true",
        "categorynameid": "Category.GeometryGeneral",
        "resourcenameid": "MassProperty.Discipline",
        "proporder": null,
        "converter": "Converter_MassElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "VolumeElementTyp",
        "ordernr": 108,
        "datatype": "floatuniqueidentifier",
        "isdefault": null"true",
        "categorynameid": "Category.GeometryGeneral",
        "resourcenameid": "VolumeType",
        "proporder": null,
        "converter": "Converter_VolumeElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "AreaWeight",
        "ordernr": 119,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "AreaMass",
        "proporder": null,
        "converter": "Converter_AreaMass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "LengthVolume",
        "ordernr": 1210,
        "datatype": "float",
        "isdefault": "true"null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.LengthVolume",
        "proporder": null,
        "converter": "Converter_LengthVolume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "WidthArea",
        "ordernr": 1311,
        "datatype": "float",
        "isdefault": "true"null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.WidthArea",
        "proporder": null,
        "converter": "Converter_LengthArea",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

...

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

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:

Deck of Cards

id	bimGetDetailsFromObjectList

Card

default	true
label	URL / Resource / 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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 530

New Version 531

Key

Messaging Service

Log Service

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 the required object's(objectview's) details from input objectview list reference

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