Page History

...

Section

Column

width	25%

Messaging Service

Column

width	25%

Log Service

Column

width	50%

Bimplus Windows Explorer related Services

Anchor

	projectService
	projectService

...

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

Anchor

	createHierarchy
	createHierarchy

...

Deck of Cards

id	bimDeleteAllHierarchies

Card

default	true
label	URL / Resource / JSON Structure

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

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=xxx<xxx>;userId=yyy<yyy>;category=name<name>;objectId=zzz<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
title	Headers
lang	xml

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

Code Block

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

Anchor

	createPropertySetting
	createPropertySetting

Create a property setting

Deck of Cards

id	bimCreatePropertySetting

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

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

Anchor

	getPropertySettingDetails
	getPropertySettingDetails

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

Anchor

	updatePropertySetting
	updatePropertySetting

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

Anchor

	deletePropertySetting
	deletePropertySetting

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

Anchor

	createAttachment
	createAttachment

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 529

New Version 530

Key

Messaging Service

Log Service

Bimplus Windows Explorer related Services

Create a property setting

Get the property setting details

Update the property setting

Delete the property setting