List classification references relations

GET

https://api.catenda.com/v2/projects/{project-id}/ifc/classification_references/relations

List all the relations for all the classification references in a project. A Classification reference is related to products and a classification.

Path Parameters

project-idstringrequired
Example
af2d8af0fa54465b89bf26dd3d92cfd0
Description
Catenda project id

Query Parameters

modelstring[]
Description
Filter by latest revision of model id.
revisionstring[]
Description
Filter by revision id. Can be repeated to filter by multiple revisions.
pageinteger
Description
Default value is 1
pageSizeinteger
Description
Default 100, max 1000

Responses

200OK

ifc-classification-reference-relation[]
- objectIdinteger<int64>
  Example
  417236566151
  Description
  The object id of the classification reference
  Format
  int64
- namestring
  Example
  Showers
  Description
  The name of the classification reference
- ifcTypestring
  Example
  IfcClassificationReference
  Description
  The entity type of the classification reference
- attributesobject
  Description
  The attributes of the classification reference including the identifier
- productsobject[]
  Description
  The products related to the classification reference
  - urlstring
    Example
    https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417236566121
    Description
    The product resource URL
  - objectIdinteger<int64>
    Example
    417236566121
    Description
    The object id of the product
    Format
    int64
  - globalIdstring
    Example
    2z$4$ZtGH92fufpaUQ_65c
    Description
    A 22 character IfcGloballyUniqueId
  - namestring
    Example
    Strainers-Carbon_Steel_Flanged:80 mm:3589667
    Description
    The name of the product
  - ifcTypestring
    Example
    IfcFlowController
    Description
    The entity type of the product
- classificationobject
  Description
  The classification related to the classification reference
  - urlstring
    Example
    https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/classifications/417236566342
    Description
    The classification resource URL
  - objectIdinteger<int64>
    Example
    417236566342
    Description
    The object id of the classification
    Format
    int64
  - namestring
    Example
    Uniformat
    Description
    The name of the classification
  - ifcTypestring
    Example
    IfcClassification
    Description
    The entity type of the classification

curl

curl --request GET \
     --url https://api.catenda.com/v2/projects/{project-id}/ifc/classification_references/relations \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.catenda.com/v2/projects/{project-id}/ifc/classification_references/relations", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.catenda.com/v2/projects/{project-id}/ifc/classification_references/relations")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.catenda.com/v2/projects/{project-id}/ifc/classification_references/relations"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
[
  {
    "objectId": 417236566151,
    "name": "Showers",
    "ifcType": "IfcClassificationReference",
    "attributes": {},
    "products": [
      {
        "url": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417236566121",
        "objectId": 417236566121,
        "globalId": "2z$4$ZtGH92fufpaUQ_65c",
        "name": "Strainers-Carbon_Steel_Flanged:80 mm:3589667",
        "ifcType": "IfcFlowController"
      }
    ],
    "classification": {
      "url": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/classifications/417236566342",
      "objectId": 417236566342,
      "name": "Uniformat",
      "ifcType": "IfcClassification"
    }
  }
]