Page History

...

Deck of Cards

id	bimCreateTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the attribute template
description	optional	string	Short description of the attribute template
freeattributes	mandatoryoptional	JSON Array	List of free attribute idsattributes directly under this template ( in create, only IDs of those attributes are required )
elementtypes	mandatory	JSON Array	List of element type ids

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attribute template using free attributes & element types.

to which the template will be assigned. At least one element type is mandatory.
groups	optional	JSON Array	Sub-groups of attributes
created	will be ignored	string ( Date )	Creation date
createdBy	will be ignored	JSON ( User )	User who created the template
changed	will be ignored	string ( Date )	Date of last modification
changedBy	will be ignored	JSON ( User )	User who did the modification

The property "groups" has following JSON structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the group
description	optional	string	Group description
freeattributes	optional	Json Array	List of free attributes directly under this group ( in create, only IDs of those attributes are required )
groups	optional	Json Array	List of subgroups of this group.

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attribute template using free attributes & element types. For both free attributes and element types, it is enough to specify just their IDs in the request, the rest of the data will be loaded automatically from the database, and returned in the response.

Free attributes may be directly under the template, or you could use the "groups" property to create a logical hierarchy of attributes in groups.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "id": "10074EEF-9418-4D64-9C6D-23932835A7F1"
    }
  ],
  "groups": [
    {
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "id": "06124729-2778-4c16-98d1-9d89e760b195"
        }
      ]

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "Attribute Template 1",
  "description": "Testing template",
  "freeattributes": [
    {
      "Id": "5EED7275-0B0D-41D5-A13E-0C1C1FA87B33"
    },
    {
      "Idname": "67900FFF-A744-4EA3-A0DC-4140E424B756"
Group 2",
       },
"groups": [
        {
          "Idname": "B5850E23-B1DF-4D4F-AAE8-CEE0D4BB06E6"
SubGroup 3",
           }
  ]"description": "Some sub group",
  "elementtypes        "freeattributes": [
            {
              "id": "F18DE608665b0658-0F7Fe64f-40E34ce2-A0F7-8088778D18CB"91b2-c5d152b177d5"
            }
          ]
    },
    {}
      "id": "F8E1D9E3-82C0-4F14-8337-7FE568117616"]
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "Attribute Template 1",
  "description": "Testing template",
  "elementtypes": [
    {
      "type": "not implemented",
      "category": "/7/1/10/",
      "name": "ID_Wandobjekte",
      "ifcType": "ID_IFCWallMy attribute template",
      "iddescription": "f8e1d9e3-82c0-4f14-8337-7fe568117616"Attribute template for Walls",
    },"elementtypes": [
    {
      "type": "not implementedWall",
      "category": "/1/10/1/",
      "name": "ID_HallArchWall",
      "ifcType": null"ID_IFCWallStandardCase",
      "id": "f18de60810074eef-0f7f9418-40e34d64-a0f79c6d-8088778d18cb23932835a7f1"
    }
  ],
  "freeattributesgroups": [
    {
      "typeid": "double960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
      "minvaluename": "0Group 1",
      "decimaldescription": 2"One of the top groups",
      "unitidfreeattributes": "f99f40cf-da64-4c4f-8434-cb90722ba485",
 [
        {
          "unittype": "mm",
string",
          "visibledecimal": 10,
          "changeable": 10,
      "controltype": "TextBox",
      "id": "b5850e2306124729-b1df2778-4d4f4c16-aae898d1-cee0d4bb06e69d89e760b195",
          "name": "bend radiusFireRating",
          "description": ""bend
 diameter for reinforcement bars"
    },
    {
  ]
    "type": "double"},
      "decimal": 2,{
      "unitidid": "3b871b650f2ff22f-516e070d-4e7e4bbd-a35fa67d-faa7501d5d0dd2f47f1737ee",
      "unitname": "kgGroup 2",
      "visiblegroups": 1,[
      "changeable": 1,
  {
          "controltypeid": "TextBoxe3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",

          "idname": "5eed7275-0b0d-41d5-a13e-0c1c1fa87b33SubGroup 3",
          "namedescription": "doubleSome sub valuegroup",
          "descriptionfreeattributes": ""[
    },
        {
              "type": "int",
       "minvalue": "1",
      "maxvaluedecimal": "1000"0,
      "defaultvalue": "1",
        "decimalchangeable": 0,
              "unitidid": "f99f40cf665b0658-da64e64f-4c4f4ce2-843491b2-cb90722ba485c5d152b177d5",
       "unit": "mm",
      "optionalunitname": "milimeterLoadBearing",
       "visible": 1,
      "changeabledescription": 1,
 ""
           "controltype": "textbox",
 }
         "id": "67900fff-a744-4ea3-a0dc-4140e424b756",
 ]
       "name": "NewFreeAttribute1_G2", }
      "description": "Test attribute"]
    }
  ],
  "created": "20152016-0402-23T0512T07:4221:5233.9143",
  "createdby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "sslacky@nemetschektest@nemetschek.com"
  },
  "id": "3e5c096449d13da3-8f282acf-469b4f0b-b176b667-bcfad48f2eef40fc0197585f"
}

