Versions Compared

Old Version 3

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version Current

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...


Anchor
createNewConnectioncreateConnectioncreateNewConnection
createConnection

Create a new connection
Deck of Cards
idbimCreateNewConnectionbimCreateConnection
command
Card
defaulttrue
labelURL / 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/bimplus/projects/e504f24c-e643-452b-b901-6a18883dc7e9/connection

JSON Structure: 

nameoptional all free attribute Ids, where are defined all parameters for CSG-contour calculationList of objects which define all rules for calculation contour’s vertex of CSG-geometry.
Structure of this objects is described below

Name

Mandatory / Optional

Type

Description

Idwill be ignoredstring(guid)Cross section definition Connection Id
elementsmandatory

string

Cross section definition name

description

optional

string

Short description of the cross section definition

freeAttributesId

JSON ArrayList of

csgParameters

mandatoryJSON Arrayelement 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 "csgParametersConnectionElement" attribute : 

Name

Mandatory / Optional

Type

Description

pointOrder

Idwill be ignoredstring(guid)Connection Id
parentwill be ignoredstring(guid)Connection parent

elementtyp

mandatory

int

Point order

string(guid)

Guid of element type "ConnectionElement"

typemandatorystring

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

mandatorystringdescription see above in xCoordinate

zCoordinate

optionalstringdescription see above in xCoordinate 
"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

optionalJSON 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
labelHTTP Method
 POST
Card
labelDescription
 Creates a new connection between single objects
Card
labelRequest
Code Block
borderColorGreen
langxml

JSON Structure: (JSON structure is an object DtoConnections)
NAME - ElementIds, optional, List<Guid>, DESCRIPTION --
NAME - ConnectionElement, mandatory Type ConnectionElement, DESCRIPTION --

Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "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
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created

{

 Code Block
borderColorRed
langxml
titleJSON
{
  "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": [{

                  "geometry": [{
                      "geoType": "StartPolygon",


                      "point": [0.0, 0.0, 2900.0]

 }, {

                    }, {
                      "geoType": "Line",


                      "point": [0.0, 0.0, 3200.0
]
 }
 ]
 }
 ],
]
                    }
                  ]
                }
              ],
              "color":
 4286611584
 }
 },
 4286611584
            }
          },
          "elementstate":
 {
 {
            "state": "0aaf5a1c-2453-40cb-9232
-315119dd288f"
 }
 }
 }, 
 ]
 },
-315119dd288f"
          }
        }
      },
    ]
  },
}

 Anchor
getConnectiongetConnectionDetailsgetConnection
getConnectionDetails
Get the connection details
 Deck of Cards
idbimGetConnectionbimGetConnectionDetails
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/connection/<id> <connection_id> 
URL: https://api-stage.bimplus.net/v2/ <team_slug>/connection/<id><connection_id>
Example: https://api.bimplus.net/v2/bimplus/connection/e5875246-7306-49b4-ab3a-30f014f01d3c
 Card
labelHTTP Method
 GET
 Card
labelDescription
 Get details of a specified connection
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

 Code Block
borderColorRed
langxml
titleJSON
{
  "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
idbimUpdateConnection
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/connection/<id><connection_id>
URL: https://api-stage.bimplus.net/v2/ <team_slug>/connection/<id><connection_id>
Example: https://api.bimplus.net/v2/bimplus/connection/e5875246-7306-49b4-ab3a-30f014f01d3c

 Card
labelHTTP Method
 PUT
 Card
labelDescription
 Updates specified connection in bimplus database.
JSON structure is the same as is defined in 'Create a new connection in Bimplus DB'
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Code Block
borderColorRed
langxml
titleJSON
{
  "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",
                  "vectorX":[1, 0, 0 ],
                  "vectorY":[0, 1, 0 ],
                  "geometry":[{
                      "geoType":"StartPolygon",
                      "point":[0, 0, 2900 ]
                    },
                    {
                      "geoType":"Line",
                      "point":[0, 0, 3200 ]
                    }
                  ]
                }
              ],
              "color":4286611584
            }
          }
        }
      }
    ]
  }
}


 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 Ok

 Code Block
borderColorRed
langxml
titleJSON
{
  "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":"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"
          },
          "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",
                  "vectorX":[1, 0, 0 ],
                  "vectorY":[0, 1, 0 ],
                  "geometry":[{
                      "geoType":"StartPolygon",
                      "point":[0, 0, 2900 ]
                    },
                    {
                      "geoType":"Line",
                      "point":[0, 0, 3200 ]
                    }
                  ]
                }
              ],
              "color":4286611584
            }
          },
          "elementstate":{
            "state":"0aaf5a1c-2453-40cb-9232-315119dd288f"
          }
        }
      }
    ]
  },
  "id":"e5875246-7306-49b4-ab3a-30f014f01d3c"
}
...
 Deck of Cards
idbimDeleteConnection
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/connection/<id><connection_id>
URL: https://api-stage.bimplus.net/v2/ <team_slug>/connection/<id><connection_id>
Example: https://api.bimplus.net/v2/bimplus/connection/e5875246-7306-49b4-ab3a-30f014f01d3c

 Card
labelHTTP Method
 DELETE
 Card
labelDescription
 Deletes a specified connection from bimplus database.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 Ok