Page History

...

Create a new selection object

Deck of Cardstab-group

iddeckId	bimCreateSelectionObject

JSON Structure of the Selection object:

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: projects/<project_id>/exportobjects

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/selections

Example: https://api-stage.bimplus.net/v2/bimplus/projects/ceac9b1e-31d9-4c5f-bd78-f909767b7b01/selections

JSON Structure: The structure of the Selection objects is the same like the structure of the object for Export Object Selection.

Name

Mandatory / Optional

Type

Description

Id

optional

string (guid)

Id of the export object

projectId

optional

string (guid)

The id of the project the export object is associated

name

mandatory

string

Name of the export object

description

optional

string

Description of the export object

selection

optional

Object

Selection object, see json structure below

Name

Mandatory / Optional

Type

Description

projectId

mandatory

string (guid)

The id of the project the export object is associated

type

madatory

string

Type of Selection object which define selection of objects to be exported from associated model.
The type can be one of following values :
"Model", "Elements", "Topology", "Filter", "Structure"

divisionId

mandatory

string (guid)

Division Id (Model Id) of the exported objects.
This is madatory for selection type "Model"

e.g.: selection of export object

"selection" : { "modelId":"GUID","type":"Model" }

elements

optional

Object

This object is mandatory for Selection type - "Elements"
e.g.: selection of export object

"selection" : {"modelId":"GUID","type":"Elements","elements":["GUID","GUID",...]}

topology

optional

Object

This object is mandatory for Selection type - "Topology"
e.g.: details see in request section

filter

optional

Object

This object is mandatory for Selection type - "Filter"
e.g. json of selection object:

"selection" : {"modelId":"GUID","type":"Filter","filter":{"filterId":"GUID", "nodeInfoList":[ "node list text1", "node list text2", ...]}}

structure

optional

Object

This object is mandatory for Selection type - "Structure"
e.g. json of selection object:

"selection" : {"modelId":"GUID","type":"Structure","structure":{"variantTypeId":"GUID", "structuresList":["GUID","GUID", ...]}}

Card

label	HTTP Method

POST

Optionally there is an opportunity to mark selection object validity just for one use with the 'singleuse' (default is null or false) attribute. The created selection for a single use ("singleuse": true) attribute selection object will be automatically deleted when the selection id is used on any of the API services where it is possible to use a selection id (Including services for example: Objects, Revision comparisions, Locks, Geometries, Clash filters).

Tab

title	HTTP Method

POST

Tab

title

Card

label	Description

Creates a new selection object

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

title	JSON

{
  "divisionId":"371D0C5F-87A1-42CF-BF43-6FE6123EBE00",
  "type":"Topology",
  "singleuse": false,
  "topology":{
    "layers":[{
        "id":"33826b01-c267-4b25-9f8e-79ac2953c443",
        "divisionId":"1B52B5F7-1B2D-461A-AA9B-6F55C8889241"
      }
    ],
    "topology":[{
        "id":"522e3cc1-c6d4-441c-974c-becfcb51cd14"
      },
      {
        "id":"02583ba2-f7da-4f3a-a2b0-976d98415740"
      }
    ]
  }
}

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
  "projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
  "divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
  "singleuse": false,
  "type":"Topology",
  "elements":null,
  "topology":{
    "camera":null,
    "topology":[{
        "id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
        "visible":false,
        "opaque":false,
        "opacity":0
      },
      {
        "id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
        "visible":false,
        "opaque":false,
        "opacity":0
      }
    ],
    "layers":[{
        "revision":0,
        "id":"33826b01-c267-4b25-9f8e-79ac2953c443",
        "name":null,
        "divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
        "divisionName":null,
        "visible":false,
        "opaque":false,
        "opacity":0
      }
    ]
  },
  "filter":null,
  "structure":null
}

...

Get the selection object details

Deck of Cardstab-group

iddeckId	bimSelectionObjectDetails

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: selections/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/selections/e9eb4f1a-827a-4c19-ae56-e91c4f2988b1

Optional query parameters

Cardtab

labeltitle	HTTP Method

GET

Cardtab

labeltitle	Description

Gets the details of the specified selection object.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labellang	Responsexml
langtitle	xmlResponse

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	In general, the response json has following format :

{
  "id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
  "projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
  "divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
  "singleuse": false,
  "type":"Topology",
  "elements":null,
  "topology":{
    "camera":null,
    "topology":[{
        "id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
        "visible":false,
        "opaque":false,
        "opacity":0
      },
      {
        "id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
        "visible":false,
        "opaque":false,
        "opacity":0
      }
    ],
    "layers":[{
        "revision":0,
        "id":"33826b01-c267-4b25-9f8e-79ac2953c443",
        "name":null,
        "divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
        "divisionName":null,
        "visible":false,
        "opaque":false,
        "opacity":0
      }
    ]
  },
  "filter":null,
  "structure":null
}

...

Get all the selection objects of the project

Deck of Cardstab-group

iddeckId	bimGetSelectionObjectsOfProject

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: projects/<project_id>/exportobjects

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/exportobjects

Example: https://api-stage.bimplus.net/v2/bimplus/projects/ceac9b1e-31d9-4c5f-bd78-f909767b7b01/exportobjects

Cardtab

labeltitle	HTTP Method

GET

Cardtab

labeltitle	Description

Get all the selection objects of a specified project.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "id":"e9eb4f1a-827a-4c19-ae56-e91c4f2988b1",
    "projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
    "divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
    "singleuse": false,
    "type":"Topology",
    "elements":null,
    "topology":{
      "camera":null,
      "topology":[{
          "id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
          "visible":false,
          "opaque":false,
          "opacity":0
        },
        {
          "id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
          "visible":false,
          "opaque":false,
          "opacity":0
        }
      ],
      "layers":[{
          "revision":0,
          "id":"33826b01-c267-4b25-9f8e-79ac2953c443",
          "name":null,
          "divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
          "divisionName":null,
          "visible":false,
          "opaque":false,
          "opacity":0
        }
      ]
    },
    "filter":null,
    "structure":null
  },
  {
    "id":"3f5125db-8fe1-47a5-980d-96ebf62e52d4",
    "projectid":"3f6de86b-0bef-4146-847c-aa21afad6cfa",
    "divisionid":"371d0c5f-87a1-42cf-bf43-6fe6123ebe00",
    "singleuse": false,
    "type":"Topology",
    "elements":null,
    "topology":{
      "camera":null,
      "topology":[{
          "id":"522e3cc1-c6d4-441c-974c-becfcb51cd14",
          "visible":false,
          "opaque":false,
          "opacity":0
        },
        {
          "id":"02583ba2-f7da-4f3a-a2b0-976d98415740",
          "visible":false,
          "opaque":false,
          "opacity":0
        }
      ],
      "layers":[{
          "revision":0,
          "id":"33826b01-c267-4b25-9f8e-79ac2953c443",
          "name":null,
          "divisionId":"1b52b5f7-1b2d-461a-aa9b-6f55c8889241",
          "divisionName":null,
          "visible":false,
          "opaque":false,
          "opacity":0
        }
      ]
    },
    "filter":null,
    "structure":null
  }
]

...

Delete the selection object

Deck of Cardstab-group

iddeckId	bimSelectionObjectDelete

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: selections/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/selections/ceac9b1e-31d9-4c5f-bd78-f909767b7b01

Cardtab

labeltitle	HTTP Method

DELETE

Cardtab

labeltitle	Description

Deletes a specified selection object.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version Current

Key

Create a new selection object

Get the selection object details

Get all the selection objects of the project

Delete the selection object