Anchor

	getTeamTemplates
	getTeamTemplates

...

Deck of Cards

id	bimGetTeamTemplates

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates

Card

label	HTTP Method

GET

Card

label	Description

Get all the attribute templates that belongs to a team..

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Request

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

	JSON

[
  {
    "name": "My attribute template",
    "description": "Attribute template for Walls",
    "elementtypes": [
      {
        "type": "Wall",
        "category": "/1/10/1/",
        "name": "ID_ArchWall",
        "ifcType": "ID_IFCWallStandardCase",
        "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
      }
    ],
    "groups": [
      {
        "id": "960005e0-c24b-44c1-a4e7-cc2d7316c1f3",

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "name": "TemplateGroup 1",
        "createddescription": "2015-10-27T09:22:13.27One of the top groups",
        "createdbyfreeattributes": [
          {
            "idtype": "71e0ac3b-fa49-e540-ac2f-8caff3dd72edstring",
            "emaildecimal": "jayaraj.purushothaman@gmail.com"0,
        },
        "changedchangeable": "2015-10-27T09:32:05.27"0,
            "changedbyid": {"06124729-2778-4c16-98d1-9d89e760b195",
            "idname": "71e0ac3b-fa49-e540-ac2f-8caff3dd72edFireRating",
            "emaildescription": "jayaraj.purushothaman@gmail.com"
          },
        ]
  "id": "511f1724-3848-49a2-8b21-77180b61edc0"    },
    }
]

...

Get the info about a particular attribute template

Deck of Cards

id	bimGetBimTemplateInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

URL: https://api-stage.bimplus.net/v2/<team_slug>/attributetemplates/<template_id>

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Attribute Template 1",
    "description": "Testing template",
    "elementtypes": [
  {
        "id": "0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
        "name": "Group 2",
        "groups": [
          {
            "id": "e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
            "name": "SubGroup 3",
            "description": "Some sub group",
            "freeattributes": {[
            "type": "not implemented",{
                "categorytype": "/7/1/10/int",

                "namedecimal": "ID_Wandobjekte"0,
                "ifcTypechangeable": "ID_IFCWall"0,
                "id": "f8e1d9e3665b0658-82c0e64f-4f144ce2-833791b2-7fe568117616c5d152b177d5",
        },
        {"name": "LoadBearing",
                "typedescription": "not implemented",
             "category": "/", }
            "name": "ID_Hall",]
          }
  "ifcType": null,
     ]
       "id": "f18de608-0f7f-40e3-a0f7-8088778d18cb"}
    ],
    }
    ]"created": "2016-02-12T07:21:33.43",
    "freeattributescreatedby": [{
      "id":  {
"7c555899-5a5f-44d1-930e-284930678bed",
      "email": "test@nemetschek.com"
    },
    "typeid": "double",49d13da3-2acf-4f0b-b667-40fc0197585f"
  },
  ...
]

Anchor

	getBimTemplateInfo
	getBimTemplateInfo

Get the info about a particular attribute template

Deck of Cards

id	bimGetBimTemplateInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

URL: https://api-stage.bimplus.net/v2/<team_slug>/attributetemplates/<template_id>

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
          "minvalue": "0",
            "decimal": 2,
            "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
            "unit": "mm",
            "visible": 1,
            "changeable": 1,
            "controltype": "TextBox",
            "idtype": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6Wall",
      "category": "/1/10/1/",
      "name": "bend radiusID_ArchWall",
      "ifcType": "ID_IFCWallStandardCase",
      "descriptionid": "bend diameter for reinforcement bars10074eef-9418-4d64-9c6d-23932835a7f1"
    }
    }],
    "groups": [
    {
            "typeid": "double960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
            "decimalname": 2"Group 1",
            "unitiddescription": "3b871b65-516e-4e7e-a35f-faa7501d5d0dOne of the top groups",
      "freeattributes": [
     "unit": "kg",
  {
          "visibletype": 1"string",
            "changeabledecimal": 10,
            "controltypechangeable": "TextBox"0,
            "id": "5eed727506124729-0b0d2778-41d54c16-a13e98d1-0c1c1fa87b339d89e760b195",
            "name": "double valueFireRating",
            "description": ""
        },
      ]
  {
  },
    {
      "typeid": "int0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
      "name": "Group 2",
      "minvaluegroups": "1",[
        {
          "maxvalueid": "1000e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
            "defaultvaluename": "1SubGroup 3",
            "decimaldescription": 0"Some sub group",
            "unitidfreeattributes": "f99f40cf-da64-4c4f-8434-cb90722ba485",
[
            {
 "unit": "mm",
            "optionalunittype": "milimeterint",
              "visibledecimal": 10,
              "changeable": 10,
              "controltypeid": "textbox665b0658-e64f-4ce2-91b2-c5d152b177d5",
              "idname": "67900fff-a744-4ea3-a0dc-4140e424b756LoadBearing",
              "namedescription": "NewFreeAttribute1_G2",
            }
       "description": "Test attribute"   ]
        }
      ],
    }
  ],
  "created": "20152016-0402-23T0512T07:4221:5233.9143",
    "createdby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschektest@nemetschek.com"
    },
    "changed": "20152016-0402-23T0512T07:4222:5251.9102",
    "changedby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschektest@nemetschek.com"
    },
    "id": "3e5c096449d13da3-8f282acf-469b4f0b-b176b667-bcfad48f2eef40fc0197585f"
}

