Codifications

Manage codification (classification) libraries and codes within projects. Codifications allow you to classify building elements using standard classification systems.

GET https://api.qonic.com/v1/projects/:projectId/codifications

Get all codification libraries and their codes

Returns all codification libraries and their codes for the given project.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.

Response fields

  • Name
    codificationLibraries
    Type
    array<object>
    Required
    Optional
    Description
    The list of codification libraries.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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/codifications

Create new codification library

Creates a new codification library in the project. Use this to organize classification codes into logical groupings.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.

Request body

  • Name
    name
    Type
    string
    Required
    Required
    Description
    Display name of the library.
  • Name
    type
    Type
    string
    Required
    Optional
    Description
    Classification system type (e.g., UniClass, OmniClass, NL-SfB).
  • Name
    uri
    Type
    string
    Required
    Optional
    Description
    URI reference to the classification system specification.
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    Human-readable description of the library.
  • Name
    source
    Type
    string
    Required
    Optional
    Description
    Origin or publisher of the classification system.
  • Name
    edition
    Type
    string
    Required
    Optional
    Description
    Version or edition of the classification system.

Response fields

  • Name
    codes
    Type
    array<object>
    Required
    Optional
    Description
    The classification codes contained in this library.
  • Name
    source
    Type
    string
    Required
    Optional
    Description
    The source or publisher of the classification system.
  • Name
    edition
    Type
    string
    Required
    Optional
    Description
    The edition or version of the classification system.
  • Name
    editionDate
    Type
    string
    Required
    Optional
    Description
    The publication date of this edition.
  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the library.
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    A description of the classification library.
  • Name
    uri
    Type
    string
    Required
    Optional
    Description
    The URI reference for the classification system.
  • Name
    moreInfo
    Type
    string
    Required
    Optional
    Description
    Link to additional information about the classification system.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the library.
  • Name
    modelGuid
    Type
    string
    Required
    Optional
    Description
    The GUID of the model this library belongs to. Empty if it is a project-level library.
  • Name
    group
    Type
    "Project" | "Model"
    Required
    Optional
    Description
    Indicates whether this library is scoped to the project or a specific model.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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
GET https://api.qonic.com/v1/projects/:projectId/codifications/:libraryGuid

Get specific library in a project

Returns the codification library with the specified identifier, including all its codification codes.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.
  • Name
    libraryGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the library.

Response fields

  • Name
    codes
    Type
    array<object>
    Required
    Optional
    Description
    The classification codes contained in this library.
  • Name
    source
    Type
    string
    Required
    Optional
    Description
    The source or publisher of the classification system.
  • Name
    edition
    Type
    string
    Required
    Optional
    Description
    The edition or version of the classification system.
  • Name
    editionDate
    Type
    string
    Required
    Optional
    Description
    The publication date of this edition.
  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the library.
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    A description of the classification library.
  • Name
    uri
    Type
    string
    Required
    Optional
    Description
    The URI reference for the classification system.
  • Name
    moreInfo
    Type
    string
    Required
    Optional
    Description
    Link to additional information about the classification system.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the library.
  • Name
    modelGuid
    Type
    string
    Required
    Optional
    Description
    The GUID of the model this library belongs to. Empty if it is a project-level library.
  • Name
    group
    Type
    "Project" | "Model"
    Required
    Optional
    Description
    Indicates whether this library is scoped to the project or a specific model.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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/codifications/:libraryGuid

Delete codification library

Permanently removes a codification library and all its codes from the project. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.
  • Name
    libraryGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the library.

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/codifications/:libraryGuid/codification

Create new codification code in a library

Adds a new classification code to the specified codification library. The code can then be assigned to building elements for standardized classification.

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 classification code.
  • Name
    identification
    Type
    string
    Required
    Required
    Description
    Unique identification code (e.g., Ss_20 for UniClass).
  • Name
    parentId
    Type
    string
    Required
    Optional
    Description
    ID of the parent classification code for hierarchical codes. Null for top-level codes.
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    Human-readable description of what this code classifies.
  • Name
    measureDefinitions
    Type
    array<object>
    Required
    Optional
    Description
    Measure definitions for quantity takeoffs.
  • Name
    sort
    Type
    string
    Required
    Optional
    Description
    Sort order key for display purposes.

Response fields

  • Name
    identification
    Type
    string
    Required
    Optional
    Description
    The classification code identifier (e.g. "Ss_20_05").
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    A human-readable description of the classification code.
  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the classification code.
  • Name
    uri
    Type
    string
    Required
    Optional
    Description
    The URI reference for this classification code.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the classification code.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this classification code.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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/codifications/:libraryGuid/codification/:codificationGuid

Update codification code

Updates the properties of an existing classification code. Use this to rename or modify a code'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
    codificationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the codification code.

Request body

  • Name
    name
    Type
    string
    Required
    Optional
    Description
    New display name. Leave null to keep the current name.
  • Name
    identification
    Type
    string
    Required
    Optional
    Description
    New identification code. Leave null to keep the current value.
  • Name
    parentId
    Type
    string
    Required
    Optional
    Description
    New parent code id. Leave null to keep the current parent.
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    New description. Leave null to keep the current description.
  • Name
    measureDefinitions
    Type
    array<object>
    Required
    Optional
    Description
    Replacement set of measure definitions. Leave null to keep existing measures.
  • Name
    sort
    Type
    string
    Required
    Optional
    Description
    New sort key. Leave null to keep the current value.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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/codifications/:libraryGuid/codification/:codificationGuid

Delete codification code

Permanently removes a classification code from the library. Any existing assignments of this code to elements will be lost.

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
    codificationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the codification code.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • 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
‹
Previous
Auth API
›
Next
Custom Properties