Versions Compared

Key

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

...

Deck of Cards
idbimCreateExportObject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/exportobjects 

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

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

JSON Structure:

Children of the object

Name

Mandatory / Optional

Type

Description

parent

optional

string (guid)

The id of the parent to which the object can be associated

type

mandatory

string

Element type of the object

attributes

optional

string

Attributes of the object

children

optional

Object

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


JSON Structure of the Selection object:

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
labelHTTP Method
 POST
Card
labelDescription
 Creates a new export object
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
titleJSON
{
    "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
    "name": "Project Selection 2",
    "description": "parcial selection of the project",
    "selection": {
        "projectidprojectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
        "modeliddivisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
        "type": "Topology",
        "elements": null,
        "topology": {
            "camera": null,
            "topology": [
                {
                    "id": "79de2e39-2dab-4698-81b3-d47d47baf5a7",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "81da639e-213d-4b1e-b390-0f4a6dd89dda",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "1bf9d9c6-d1e8-476c-ada2-c1826e94cdda",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "8b99a203-a2c6-4ac9-82ff-a04d1485239d",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "d93ffea5-1def-462a-9085-c626f7bedfc0",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                }
            ],
            "layers": [
                {
                    "revision": 0,
                    "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                }
            ]
        },
        "filter": null,
        "structure": null
    }
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
titleJSON
{
    "id": "f00817c3-73b3-4406-aef7-78a11ae801bd",
    "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
    "name": "Project Selection 2",
    "description": "parcial selection of the project",
    "selection": {
        "projectid": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
        "modelid": "f012f6e0-fa56-4234-9760-a3ca711163da",
        "type": "Topology",
        "elements": null,
        "topology": {
            "camera": null,
            "topology": [
                {
                    "id": "79de2e39-2dab-4698-81b3-d47d47baf5a7",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "81da639e-213d-4b1e-b390-0f4a6dd89dda",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "1bf9d9c6-d1e8-476c-ada2-c1826e94cdda",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "8b99a203-a2c6-4ac9-82ff-a04d1485239d",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "id": "d93ffea5-1def-462a-9085-c626f7bedfc0",
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                }
            ],
            "layers": [
                {
                    "revision": 0,
                    "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                }
            ]
        },
        "filter": null,
        "structure": null
    }
}



...