Page History

...

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

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.
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
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	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	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
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
}

...

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

Optional query parameters

Name

Type

Default value

Description

filter

string

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.

NOTE :
To get details for cross section or groups of cross sections without known or available cross_section_id is possible
to use this call without using cross_section_id, but in such case must be defined requested cross section(s) with filter.
When is used filter to define requested cross sections will be returned all cross sections with matching filter pattern.

e.g. to get all cross sections which names contains string 'H200' let's use api with filter

https://api-stage.bimplus.net/v2/content/crosssections?filter=name=H200

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

{
	"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
        },
	...
	]
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 23

New Version 24

Key