Cross Section Service
Bimplus DB
- Create a new cross section definition
- Get details of the cross section definition
- Get all cross sections section definitions
- 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 cross section
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.
eg: Bimplus DB: https://api-stage.bimplus.net/v2/content//crosssectiondefinitions. Similar call in Team DB will be https://api-stage.bimplus.net/v2/<team_slug>/crosssectiondefinitions.
Create a new cross section definition in Bimplus DB
URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions
Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
Id | will be ignored | string(guid) | Cross section definition Id |
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 |
mandatory | JSON Array | List of objects which define all rules for calculation contour’s vertex of CSG-geometry. Structure of this objects is described below. |
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". |
yCoordinate |
mandatory | string | description see above in xCoordinate |
zCoordinate |
optional | string | description see above in xCoordinate |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/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" }, ... ] }
Status: 201 Created
{ "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
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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
URL: https://api-stage.bimplus.net/v2/ content/crosssectiondefinitions
Example: https://api-stage.bimplus.net/v2/content/crosssectiondefinitions
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[ { "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" }, ... ]
Update the cross section definition
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
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'
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/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" }
Status: 200 Ok
{ "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
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
Deletes a specified cross section definition from bimplus database.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 Ok
Create a new cross section for cross section definition in Bimplus DB
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
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
Id | will be ignored | string(guid) | Cross section Id |
name |
mandatory |
string |
Cross section name |
description |
optional |
string |
Short description of the cross section |
crossSectionParameters |
mandatory | JSON Array | List of objects which define all parameters values for cross section. |
JSON Structure of the object in "crossSectionParameters" attribute :
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
freeAttibId | mandatory | string(guid) | Id of the Free Attibute (attribute is used in array "freeAttributesId" of cross section definition to define parameter name) |
value |
mandatory |
double |
free attribute value |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/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 } ], }
Status: 201 Created
{ "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 } ], "name":"IPE-200", "description":"parameters IPE-200", "id":"bef3f6a2-e869-4282-adab-84114ad672f7" }
Get details of cross section
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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 } ], "name":"IPE-200", "description":"parameters IPE-200", "id":"bef3f6a2-e869-4282-adab-84114ad672f7" }
Get all cross sections from cross section definition
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[ { "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 } ], "name":"IPE-200", "description":"parameters IPE-200", "id":"bef3f6a2-e869-4282-adab-84114ad672f7" }, ... ]
Update cross section for cross section definition
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
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'
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "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 } ], "name":"IPE-200", "description":"parameters IPE-200" }
Status: 200 Ok
{ "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 } ], "name":"IPE-200", "description":"parameters IPE-200", "id":"bef3f6a2-e869-4282-adab-84114ad672f7" }
Delete the cross section
URL: https://api-stage.bimplus.net/v2/ content/crosssections/<cross_section_id>
Example: https://api-stage.bimplus.net/v2/content/crosssections/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a
Deletes a specified cross section from bimplus database.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 Ok