Page History

...

Deck of Cards

id	bimCreateObjectFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: settings/filter

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

Example: https://api-stage.bimplus.net/v2/bimplus/settings/filter

JSON Structure:

Name	Mandatory / Optional	Type	Description
disciplineID	mandatory	string(guid)	Id of the layer/discipline
name	mandatory	guid	Name of the filter
filterString	mandatory	string	Id of the object attribute in this format [Attribute_ID].Value

Card

label	HTTP Method

POST

Card

label	Description

Creates a new user's object filter.

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

{
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

...

Code Block

...

title

...

JSON

{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}

Anchor

	updateObjectFilter
	updateObjectFilter

Update object filter

Deck of Cards

id	bimUpdateObjectFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: settings/filter

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

Example: https://api-stage.bimplus.net/v2/bimplus/settings/filter

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	Filter Id
disciplineID	mandatory	string(guid)	Id of the layer/discipline
name	mandatory	guid	Name of the filter
filterString	mandatory	string	Id of the object attribute in this format [Attribute_ID].Value

Card

label	HTTP Method

PUT

Card

label	Description

Update existing object filter

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

{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}

Card

label	Response

Update object filter

Deck of Cards

id	bimUpdateObjectFilter

Card

default	true
label	URL / Resource / JSON Structure

Resource: settings/filter

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

Example: https://api-stage.bimplus.net/v2/bimplus/settings/filter

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	Filter Id
disciplineID	mandatory	string(guid)	Id of the layer/discipline
name	mandatory	guid	Name of the filter
filterString	mandatory	string	Id of the object attribute in this format [Attribute_ID].Value

Card

label	HTTP Method

PUT

Card

label	Description

Update existing object filter

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	HeadersStatus

AuthorizationStatus: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json200 OK

xml

Code Block

borderColor

Red

lang

title	JSON

{
 "id" : "10074EEF-9418-4D64-9C6D-23932835A7F1",
 "disciplineID" : "0F106AF0-A919-44C5-B211-15BD5EF620B6",
 "name" : "Custom Filter",
 "filterString" : "[ae647490-054c-45d9-a348-122fba25bd3d].Value"
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key