Page History

Connection Service

...

Bimplus DB

Anchor

	createConnection
	createConnection

Create a new

...

Team DB

Important: All the APIs described in the Bimplus DB section applies to the Team DB as well. Replace the keyword "content" with the "team_slug" for working with the cross section definition and cross sections in Team DB.

...

connection

Deck of Cards

id	bimCreateConnection

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/connection

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

...

projects/

...

<project_id>/connection

Example: https://api

...

.bimplus.net/v2

...

Create a new cross section definition in Bimplus DB

...

id	bimCreateCrossSectionDefinition

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions

Optional query parameters

...

When query parameter "check=true" is defined, the API call will check existence of the cross section definition.
If cross section definition already exists in such case is returned error code 409 conflict. This is default behavior.

When "check=false" this call will not check existence same cross section definition,
in such case new cross section definition will be created.

JSON Structure:

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

name

...

mandatory

...

string

...

Cross section definition name

...

description

...

optional

...

string

...

Short description of the cross section definition

...

freeAttributesId

...

optional

...

JSON Array

...

List of all free attribute Ids, where are defined all parameters for CSG-contour calculation

...

csgParameters

...

JSON Structure of the object in "csgParameters" attribute :

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

pointOrder

...

mandatory

...

int

...

Point order

...

command

...

mandatory

...

string

...

Command for creation CSG-Geometry contour e.g. "O", "L", "R", ....

...

xCoordinate

...

mandatory

...

string

...

Contains either direct numerical value of coordinate e.g. "0.0" or formula which can contain simple operations between numerical values and/or attribute values defined by attribute name e.g "(B-B1)/2+B1".
Expression may contain mathematical operation: [sin], [cos], [tan], [pi], +, /, -, *

...

yCoordinate

...

zCoordinate

...

Card

label	HTTP Method

POST

Card

label	Description

Creates a new cross section definition in bimplus database. Cross section definition is defined as contour of CSG-geometry.

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":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":[
		"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[
		{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		...
	]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
	"name":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":["a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		{
			"pointOrder":3,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"D"
		},
		{
			"pointOrder":4,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":5,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":6,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":7,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":8,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T"
		},
		{
			"pointOrder":9,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T"
		},
		{
			"pointOrder":10,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":11,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":12,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":13,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"D"
		},
		{
			"pointOrder":14,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":15,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"D"
		},
		{
			"pointOrder":16,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":17,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		}
	],
	"id":"1b0b4c54-1084-4b7b-8b6b-d0154e44f05a"
}

...

Get details of the cross section definition

...

id	bimGetCrossSectionDefinition

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a

...

default	true
label	URL / Resource / JSON Structure

Optional query parameters

...

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified cross section definition

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":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":["a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		{
			"pointOrder":3,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"D"
		},
		{
			"pointOrder":4,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":5,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":6,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":7,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":8,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T"
		},
		{
			"pointOrder":9,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T"
		},
		{
			"pointOrder":10,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":11,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":12,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":13,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"D"
		},
		{
			"pointOrder":14,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":15,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"D"
		},
		{
			"pointOrder":16,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":17,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		}
	],
	"id":"1b0b4c54-1084-4b7b-8b6b-d0154e44f05a"
}

...

Get all cross sections section definitions

...

id	bimGetAllCrossSectionDefinitions

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions

Optional query parameters

/bimplus/projects/e504f24c-e643-452b-b901-6a18883dc7e9/connection

JSON Structure:

Name	Mandatory / Optional	Type	Description
Id	will be ignored	string(guid)	Connection Id
elements	mandatory	JSON Array	List of element Ids. Connection will be created between elements in this array.
ConnectionElement	mandatory	object	Connection definition object, in this object are defined properties of the connection element which will be created.

JSON Structure of the object in "ConnectionElement" :

