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
    string
    Required
    Required
    Description
    Identifier of the project.

Response fields

  • Name
    typesPerLibrary
    Type
    object
    Required
    Optional
    Description
    A dictionary mapping library GUIDs to their type entries. Use the type GUID as the typeGuid path parameter.

Error responses

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

GET https://api.qonic.com/v1/projects/:projectId/types/:typeGuid

Get a single type by id

Resolves a single type guid (e.g. the TypeId returned by the product query) without paging through the full type list yourself.

Path parameters

  • Name
    projectId
    Type
    string
    Required
    Required
    Description
    Identifier of the project.
  • Name
    typeGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the type (e.g. the TypeId returned by the product query).

Response fields

  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the type. Use this as the typeGuid path parameter.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties of this type element.
    • Name
      set
      Type
      string
      Required
      Optional
      Description
      The name of the property set this property belongs to.
    • Name
      name
      Type
      string
      Required
      Optional
      Description
      The property name.
    • Name
      value
      Type
      string
      Required
      Optional
      Description
      The property value.

Error responses

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/json
    Description
    Not Found

    Body: ProblemDetails

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
    string
    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
    application/problem+json
    Description
    Invalid request parameters or body

    Body: ProblemDetails

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

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
    string
    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
    application/problem+json
    Description
    Invalid request parameters or body

    Body: ProblemDetails

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

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
    string
    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
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

‹
Previous
Spatial Locations