Page History

...

Deck of Cards

id	bimCreateCrossSectionDefinition

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/crosssectiondefinitions

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". Expression may contain mathematical operation: [sin], [cos], [tan], [pi], +, /, -, *
yCoordinate	mandatory	string	description see above in xCoordinate
zCoordinate	optional	string	description see above in xCoordinate

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"
}

...

Deck of Cards

id	bimCreateCrossSectionForDefinition

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

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. 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.
crossSectionCharacteristics	optional	JSON Array	List of objects which define all parameters of sectional characteristics for cross section. e.g Elastic section modulus
shape	optional	JSON Array	List of points whole profile contour

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

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

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
		}
	],
	"namecrossSectionCharacteristics":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
}
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
}

Anchor

getCrossSection
	getCrossSection

...

Deck of Cards

id	bimGetCrossSection

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/crosssections/<cross_section_id>

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

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

 {
	"crossSectionParametersname":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200"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
		}
	],
	"namecrossSectionCharacteristics":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
}

	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
}

Anchor

	getAllCrossSectionsOfCrossSectionDefinition
	getAllCrossSectionsOfCrossSectionDefinition

...

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

[ 
{
	"crossSectionParametersname":
	[
		"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
		}
	],
	"namecrossSectionCharacteristics":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"

	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
},
...
]

Anchor

	updateCrossSectionOfCrossSectionDefinition
	updateCrossSectionOfCrossSectionDefinition

...

Deck of Cards

id	bimUpdateCrossSectionOfCrossSectionDefinition

Card

default	true
label	URL / Resource / JSON Structure

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

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

{
	"crossSectionParametersname":
	[
		"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":
	[
		{
			"namefreeAttibId":"IPE-200 "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
	"description":"parameters IPE-200"
}            "value": 200,
        }
	],
}

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
		}
	],
	"name"crossSectionCharacteristics":
	[
		{
			"freeAttibId":"IPE-200 "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"            "value": 200,
            "name": "Area"
        }
	],
}

Anchor

	deleteCrossSection
	deleteCrossSection

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 18

New Version 19

Key