Versions Compared

Old Version 10

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 11

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimCreateCrossSectionForDefinition
Card
defaulttrue
labelURL / 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

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.


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

double

free attribute value

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",
	"crosssectionparameterscrossSectionParameters":
	[
		{
			"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
		}
	],
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
	"crosssectionparameterscrossSectionParameters":
	[
		{
			"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"
}

...