Page History

...

Deck of Cards

id	bimCreateExportObject

Card

default	true
label	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

JSON Structure:

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

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
singleuse	optional	bool	Validity just for one use

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

label	HTTP Method

POST

Card

label	Description

Creates a new export object

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

title	JSON

{
    "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
    "name": "Project Selection 2",
    "description": "parcial selection of the project",
	"singleuse": false,
    "selection": {
        "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
        "divisionId": "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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
    "id": "f00817c3-73b3-4406-aef7-78a11ae801bd",
    "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
    "name": "Project Selection 2",
    "description": "parcial selection of the project",
	"singleuse": false,
    "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
    }
}

...

Deck of Cards

id	bimExportObjectDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: exportobjects/<object_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/exportobjects/8dbb2a20-a75b-40b5-8079-540d9d2a2b0a

Optional query parameters

Card

label	HTTP Method

GET

Card

label	Description

Gets the details of the specified export object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response
lang	xml

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": "8dbb2a20-a75b-40b5-8079-540d9d2a2b0a",
    "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
    "name": "Project Selection 1",
    "description": "complete project",
	"singleuse": false,
    "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
                },
                {
                    "revision": 0,
                    "id": "11555f6f-10ec-4180-88b3-699738c079c3",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "revision": 0,
                    "id": "33826b01-c267-4b25-9f8e-79ac2953c443",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "revision": 0,
                    "id": "30114b52-bc05-47c1-80b5-c7d5485d5831",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                },
                {
                    "revision": 0,
                    "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
                    "name": null,
                    "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                    "divisionName": null,
                    "visible": false,
                    "opaque": false,
                    "opacity": 0
                }
            ]
        },
        "filter": null,
        "structure": null
    }
}

...

Deck of Cards

id	bimGetExportObjectsOfProject

Card

default	true
label	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

Card

label	HTTP Method

GET

Card

label	Description

Get all the export objects of a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

  [
    {
        "id": "8dbb2a20-a75b-40b5-8079-540d9d2a2b0a",
        "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
        "name": "Project Selection 1",
        "description": "complete project",
		"singleuse": false,
        "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
                    },
                    {
                        "revision": 0,
                        "id": "11555f6f-10ec-4180-88b3-699738c079c3",
                        "name": null,
                        "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                        "divisionName": null,
                        "visible": false,
                        "opaque": false,
                        "opacity": 0
                    },
                    {
                        "revision": 0,
                        "id": "33826b01-c267-4b25-9f8e-79ac2953c443",
                        "name": null,
                        "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                        "divisionName": null,
                        "visible": false,
                        "opaque": false,
                        "opacity": 0
                    },
                    {
                        "revision": 0,
                        "id": "30114b52-bc05-47c1-80b5-c7d5485d5831",
                        "name": null,
                        "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                        "divisionName": null,
                        "visible": false,
                        "opaque": false,
                        "opacity": 0
                    },
                    {
                        "revision": 0,
                        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
                        "name": null,
                        "divisionId": "f012f6e0-fa56-4234-9760-a3ca711163da",
                        "divisionName": null,
                        "visible": false,
                        "opaque": false,
                        "opacity": 0
                    }
                ]
            },
            "filter": null,
            "structure": null
        }
    },
    {
        "id": "f00817c3-73b3-4406-aef7-78a11ae801bd",
        "projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
        "name": "Project Selection 2",
        "description": "parcial selection of the project",
		"singleuse": false,
        "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
        }
    }
]

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version Current

Key