Page History

...

Deck of Cards

id	bimGetCatalogTypesList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/types

URL: https://api-stage.bimplus.net/v2/ catalogs/types

Example: https://api-stage.bimplus.net/v2/catalogs/types

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog type.
name	mandatory	string	Catalog type name
description	optional	string	Catalog type description

Card

label	HTTP Method

GET

Card

label	Description

Get a list of catalog types

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

[{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  ...
]

...

Deck of Cards

id	bimCreateCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

URL: https://api-stage.bimplus.net/v2/ catalogitems

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog item
name	mandatory	string	Catalog item name
description	optional	string	Catalog item description
catalogId	mandatory	string	Catalog id. Newly created catalog item belongs to this catalog
properties	optional	object(dictionary)	Object which contains pairs of all parameter values for catalog item. Value in pair represent attribute value of the attribute with Id specified as key in pair.
diagram	optional	object	Object which includes data for custom table (sigma-epsilon diagram )

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog item to the specified catalog.

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

{
    "catalogId": "2d116846ae2122c0-5f7cf667-a780f242-3a8240ee-6dd8150989df3e57161e433a",
    "properties": {
        "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4": "1.2e1e-05",
        "029ca99d-d590-3f36-60ad-c2f8538b6bf4": "No",
        "9df611ca4fd9b113-c5474e9f-e0ab22e5-459562ab-8a017a383592eb099fb0836f":210000000000 "Bi-linear stress-strain diagram",
        "ca5d193dbb88f378-c7c8a30c-be57de7c-a244a70b-e7d751a678246522c917bd3f":80769200000,
 "slow",
        "ceb34ade71164ead-8a26883b-f9a5a610-b3ea61d0-f247486a1778c32e8caa5cfa":7850 "Quartzite",
        "52941ec911f347c7-f1254ebf-d765fe22-aaca5285-07c7a3e869971edeb916c0de":0.3 32300000000,
        "efd8c210ca5d193d-8d8ec7c8-21e6be57-987fa244-8924159f961fe7d751a67824":0.15 13458300000,
        "c905659bceb34ade-74c88a26-dd27f9a5-7c61b3ea-e9722abbf9a3f247486a1778":600 2500,
        "9813d85d52941ec9-cd87f125-1db0d765-a4ceaaca-08a94375ecae07c7a3e86997":45 0.2,
        "633a90c2efd8c210-a9278d8e-faf321e6-22d4987f-7a17e4f2b81a8924159f961f":355000000 0.2,
        "d450c196c905659b-451f74c8-6811dd27-0b477c61-53c5b81f2cc9e9722abbf9a3":470000000 600,
  },
      "name9813d85d-cd87-1db0-a4ce-08a94375ecae":"S 998"45,
        "description":"test catalog item "
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
  "properties":{
3f2e236f-5708-2eb7-8715-e2f52a6af34b": 28000000,
        "2a30c3bb-3584-5ea9-599e-497f7a984d1d": 2800000,
        "7f670d2a9b6d72a6-6c00b230-4fb178da-0dce6ed3-bb4f700ca0f479630fc263e7":"1.2e-05" 1900000,
        "029ca99d9b6e9387-d590a6d4-3f36af90-60adbfd5-c2f8538b6bf4196d47e67f64":"No" 0.002,
        "9df611cad91470f2-c5478a8d-e0abf7d2-4595de56-8a017a383592e61747fbbb27":210000000000 0.0035,
        "ca5d193d84bbcf5f-c7c8fc3f-be5719fe-a24447e3-e7d751a678240e9edbb6961e":80769200000 0.00175,
        "ceb34adeae3aa29d-8a26e553-f9a5afe6-b3ea5a71-f247486a177882363dab1636":7850 0.0035,
        "52941ec92f6bcd7f-f125f3b3-d765b346-aacad857-07c7a3e869975cd0ca17e31f":0.3 36000000,
    "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
    "0e588097-5259-fc18-9e74-122f73bbb4f8": 0,
        "c905659bd3535e56-74c8710b-dd27a585-7c613f79-e9722abbf9a3c984760625b2":600 0,
        "9813d85d9b7d1f57-cd870872-1db0b143-a4ce4d5f-08a94375ecae19630077c058":45 0.032,
        "633a90c2a27d570d-a927b739-faf36acf-22d450b1-7a17e4f2b81a12c73ba1ce36":355000000 2,
        "d450c196aa309ea3-451fde6d-68111274-0b47fc6b-53c5b81f2cc9380a14e91ef2":470000000 0.9,
  },
  "id":"f15e402a-d29d-023c-745d-2b2f41c58483",
  "name":"S 998",
  "description":"test catalog item "
}

...

Get the catalog item details

...

id	bimGetCatalogItem

    "5b92e65f-9874-4187-c561-064fb845507d": 0,
        "2cd643c8-f198-aad7-8f99-5f35052b3e7c": 3600000
    },
    "diagram": {
        "columns": [
            { "name": "sig", "type": "Double" },
            { "name": "eps", "type": "Double" },
        ],
        "rows": [
            { "items": [ -4.69565e+08, -0.05 ] },
            { "items": [ -4.6751e+08, -0.045 ] },
            { "items": [ -4.34783e+08, -0.00217391 ] },
            { "items": [ 0, 0 ] }
        ]
    },
    "id": "3ea0079e-7cd9-8ea0-1163-70cef77e7eff",
    "name": "C28/35",
    "description": "(Dutch NEN-EN NA)"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
    "catalogId": "ae2122c0-f667-f242-40ee-3e57161e433a",
    "properties": {
        "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4": "1e-05",
        "029ca99d-d590-3f36-60ad-c2f8538b6bf4": "No",
        "4fd9b113-4e9f-22e5-62ab-eb099fb0836f": "Bi-linear stress-strain diagram",
        "bb88f378-a30c-de7c-a70b-6522c917bd3f": "slow",
        "71164ead-883b-a610-61d0-c32e8caa5cfa": "Quartzite",
        "11f347c7-4ebf-fe22-5285-1edeb916c0de": 32300000000,
        "ca5d193d-c7c8-be57-a244-e7d751a67824": 13458300000,
        "ceb34ade-8a26-f9a5-b3ea-f247486a1778": 2500,
        "52941ec9-f125-d765-aaca-07c7a3e86997": 0.2,
        "efd8c210-8d8e-21e6-987f-8924159f961f": 0.2,
        "c905659b-74c8-dd27-7c61-e9722abbf9a3": 600,
        "9813d85d-cd87-1db0-a4ce-08a94375ecae": 45,
        "3f2e236f-5708-2eb7-8715-e2f52a6af34b": 28000000,
        "2a30c3bb-3584-5ea9-599e-497f7a984d1d": 2800000,
        "9b6d72a6-b230-78da-6ed3-79630fc263e7": 1900000,
        "9b6e9387-a6d4-af90-bfd5-196d47e67f64": 0.002,
        "d91470f2-8a8d-f7d2-de56-e61747fbbb27": 0.0035,
        "84bbcf5f-fc3f-19fe-47e3-0e9edbb6961e": 0.00175,
        "ae3aa29d-e553-afe6-5a71-82363dab1636": 0.0035,
        "2f6bcd7f-f3b3-b346-d857-5cd0ca17e31f": 36000000,
        "0e588097-5259-fc18-9e74-122f73bbb4f8": 0,
        "d3535e56-710b-a585-3f79-c984760625b2": 0,
        "9b7d1f57-0872-b143-4d5f-19630077c058": 0.032,
        "a27d570d-b739-6acf-50b1-12c73ba1ce36": 2,
        "aa309ea3-de6d-1274-fc6b-380a14e91ef2": 0.9,
        "5b92e65f-9874-4187-c561-064fb845507d": 0,
        "2cd643c8-f198-aad7-8f99-5f35052b3e7c": 3600000
    },
    "diagram": {
        "columns": [
            { "name": "sig", "type": "Double" },
            { "name": "eps", "type": "Double" },
        ],
        "rows": [
            { "items": [ -4.69565e+08, -0.05 ] },
            { "items": [ -4.6751e+08, -0.045 ] },
            { "items": [ -4.34783e+08, -0.00217391 ] },
            { "items": [ 0, 0 ] }
        ]
    },
    "id": "3ea0079e-7cd9-8ea0-1163-70cef77e7eff",
    "name": "C28/35",
    "description": "(Dutch NEN-EN NA)"
}

