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

Optional query parameters

Name

Type

Default value

Description

check

boolean

true

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
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",
	"fabrication": "Rolled",
	"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"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 31

New Version 32

Key