Anchor

	updateTeamTemplate
	updateTeamTemplate

...

Deck of Cards

id	updateTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	Id of the template
name	will be ignored	string	Name of the attribute template
description	optional	string	Short description of the attribute template
freeattributes	optional	JSON Array	List of free attribute ids
elementtypes	optional	JSON Array	List of element type ids

-b176-bcfad48f2eef

JSON Structure: See Create attribute template

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "descriptionname": "updated description"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "nameMy attribute template updated",
  "description": "Attribute Template 1",
    "description": "updated descriptiontemplate for Walls",
    "elementtypes": [
        {
      "id": "10074EEF-9418-4D64-9C6D-23932835A7F1"
     "type": "not implemented"}
  ],
  "groups": [
    {
      "categoryname": "/7/1/10/Group 1",
      "description": "One of the top  "name": "ID_Wandobjekte"groups",
      "freeattributes": [
     "ifcType": "ID_IFCWall",
  {
          "id": "f8e1d9e306124729-82c02778-4f144c16-833798d1-7fe5681176169d89e760b195"
        },
        {]
            "type": "not implemented"},
      {
      "categoryname": "/Group 2",
            "name"groups": "ID_Hall",[
            "ifcType": null,
  {
          "idname": "f18de608-0f7f-40e3-a0f7-8088778d18cb"SubGroup 3",
        }
    ],
  "description": "Some sub group",
          "freeattributes": [
            {
              "typeid": "double",
665b0658-e64f-4ce2-91b2-c5d152b177d5"
            }
    "minvalue": "0",
     ]
       "decimal": 2,
 }
      ]
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "unitidname": "f99f40cf-da64-4c4f-8434-cb90722ba485My attribute template updated",
            "unitdescription": "mmAttribute template for Walls",
            "visible"elementtypes": 1,[
      {
      "changeabletype": 1"Wall",
            "controltypecategory": "TextBox/1/10/1/",
            "idname": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6ID_ArchWall",
            "nameifcType": "bend radiusID_IFCWallStandardCase",
            "descriptionid": "bend diameter for reinforcement bars10074eef-9418-4d64-9c6d-23932835a7f1"
    }
    }],
    "groups": [
    {
            "typeid": "double960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
            "decimal"name": "Group 21",
      "description": "One of the   "unitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d"top groups",
      "freeattributes": [
     "unit": "kg",
  {
          "visibletype": 1"string",
            "changeabledecimal": 10,
            "controltypechangeable": "TextBox"0,
            "id": "5eed727506124729-0b0d2778-41d54c16-a13e98d1-0c1c1fa87b339d89e760b195",
            "name": "double value"FireRating",
            "description": ""
        },
      ]
  {
  },
    {
      "typeid": "int0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
      "name": "Group 2",
      "minvaluegroups": "1",
[
        {
          "maxvalueid": "1000e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
            "defaultvaluename": "1SubGroup 3",
            "decimaldescription": 0 "Some sub group",
            "unitidfreeattributes": "f99f40cf-da64-4c4f-8434-cb90722ba485",[
            "unit": "mm",
{
              "optionalunittype": "milimeterint",
              "visibledecimal": 10,
              "changeable": 10,

              "controltypeid": "textbox665b0658-e64f-4ce2-91b2-c5d152b177d5",
              "idname": "67900fff-a744-4ea3-a0dc-4140e424b756LoadBearing",
              "namedescription": "NewFreeAttribute1_G2",
            "description": "Test attribute"}
          ]
        }
      ],
    }
  ],
  "created": "20152016-0402-23T0512T07:4221:5233.9143",
    "createdby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschektest@nemetschek.com"
    },
    "changed": "20152016-0402-23T0512T07:4222:5251.9102",
    "changedby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschektest@nemetschek.com"
    },
    "id": "3e5c096449d13da3-8f282acf-469b4f0b-b176b667-bcfad48f2eef40fc0197585f"
}

Anchor

	deleteTeamTemplate
	deleteTeamTemplate

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 47

New Version 48

Key

Get the info about a particular attribute template

Get the info about a particular attribute template