...
Structure Service
...
A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service
...
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
|
Resource: structures/<structure_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id> Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5 JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
parentId | optional | string(guid) | Parent node id of the structure (for the first structure, projectId is the parentId) | name | optional | string | Name of the structure | description | optional | string | Description of the structure | type | optional | string | Type of the structure (eg: costStructure, specificationStructure) | nr | optional | integer | The index of the structure | color | optional | integer | Color of the structure | id | will be ignored | string(guid) | Unique guid of the structure |
|
Anchor |
---|
| createVariant |
---|
| createVariant |
---|
|
Create a new variant in a project
Deck of Cards |
---|
|
Card |
---|
| Create a new variant of defined structure(eg: cost structure, specification structure) under a project |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Headers |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"name": "TestVariant",
"description": "Description of the Test variant"
} |
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
lang | xml |
---|
title | Status |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
lang | xml |
---|
title | JSON |
---|
| {
"name": "TestVariant",
"description": "Description of the Test variant",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|