...
Structure Service
...
A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service
...
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Url / Resource /Json |
|---|
| Resource: structures/<structureprojects/<project_id>/variants/<targetvariant_id>/copycopyfrom URL: https://api-stage.bimplus.net/v2/<team_slug>projects/structures/<structure<project_id>/variants/<targetvariant_id>/copycopyfrom Example:https://api-stage.bimplus.net/v2/bimplus/structures/35b986c2-e9cd-482e-9281-6000671a49f0/copy /projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c/copyfrom JSON Structure: | | | |
|---|
| | | | namemandatory | will be ignored | string | Name of the new structurevariant | description | will be ignored | | | | type | optional | string | Type of the new structure (eg: costStructure, specificationStructure) | | nr | will be ignored | integer | The index of the new structure | | color | optional | integer | Color of the new structure | | string | Description of the variant | | id | mandatory | id | will be ignored | string(guid) | Unique guid of the structuresource variantstartDate |
| optional | string (date) | Start date ( depends on type of structure ) | | endDate | optional | string (date) | End date ( depends on type of structure ) |
| Card |
|---|
| Updates the specified target variant with all structure element's assignments of elements from source variant.
Note:
In case when at least one element is already assigned in target variant and the same element is also present in source variant,
such api call will return Conflict response and nothing will be updated. |
| 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": "ignored variant name",
"description": "ignored variant description of variant",
"id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "Updated TestVariant4 name",
"description": "Updated description of the TestVariant4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
POST |
|