Anchor

	getCatalogItem
	getCatalogItem

Get the catalog item details

Deck of Cards

id	bimGetCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

URL: https://api-stage.bimplus.net/v2/ catalogitems/<catalogitem_id>

Example: https://api-stage.bimplus.net/v2/catalogitems/f15e402a-d29d-023c-745d-2b2f41c58483

Optional query parameters: Used to refine and reduce the set of returned catalog items

Name

Type

Default value

Description

unit

string

metric

When query parameter "unit=imperial" is defined, the API will return free-attribute of catalog item with imperial unit.
e.g. https://api-stage.bimplus.net/v2/catalogitems/d3a532ce-145a-5a91-4bba-a445630b93ca/?unit=imperial

Query unit can be only ?unit=metric or ?unit=imperial.

filter

string

When filter "name=I200" is defined the API will return only of catalog item which Name contains requested sub-string, e.g. https://api-stage.bimplus.net/v2/catalogitems?filter=name=I1

if filter is "name=I1" will be returned all catalog items which Name contains substring "I1".
Like I100 I150, etc.

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog item

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

{
  "catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
  "properties":{
    "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4":"1.2e-05",
    "029ca99d-d590-3f36-60ad-c2f8538b6bf4":"No",
    "9df611ca-c547-e0ab-4595-8a017a383592":210000000000,
    "ca5d193d-c7c8-be57-a244-e7d751a67824":80769200000,
    "ceb34ade-8a26-f9a5-b3ea-f247486a1778":7850,
    "52941ec9-f125-d765-aaca-07c7a3e86997":0.3,
    "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
    "c905659b-74c8-dd27-7c61-e9722abbf9a3":600,
    "9813d85d-cd87-1db0-a4ce-08a94375ecae":45,
    "633a90c2-a927-faf3-22d4-7a17e4f2b81a":355000000,
    "d450c196-451f-6811-0b47-53c5b81f2cc9":470000000
  },
  "id":"f15e402a-d29d-023c-745d-2b2f41c58483",
  "name":"S 998",
  "description":"test catalog item "
}

