Materials

Material libraries are used to assign physical materials to objects in your models. For more information about materials, visit our help page here.

The Material Library object

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

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
    materials
    Type
    string
    Description
    The materials contained in the material library.

The material object

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

Properties

  • Name
    name
    Type
    string
    Description
    The name of the material.
  • Name
    color
    Type
    string
    Description
    The color of the material.
  • Name
    description
    Type
    string
    Description
    The description of the material.
  • Name
    category
    Type
    string
    Description
    The category of the material.
GET https://api.qonic.com/v1/projects/:projectId/material-libraries

List all material libraries

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

Path parameters

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

Create a material library

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

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to create the material 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/material-libraries/:libraryGuid

Retrieve a specific material library

This endpoint allows you to retrieve a specific material 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/material-libraries/:libraryGuid

Delete a material library

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

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the material library.
  • Name
    libraryGuid
    Type
    string
    Description
    The Guid of the material library to delete.
POST https://api.qonic.com/v1/projects/:projectId/material-libraries/:libraryGuid/materials

Create new material in library

This endpoint allows you to create a new material in a specfied 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 material for.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the material.
  • Name
    color
    Type
    string
    Description
    The color of the material.
  • Name
    description
    Type
    string
    Description
    The description of the material.
  • Name
    category
    Type
    string
    Description
    The material of the material.
PUT https://api.qonic.com/v1/projects/:projectId/material-libraries/:libraryGuid/materials/:materialGuid

Update a material

This endpoint allows you to update an existing material.

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 update.
  • Name
    materialGuid
    Type
    string
    Description
    The Guid of the material to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The updated name of the material.
  • Name
    color
    Type
    string
    Description
    The updated color for the material.
  • Name
    description
    Type
    string
    Description
    The updated description of the material.
  • Name
    category
    Type
    string
    Description
    The updated category for the material.
DELETE https://api.qonic.com/v1/projects/:projectId/material-libraries/:libraryGuid/materials/:materialGuid

Delete a material

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

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the material library.
  • Name
    libraryGuid
    Type
    string
    Description
    The Guid of the material library.
  • Name
    materialGuid
    Type
    string
    Description
    The Guid of the material to delete.
‹
Previous
Custom Properties
›
Next
Spatial