Versions Compared

Key

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

...

Deck of Cards
idbimCreateCrossSectionDefinition
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/crosssectiondefinitions

URLhttps://api-stage.bimplus.net/v2/ content/crosssectiondefinitions

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


Optional query parameters

NameTypeDefault valueDescription
checkbooleantrue

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,
so in such case new cross section definition will be created in such case.

 

JSON Structure

Name

Mandatory / Optional

Type

Description

Idwill be ignoredstring(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

mandatoryJSON ArrayList 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".
Expression may contain mathematical operation: [sin], [cos], [tan], [pi], +, /, -, *

yCoordinate

mandatorystringdescription see above in xCoordinate

zCoordinate

optionalstringdescription see above in xCoordinate 
Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new cross section definition in bimplus database. Cross section definition is defined as contour of CSG-geometry.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
	"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
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
	"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"
}

...

Deck of Cards
idbimCreateCrossSectionForDefinition
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/crosssectiondefinitions/<cross_section_definition_id>/crosssections

URLhttps://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

NameTypeDefault valueDescription
checkbooleantrue

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

Idwill be ignoredstring(guid)Cross section Id

name

mandatory

string

Cross section name

description

optional

string

Short description of the cross section

crossSectionParameters

mandatoryJSON Array

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.

crossSectionCharacteristicsoptionalJSON ArrayList of objects which define all parameters of sectional characteristics for cross section. e.g Elastic section modulus
shapeoptionalJSON ArrayList of points whole profile contour


JSON Structure of the object in "crossSectionParameters" attribute

Name

Mandatory / Optional

Type

Description

freeAttibIdmandatorystring(guid)Id of the Free Attibute (attribute is used in array "freeAttributesId" of cross section definition to define parameter name)

value

mandatory

object

free attribute value

name

optional

string

Name of free attribute

Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new cross section for specified cross section definition in bimplus database.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
	"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
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
	"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"
        }
	],
}

...

Deck of Cards
idbimGetCrossSection
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/crosssections/<cross_section_id>

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

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


Optional query parameters

NameTypeDefault valueDescription
filterstring 

When filter "name=I200" is defined the API will return only cross section 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.


Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified cross section
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
{
	"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
        },
	...
	]
}


...