...
| Section |
|---|
| Column |
|---|
| Structure Service
- Create a new structure in a project
- Get the structure details
- Create a sub-node under the structure
- Get the structure topology
- Assign an object to the latest/last structure node
- Update the structure
- Delete the structure
- Get the structure list from a project
- Delete all the structures from a project
- Get the topology of all structures belonging to a project
|
|
...
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| Resource: hyperlink/<hyperlink_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id> Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea |
| Card |
|---|
| | Deletes a specified hyperlink. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| structureService |
|---|
| structureService |
|---|
|
Structure Service
...
A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service
| Anchor |
|---|
| createStructure |
|---|
| createStructure |
|---|
|
Create a new structure in a project
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: projects/<project_id>/structures URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/structures |
| Card |
|---|
| | Create a new structure(eg: cost structure, specification structure) under a project |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"projectId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
| Anchor |
|---|
| authorizationService |
|---|
| authorizationService |
|---|
|
...