Name	Mandatory / Optional	Type	Description
Id	will be ignored	string(guid)	Connection Id
parent	will be ignored	string(guid)	Connection parent
elementtyp	mandatory	string(guid)	Guid of element type "ConnectionElement"
type	mandatory	string	"ConnectionElement"
layerid	mandatory	string(guid)	Connection layer Id, in this layer will be created connection element
attributes	mandatory	object	List of free attribute Ids, where are defined name and description of the connection element.
children	optional	JSON Array	Array of objects which define single parts of connection from which is built connection. E.g. one type of connection may have only plates with welds or another one maybe assembled from plates with wholes together with screws with nuts, generally can be defined any wanted connection geometry.

Card

label	HTTP Method

POST

Card

label	Description

Creates a new connection between single objects

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

{
  "elements":["909ff986-f74e-44b5-bcf2-ec7b779e3011", "6b12bd40-a4c6-4eae-8a0b-b93592f71483"
  ],
  "ConnectionElement":{
    "elementtyp":"a48f8bcc-79c7-47ed-ab43-f8c7f0ddffdf",
    "type":"ConnectionElement",
    "layerid":"72b7e0ba-ae1a-4a71-b1ec-ad8f553fb3bc",
    "attributes":{
      "general":{
        "name":"Conection_Test",
        "description":"Connection_Part_Of_test"
      }
    },
    "children":[{
        "elementtyp":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "parent":"61d54a09-3076-41f9-93e2-810cb3df99d0",
        "type":"Opening",
        "layerid":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "attributes":{
          "general":{
            "name":"Hole_1"
          },
          "element":{
            "divisionid":"6a764b22-22dd-4cdb-83cc-33366ce8b4d3",
            "logparentid":"548126f3-d69e-485b-a8ba-8fc5a615ed1c",
            "matrix":{
              "Values":[1, 0, 0, 100,
                        0, 1, 0, 100,
                        0, 0, 1, 0,
                        0, 0, 0, 1 ]
            }
          },
          "geometry":{
            "csg":{
              "elements":[{
                  "type":"Path",
                  "crossSection":"RD8",
                  "vectorX":[1, 0, 0 ],
                  "vectorY":[0, 1, 0 ],
                  "geometry":[{
                      "geoType":"StartPolygon",
                      "point":[0, 0, 2900 ]
                    },
                    {
                      "geoType":"Line",
                      "point":[0, 0, 3200 ]
                    }
                  ]
                }
              ],
              "color":4286611584
            }
          }
        }
      }
    ]
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id": "e5875246-7306-49b4-ab3a-30f014f01d3c"
  "elements": ["909ff986-f74e-44b5-bcf2-ec7b779e3011", "6b12bd40-a4c6-4eae-8a0b-b93592f71483"],
  "ConnectionElement": 
  {
    "elementtyp": "a48f8bcc-79c7-47ed-ab43-f8c7f0ddffdf",
    "id": "7470de4c-6893-4a2e-9c2c-60629e28ad93",
    "parent": "61d54a09-3076-41f9-93e2-810cb3df99d0",
    "type": "ConnectionElement",
    "layerid": "72b7e0ba-ae1a-4a71-b1ec-ad8f553fb3bc",
    "attributes": {
      "general": {
        "name": "Conection_Test",
        "description": "Connection_Part_Of_test"
      }
    },
    "children": 
    [ {
        "elementtyp": "0a98744d-baf5-4606-ad86-2097a93f188f",
        "parent": "61d54a09-3076-41f9-93e2-810cb3df99d0",
        "id": "c5ba93c2-ef80-451f-8104-aa58f8ef787a",
        "type": "Opening",
        "layerid": "0a98744d-baf5-4606-ad86-2097a93f188f",
        "attributes": 
        {
          "general": {
            "name": "Hole_1"
          },
          "element": {
            "divisionid": "6a764b22-22dd-4cdb-83cc-33366ce8b4d3",
            "logparentid": "548126f3-d69e-485b-a8ba-8fc5a615ed1c",
            "matrix": {
              "Values": [1.0, 0.0, 0.0, 100.0, 0.0, 1.0, 0.0, 100.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0]
            }
          },
          "geometry": {
            "csg": {
              "elements": [{
                  "type": "Path",
                  "crossSection": "RD8",
                  "vectorX": [1.0, 0.0, 0.0],
                  "vectorY": [0.0, 1.0, 0.0],
                  "geometry": [{
                      "geoType": "StartPolygon",
                      "point": [0.0, 0.0, 2900.0]
                    }, {
                      "geoType": "Line",
                      "point": [0.0, 0.0, 3200.0]
                    }
                  ]
                }
              ],
              "color": 4286611584
            }
          },
          "elementstate": {
            "state": "0aaf5a1c-2453-40cb-9232-315119dd288f"
          }
        }
      },
    ]
  },
}

Anchor

	getConnectionDetails
	getConnectionDetails

Get the connection details

Deck of Cards

id	bimGetConnectionDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/connection/<connection_id>

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

Example: https://api.bimplus.net/v2/bimplus/connection/e5875246-7306-49b4-ab3a-30f014f01d3c

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified connection

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

{
  "elements":["909ff986-f74e-44b5-bcf2-ec7b779e3011",
    "6b12bd40-a4c6-4eae-8a0b-b93592f71483"
  ],
  "connectionelement":{
    "elementtyp":"a48f8bcc-79c7-47ed-ab43-f8c7f0ddffdf",
    "id":"7470de4c-6893-4a2e-9c2c-60629e28ad93",
    "type":"ConnectionElement",
    "layerid":"72b7e0ba-ae1a-4a71-b1ec-ad8f553fb3bc",
    "attributes":{
      "producer data":{
        "product by company":null,
        "product name":null,
        "product description":null,
        "article number":null
      }
    },
    "children":[{
        "elementtyp":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "id":"c5ba93c2-ef80-451f-8104-aa58f8ef787a",
        "parent":"7470de4c-6893-4a2e-9c2c-60629e28ad93",
        "type":"Opening",
        "layerid":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "attributes":{
          "producer data":{
            "product by company":null,
            "product name":null,
            "product description":null,
            "article number":null
          }
        },
        "name":"Hole_1"
      }
    ],
    "name":"Conection_Test"
  },
  "id":"e5875246-7306-49b4-ab3a-30f014f01d3c"
}

Anchor

	updateConnection
	updateConnection

Update the connection

Deck of Cards

id	bimUpdateConnection

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/connection/<connection_id>

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

Example: https://api.bimplus.net/v2/bimplus/connection/e5875246-7306-49b4-ab3a-30f014f01d3c

Card

label	HTTP Method

PUT

Card

label	Description

Updates specified connection in bimplus database.
JSON structure is the same as is defined in 'Create a new connection in Bimplus DB'

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

{
  "elements":["909ff986-f74e-44b5-bcf2-ec7b779e3011",
    "6b12bd40-a4c6-4eae-8a0b-b93592f71483"
  ],
  "ConnectionElement":{
    "elementtyp":"a48f8bcc-79c7-47ed-ab43-f8c7f0ddffdf",
    "type":"ConnectionElement",
    "layerid":"72b7e0ba-ae1a-4a71-b1ec-ad8f553fb3bc",
    "attributes":{
      "general":{
        "name":"Update_Test",
        "description":"Connection_Part_Of_test"
      }
    },
    "children":[{
        "elementtyp":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "parent":"61d54a09-3076-41f9-93e2-810cb3df99d0",
        "type":"Opening",
        "layerid":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "attributes":{
          "general":{
            "name":"Update_Hole_1"
          },
          "element":{
            "divisionid":"6a764b22-22dd-4cdb-83cc-33366ce8b4d3",
            "logparentid":"548126f3-d69e-485b-a8ba-8fc5a615ed1c",
            "matrix":{
              "Values":[1, 0, 0, 200,
                        0, 1, 0, 200,
                        0, 0, 1, 0,
                        0, 0, 0, 1 ]
            }
          },
          "geometry":{
            "csg":{
              "elements":[{
                  "type":"Path",
                  "crossSection":"RD8",

...

When query parameter "groups=true" is defined, the API function returns only all groups of crosssection definitions.
All crosssection definitions are returned only if this parameter is set to false or missing.

...

When query parameter "types=true" is defined, the API function returns only id, name, description attributes of crosssection definition
of all crosssection definitions (reduced crosssection definition).
Complete crosssection definitions are returned only if this parameter is set to false or missing.

Card

label	HTTP Method

GET

Card

label	Description

Get details about all cross section definitions

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":"1b0b4c54-1084-4b7b-8b6b-d0154e44f05a"
	"name":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":["a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		{
			"pointOrder":3,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"D"
		},
		{
			"pointOrder":4,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":5,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":6,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":7,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":8,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T"
		},
		{
			"pointOrder":9,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T"
		},
		{
			"pointOrder":10,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":11,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":12,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":13,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"D"
		},
		{
			"pointOrder":14,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":15,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"D"
		},
		{
			"pointOrder":16,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":17,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		}
	],
},
...
]

...

Update the cross section definition

...

id	bimUpdateCrossSectionDefinition

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a

Card

label	HTTP Method

PUT

Card

label	Description

Updates specified cross section definition in bimplus database. Cross section definition is defined as contour of CSG-geometry.
JSON structure is the same as is defined in 'Create new cross section definition'

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":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":[
		"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[
		{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		...
	],
	"id":"1b0b4c54-1084-4b7b-8b6b-d0154e44f05a"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

{
	"name":"IPE",
	"description":"IPE-profil",
	"freeAttributesId":["a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
		"46065318-8776-4f30-85ff-c7276b094097",
		"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
		"d5e91f99-ff75-4262-b21e-05dea7bff340",
		"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2"
	],
	"csgParameters":[{
			"pointOrder":1,
			"command":"O",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":2,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"D"
		},
		{
			"pointOrder":3,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"D"
		},
		{
			"pointOrder":4,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":5,
			"command":"L",
			"xCoordinate":"(B-B1)/2",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":6,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":7,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":8,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"T"
		},
		{
			"pointOrder":9,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T"
		},
		{
			"pointOrder":10,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":11,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"T-D"
		},
		{
			"pointOrder":12,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":13,
			"command":"L",
			"xCoordinate":"(B-B1)/2+B1",
			"yCoordinate":"D"
		},
		{
			"pointOrder":14,
			"command":"R",
			"xCoordinate":"R",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":15,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"D"
		},
		{
			"pointOrder":16,
			"command":"L",
			"xCoordinate":"B",
			"yCoordinate":"0.0"
		},
		{
			"pointOrder":17,
			"command":"L",
			"xCoordinate":"0.0",
			"yCoordinate":"0.0"
		}
	],
	"id":"1b0b4c54-1084-4b7b-8b6b-d0154e44f05a"
}

...

Delete the cross section definition

...

id	bimDeleteCrossSectionDefinition

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified cross section definition from bimplus database.

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

...

Create a new cross section for cross section definition in Bimplus DB

...

id	bimCreateCrossSectionForDefinition

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>/crosssections

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections

Optional query parameters

...

When query parameter "check=true" is defined, the API call will check existence of the cross section.
If cross section already exists in such case is returned error code 409 conflict. This is default behavior.

When "check=false" this call will not check existence same cross section,
in such case new cross section will be created.

JSON Structure:

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

name

...

mandatory

...

string

...

Cross section name

...

description

...

optional

...

string

...

Short description of the cross section

...

crossSectionParameters

...

List of objects which define all parameters values for cross section.
Set of parametres should correspond to set of parameters required by cross section definition for which cross section is created.
Structure of objects in this array is described below.

...

JSON Structure of the object in "crossSectionParameters" attribute :

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

value

...

mandatory

...

object

...

free attribute value

...

name

...

optional

...

string

...

Name of free attribute

Card

label	HTTP Method

POST

Card

label	Description

Creates a new cross section for specified cross section definition in bimplus database.

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":"IPE-200",
	"description":"parameters IPE-200",
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100
		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200
        }
	],
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
	"name":"IPE-200",
	"description":"parameters IPE-200",
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
			"name":B
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
			"name":r1
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,
			"name":s

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
			"name":t
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
			"name":h
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
}

...

Get details of cross section

...

id	bimGetCrossSection

...

default	true
label	URL / Resource / JSON Structure

...

URL: https://api-stage.bimplus.net/v2/ content/crosssections/<cross_section_id>

Example: https://api-stage.bimplus.net/v2/content/crosssections/bef3f6a2-e869-4282-adab-84114ad672f7

Optional query parameters

...

When filter "name=I200" is defined the API will return only cross sections which Name contains requested sub-string,
e.g. if filter is "name=I1" will be returned all cross section which Name contains substring "I1".
Like I100 I150, etc.

...

When round parameter is defined with value "false", API will return simplified cross section geometry.
In such case has all arc segmets radius equal to zero.

NOTE :
To get details for cross section or groups of cross sections without known or available cross_section_id is possible
to use this call without using cross_section_id, but in such case must be defined requested cross section(s) with filter.
When is used filter to define requested cross sections will be returned all cross sections with matching filter pattern.

e.g. to get all cross sections which names contains string 'H200' let's use api with filter

https://api-stage.bimplus.net/v2/content/crosssections?filter=name=H200

In case you know only cross section name, this name can be used in place of <cross_section_id>. In this case will be returned
wanted cross section with required name. If required name was not found will be returned error 404 Not found.

...

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified cross section

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":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
			"name":B
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
			"name":r1
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,
			"name":s

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
			"name":t
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
			"name":h
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
	"shape": 
	[
        {
            "x": 0,
            "y": 0,
            "z": 0
        },
        {
            "x": 200,
            "y": 0,
            "z": 0
        },
        {
            "x": 200,
            "y": 108.5315793,
            "z": 0
        },
        {
            "x": 199.3260249,
            "y": 110.9033885,
            "z": 0
        },
        {
            "x": 197.7059317,
            "y": 112.7599257,
            "z": 0
        },
	...
	]
}

...

Get all cross sections from cross section definition

Deck of Cards

id	bimGetAllCrossSectionsOfCrossSectionDefinition

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/crosssectiondefinitions/<cross_section_definition_id>/crosssections

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>/crosssections

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections

Card

label	HTTP Method

GET

Card

label	Description

Get all cross sections which were created for specified cross section definition

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":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
			"name":B
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
			"name":r1
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,
			"name":s

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
			"name":t
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
			"name":h
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "valuevectorX": 200,
[1, 0, 0 ],
                  "namevectorY":[0, 1, 0 ],
                  "Area"
geometry":[{
                      }
	],
	"shape": 
	[
"geoType":"StartPolygon",
          {
            "xpoint":[0, 0,
 2900 ]
          "y": 0,
         },
   "z": 0
        },
        {
            "x": 200,
            "ygeoType": 0"Line",
              "z": 0
        },"point":[0, 0, 3200 ]
        {
            "x": 200, }
            "y": 108.5315793,
     ]
       "z": 0
        },
             { ],
              "xcolor": 199.3260249,
4286611584
            }
    "y": 110.9033885,
     }
       "z": 0}
      }
    },]
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "elements":["909ff986-f74e-44b5-bcf2-ec7b779e3011"     {
            "x": 197.7059317,
          "6b12bd40-a4c6-4eae-8a0b-b93592f71483"
  ],
  "yconnectionelement": 112.7599257,{
            "z": 0
        },
	...
	]
},
...
]