Anchor

	createCatalog
	createCatalog

Create a new catalog

Deck of Cards

id	bimCreateCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog
name	mandatory	string	Catalog name
description	optional	string	Catalog description
catalogtype	mandatory	object	Catalog type object. Mandatory is only Id of the catalog type object. See response of Get a list of catalog types
norms	optional	JSON array	Array of norm objects, see json response part of Get the norm list . Mandatory is only Id of the norm object
countries	optional	JSON array	Array of country objects, see json response part of Get the country list . Mandatory is only Id of the country object

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog.

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":"Timber",
  "description":"Timber",
  "catalogtype":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "norms":[],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"10e3f185-234e-9686-5fea-73075149abd2",
  "name":"Timber",
  "description":"Timber"
}

Anchor

	getCatalogList
	getCatalogList

Get the catalog list

Deck of Cards

id	bimGetCatalogList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the catalog list

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

[{
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2d116846-5f7c-a780-3a82-6dd8150989df",
    "name":"Steel",
    "description":"Steel"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

URL: https://api-stage.bimplus.net/v2/ catalogitems/<catalogitem_id>

Example: https://api-stage.bimplus.net/v2/catalogitems/f15e402a-d29d-023c-745d-2b2f41c58483

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog item

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
  "properties":{
    "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4":"1.2e-05",
    "029ca99d-d590-3f36-60ad-c2f8538b6bf4":"No",
    "9df611ca-c547-e0ab-4595-8a017a383592":210000000000,
    "ca5d193d-c7c8-be57-a244-e7d751a67824":80769200000,
    "ceb34ade-8a26-f9a5-b3ea-f247486a1778":7850,
    "52941ec9-f125-d765-aaca-07c7a3e86997":0.3,
    "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
    "c905659b-74c8-dd27-7c61-e9722abbf9a3":600,
    "9813d85d-cd87-1db0-a4ce-08a94375ecae":45,
    "633a90c2-a927-faf3-22d4-7a17e4f2b81a":355000000,
    "d450c196-451f-6811-0b47-53c5b81f2cc9":470000000
  },
  "id":"f15e402a-d29d-023c-745d-2b2f41c58483",
  "name":"S 998",
  "description":"test catalog item "
}

...

Create a new catalog

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

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

JSON Structure:

Deck of Cards

id	bimCreateCatalog

Card

default	true
label	URL / Resource / JSON Structure

Name

Mandatory / Optional

Type

Description

id

will be ignored

string(guid)

The id of the catalog

name

mandatory

string

Catalog name

description

optional

string

Catalog description

catalogtype

mandatory

object

Catalog type object. Mandatory is only Id of the catalog type object.
See response of Get a list of catalog types

norms

optional

JSON array

Array of norm objects, see json response part of Get the norm list .
Mandatory is only Id of the norm object

countries

optional

JSON array

Array of country objects, see json response part of Get the country list .
Mandatory is only Id of the country object

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog.

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":"Timber",
  "description":"Timber",
  "catalogtype":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "norms":[],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"10e3f185ae2122c0-234ef667-9686f242-5fea40ee-73075149abd23e57161e433a",
  "name":"Timber",
  "description":"Timber"
}

