Versions Compared

Key

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

...

Deck of Cards
idbimGetAllCrossSectionsOfCrossSectionDefinition
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

Examplehttps://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections

Card
labelHTTP Method
 GET
Card
labelDescription
 Get all cross sections which were created for specified cross section definition
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
        },
	...
	]
},
...
]

Anchor
updateCrossSectionOfCrossSectionDefinition
updateCrossSectionOfCrossSectionDefinition

Update cross section for cross section definition
Deck of Cards
idbimUpdateCrossSectionOfCrossSectionDefinition
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/crosssectiondefinitions/<cross_section_definition_id>crosssections/<cross_section_id>

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

Examplehttps://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections/bef3f6a2-e869-4282-adab-84114ad672f7


Card
labelHTTP Method
 PUT
Card
labelDescription

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

...

Update cross section for cross section definition
Resource: content/crosssectiondefinitions/<cross_section_definition_id>crosssections/<cross_section_id>

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

Examplehttps://api-stage.bimplus.net/v2/content/crosssectiondefinitions/1b0b4c54-1084-4b7b-8b6b-d0154e44f05a/crosssections/bef3f6a2-e869-4282-adab-84114ad672f7

Deck of Cards
idbimUpdateCrossSectionOfCrossSectionDefinition
Card
defaulttrue
labelURL / Resource / JSON Structure
Card
labelHTTP Method
 PUT
Card
labelDescription

 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
labelRequest
Code Block
borderColorGreen
langxml
titleHeadersStatus
AuthorizationStatus: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json200 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-1ae5efaae4f0IPE-200",
			"valuedescription":200
		},
		{
			"freeAttibId"parameters IPE-200",
	"id":"46065318bef3f6a2-8776e869-4f304282-85ffadab-c7276b09409784114ad672f7",
			"valuecrossSectionParameters":5.6
		},[
		{
			"freeAttibId":"ec94c7eea51576ae-b810ecaa-401243c0-9e94b00c-cc7ed2a9c4bd1ae5efaae4f0",
			"value":100,

		},
		{200
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5name":B
		},
		{
			"freeAttibId":"df51e06446065318-ee1b8776-4b5d4f30-bdaa85ff-5b053fd8b8a2c7276b094097",
			"value":125.6
		}
	],
	"crossSectionCharacteristicsname":r1
		[},
		{
			"freeAttibId": "f6dccf78ec94c7ee-0bb7b810-4fe74012-bd249e94-a6dee284fcd0cc7ed2a9c4bd",
            			"value": 200,
        }
	],
}
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"
	"crossSectionParameters100,
			"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": "a51576aef6dccf78-ecaa0bb7-43c04fe7-b00cbd24-1ae5efaae4f0a6dee284fcd0",
			            "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" "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,
            "valuey": 200112.7599257,
            "namez": "Area"0
        },
	...
	],
}

Anchor
deleteCrossSection
deleteCrossSection

...