...
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 Cardstab-group |
|---|
| iddeckId | bimcreateStructure |
|---|
|
| Cardtab |
|---|
| default | true |
|---|
| labeltitle | 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 |
| 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. |
|
| Tab |
|---|
| 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). |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| A) Sample to create single structure:
{
"parentId": "3904db18-cf1a-4665-9c2b-152b84293259",
|
| | 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"
} |
| | Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| }
B) Sample to create structure hierarchy:
{
"parentId": "622272da3904db18-f1ffcf1a-45ab4665-a3f09c2b-c8f1255c80e8152b84293259",
"name": "TestStructureStatus structure",
"descriptionattributeId": "FullLifeCycleTest"02bbe8de-c623-489f-9baa-87f8ff3205f2",
"typedescription": "CostStructure",
Status of the project "nr": 1,(enumeration)"
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
...
Get the structure details
| 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": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
} |
|
|
...
Create a sub-node under the structure
| Tab |
|---|
|
| 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",
"nr": 0,
"id": "ee209608-19b1-40da-a089-53b20a858d41",
"structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d",
"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",
|
|
|
| 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",
"name": "Nodein planning 1stage",
"typedescription": "TopologyStructure1",
"nrtype": 1"mainStructure2",
"colornr": 0,
"id": "adf506aeecf9c518-36281e24-45014706-9af1-22bcf27e4ab4"8557-d29d75fb7ddc"
},
......
],
"elements": []
} |
|
| Anchor |
|---|
| getStructureTopologygetStructureDetailsgetStructureTopology |
|---|
| getStructureDetails |
|---|
|
Get the structure
...
details
| Deck of Cardstab-group |
|---|
| iddeckId | bimGetStructureTopologybimGetStructureDetails |
|---|
|
| Cardtab |
|---|
| | Get details of a specified structure. |
| Cardtab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Cardtab |
|---|
|
| 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,
"parentid": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "
} |
|
|
| Anchor |
|---|
| createSubStructure |
|---|
| createSubStructure |
|---|
|
Create a sub-node under the structure
| Tab Group |
|---|
| deckId | bimcreateSubStructure |
|---|
|
|
...
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 |
|
| Tab |
|---|
| | Create a sub-node under a particular structure |
| Tab |
|---|
|
| 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"
} |
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
|
|
...
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 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"
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"nameparentId": "WallConnection"179439d6-df16-41cc-bd2c-74d05b7995d5",
"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 |
|---|
| {name": "Node 1",
"structureIdtype": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
TopologyStructure",
"objectIdnr": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"1,
"namecolor": "WallConnection",
"nr": 10,
"id": "35b986c2adf506ae-e9cd3628-482e4501-92819af1-6000671a49f022bcf27e4ab4"
} |
|
| Anchor |
|---|
| assignAdditionalObjectsgetStructureTopology | assignAdditionalObjects |
|---|
|
...
Get the structure topology
| Tab Group |
|---|
| deckId | bimGetStructureTopology |
|---|
|
| Tab |
|---|
| default | true |
|---|
| title | URL / Resource / JSON Structure |
|---|
| | Resource: structures/<structure_id>/topology?varianttype=<varianttype |
|
| Deck of Cards |
|---|
| id | bimAssignAdditionalObjects |
|---|
|
| Tab |
|---|
| | Get details of a specified structure. |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| { |
| | Card |
|---|
| {
"structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",name"WallConnection"nr1id35b986c2-e9cd-482e-9281-6000671a49f0variantType "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
[
{
"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
| Tab Group |
|---|
| deckId | bimGetStructureTopology |
|---|
|
| Tab |
|---|
| | Reorder the structure for specified variant type. |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Tab |
|---|
|
| 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
| Tab Group |
|---|
|
| Tab |
|---|
| default | true |
|---|
| title | 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 |
|
| Tab |
|---|
| 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"
|
| Tab |
|---|
|
| 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"
} |
|
| Tab |
|---|
|
| 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
| Tab Group |
|---|
| deckId | bimAssignAdditionalObjects |
|---|
|
| Tab |
|---|
| {
"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
| Tab Group |
|---|
| deckId | bimAssignProjectElements |
|---|
|
| Tab |
|---|
| 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) |
| Tab |
|---|
|
| 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"
}
|
|
| Tab |
|---|
|
| 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
| Tab Group |
|---|
| deckId | bimRemoveAssignedObject |
|---|
|
|
| Anchor |
|---|
| copyStructure |
|---|
| copyStructure |
|---|
|
Copy Structure
| Anchor |
|---|
| updateStructure |
|---|
| updateStructure |
|---|
|
Update the structure
| Tab Group |
|---|
|
| Tab |
|---|
| default | true |
|---|
| title | 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 |
|
| Tab |
|---|
| | Update the specified structure |
| Tab |
|---|
|
| 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"
} |
|
| Tab |
|---|
|
| 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 |
|---|
| deleteStructure |
|---|
| deleteStructure |
|---|
|
Delete the structure
| Tab Group |
|---|
|
| Tab |
|---|
| default | true |
|---|
| title | 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/db540336-47a3-426e-b3bf-1e532bfac8ea 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 |
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. |
|
| Tab |
|---|
| | Deletes a specified structure. |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| downloadStructureAttachments |
|---|
| downloadStructureAttachments |
|---|
|
Download attachments of the structure
| Tab Group |
|---|
| deckId | bimDownloadStructureAttachments |
|---|
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/zip
|
|
| Tab |
|---|
|
| 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
| Tab Group |
|---|
|
| Tab |
|---|
| | Create a new variant type of defined structure(eg: cost structure, specification structure) under a project |
| Tab |
|---|
|
| 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"
} |
|
| Tab |
|---|
|
| 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
| Tab Group |
|---|
| deckId | bimGetVariantDetails |
|---|
|
| Tab |
|---|
| | Get details of a specified variant type. |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| 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 |
|---|
| getVariantList |
|---|
| getVariantList |
|---|
|
Get the list of existing variant types in the project
| Tab Group |
|---|
|
| Tab |
|---|
| | Gets the list of existing variant types created in the project. |
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| [
{
"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
| Tab Group |
|---|
|
| Tab |
|---|
| default | true |
|---|
| title | URL / Resource / JSON Structure |
|---|
|
|
...
Copy Structure
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Url / Resource /Json |
|---|
| | Resource: projects/<project_id>/variants/<varianttype_id> | Resource: structures/<structure_id>/copyURL: https://api-stage.bimplus.net/v2/<team_slug>projects/<project_id>/structuresvariants/<structure<varianttype_id>/copy Example:https://api-stage.bimplus.net/v2/bimplus/structuresprojects/35b986c2622272da-e9cdf1ff-482e45ab-9281a3f0-6000671a49f0/copy c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
| | | mandatory | string | Name of the new structure | | | | | | 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 | optional | string | Name of the variant type | description | optional | string | Description of the variant type | | 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 ) | |
|
...
Update the structure
| Tab |
|---|
| | Update the specified variant type |
| Tab |
|---|
|
| 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 TestVariantType4 name"
"description": "Updated description of the TestVariantType4"
} |
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "Updated TestVariantType4 name",
"description": "Updated description of the TestVariant type 4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|
| Anchor |
|---|
| deleteVariant |
|---|
| deleteVariant |
|---|
|
Delete the variant
| Tab Group |
|---|
|
| Tab |
|---|
| | Deletes a specified variant type. |
|
| 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"
} |
|
| Cardtab |
|---|
|
| 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"
} |
|
|
...
Copy content of source variant type to target variant type
| Tab Group |
|---|
|
| Tab |
|---|
| 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. |
|
...
Delete the structure
| Deck of Cards |
|---|
|
| Card |
|---|
| | Deletes 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
|
|
|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "ignored variant type name",
"description": "ignored description of variant type",
"id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
} |
|
| Tab |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "Updated TestVariantType4 name",
"description": "Updated description of the TestVariant type 4",
"id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
} |
|
|
| 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