Types
Manage type libraries and building element types within projects.
GET https://api.qonic.com/v1/projects/:projectId/types
Get all types
Returns all element types for the project, grouped by their parent type library. Use this to retrieve the available type definitions that can be assigned to building elements.
Path parameters
-
- Name
-
projectId - Type
- integer
- Required
- Required
- Description
- Identifier of the project.
Response fields
-
- Name
-
typesPerLibrary - Type
- object
- Required
- Optional
- Description
- A dictionary mapping library identifiers to their type definitions, each represented as grouped properties.
Error responses
-
- Name
-
401 - Type
- error
- Description
- Authentication required. Provide a valid Bearer token in the Authorization header.
-
- Name
-
403 - Type
- error
- Description
- Insufficient permissions for this operation
-
- Name
-
404 - Type
- error
- Description
- The requested resource was not found
POST https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid
Create type
Creates a new element type within the specified type library. Types define reusable templates that can be assigned to building elements.
Path parameters
-
- Name
-
projectId - Type
- integer
- Required
- Required
- Description
- Identifier of the project.
-
- Name
-
libraryGuid - Type
- string
- Required
- Required
- Description
- Identifier of the library.
Request body
-
- Name
-
name - Type
- string
- Required
- Required
- Description
- Display name of the type.
-
- Name
-
class - Type
- string
- Required
- Optional
- Description
- IFC entity class (e.g., IfcWallType, IfcDoorType).
-
- Name
-
subtype - Type
- string
- Required
- Optional
- Description
- Predefined subtype within the class.
Response fields
-
- Name
-
guid - Type
- string
- Required
- Optional
- Description
- The unique identifier of the type.
-
- Name
-
name - Type
- string
- Required
- Optional
- Description
- The display name of the type.
-
- Name
-
libraryGuid - Type
- string
- Required
- Optional
- Description
- The unique identifier of the library this type belongs to.
Error responses
-
- Name
-
400 - Type
- error
- Description
- Invalid request parameters or body
-
- Name
-
401 - Type
- error
- Description
- Authentication required. Provide a valid Bearer token in the Authorization header.
-
- Name
-
403 - Type
- error
- Description
- Insufficient permissions for this operation
-
- Name
-
404 - Type
- error
- Description
- The requested resource was not found
PUT https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid/types/:typeGuid
Update type in project library
Updates the properties of an existing element type. Use this to rename or modify a type's attributes.
Path parameters
-
- Name
-
projectId - Type
- integer
- Required
- Required
- Description
- Identifier of the project.
-
- Name
-
libraryGuid - Type
- string
- Required
- Required
- Description
- Identifier of the library.
-
- Name
-
typeGuid - Type
- string
- Required
- Required
- Description
- Identifier of the type.
Request body
-
- Name
-
name - Type
- string
- Required
- Required
- Description
- Display name of the type.
-
- Name
-
class - Type
- string
- Required
- Optional
- Description
- IFC entity class (e.g., IfcWallType, IfcDoorType).
-
- Name
-
subtype - Type
- string
- Required
- Optional
- Description
- Predefined subtype within the class.
Error responses
-
- Name
-
400 - Type
- error
- Description
- Invalid request parameters or body
-
- Name
-
401 - Type
- error
- Description
- Authentication required. Provide a valid Bearer token in the Authorization header.
-
- Name
-
403 - Type
- error
- Description
- Insufficient permissions for this operation
-
- Name
-
404 - Type
- error
- Description
- The requested resource was not found
DELETE https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid/types/:typeGuid
Delete type in project library
Permanently removes an element type from the library. Any elements currently assigned this type will no longer reference it.
Path parameters
-
- Name
-
projectId - Type
- integer
- Required
- Required
- Description
- Identifier of the project.
-
- Name
-
libraryGuid - Type
- string
- Required
- Required
- Description
- Identifier of the library.
-
- Name
-
typeGuid - Type
- string
- Required
- Required
- Description
- Identifier of the type.
Error responses
-
- Name
-
401 - Type
- error
- Description
- Authentication required. Provide a valid Bearer token in the Authorization header.
-
- Name
-
403 - Type
- error
- Description
- Insufficient permissions for this operation
-
- Name
-
404 - Type
- error
- Description
- The requested resource was not found