AlphaAlpha Docs

Types

Types API

Create a new type

POST
/types
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types" \  -H "Content-Type: application/json" \  -d '{    "concept": "string",    "name": "string"  }'
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Delete by list of ids in current tenant

DELETE
/types
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/types" \  -H "Content-Type: application/json" \  -d '[    "string"  ]'
Empty
{
  "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"
}

Check if a prefix is already used

GET
/types/check-prefix
AuthorizationBearer <token>

In: header

Query Parameters

resolvedPrefix*string
excludeTypeId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/check-prefix?resolvedPrefix=string"
{
  "property1": null,
  "property2": null
}
{
  "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"
}

Find by list of ids in current tenant

GET
/types/find
AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/find?ids=string"
[
  {
    "baseVariables": [
      {
        "configuration": {
          "defaultValue": 0.1,
          "isFixed": true,
          "max": 0.1,
          "min": 0.1,
          "stepSize": 0.1
        },
        "id": "string"
      }
    ],
    "color": "string",
    "compensateNulpunt": true,
    "concept": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "elementNamePrefix": "string",
    "enforcedCategories": [
      "string"
    ],
    "hideBaseOptionInName": true,
    "id": "string",
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "name": "string",
    "options": [
      {
        "activeViews": [
          "string"
        ],
        "category": "string",
        "codes": [
          {
            "code": "string",
            "description": "string",
            "option": "string",
            "price": 0.1,
            "visible": true
          }
        ],
        "id": "string",
        "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"
                  }
                ]
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "staticModels": [
      {
        "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
                  }
                }
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        },
        "nameOverrides": {
          "property1": "string",
          "property2": "string"
        },
        "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
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "variantSuffixFormat": "string",
    "views": [
      {
        "active": true,
        "activeCategories": [
          "string"
        ],
        "description": "string",
        "id": "string",
        "maxHeight": 0.1,
        "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
          }
        }
      }
    ]
  }
]
{
  "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"
}

Find all for current tenant

GET
/types/find-all
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/find-all"
[
  {
    "baseVariables": [
      {
        "configuration": {
          "defaultValue": 0.1,
          "isFixed": true,
          "max": 0.1,
          "min": 0.1,
          "stepSize": 0.1
        },
        "id": "string"
      }
    ],
    "color": "string",
    "compensateNulpunt": true,
    "concept": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "elementNamePrefix": "string",
    "enforcedCategories": [
      "string"
    ],
    "hideBaseOptionInName": true,
    "id": "string",
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "name": "string",
    "options": [
      {
        "activeViews": [
          "string"
        ],
        "category": "string",
        "codes": [
          {
            "code": "string",
            "description": "string",
            "option": "string",
            "price": 0.1,
            "visible": true
          }
        ],
        "id": "string",
        "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"
                  }
                ]
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "staticModels": [
      {
        "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
                  }
                }
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        },
        "nameOverrides": {
          "property1": "string",
          "property2": "string"
        },
        "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
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "variantSuffixFormat": "string",
    "views": [
      {
        "active": true,
        "activeCategories": [
          "string"
        ],
        "description": "string",
        "id": "string",
        "maxHeight": 0.1,
        "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
          }
        }
      }
    ]
  }
]
{
  "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"
}

Find by id in current tenant

GET
/types/find/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/find/string"
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Import a new type from file

POST
/types/import
AuthorizationBearer <token>

In: header

Query Parameters

name*string
concept*string
overwrite*boolean

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/import?name=string&concept=string&overwrite=true" \  -F file="string"
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Import a type from WOCO JSON

POST
/types/import/woco
AuthorizationBearer <token>

In: header

Query Parameters

name*string
concept*string
overwrite*boolean

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/import/woco?name=string&concept=string&overwrite=true" \  -F file="string"
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/types/page
AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

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"
        }
      ],
      "color": "string",
      "compensateNulpunt": true,
      "concept": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "elementNamePrefix": "string",
      "enforcedCategories": [
        "string"
      ],
      "hideBaseOptionInName": true,
      "id": "string",
      "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"
                }
              }
            ],
            "decisionTree": {
              "id": "string",
              "result": null
            }
          }
        }
      ],
      "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"
                }
              }
            ],
            "decisionTree": {
              "id": "string",
              "result": null
            }
          }
        }
      ],
      "name": "string",
      "options": [
        {
          "activeViews": [
            "string"
          ],
          "category": "string",
          "codes": [
            {
              "code": "string",
              "description": "string",
              "option": "string",
              "price": 0.1,
              "visible": true
            }
          ],
          "id": "string",
          "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"
                    }
                  ]
                }
              }
            ],
            "decisionTree": {
              "id": "string",
              "result": null
            }
          }
        }
      ],
      "staticModels": [
        {
          "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
                    }
                  }
                }
              }
            ],
            "decisionTree": {
              "id": "string",
              "result": null
            }
          },
          "nameOverrides": {
            "property1": "string",
            "property2": "string"
          },
          "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
                }
              }
            ],
            "decisionTree": {
              "id": "string",
              "result": null
            }
          }
        }
      ],
      "variantSuffixFormat": "string",
      "views": [
        {
          "active": true,
          "activeCategories": [
            "string"
          ],
          "description": "string",
          "id": "string",
          "maxHeight": 0.1,
          "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
            }
          }
        }
      ]
    }
  ],
  "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"
}

Search types

GET
/types/search
AuthorizationBearer <token>

In: header

Query Parameters