...

Get the catalog list

Deck of Cards

id	bimGetCatalogList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the catalog list

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":"Concrete",
    "description":"Concrete"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "normscountries":[{
        "id":"96b6d63f7a286f49-7d86ca3e-2270f2c9-5ded2555-a7868308679baf6f9713071c",
        "name":"ECStandard EN"
      }
    ],
    "countriescatalogType":[{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"7a286f492e5f209b-ca3e98e4-f2c9f731-25559f54-af6f9713071cf9ade4a87587",
        "name":"Standard ENAluminium",
    "description":"Aluminium"
  }
    ],
    "catalogType":{
    ]

Anchor

	getCatalog
	getCatalog

Get the catalog details

Deck of Cards

id	bimGetCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Example: https://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog

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

{
  "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2d116846-5f7c-a780-3a82-6dd8150989df",
    "name":"Steel",
    "description":"Steel"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "namedescription":"Material"
  },
     "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete",
  "description":"MaterialConcrete"
    },
    "id":"}

Anchor

	putCatalog
	putCatalog

Update the specified catalog

Deck of Cards

id	bimPutCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Example: https://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified catalog.

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":"Concrete",
    "description":"Concrete"
  },
  {
    "norms":[{
        "id":"96b6d63f0da7bbc8-7d86c63d-2270d090-5dedc458-a7868308679b1431f78987e0",
        "name":"EC"
      }
    ]European",
    "countries":[{
        "id"description":"7a286f49-ca3e-f2c9-2555-af6f9713071c",European"
    }
  ],
  "namecountries":"Standard EN"
      }
    [],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "namedescription":"Material"
  },
  "name":"Concrete X",
   "description":"MaterialConcrete"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "norms":[{
    },
    "id":"2e5f209b0da7bbc8-98e4c63d-f731d090-9f54c458-f9ade4a875871431f78987e0",
      "name":"AluminiumEuropean",
      "description":"AluminiumEuropean"
    }
]

...

Get the catalog details

...

