Types

Types are reusable definitions that describe the properties and characteristics of building elements, such as walls, doors, or equipment. Types help standardize data, enabling consistent classification and efficient management of objects. For more information about types, visit our help page here.

The type object

The type object contains all the information about a type, such as their libraryGuid, name, description, type, source, uri, edition and codes.

Properties

  • Name
    libraryGuid
    Type
    string
    Description
    The Global Unique Identifier for the type library.
  • Name
    projectId
    Type
    string
    Description
    The ID of the project the type belongs to.
  • Name
    guid
    Type
    string
    Description
    The Global Unique Identifier of the type.
  • Name
    name
    Type
    string
    Description
    The name of the type.
  • Name
    class
    Type
    string
    Description
    The class of the type.
  • Name
    subtype
    Type
    string
    Description
    The subtype of the type.
GET https://api.qonic.com/v1/projects/:projectId/types

List all types

This endpoint allows you to retrieve a list of all types in a specific project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to retrieve types from.
POST https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid

Create a new type in a library

This endpoint allows you to create a new type in a specific library.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    libraryGuid
    Type
    string
    Description
    The Guid of the library to create the type for.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the type.
  • Name
    class
    Type
    string
    Description
    The class of the type.
  • Name
    subtype
    Type
    string
    Description
    The subtype of the type.
PUT https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid/types/:typeGuid

Update a type in a library

This endpoint allows you to update an existing type.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the type.
  • Name
    libraryGuid
    Type
    string
    Description
    The Guid of the library to update.
  • Name
    locationGuid
    Type
    string
    Description
    The Guid of the type to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the type.
  • Name
    class
    Type
    string
    Description
    The class of the type.
  • Name
    subtype
    Type
    string
    Description
    The subtype of the type.
DELETE https://api.qonic.com/v1/projects/:projectId/types/:libraryGuid/types/:typeGuid

Delete a type in a library

This endpoint allows you to permanently delete a specific type inside a library from a project. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the spatial location.
  • Name
    libraryGuid
    Type
    string
    Description
    The Guid of the codification library to delete the type from.
  • Name
    typeGuid
    Type
    string
    Description
    The Guid of the type to delete.
‹
Previous
Spatial