search?string
pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/search"
{
  "content": [
    {
      "concept": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "massModels": [
        {
          "id": "string"
        }
      ],
      "models": [
        {
          "id": "string"
        }
      ],
      "name": "string",
      "options": [
        {
          "activeViews": [
            "string"
          ],
          "category": "string",
          "codes": [
            {
              "code": "string",
              "description": "string",
              "option": "string",
              "price": 0.1,
              "visible": true
            }
          ],
          "id": "string",
          "isNeighborOption": true,
          "name": "string",
          "neighborOption": true,
          "phase": "PLAN",
          "visible": true
        }
      ],
      "restrictions": [
        {
          "active": true,
          "id": "string"
        }
      ],
      "staticModels": [
        {
          "id": "string",
          "modelNamePrefix": "string",
          "stats": {
            "glbInDb": 0,
            "lastSynced": "2019-08-24T14:15:22Z",
            "modelsComplete": 0,
            "modelsInDb": 0,
            "rvtInDb": 0,
            "totalFileSize": 0,
            "totalModels": 0
          },
          "type": "CONCEPT"
        }
      ],
      "stats": {
        "glbInDb": 0,
        "lastSynced": "2019-08-24T14:15:22Z",
        "modelsComplete": 0,
        "modelsInDb": 0,
        "rvtInDb": 0,
        "totalFileSize": 0,
        "totalModels": 0
      },
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "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"
}

Get all types for the current tenant

GET
/types/tenant/list
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/tenant/list"
[
  {
    "baseVariables": [
      {
        "configuration": {
          "defaultValue": 0.1,
          "isFixed": true,
          "max": 0.1,
          "min": 0.1,
          "stepSize": 0.1
        },
        "id": "string"
      }
    ],
    "color": "string",
    "compensateNulpunt": true,
    "concept": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "elementNamePrefix": "string",
    "enforcedCategories": [
      "string"
    ],
    "hideBaseOptionInName": true,
    "id": "string",
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "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"
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "name": "string",
    "options": [
      {
        "activeViews": [
          "string"
        ],
        "category": "string",
        "codes": [
          {
            "code": "string",
            "description": "string",
            "option": "string",
            "price": 0.1,
            "visible": true
          }
        ],
        "id": "string",
        "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"
                  }
                ]
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "staticModels": [
      {
        "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
                  }
                }
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        },
        "nameOverrides": {
          "property1": "string",
          "property2": "string"
        },
        "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
              }
            }
          ],
          "decisionTree": {
            "id": "string",
            "result": null
          }
        }
      }
    ],
    "variantSuffixFormat": "string",
    "views": [
      {
        "active": true,
        "activeCategories": [
          "string"
        ],
        "description": "string",
        "id": "string",
        "maxHeight": 0.1,
        "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
          }
        }
      }
    ]
  }
]
{
  "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"
}

Get page by page number and size

GET
/types/tenant/page
AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/tenant/page"
{
  "content": [
    {
      "concept": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "previewBlob": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "totalStaticModels": 0,
      "totalStaticModelsComplete": 0,
      "totalStaticModelsFileSize": 0,
      "totalStaticModelsInDb": 0,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "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"
}

Update an existing type

PATCH
/types/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/types/string" \  -H "Content-Type: application/json" \  -d '{    "concept": "string",    "name": "string"  }'
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Delete by id in current tenant

DELETE
/types/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/types/string"
Empty
{
  "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"
}

Duplicate a type

POST
/types/{id}/duplicate
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

name?string
concept?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/string/duplicate"
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Upload preview image for type

POST
/types/{id}/preview
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/string/preview" \  -F file="string"
{
  "baseVariables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "string"
    }
  ],
  "color": "string",
  "compensateNulpunt": true,
  "concept": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "elementNamePrefix": "string",
  "enforcedCategories": [
    "string"
  ],
  "hideBaseOptionInName": true,
  "id": "string",
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "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"
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "name": "string",
  "options": [
    {
      "activeViews": [
        "string"
      ],
      "category": "string",
      "codes": [
        {
          "code": "string",
          "description": "string",
          "option": "string",
          "price": 0.1,
          "visible": true
        }
      ],
      "id": "string",
      "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"
                }
              ]
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "staticModels": [
    {
      "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
                }
              }
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      },
      "nameOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "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
            }
          }
        ],
        "decisionTree": {
          "id": "string",
          "result": null
        }
      }
    }
  ],
  "variantSuffixFormat": "string",
  "views": [
    {
      "active": true,
      "activeCategories": [
        "string"
      ],
      "description": "string",
      "id": "string",
      "maxHeight": 0.1,
      "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
        }
      }
    }
  ]
}
{
  "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"
}

Get project usage for a type

GET
/types/{id}/project-usage
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/types/string/project-usage"
[
  {
    "houseCount": 0,
    "houses": [
      {
        "blockId": "string",
        "bnr": "string",
        "scenarioId": "string"
      }
    ],
    "projectId": "string",
    "projectName": "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"
}

Calculate sandbox data for a type

POST
/types/{id}/sandbox
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/string/sandbox" \  -H "Content-Type: application/json" \  -d '[    {      "code": "string",      "option": "string"    }  ]'
{
  "massModels": [
    {
      "box": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "id": "string",
      "position": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "rotation": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "type": "Box"
    }
  ],
  "staticModels": [
    {
      "id": "string",
      "name": "string",
      "position": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "rotation": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "staticModelTreeId": "string"
    }
  ],
  "variables": [
    {
      "configuration": {
        "defaultValue": 0.1,
        "isFixed": true,
        "max": 0.1,
        "min": 0.1,
        "stepSize": 0.1
      },
      "id": "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"
}