Custom Properties

Property libraries are used to define and manage properties and property sets. By default every project contains two property libraries: a predefined read-only Qonic Properties library based on the IFC schema, and Custom Properties library which can be modified to create and manage your own properties. For more information about custom properties, visit our help page here.

The property set object

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

Properties

  • Name
    projectId
    Type
    string
    Description
    The ID of the project the library belongs to.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set inside the custom properties.
  • Name
    propertyDefinitionId
    Type
    string
    Description
    The ID of the property definition.
  • Name
    id
    Type
    string
    Description
    The ID of the property set.
  • Name
    name
    Type
    string
    Description
    The name of the property set.
  • Name
    propertyDefinitions
    Type
    array
    Description
    An array of property definitions.
  • Name
    entityTypes
    Type
    array
    Description
    An array of entity types.

The property object

The property object contains the name, dataType, measureType, unit and enumerationValues properties.

Properties

  • Name
    id
    Type
    string
    Description
    The ID of the property definition.
  • Name
    guid
    Type
    string
    Description
    The Global Unique Identifier of the property definition.
  • Name
    name
    Type
    string
    Description
    The name of the property definition.
  • Name
    dataType
    Type
    string
    Description
    The dataType of the property definition.
  • Name
    measureType
    Type
    string
    Description
    The measureType of the property definition.
  • Name
    unitName
    Type
    string
    Description
    The name of the unit of the property definition.
  • Name
    enumerationValues
    Type
    array
    Description
    The array of enumerationValues of the property definition.
GET https://api.qonic.com/v1/projects/:projectId/customProperties

List all custom properties

This endpoint allows you to retrieve all custom properties in a specific project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to retrieve custom properties from.
POST https://api.qonic.com/v1/projects/:projectId/customProperties/property-sets

Create a property set

This endpoint allows you to create a new property set in the custom properties library in a project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to create the property set in.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the property set.
  • Name
    entityTypes
    Type
    array
    Description
    An array of entityTypes.
PUT https://api.qonic.com/v1/projects/:projectId/customProperties/property-sets/:propertySetId

Update a property set

This endpoint allows you to update a property set from a project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the property set.
  • Name
    entityTypes
    Type
    array
    Description
    An array of entityTypes.
DELETE https://api.qonic.com/v1/projects/:projectId/customProperties/property-sets/:propertySetId

Delete a property set

This endpoint allows you to permanently delete a property set from a project. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set to delete.
POST https://api.qonic.com/v1/projects/:projectId/customProperties/:propertySetId/property

Create new property in property set

This endpoint allows you to create a new property in a specfied property set.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set to create the property for.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the property.
  • Name
    dataType
    Type
    string
    Description
    The identification of the property.
  • Name
    measureType
    Type
    string
    Description
    The measureType of the property.
  • Name
    unit
    Type
    string
    Description
    The unit of the property.
  • Name
    enumerationValues
    Type
    array
    Description
    An array of enumerationValues of the property.
PUT https://api.qonic.com/v1/projects/:projectId/customProeprties/property-sets/:propertySetId/property/:propertyDefinitionId

Update a property

This endpoint allows you to update an existing property in a property set.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set to update.
  • Name
    propertyDefinitionId
    Type
    string
    Description
    The ID of the property definition to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the property.
  • Name
    dataType
    Type
    string
    Description
    The identification of the property.
  • Name
    measureType
    Type
    string
    Description
    The measureType of the property.
  • Name
    unit
    Type
    string
    Description
    The unit of the property.
  • Name
    enumerationValues
    Type
    array
    Description
    An array of enumerationValues of the property.
DELETE https://api.qonic.com/v1/projects/:projectId/customProperties/property-sets/:propertySetId/property/:propertyDefinitionId

Delete a property

This endpoint allows you to permanently delete a property from a property set in a project. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    propertySetId
    Type
    string
    Description
    The ID of the property set containing the property to delete.
  • Name
    propertyDefinitionId
    Type
    string
    Description
    The ID of the property to delete.
‹
Previous
Codification
›
Next
Material