id	bimGetCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Example: https://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "norms":[{
      "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
      "name":"EC"
    }
  ],
  "countries":[{
      "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
      "name":"Standard EN"
    }
  ],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete",
  "description":"Concrete"
}

  ],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete X",
  "description":"Concrete"
}

Anchor

	getCatalogItemList
	getCatalogItemList

Get the catalog item list from the specified catalog

Deck of Cards

id	bimGetCatalogItemList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/<catalog_id>/items

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>/items

Example: https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items

Optional query parameters: Used to refine and reduce the set of returned catalog items

...

Update the specified catalog

Deck of Cards

id	bimPutCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL:

Name

Type

Default value

Description

code

string

When query parameter "code=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045.
Instead of code name can be used also codeId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'code' can be interchanged with query parameter norm.
When are defined both query parameters - code and norm, only code is used in api call.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany

norm

string

When query parameter "norm=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045.
Instead of code name can be used also normId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'norm' can be interchanged with query parameter code.
When are defined both query parameters - code and norm, only code is used in api call.

e.g.

https://api-stage.bimplus.net/v2/catalogs/

<catalog_id>Example:

10e3f185-234e-9686-5fea-73075149abd2/items?norm=DIN 1045

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g.

https://api-stage.bimplus.net/v2/catalogs/

ae2122c0

10e3f185-

f667

234e-

f242

...

Get the catalog item list from the specified catalog

Deck of Cards

id	bimGetCatalogItemList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/<catalog_id>/items

URL:

9686-

40ee-3e57161e433a

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified catalog.

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

{
  "norms":[{
      "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
      "name":"European",
      "description":"European"
    }
  ],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "name":"Concrete X",
  "description":"Concrete"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "norms":[{
      "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
      "name":"European",
      "description":"European"
    }
  ],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete X",
  "description":"Concrete"
}

...

5fea-73075149abd2/items?code=DIN 1045&country=Germany
na	string	When query parameter "na=Germany" is defined, the API will return from requested catalog only items which are related to country Germany. Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'na' can be interchanged with query parameter 'country'. When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?na=Germany To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&na=Germany
country	string	When query parameter "country=Germany" is defined, the API will return from requested catalog only items which are related to country Germany. Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'country' can be interchanged with query parameter 'na'. When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?country=Germany To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany
filter	string	When filter "name=S 998" is defined the API will return only catalog items which Name contains requested sub-string, e.g. if filter is "name=S 998" will be returned all catalog items which Name contains substring "S 998". e.g.

Example:

https://api-stage.bimplus.net/v2/catalogs/

<catalog_id>/items

2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998

To get more precisely specified result set of catalog items, can be combined query parameter filter (by name) together with 'country' or 'code' query parameter.

e.g.

https://api-stage.bimplus.net/v2/catalogs/

10e3f185

234e

9686

5fea

73075149abd2

6dd8150989df/items?filter=name=S 998&code=DIN 1045&country=Germany

Card

label	HTTP Method

GET

Card

label	Description

Get all catalog items of the catalog

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

[{
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"754da75a-c96d-6d4f-01a9-33a178394ecb",
    "name":"GL 26h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"27d2555d-2245-a84a-7950-a4898077261f",
    "name":"GL 30h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"02ce9b8b-720c-a44c-b115-f45a0de7d965",
    "name":"GL 32c",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"0e00c600-8004-6a03-8110-4d38c3dc40aa",
    "name":"GL 24h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"fb3bfbb8-aa6a-64b3-b78e-8950ca107891",
    "name":"GL 28h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"9be0c733-243d-2e1c-c79c-7be0a2b6c1a3",
    "name":"GL 32h",
    "description":"(EN 14080)"
  }
]

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 14

New Version Current

Key

Get the catalog item details

Get the catalog item details

Create a new catalog

Get the catalog list

Create a new catalog

Get the catalog list

Get the catalog details

Update the specified catalog

Get the catalog details

Get the catalog item list from the specified catalog

Update the specified catalog

Get the catalog item list from the specified catalog