Codifications

Codification libraries are used to assign classification codes to objects in your models, which will help keep the models more organized and can help in creating automated quantity takeoffs and schedules. For more information about codifications, visit our help page here.

The codification 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
    libraryGuid
    Type
    string
    Description
    The Global Unique identifier for the library.
  • Name
    projectId
    Type
    string
    Description
    The ID of the project the library belongs to.
  • Name
    name
    Type
    string
    Description
    The name of the library.
  • Name
    description
    Type
    string
    Description
    The description of the library.
  • Name
    type
    Type
    string
    Description
    The type of library, on project level or model level.
  • Name
    source
    Type
    string
    Description
    The name of the template source used.
  • Name
    uri
    Type
    string
    Description
    The url of the template source.
  • Name
    edition
    Type
    string
    Description
    The edition of the library.
  • Name
    codes
    Type
    string
    Description
    The codes contained in the codification library.

The codification code object

The codification code object contains all the information about a specific code, such as their name, description, identification, and measureDefinitions.

Properties

  • Name
    name
    Type
    string
    Description
    The name of the codification code.
  • Name
    description
    Type
    string
    Description
    The description of the codification code.
  • Name
    identification
    Type
    string
    Description
    The identification of the codification code.
  • Name
    parentId
    Type
    string
    Description
    The id of the parent codification code, null if it is a top level item.
GET https://api.qonic.com/v1/projects/:projectId/codifications

List all codifications

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

Path parameters

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

Create a codification library

This endpoint allows you to create a new codification library in a project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to create the codification library in.

Required parameters

  • Name
    name
    Type
    string
    Description
    The name of the library.

Optional parameters

  • Name
    type
    Type
    "project" | "model"
    Description
    The type of the library.
  • Name
    uri
    Type
    string
    Description
    The uri of the template used for this library.
  • Name
    description
    Type
    string
    Description
    The description used for this library.
  • Name
    source
    Type
    string
    Description
    The name of the template used for this library.
  • Name
    edition
    Type
    string
    Description
    The edition for this library.
GET https://api.qonic.com/v1/projects/:projectId/codifications/:libraryGuid

Retrieve a specific codification library

This endpoint allows you to retrieve a specific codification library by its GUID.

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 retrieve.
DELETE https://api.qonic.com/v1/projects/:projectId/codifications/:libraryId

Delete a codification library

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

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the codification library.
  • Name
    libraryId
    Type
    string
    Description
    The ID of the codification library to delete.
POST https://api.qonic.com/v1/projects/:projectId/codifications/:libraryId/codification

Create a new codification code in a library

This endpoint allows you to create a new codification code in a specfied library.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    libraryId
    Type
    string
    Description
    The ID of the library to create the code for.

Required parameters

  • Name
    name
    Type
    string
    Description
    The name of the code.
  • Name
    identification
    Type
    string
    Description
    The identification of the code.
  • Name
    parentId
    Type
    string
    Description
    The parentId of the code.
  • Name
    description
    Type
    string
    Description
    The description of the code.
  • Name
    measureDefinitions
    Type
    array
    Description
    An array of measureDefinitions of the code.
PUT https://api.qonic.com/v1/projects/:projectId/codifications/:libraryId/codification/:codificationId

Update a codification code in a library

This endpoint allows you to update an existing codification library's code.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the library.
  • Name
    libraryId
    Type
    string
    Description
    The ID of the library to update.
  • Name
    codificationId
    Type
    string
    Description
    The ID of the codification code to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The updated name of the code.
  • Name
    identification
    Type
    string
    Description
    The updated file name for the code.
DELETE https://api.qonic.com/v1/projects/:projectId/codifications/:libraryId/codifications/:codificationId

Delete a codification code in a library

This endpoint allows you to permanently delete a specific codification code 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 codification library.
  • Name
    libraryId
    Type
    string
    Description
    The ID of the codification library to delete the code from.
  • Name
    codificationId
    Type
    string
    Description
    The ID of the codification code to delete.
‹
Previous
Product
›
Next
Custom Properties