Page History

...

Anchor

	createVariant
	createVariant

Create a new variant type in a project

Deck of Cards

id	bimcreateVariantbimCreateVariant

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/variants

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the variant type
description	optional	string	Description of the variant type
id	will be ignored	string(guid)	Unique guid of the structurevariant type

Card

label	HTTP Method

POST

Card

label	Description

Create a new variant type of defined structure(eg: cost structure, specification structure) under a project

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": "TestVariant type",
    "description": "Description of the Test variant type"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "TestVariant type",
  "description": "Description of the Test variant type",
  "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

Anchor

	getVariantDetails
	getVariantDetails

Get the variant type details

Deck of Cards

id	bimGetVariantDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/variants/<variantvarianttype_id>

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified variant type.

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": "TestVariant type",
  "description": "Description of the Test variant type",
  "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

Anchor

	getVariantList
	getVariantList

Get the list of existing

...

variant types in the project

Deck of Cards

id	bimGetVariantList

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/variants

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants

Card

label	HTTP Method

GET

Card

label	Description

Gets the list of existing variants inside a variant types created in the project.

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": "TestVariant1TestVariantType1",
    "description": "Description of the Test variant type 1",
    "id": "6dc03014-8601-49fd-bae9-ef5b185603b6"
  },
  {
    "name": "TestVariant2TestVariantType2",
    "description": "Description of the Test variant type 2",
    "id": "4c1fda6b-7fd9-42a7-a4ae-88eababd3082"
  },
  {
    "name": "TestVariant3TestVariantType3",
    "description": "Description of the Test variant type 3",
    "id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
  },
  {
    "name": "TestVariant4TestVariantType4",
    "description": "Description of the Test variant type 4",
    "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
  }
]

Anchor

	updateVariant
	updateVariant

Update the variant type

Deck of Cards

id	bimUpdateVariant

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/variants/<variant<varianttype_id>

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the variant type
description	optional	string	Description of the variant type
id	will be ignored	string(guid)	Unique guid of the variant type

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified variant type

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": "Updated TestVariant4TestVariantType4 name"
  "description": "Updated description of the TestVariant4TestVariantType4"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Updated TestVariant4TestVariantType4 name",
    "description": "Updated description of the TestVariant TestVariant4type 4",
    "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

...

Deck of Cards

id	bimDeleteVariant

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/variants/<variant<varianttype_id>

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified variant type.

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

Anchor

	copyVariant
	copyVariant

Copy content of source variant type to target variant type

Deck of Cards

id	bimCopyVariant

Card

label	Url / Resource /Json

Resource: projects/<project_id>/variants/<targetvariant<targetvarianttype_id>/copyfrom

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c/copyfrom

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	will be ignored	string	Name of the variant type
description	will be ignored	string	Description of the variant type
id	mandatory	string(guid)	Unique guid of the source variant type

Card

label	HttpMethod

PUT

Card

label	Description

Updates the specified target variant type with all structure element's assignments of elements from source variant type.

Note:
In case when at least one element is already assigned in target variant type and the same element is also present in source variant type,
such api call will return Conflict response and nothing will be updated.

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": "ignored variant type name",
    "description": "ignored variant description of variant type",
    "id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Updated TestVariant4TestVariantType4 name",
    "description": "Updated description of the TestVariant TestVariant4type 4",
    "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 30

New Version 31

Key

Create a new variant type in a project

Get the variant type details

Get the list of existing

variant types in the project

Update the variant type

Copy content of source variant type to target variant type