This page is under construction
Custom attribute Service
Bimplus DB
- Create a free attribute group
- Get all the free attribute groups
- Get the info about a particular free attribute group
- Update a particular free attribute group
- Delete a particular free attribute group
- Create a free attribute under a particular attribute group or as stand-alone
- Get all the free attributes
- Get all the free attributes under a attribute group
- Get the info about a particular free attribute
- Update a particular free attribute
Team DB
- Create a free attribute group
- Get the info about a particular free attribute group
- Update a particular free attribute group
- Delete a particular free attribute group
- Create a free attribute under a particular attribute group or as stand-alone
- Get the info about a particular free attribute
- Update a particular free attribute
Custom attribute Service
Using these services, custom property groups & its associated properties can be created.
Create a new custom group in Bimplus DB
Resource: content/freeattributegroups
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the attribute group |
description |
optional |
string |
Short description of the attribute group |
parent |
optional |
string (guid) |
Parent attribute group. If not specified, then the created group is a stand-alone group |
POST
Creates a new custom attribute group. The created group could be either stand-alone ( parent not specified ), or created inside another group (the id of the parent has to be specified)
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "TestGroup",
"description": "Test group",
"parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}
Status
Status: 201 Created
JSON
{
"id": "da9c6db5-92fa-473d-9282-483c40907a95",
"name": "TestGroup",
"description": "Test group",
"parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}
Get all the free attribute groups from the Bimplus DB
Resource: content/freeattributegroups
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups
GET
Get all the free attribute groups from the Bimplus DB
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
[
{
"id": "81a39304-9d4a-4e8d-826e-7736b9350562",
"name": "ALLFA Attributes",
"description": ""
},
{
"id": "e6b44081-8983-4c07-b1a7-2c43bc199927",
"name": "Allplan Attributes",
"description": ""
},
{
"id": "af12dda5-dafe-4b05-adeb-638617cc6907",
"name": "BaseQuantities",
"description": ""
},
{
"children": [
{
"parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
"id": "170820da-de29-437a-aa97-f7984a319890",
"name": "Element",
"description": "tabAttribbElement"
},
{
"parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
"id": "af946941-5a14-4c6a-be9f-424ca59b10b5",
"name": "Element State",
"description": "tabAttribbElementState"
},
{
"parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
"id": "0f6906f2-305d-4899-979a-6ce1e49af6a9",
"name": "General",
"description": "tabAttribGeneral"
},
{
"parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
"id": "66c2ba5e-8a70-40b8-9918-fccd1663f3bb",
"name": "IFC",
"description": "tabAttribIFC"
}
],
"id": "073245c3-6ed4-40a0-9146-ecd1eb111500",
"name": "Bimplus Property Sets",
"description": ""
},
{
"id": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
"name": "Building Attribute",
"description": ""
},
{
"id": "1b567ec2-4a10-43ba-b791-45f288866808",
"name": "CostPlanning",
"description": "DIN276"
},
{
"id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"name": "Engineering Attributes",
"description": ""
},
{
"id": "1d9b883c-ecf5-4b91-b6a0-adea66432f6c",
"name": "Identity Data",
"description": ""
},
{
"children": [
{
"parent": "99b99afa-abed-4a9e-99be-f2d3a2cb29de",
"id": "6f496c13-e153-4ebd-8662-f00fe3e81e20",
"name": "Pset_StairCommon",
"description": ""
}
],
"id": "99b99afa-abed-4a9e-99be-f2d3a2cb29de",
"name": "IFC",
"description": ""
},
{
"id": "cf83b687-b7ff-466b-9c15-853488455c5b",
"name": "MEP Attribute",
"description": ""
},
{
"id": "969df3d1-5e79-4eea-aca9-5758d0026b39",
"name": "Pset_[EType]Common",
"description": ""
},
{
"id": "431754db-32e6-4fc4-b252-a647b94aa5a8",
"name": "Space Attributes",
"description": ""
}
]
Get the info about a particular free attribute group
Resource: content/freeattributegroups
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<attributegroup_id>
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8
GET
Get the info about a particular free attribute group and its sub-groups(hierarchy) It doesn't return the free attributes under this group.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
{
"id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"name": "Engineering Attributes",
"description": ""
}
Update a particular free attribute group
Resource: content/freeattributegroups
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<id>
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the attribute group |
description |
optional |
string |
Short description of the attribute group |
id |
will be ignored |
string (guid) |
Id of the free attribute group |
PUT
Update a particular free attribute group. It is also possible to move the group as a sub-group of another group by changing its parent
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"description": "updated description"
}
Status
Status: 200 OK
JSON
{
"id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"name": "Engineering Attributes",
"description": "updated description"
}
Delete a particular free attribute group
Resource: content/freeattributegroups
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<id>
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8
DELETE
Deletes a specified attribute group.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
Create a free attribute under a particular attribute group or as stand-alone
Resource: content/freeattributes
URL: https://api-stage.bimplus.net/v2/content/freeattributes
Example: https://api-stage.bimplus.net/v2/content/freeattributes
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the attribute |
description |
optional |
string |
Short description of the attribute |
type |
mandatory |
string |
Type of free attributes. It could be one of the following: "int", "double", "string", "guid", "datetime", "binary" |
| minvalue | optional | string(numbers) | Minimum value constraint of the attribute |
| maxvalue | optional | string(numbers) | Maximum value constraint of the attribute |
| defaultvalue | optional | string(numbers) | Default value of the attribute (if it's value is not specified) |
| decimal | optional | int | Number of decimals |
| unitid | optional | string(guid) | Id of the unit |
| optionalsymbol | optional | string(symbol) | Optional symbol |
| visible | optional | int | 0 or 1. It determines whether the attribute should be visible |
| changeable | optional | int | 0 or 1. It determines whether the attribute should be chnageable |
| controltype | optional | string | The control type (eg: "textbox") |
| symbol | will be ignored | string | Symbol of the unit |
| parent | optional | string(guid) | Id of the attribute group. If not specified, then the created attribute is a stand-alone one. |
POST
Creates a new custom attribute. The created attribute could be either stand-alone ( parent not specified ), or part of the custom attribute group (the id of the parent has to be specified)
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "NewFreeAttribute",
"description": "Test attribute",
"type": "int",
"minvalue" : "1",
"maxvalue" : "1000",
"defaultvalue" : "1",
"decimal" : "0",
"attribunitnameid" : "F99F40CF-DA64-4C4F-8434-CB90722BA485",
"optionalsymbol" : "$",
"visible" : "1",
"changeable" : "1",
"controltype" : "textbox",
"parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}
Status
Status: 201 Created
JSON
{
"freeattribtype": "int",
"minvalue": "1",
"maxvalue": "1000",
"defaultvalue": "1",
"decimal": 0,
"attribunitnameid": "f99f40cf-da64-4c4f-8434-cb90722ba485", --> unitId (we already know it is attribute)
"symbol": "mm",
"optionalsymbol": "$",
"visible": 1,
"changeable": 1,
"controltype": "textbox", --> The client should decide
"id": "d6cac39a-4b6e-473f-813f-87f7fb92d3fe",
"name": "NewFreeAttribute",
"description": "Test attribute",
"parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}
Get all the free attributes from the Bimplus DB
Resource: content/freeattributes
URL: https://api-stage.bimplus.net/v2/content/freeattributes
Example: https://api-stage.bimplus.net/v2/content/freeattributes
GET
Get all the free attributes from the Bimplus DB
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
[
{
"parent": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
"type": null,
"id": "8d3d9dd5-c998-465b-b13e-87901c90f3bc",
"name": "heat transfer coefficient"
},
{
"parent": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
"type": null,
"id": "a6645047-39ee-4c87-9fc3-14ccca0c50ac",
"name": "density"
},
{
"parent": "431754db-32e6-4fc4-b252-a647b94aa5a8",
"type": null,
"id": "8807e401-6e3c-4536-88e1-e834d4de745d",
"name": "floor area"
},
{
"parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"type": null,
"id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
"name": "bend radius"
},
.....
]
Get all the free attributes under a attribute group
Resource: freeattributes
URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<attributegroup_id>/freeattributes
Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8/freeattributes
GET
Get all the free attributes under a attribute group
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
[
{
"parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"type": "double",
"minvalue": "0",
"decimal": 2,
"unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
"unit": "mm",
"visible": 1,
"changeable": 0,
"controltype": "TextBox",
"id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
"name": "bend radius",
"description": "bend diameter for reinforcement bars"
},
{
"parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"type": "double",
"minvalue": "0",
"defaultvalue": "5",
"decimal": 2,
"unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
"unit": "mm",
"visible": 1,
"changeable": 0,
"controltype": "TextBox",
"id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
"name": "concrete cover",
"description": "the least distance between the surface of embedded reinforcement and the outer surface of the concrete"
},
{
"parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"type": "int",
"decimal": 0,
"visible": 1,
"changeable": 0,
"controltype": "TextBox",
"id": "1c838554-3692-4ed4-afaf-989a9e59252b",
"name": "SteelGrade",
"description": "Kurzbez. der Stahlgüte @495@"
},
{
"parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
"type": "int",
"decimal": 0,
"visible": 1,
"changeable": 0,
"controltype": "TextBox",
"id": "d7ab92f4-ddf1-404b-8875-57b25b8fe66a",
"name": "CrossSectionNumber",
"description": "Nummer der Querschnittsreihe @496@"
}
]
