Query Products

List product fields
List the fields that can be queried for products.
Example
Curl
curl -X GET \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products/fields" \
  --header "Authorization: Bearer $ACCESS_TOKEN"
curl -X GET \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products/fields" \
  --header "Authorization: Bearer $ACCESS_TOKEN"
﻿
Response
JSON
[
  {
    "field": "attributes.GlobalId",
    "type": "string",
    "measureType": null
  },
  {
    "field": "attributes.Name",
    "type": "string",
    "measureType": null
  },
  {
    "field": "ifcType",
    "type": "string",
    "measureType": null
  },
  {
    "field": "objectId",
    "type": "number",
    "measureType": null
  }
]
[
  {
    "field": "attributes.GlobalId",
    "type": "string",
    "measureType": null
  },
  {
    "field": "attributes.Name",
    "type": "string",
    "measureType": null
  },
  {
    "field": "ifcType",
    "type": "string",
    "measureType": null
  },
  {
    "field": "objectId",
    "type": "number",
    "measureType": null
  }
]
﻿
Query products
The product query endpoint allows you to query products. The query language is based on the MongoDB query language and supports the following operators.
Comparison operators: $eq, $in
Logical operators: $and
Custom operators: $ifcType
Comparison operator example
Curl
curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "ifcType": {
        "$in": ["IfcWall", "IfcWallStandardCase"]
      }
    }
  }'
curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "ifcType": {
        "$in": ["IfcWall", "IfcWallStandardCase"]
      }
    }
  }'
﻿
Logical operator example
Curl
 curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "$and": [
        { "ifcType": { "$eq": "IfcWall" }},
        { "attributes.GlobalId": { "$eq": "$PRODUCT_GUID" }}
      ]
    }
  }'
 curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "$and": [
        { "ifcType": { "$eq": "IfcWall" }},
        { "attributes.GlobalId": { "$eq": "$PRODUCT_GUID" }}
      ]
    }
  }'
﻿
Custom operator example
The custom operator $ifcType allows you to match entities that are equal to an IFC type or its subtypes.
Curl
curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "ifcType": { "$ifcType": "IfcWall" }
    },
  }'
curl -X POST \
  "https://api.catenda.com/v2/projects/af2d8af0fa54465b89bf26dd3d92cfd0/ifc/products" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "query":{
      "ifcType": { "$ifcType": "IfcWall" }
    },
  }'
﻿
﻿
Updated 11 Jun 2024
Did this page help you?
Product
List models