Products

Products represent individual elements within a construction model. Each product contains specific properties and data, allowing you to query, filter, and update information.

The product object

The product object contains all the information about individual elements within a construction model. Each product includes its unique identifier, relevant properties, and associated data.

Properties

  • Name
    guid
    Type
    string
    Description
    Unique identifier for the model.
  • Name
    fields
    Type
    string
    Description
    The ID of the project the model belongs to.
  • Name
    filters
    Type
    string
    Description
    Name of the model.
GET https://api.qonic.com/v1/projects

List all projects

This endpoint allows you to retrieve a list of all projects.

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

List all models

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

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to retrieve models from.
GET https://api.qonic.com/v1/projects/:projectId/models/:modelId/products?fields=fieldValue&fields=fieldValue&filters%5BfilterKey%5D=filterValue

Retrieve products from a model

This endpoint allows you to retrieve products from a specific model by the model ID.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to retrieve.

Query parameters

  • Name
    fields
    Type
    array<string>
    Description
    A list of properties you want to return.
  • Name
    filters
    Type
    object
    Description
    An object of properties you want to filter on.
GET https://api.qonic.com/v1/projects/:projectId/models/:modelId/products/available-data

Retrieve available properties for products

This endpoint allows you to retrieve the available properties of products from a specific model by the model ID.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to retrieve.
POST https://api.qonic.com/v1/projects/:projectId/models/products

Update product properties

This endpoint allows you to update product proeprtie in a model in a project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to update the properties in.

Optional parameters

  • Name
    add
    Type
    object
    Description
    An object of properties to add.
  • Name
    update
    Type
    object
    Description
    An object of properties to update.
  • Name
    delete
    Type
    object
    Description
    An object of properties to delete.
  • Name
    property
    Type
    object
    Description
    A property object to add, update or delete a propertySet by its Guid.
POST https://api.qonic.com/v1/projects/:projectId/models/products/query

Retrieve filtered products

This endpoint allows you to receive a list of requested properties for all products that satisfy the given filters.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to get the products from.

Optional parameters

  • Name
    fields
    Type
    array<string>
    Description
    An array of properties you want to return.
  • Name
    filters
    Type
    object
    Description
    An object of properties you want to filter on.
POST https://api.qonic.com/v1/projects/:projectId/models/products/start-session

Start modification session

This endpoint allows you to start a modification session on the given model.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to start the modification session on.
POST https://api.qonic.com/v1/projects/:projectId/models/products/end-session

End modification session

This endpoint allows you to end a modification session on the given model.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to end the modification session on.
DELETE https://api.qonic.com/v1/projects/:projectId/models/:modelId/products/:guid

Delete product

This endpoint allows you to permanently delete a product on a model. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the model.
  • Name
    modelId
    Type
    string
    Description
    The ID of the model to delete the product on.
‹
Previous
Errors
›
Next
Codification