Materials

Manage material libraries and materials within projects. Define material properties for building elements.

GET https://api.qonic.com/v1/projects/:projectId/material-libraries

Get material libraries

Returns all material libraries and their materials for the project, grouped by library.

Path parameters

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

Response fields

  • Name
    materialProperties
    Type
    array<object>
    Required
    Optional
    Description
    The list of material libraries and their properties.

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/material-libraries

Create new material library

Creates a new material library in the project. Use libraries to organize materials 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
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the material library.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the material library.
  • Name
    properties
    Type
    array<array<object>>
    Required
    Optional
    Description
    Grouped property sets for materials in this library.

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • 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/material-libraries/:libraryGuid

Get specific library in a project

Returns the material library with the specified identifier, including all its materials.

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
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the material library.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the material library.
  • Name
    properties
    Type
    array<array<object>>
    Required
    Optional
    Description
    Grouped property sets for materials in this 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
DELETE https://api.qonic.com/v1/projects/:projectId/material-libraries/:libraryGuid

Delete material library

Permanently removes a material library and all its materials 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/material-libraries/:libraryGuid/materials

Create new material in library

Creates a new material within the specified material library. Use this to define materials that can be assigned to building elements.

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 material.
  • Name
    color
    Type
    string
    Required
    Optional
    Description
    Color in hex format (e.g., #FF5733).
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    Human-readable description of the material.
  • Name
    category
    Type
    string
    Required
    Optional
    Description
    Category grouping (e.g., Concrete, Steel, Wood).

Response fields

  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the material.
  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    The unique identifier of the material.

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • 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/material-libraries/:libraryGuid/materials/:materialGuid

Update a material

Updates the properties of an existing material. Use this to change a material's name or other attributes.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.
  • Name
    materialGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the material.
  • Name
    libraryGuid
    Type
    string
    Required
    Required
    Description
    Unique identifier of the library.

Request body

  • Name
    name
    Type
    string
    Required
    Required
    Description
    Display name of the material.
  • Name
    color
    Type
    string
    Required
    Optional
    Description
    Color in hex format (e.g., #FF5733).
  • Name
    description
    Type
    string
    Required
    Optional
    Description
    Human-readable description of the material.
  • Name
    category
    Type
    string
    Required
    Optional
    Description
    Category grouping (e.g., Concrete, Steel, Wood).

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • 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/material-libraries/:libraryGuid/materials/:materialGuid

Delete material from library

Permanently removes a material from the specified library. Any existing material assignments 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
    materialGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the material.

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
‹
Previous
Custom Properties
›
Next
MeshStream