...
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 |
|---|
|
...
| 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 JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
parentId | mandatory | string(guid) | Parent node id of the structure (for the first structure, projectId is the parentId) | name | mandatory | string | Name of the structure | description | optional | string | Description of the structure | | type | optional | string | Type of the structure (eg: costStructure, specificationStructure) | | nr | will be ignored | integer | The index of the structure | | color | optional | integer | Color of the structure | | id | will be ignored | string(guid) | Unique guid of the structure | | startDate | optional | string (date) | Start date ( depends on type of structure ) | | endDate | optional | string (date) | End date ( depends on type of structure ) |
| card | | | POST |
| Card |
|---|
| | Create a new 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": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure"
} |
|
| optional | string(guid) | Free attribute Id.
When this value is set, the corresponding attribute must have a suitable controlType
to define set of structures to be created. At a moment is supported only controlType "Enumeration",
for all other controlType-s is returned status 404 Not found. | | variantType | optional | string(guid) | Variant Type Id to whom the object will be assigned.
Used only when attributeId is defined. |
|
| Card |
|---|
| Create a new structure(eg: cost structure, specification structure) under a project. NOTE :
When is defined attributeId of attribute with controlType "Enumeration" will be created structure hierarchy.
The structure will be created under parent element (structure or project) together with its child structures.
Child structures will be created according enumDefinition (enumeration list) of attribute (defined by attributeId). |
| Card |
|---|
| | Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | StatusHeaders |
|---|
| Status Authorization: 201BimPlus Created
9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| A) Sample to create single structure:
{
"parentId": "622272da3904db18-f1ffcf1a-45ab4665-a3f09c2b-c8f1255c80e8152b84293259",
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
}
"nr": 1,
"color": 0,B) Sample to create structure hierarchy:
{
"idparentId": "179439d63904db18-df16cf1a-41cc4665-bd2c9c2b-74d05b7995d5152b84293259",
"name": "Status structure",
"attributeId": "02bbe8de-c623-489f-9baa-87f8ff3205f2",
"description": "Status of the project (enumeration)"
}
|
|
|
...
...
...
Get the structure details
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| A) Sample to create single structure:
{
"parentId": "3904db18-cf1a-4665-9c2b-152b84293259",
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
B) Sample to create structure hierarchy:
{
"projectId": "3904db18-cf1a-4665-9c2b-152b84293259",
"name": "Status structure",
"description": "Status of the project (enumeration)",
"type": "mainStructure2",
|
|
|
| Deck of Cards |
|---|
|
| Card |
|---|
| | Get details of a specified structure. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 10,
"colorid": 0"ee209608-19b1-40da-a089-53b20a858d41",
"idstructuretypeid": "179439d614c1ca64-df164001-41cc438f-bd2ca2f6-74d05b7995d577ca951c488d"
} |
|
|
...
Create a sub-node under the structure
| Deck of Cards |
|---|
|
| 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 | mandatory | string(guid) | Parent node id of the structure (the id specified in the resource url) |
name | mandatory | string | Name of the structure |
description | optional | string | Description of the structure |
| type | optional | string | Type of the structure (eg: costStructure, specificationStructure) |
| nr | will be ignored | integer | The index of the structure |
| color | optional | integer | Color of the structure |
| id | will be ignored | string(guid) | Unique guid of the structure |
| Card |
|---|
|
| Create a sub-node under a particular structure |
| 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": "Node 1"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
,
"children": [
{
"structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d",
"children": [],
"elements": [],
"parentId": "ee209608-19b1-40da-a089-53b20a858d41",
"name": "Undefined",
"description": "0",
"type": "mainStructure2",
"nr": 0,
"id": "40da49c5-3f3a-4e12-a4f8-94fb829c7c1e"
},
{
"structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d",
"children": [],
"elements": [],
"parentId": "ee209608-19b1-40da-a089-53b20a858d41",
"name": "Nodein planning 1stage",
"typedescription": "TopologyStructure1",
"nrtype": 1"mainStructure2",
"colornr": 0,
"id": "adf506aeecf9c518-36281e24-45014706-9af18557-22bcf27e4ab4d29d75fb7ddc"
} },
......
],
"elements": []
} |
|
| Anchor |
|---|
| getStructureDetails |
|---|
| getStructureDetails |
|---|
|
| Anchor |
|---|
| getStructureTopology | getStructureTopology |
|
Get the structure
...
details
| Deck of Cards |
|---|
| id | bimGetStructureTopologybimGetStructureDetails |
|---|
|
| Card |
|---|
| | Get details of a specified structure. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parentname": null"TestStructure",
"namedescription": "TestStructureFullLifeCycleTest",
"type": "StructureCostStructure",
"childrennr": [1,
{"color": 0,
"parent"id": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
]
} |
|
|
| Anchor |
|---|
| createSubStructure |
|---|
| createSubStructure |
|---|
|
Create a sub-node under the structure
| Deck of Cards |
|---|
|
| Card |
|---|
| | Create a sub-node under a particular structure |
| 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": "Node 1"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "TopologyStructure",
"nr": 1,
"color": 0,
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
} |
|
|
| Anchor |
|---|
| getStructureTopology |
|---|
| getStructureTopology |
|---|
|
Get the structure topology
| Deck of Cards |
|---|
| id | bimGetStructureTopology |
|---|
|
| Card |
|---|
| | Get details of a specified structure. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parent": null,
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
| Anchor |
|---|
| putReorderStructure |
|---|
| putReorderStructure |
|---|
|
Reorder the structure
| Deck of Cards |
|---|
| id | bimGetStructureTopology |
|---|
|
| Card |
|---|
| | Reorder the structure for specified variant type. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parent": null,
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
| Anchor |
|---|
| assignStructure |
|---|
| assignStructure |
|---|
|
Assign an object to the latest/last structure node
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: structures/<structure_id>/assign/<object_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/assign/<object_id> Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
color | optional | string(guid) | The id of the last node to which an object will be assigned | objectId | will be ignored | string(guid) | The id of the object to whom a structure will be assigned | name | mandatory | string | The name of the structure-object connection | | nr | will be ignored | integer | The index of the structure-object connection | | id | will be ignored | string(guid) | Unique guid of the structure-object connection | | variantType | optional | string(guid) | Variant Type Id to whom the object will be assigned | | IfcGloballyUniqueId | optional | string | IFC globally unique ID |
|
| Card |
|---|
| Assign an object to the latest/last structure node
Note : Works with two different inputs - Object ID is present in the url - this object ID is used
- Object ID is not present, but content json contains IfcGloballyUniqueId - a corresponding Bimplus object is found and used as input object ID
- if this IFC id is not found -> return "404 Not Found", if present multiple times -> return "409 Conflict"
|
| 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": "WallConnection",
"variantType" : "35b986c2-e9cd-482e-9281-6000671a49f0"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
"name": "WallConnection",
"nr": 1,
"id": "35b986c2-e9cd-482e-9281-6000671a49f0"
} |
|
|
| Anchor |
|---|
| assignAdditionalObjects |
|---|
| assignAdditionalObjects |
|---|
|
Assign additional objects to the latest structureElement node
| Deck of Cards |
|---|
| id | bimAssignAdditionalObjects |
|---|
|
| Card |
|---|
| {
"structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
"name": "WallConnection",
"nr": 1,
"id": "35b986c2-e9cd-482e-9281-6000671a49f0", "variantType" : "35b986c2-e9cd-482e-9281-6000671a49f0" } |
|
| Anchor |
|---|
| assignProjectElements |
|---|
| assignProjectElements |
|---|
|
Assign a project element(s) into existing hierarchy structure
| Deck of Cards |
|---|
| id | bimAssignProjectElements |
|---|
|
| Card |
|---|
| Assign a project element(s) into existing hierarchy structure according attribute value of element
(i.e. structure hierarchy description is identical to free attribute value) |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"attributeId": "8ef4d2fd-8959-4aa1-8da9-3e238b1c7705",
"variantType": "d120adc6-8382-4a0c-9638-a0d246590ed3"
}
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
Function ended OK and minimal one project element was assigned to structure node
Status: 204 NoContent
Function ended OK, but no project element was assigned to structure node (i.e. no project element with requested free attribute was found) |
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"structuretypeid": "512b5bcd-619d-4ef5-9644-7fe5d783b73a",
"children": [
{
"structuretypeid": "512b5bcd-619d-4ef5-9644-7fe5d783b73a",
"children": [],
"elements": [
{
"structureId": "f0ebc65f-6ddc-4fa3-8f02-2911665adee4",
"objectId": "72bd0a48-f0e8-4385-9d95-f242d42deb60",
"name": "Basic Wall:Standard 20.0:491928",
"nr": 0,
"id": "23ee744f-0cca-4e39-adcd-e91396ad10ea"
},
{
"structureId": "f0ebc65f-6ddc-4fa3-8f02-2911665adee4",
"objectId": "228b0d93-f3fd-433a-9242-c4dbfe806b53",
"name": "Basic Wall:Standard 20.0:491025",
"nr": 0,
"id": "c2586c7a-5b61-456a-ba84-c27ffe0976d6"
}
],
"parentId": "653afdf7-7cfb-42e5-a9b5-e99275ce5cf4",
"name": "Subnode3",
"description": "TestStrukturyPreAtributy1",
"type": "FreeAttrTestStructure",
"nr": 4,
"color": 0,
"disableElementAssignment": false,
"id": "f0ebc65f-6ddc-4fa3-8f02-2911665adee4"
}
],
"elements": [],
"projectId": "3904db18-cf1a-4665-9c2b-152b84293259",
"name": "FreeAttrStructure",
"description": "MainNode",
"type": "FreeAttrTestStructure",
"nr": 1,
"color": 0,
"disableElementAssignment": false,
"id": "653afdf7-7cfb-42e5-a9b5-e99275ce5cf4"
} |
|
|
| Anchor |
|---|
| removeAssignedObject |
|---|
| removeAssignedObject |
|---|
|
Remove assigned object from the latest structureElement node
| Deck of Cards |
|---|
| id | bimRemoveAssignedObject |
|---|
|
|
| Anchor |
|---|
| copyStructure |
|---|
| copyStructure |
|---|
|
Copy Structure
| Anchor |
|---|
| updateStructure |
|---|
| updateStructure |
|---|
|
Update the structure
| Deck of Cards |
|---|
|
| 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 |
|
| Card |
|---|
| | Update the specified structure |
| 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": "Updated Structure"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "Updated Structure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
| Anchor |
|---|
| assignStructuredeleteStructure | assignStructure |
|---|
|
...
Delete the structure
| Deck of Cards |
|---|
| id | bimassignStructurebimDeleteStructure |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| Resource: structures/<structure_ id>/assign/<object_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/assign/<object_id> Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6db540336-df1647a3-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f426e-b3bf-1e532bfac8ea JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
color | optional | string(guid) | The id of the last node to which an object will be assigned | objectId | will be ignored | string(guid) | The id of the object to whom a structure will be assigned | name | mandatory | string | The name of the structure-object connection | | nr | will be ignored | integer | The index of the structure-object connection | id | will be ignoredUnique guid Parent node id of the structure |
-object connectionvariantType(for the first structure, projectId is the parentId) | name | optional | string |
(guid)Variant Type Id to whom the object will be assigned | IfcGloballyUniqueId | Name of the structure | description | optional | string |
IFC globally unique ID | |
| Card |
|---|
|
|
Assign an object to the latest/last structure node
Note :
Works with two different inputs
Object ID is present in the url - this object ID is usedObject ID is not present, but content json contains IfcGloballyUniqueId - a corresponding Bimplus object is found and used as input object ID
- if this IFC id is not found -> return "404 Not Found", if present multiple times -> return "409 Conflict"
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 |
Optional query parameters | Name | Type | Default value | Description |
|---|
| forceDelete | string(boolean) | false | if true delete also all attachments which are under structure and are not lock, if under structure are locked document return 207 and delete just not locked document and structure. | | deleteAll | string (boolean) | false | if true delete also all attachments which are under structure and are not lock, if under structure are locked document return forbidden. |
|
| Card |
|---|
|
| Deletes a specified structure. |
| 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": "WallConnection",
"variantType" : "35b986c2-e9cd-482e-9281-6000671a49f0"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSONHeaders |
|---|
| {
Authorization: "structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
"name": "WallConnection",
"nr": 1,
"id": "35b986c2-e9cd-482e-9281-6000671a49f0"
} |
|
...
BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| downloadStructureAttachments |
|---|
| downloadStructureAttachments |
|---|
|
Download attachments of the structure
| Deck of Cards |
|---|
| id | bimDownloadStructureAttachments |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
|
|
...
| Deck of Cards |
|---|
| id | bimAssignAdditionalObjects |
|---|
|
| Card |
|---|
| | Resource: structures/<structure_id>/downloadattachments | Resource: structures/<structureElement_id>/assign/<object_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structureElement<structure_id>/assign/<object_id> downloadattachments Example: https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f |
| Card |
|---|
| {
"structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
"name": "WallConnection",
"nr": 1,
"id": "35b986c2-e9cd-482e-9281-6000671a49f0", "variantType" : "35b986c2-e9cd-482e-9281-6000671a49f0" } |
|
...
Remove assigned object from the latest structureElement node
...
| id | bimRemoveAssignedObject |
|---|
...
Resource: structures/<structureElement_id>/delete/<object_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structureElement_id>/delete/<object_id>
Example: https://api-stage.bimplus.net/v2/bimplus/structures/35b986c2-e9cd-482e-9281-6000671a49f0/delete/df4a81d6-42fb-4187-bbce-82a2fc093b2f
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/zip
|
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
The response format is application/octet-stream. |
|
| Anchor |
|---|
| createVariant |
|---|
| createVariant |
|---|
|
Create a new variant type in a project
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
|
|
...
Copy Structure
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Url / Resource /Json |
|---|
| | Resource: projects/<project_id>/variants | Resource: structures/<structure_id>/copyURL: https://api-stage.bimplus.net/v2/<team_slug>/structuresprojects/<structure<project_id>/copyvariants Example:https://api-stage.bimplus.net/v2/bimplus/structuresprojects/35b986c2622272da-e9cdf1ff-482e45ab-9281a3f0-6000671a49f0c8f1255c80e8/copyvariants JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
| | | |
|---|
name | mandatory | string | Name of the |
new structure | | | | type | description | optional | string |
Type new structure (eg: costStructure, specificationStructure)nrvariant type | | id | will be ignored |
integer | The index of the new structure | | color | optional | integer | Color of the new structure | | id | will be ignored | string(guid) | Unique guid of the structure | | startDate | optional | string (date) | Start date ( depends on type of structure ) | | endDate | optional | string (date) | End date ( depends on type of structure ) | |
|
...
| string(guid) | Unique guid of the variant type |
|
| Card |
|---|
| | Create a new variant type 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 type",
"description": "Description of the Test variant type"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "TestVariant type",
"description": "Description of the Test variant type",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|
| Anchor |
|---|
| getVariantDetails |
|---|
| getVariantDetails |
|---|
|
Get the variant type details
...
Update the structure
| Deck of Cards |
|---|
|
| 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
| Card |
|---|
| | Update the specified structure Get details of a specified variant type. |
| 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": "Updated Structure"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON | JSON |
|---|
| {{
"parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "Updated Structure",
"descriptionname": "FullLifeCycleTestTestVariant type",
"typedescription": "CostStructure",
Description of the Test "nr": 1,
"color": 0,
variant type",
"id": "179439d6733e429a-df16e232-41cc4e5d-bd2ca41e-74d05b7995d59bd50aa9763c"
} |
|
|
| Anchor |
|---|
| deleteStructuregetVariantList | deleteStructure |
|---|
|
...
Get the list of existing variant types in the project
| Deck of Cards |
|---|
| id | bimDeleteStructurebimGetVariantList |
|---|
|
| Card |
|---|
| | Gets the list of existing variant types created in the project. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
|
DELETE | card | label | Description | | Deletes a specified structure. | | | Card |
|---|
| label | Request
| Code Block |
|---|
| borderColor | GreenRed |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|---|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
|
|
| 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 |
|
...
| [
{
"name": "TestVariantType1",
"description": "Description of the Test variant type 1",
"id": "6dc03014-8601-49fd-bae9-ef5b185603b6"
},
{
"name": "TestVariantType2",
"description": "Description of the Test variant type 2",
"id": "4c1fda6b-7fd9-42a7-a4ae-88eababd3082"
},
{
"name": "TestVariantType3",
"description": "Description of the Test variant type 3",
"id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
},
{
"name": "TestVariantType4",
"description": "Description of the Test variant type 4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}
] |
|
|
| Anchor |
|---|
| updateVariant |
|---|
| updateVariant |
|---|
|
Update the variant type
...
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 Update the specified variant type |
| 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": "TestVariantUpdated TestVariantType4 name",
"description": "DescriptionUpdated description of the Test variantTestVariantType4"
} |
|
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201200 CreatedOK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "TestVariantUpdated TestVariantType4 name",
"description": "DescriptionUpdated description of the TestTestVariant type variant4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|
| Anchor |
|---|
| getVariantDetailsdeleteVariantgetVariantDetails |
|---|
| deleteVariant |
|---|
|
...
Delete the variant
...
| Deck of Cards |
|---|
| id | bimGetVariantDetailsbimDeleteVariant |
|---|
|
| Card |
|---|
| | Get details of Deletes a specified variant type. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | RedGreen |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "TestVariant",
"description": "Description of the Test variant",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|
...
Copy content of source variant type to target variant type
| Deck of Cards |
|---|
| id | bimGetVariantListbimCopyVariant |
|---|
|
| Card |
|---|
| | Gets the list of existing variants inside a project. |
| | |
|---|
name | will be ignored | string | Name of the variant type | description | will be ignored | string | Description of the variant type | | id | mandatory | string(guid) | Unique guid of the source variant type |
| | Card |
|---|
| | Code Block |
|---|
| | borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
| Card |
|---|
Green | Updates the specified target variant type with all structure element's assignments of elements from source variant type.
When variant type id is missing will be used internally default variant type (Guid.Empty) as a source variant type Note:
In case when at least one element is already assigned in target variant type and the same element is also present in source variant type,
such api call will return Conflict response and target variant type will not 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 |
|---|
| | lang | xml |
|---|
| title | Status |
|---|
Status: 200 OK
| | Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| [
{
"name": "TestVariant1",
"description": "Description of the Test variant 1",
"id": "6dc03014-8601-49fd-bae9-ef5b185603b6"
},
{
"name": "TestVariant2",
"description": "Description of the Test variant 2",
"id": "4c1fda6b-7fd9-42a7-a4ae-88eababd3082"
},
{
"name": "TestVariant3ignored variant type name",
"description": "Descriptionignored description of the Test variant 3type",
"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": "TestVariant4Updated TestVariantType4 name",
"description": "DescriptionUpdated description of the TestTestVariant varianttype 4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}
] |
|
|