...

Update cross section for cross section definition

Resource: content/crosssectiondefinitions/<cross_section_definition_id>/crosssections/<cross_section_id>

URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions/<cross_section_definition_id>/crosssections/<cross_section_id>

Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections/bef3f6a2-e869-4282-adab-84114ad672f7

Deck of Cards

id	bimUpdateCrossSectionOfCrossSectionDefinition

Card

default	true
label	URL / Resource / JSON Structure

Card

label	HTTP Method

PUT

Card

label	Description

Updates specified cross section of cross section definition in bimplus database.
JSON structure is the same as is defined in 'Create a new cross section for cross section definition in Bimplus DB'

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":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
  "elementtyp":"a48f8bcc-79c7-47ed-ab43-f8c7f0ddffdf",
    "id":"7470de4c-6893-4a2e-9c2c-60629e28ad93",
    "parent":"61d54a09-3076-41f9-93e2-810cb3df99d0",
    "type":"ConnectionElement",
    "layerid":"72b7e0ba-ae1a-4a71-b1ec-ad8f553fb3bc",
    "attributes":{
      "general":{
        "name":"Update_Test",
        "description":"Connection_Part_Of_test"
      },
      "element":{
        "divisionid":"6a764b22-22dd-4cdb-83cc-33366ce8b4d3",
        "logparentid":"548126f3-d69e-485b-a8ba-8fc5a615ed1c"
      },
      "elementstate":{
        "state":"0aaf5a1c-2453-40cb-9232-315119dd288f"
      }
    },
    "children":[{
        "elementtyp":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "id":"66b5ac4c-62f1-4af2-b304-acc4da903d15",
        "parent":"7470de4c-6893-4a2e-9c2c-60629e28ad93",
        "type":"Opening",
        "layerid":"0a98744d-baf5-4606-ad86-2097a93f188f",
        "attributes":{
          "general":{
            "name":"Update_Hole_1"
          },
          "valueelement":{
  200,
        }
	],
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

{
	"name"divisionid":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
			"name":B
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
			"name":r1
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,
			"name":s

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
			"name":t
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
			"name":h
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
6a764b22-22dd-4cdb-83cc-33366ce8b4d3",
            "logparentid":"548126f3-d69e-485b-a8ba-8fc5a615ed1c",
            "matrix":{
              "Values":[1, 0, 0, 200,
                        0, 1, 0, 200,
                        0, 0, 1, 0,
                        0, 0, 0, 1 ]
            }
          },
          "geometry":{
            "csg":{
              "elements":[{
                  "type":"Path",
                  "crossSection":"RD8",
                  "vectorX":[1, 0, 0 ],
                  "vectorY":[0, 1, 0 ],
                  "valuegeometry": 200,[{
             "name": "Area"
        }
	],
	"shape": 
	[
"geoType":"StartPolygon",
          {
            "xpoint":[0, 0,
 2900 ]
          "y": 0,
         },
   "z": 0
        },
        {
            "x": 200,
            "ygeoType": 0"Line",
             "z": 0
        },
        {"point":[0, 0, 3200 ]
            "x": 200,
       }
     "y": 108.5315793,
            "z": 0]
        },
        {}
            "x": 199.3260249  ],
              "ycolor":4286611584
 110.9033885,
           }
 "z": 0
        },
          "elementstate":{
            "x": 197.7059317,
  state":"0aaf5a1c-2453-40cb-9232-315119dd288f"
          "y": 112.7599257,
 }
        }
     "z": 0}
      ]
  },
	...
	]  "id":"e5875246-7306-49b4-ab3a-30f014f01d3c"
}

Anchor

	deleteCrossSectiondeleteConnectiondeleteCrossSection
	deleteConnection

Delete the

...

connection

Deck of Cards

id	bimDeleteCrossSectionbimDeleteConnection

Card

default	true
label	URL / Resource / JSON Structure

Resource: content <team_slug>/crosssectionsconnection/<cross_section_id> <connection_id>

URL: https://api-stage.bimplus.net/v2/ content <team_slug>/crosssectionsconnection/<cross_section_id><connection_id>

Example: https://api-stage.bimplus.net/v2/contentbimplus/crosssectionsconnection/1b0b4c54e5875246-10847306-4b7b49b4-8b6bab3a-d0154e44f05a30f014f01d3c

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified cross section specified connection from bimplus database.

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Connection Service

Bimplus DB

Create a new

Team DB

connection

Create a new cross section definition in Bimplus DB

Get details of the cross section definition

Get all cross sections section definitions

Get the connection details

Update the connection

Update the cross section definition

Delete the cross section definition

Create a new cross section for cross section definition in Bimplus DB

Get details of cross section

Get all cross sections from cross section definition

Update cross section for cross section definition

Delete the

connection