Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimUpdateObjectFilter


Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: settings/filter 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/settings/filter?project_id=<project_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/settings/filter?project_id=5cd37c77-d341-4ab2-9f0d-44467955b218

Optional query parameters:

NameTypeDescription
project_idstring(guid)

When query parameter "project_id" is defined, the updated custom filter will be assigned only to requested project


JSON Structure:

Name

Mandatory / Optional

Type

Description

idmandatoryguidFilter Id

disciplineID

mandatory

string(guid)

Id of the layer/discipline

name

mandatory

guidstring

Name of the filter

filterString

mandatory

string

Id of the object attribute in this format [Attribute_ID].Value



Card
labelHTTP Method
PUT


Card
labelDescription
 Update existing object filter


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


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



...