Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Deck of Cards
idbimGetBimAttributeGroup
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/freeattributegroups

URLhttps://api-stage.bimplus.net/v2/content/freeattributegroups/<attributegroup_id>

Examplehttps://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8

Card
labelHTTP Method
 GET
Card
labelDescription
 Get the info about a particular free attribute group and its sub-groups(hierarchy) It doesn't return the free attributes under this group.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
    "name": "Engineering Attributes",
    "description": ""
}

Anchor
updateProjectupdateBimAttributeGroupupdateProject
updateBimAttributeGroup

Update

...

a particular free attribute group
Deck of Cards
idbimUpdateProjectbimUpdateBimAttributeGroup
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource:  projectscontent/<project_id>freeattributegroups

URLhttps://api-stage.bimplus.net/v2/<team_slug>content/projectsfreeattributegroups/<project_id><id>

Example:   https://api-stage.bimplus.net/v2/bimpluscontent/projectsfreeattributegroups/0d2ce2ccb03b5eb0-358858f0-45d640a7-a59a95fb-f6b89ebed34ecb36b6f14cc8

JSON Structure: 

Name

Mandatory / Optional

Type

Description

name

optionalmandatory

string

Name of the projectattribute group

shortDescrdescription

optional

string

Short description of the projectattribute group

createdid

will be ignored

string (dateguid)

Creation date Id of the project

changed

will be ignored

string (date)

Changed date of the project

free attribute group

Card
labelHTTP Method
 PUT
Card
labelDescription
 Update or replace a specified existing project with a new one.a particular free attribute group. It is also possible to move the group as a sub-group of another group by changing its parent
Card
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "propertiesdescription": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH"updated description"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
            "phone1"name": "089/12793-1115Engineering Attributes",
            "phone2description": "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"
        }
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
updated description"
}