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 |
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 |
---|
| Creates a new export object |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
| {
"projectId": "ceac9b1e-31d9-4c5f-bd78-f909767b7b01",
"name": "Project Selection 2",
"description": "parcial selection of the project",
"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 |
---|
|
Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
| {
"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
}
} |
|
|