Alpha API ReferenceConfiguration
Calculate Configurator Data
Calculates configurator data for a house in a project based on the provided
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
projectId*string
houseId*string
Query Parameters
scenarioId?string
extension?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/configurations/public/string/string/string/calculate-configurator-data" \ -H "Content-Type: application/json" \ -d '{ "additionalOptions": [ { "id": "string", "position": { "x": 0.1, "y": 0.1, "z": 0.1 }, "rotation": { "x": 0.1, "y": 0.1, "z": 0.1 }, "type": "WANDCONTACTDOOS" } ], "choices": [ { "code": "string", "option": "string" } ] }'{
"additionalOptions": [
{
"description": "string",
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"type": "WANDCONTACTDOOS"
}
],
"basePrice": 0.1,
"choices": [
{
"code": "string",
"option": "string"
}
],
"compensateInsertion": true,
"consequences": {
"property1": [
{
"code": "string",
"optionName": "string"
}
],
"property2": [
{
"code": "string",
"optionName": "string"
}
]
},
"coordinateSystem": "string",
"footsteps": [
{
"direction": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"displayName": "string",
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"viewRange": {
"horizontalMax": 0.1,
"horizontalMin": 0.1,
"verticalMax": 0.1,
"verticalMin": 0.1
},
"visible": true
}
],
"hideRestrictedOptions": true,
"houseId": "string",
"lightSources": [
{
"color": "string",
"distance": 0.1,
"id": "string",
"intensity": 0.1,
"length": 0.1,
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"type": "POINT",
"visible": true,
"width": 0.1
}
],
"models": [
{
"blob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"materialBreakdown": [
{
"areaM2": 0.1,
"categories": "string",
"materialName": "string",
"volumeM3": 0.1
}
],
"name": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"productId": "string",
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"staticModelTreeId": "string"
}
],
"optionChangers": [
{
"id": "string",
"optionName": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
}
}
],
"optionsGroupedByCategory": {
"property1": [
{
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"message": "string",
"price": 0.1,
"valid": true
}
],
"option": "string",
"phase": "PLAN"
}
],
"property2": [
{
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"message": "string",
"price": 0.1,
"valid": true
}
],
"option": "string",
"phase": "PLAN"
}
]
},
"preserveSourceVerticalPosition": true,
"status": "AVAILABLE",
"typeId": "string",
"views": [
{
"active": true,
"activeCategories": [
"string"
],
"clipAxis": "string",
"description": "string",
"id": "string",
"label": "string",
"maxHeight": 0.1,
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"target": {
"x": 0.1,
"y": 0.1,
"z": 0.1
}
}
]
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}