Alpha API ReferenceTypes
Get page by page number and size with optional sorting based on field to sortBy and direction
Returns a lightweight paginated list of types for overview display
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/types/page"{
"content": [
{
"baseVariables": [
{
"configuration": {
"defaultValue": 0.1,
"isFixed": true,
"max": 0.1,
"min": 0.1,
"stepSize": 0.1
},
"id": "string"
}
],
"closingPhasePresets": [
{
"description": "string",
"id": "string",
"name": "string",
"optionCategories": [
"string"
],
"optionNames": [
"string"
],
"order": 0
}
],
"color": "string",
"compensateInsertion": true,
"concept": "string",
"cornerHouseSettings": {
"left": {
"code": "string",
"mirrored": true
},
"middle": {
"code": "string",
"mirrored": true
},
"right": {
"code": "string",
"mirrored": true
}
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"elementNamePrefix": "string",
"enforcedCategories": [
"string"
],
"footsteps": [
{
"footsteps": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"direction": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"displayName": "string",
"id": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"viewRange": {
"horizontalMax": 0.1,
"horizontalMin": 0.1,
"verticalMax": 0.1,
"verticalMin": 0.1
},
"visible": true
}
}
]
},
"id": "string"
}
],
"hideBaseOptionInName": true,
"hideRestrictedOptions": true,
"id": "string",
"lightSources": [
{
"id": "string",
"lightSources": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"color": "string",
"distance": 0.1,
"id": "string",
"intensity": 0.1,
"length": 0.1,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "POINT",
"visible": true,
"width": 0.1
}
}
]
}
}
],
"massModel": [
{
"id": "string",
"models": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "Box"
}
}
]
}
}
],
"models": [
{
"id": "string",
"models": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"material": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "WALL"
}
}
]
}
}
],
"name": "string",
"optionChangers": [
{
"id": "string",
"optionChangers": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"id": "string",
"optionName": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
}
}
}
]
}
}
],
"optionSalesPresets": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"order": 0
}
],
"options": [
{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"consumerOption": true,
"id": "string",
"isConsumerOption": true,
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": true
}
],
"previewBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"restrictions": [
{
"active": true,
"category": "string",
"id": "string",
"restrictions": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"id": "string",
"options": [
{
"allowedCodes": [
"string"
],
"optionName": "string",
"reason": "string"
}
]
}
}
]
}
}
],
"staticModelOffset": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"staticModels": [
{
"disabledInViewer": true,
"id": "string",
"modelNamePrefix": "string",
"models": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"exhaustiveOptions": [
"string"
],
"id": "string",
"isEmpty": true,
"isExhaustive": true,
"name": "string",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"scale": 0.1
}
}
]
},
"stats": {
"glbInDb": 0,
"lastSynced": "2019-08-24T14:15:22Z",
"modelsComplete": 0,
"modelsInDb": 0,
"rvtInDb": 0,
"totalFileSize": 0,
"totalModels": 0
},
"type": "CONCEPT"
}
],
"tenantId": "string",
"totalStaticModels": 0,
"totalStaticModelsComplete": 0,
"totalStaticModelsFileSize": 0,
"totalStaticModelsGlbInDb": 0,
"totalStaticModelsInDb": 0,
"totalStaticModelsRvtInDb": 0,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variables": [
{
"id": "string",
"phase": "PLAN",
"tree": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"defaultValue": 0.1,
"isFixed": true,
"max": 0.1,
"min": 0.1,
"stepSize": 0.1
}
}
]
}
}
],
"variantSuffixFormat": "string",
"version": 0,
"views": [
{
"active": true,
"activeCategories": [
"string"
],
"clipAxis": "string",
"description": "string",
"id": "string",
"label": "string",
"maxHeight": {
"formula": "string",
"isConstant": true
},
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"target": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
}
}
],
"viewsheets": [
{
"id": "string",
"viewsheets": {
"branches": [
{
"choices": [
{
"code": "string",
"option": "string"
}
],
"id": "string",
"result": {
"displayName": "string",
"id": "string",
"pattern": "string",
"type": "EXACT"
}
}
]
}
}
]
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"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"
}