This page is under construction

Custom attribute Service

Bimplus DB

Team DB

 

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)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
  "name": "TestGroup",
  "description": "Test group",
  "parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}

Status: 201 Created

{
  "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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

 [
    {
        "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.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
    "name": "Engineering Attributes",
    "description": ""
}

Update the project
Resource: projects/<project_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure: 

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the project

shortDescr

optional

string

Short description of the project

created

will be ignored

string (date)

Creation date of the project

changed

will be ignored

string (date)

Changed date of the project

 PUT
 Update or replace a specified existing project with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}

Status: 200 OK