---
title: List types relations
slug: model-api/list-types-relations
docTags: 
createdAt: 2024-06-10T16:48:45.445Z
---

{
  "id": "mYMAiVcKxoCqIIYyGiPDu",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations",
    "servers": [
      {
        "url": "https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations"
      }
    ],
    "name": "List types relations",
    "description": "List all the relations for all the types in a project. A type is related to products and an owner history.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "project-id",
          "type": "string",
          "example": "af2d8af0fa54465b89bf26dd3d92cfd0",
          "description": "Catenda project id"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "model",
          "type": "array",
          "description": "Filter by latest revision of model id.",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "revision",
          "type": "array",
          "description": "Filter by revision id. Can be repeated to filter by multiple revisions.",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "integer",
          "description": "Default value is 1"
        },
        {
          "kind": "optional",
          "name": "pageSize",
          "type": "integer",
          "description": "<p>Default 100, max 1000</p>"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "ifc-type-relation[]",
            "schema": [
              {
                "name": "objectId",
                "kind": "optional",
                "type": "integer<int64>",
                "description": "The object id of the type",
                "example": 317235939074,
                "format": "int64"
              },
              {
                "name": "globalId",
                "kind": "optional",
                "type": "string",
                "description": "A 22 character IfcGloballyUniqueId",
                "example": "4bJZO1Wyv3kBqbZkwgAALf"
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": "The name of the type",
                "example": "Basic Wall:0-LBA"
              },
              {
                "name": "ifcType",
                "kind": "optional",
                "type": "string",
                "description": "The entity type of the type",
                "example": "IfcWallType"
              },
              {
                "name": "products",
                "kind": "optional",
                "type": "array",
                "description": "The related products",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "url",
                    "kind": "optional",
                    "type": "string",
                    "description": "The product resource URL",
                    "example": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/717235939038"
                  },
                  {
                    "name": "objectId",
                    "kind": "optional",
                    "type": "integer<int64>",
                    "description": "The object id of the product",
                    "example": 717235939038,
                    "format": "int64"
                  },
                  {
                    "name": "globalId",
                    "kind": "optional",
                    "type": "string",
                    "description": "A 22 character IfcGloballyUniqueId",
                    "example": "6K4519Zt51AQBUMqG6OuG1"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "The name of the product",
                    "example": "Basic Wall:0-LBA:1328157"
                  },
                  {
                    "name": "ifcType",
                    "kind": "optional",
                    "type": "string",
                    "description": "The entity type of the product",
                    "example": "IfcWall"
                  }
                ]
              },
              {
                "name": "ownerHistory",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "url",
                    "kind": "optional",
                    "type": "string",
                    "description": "The owner history resource URL",
                    "example": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/ownerhistory/217235853093"
                  },
                  {
                    "name": "objectId",
                    "kind": "optional",
                    "type": "integer<int64>",
                    "description": "The object id of the owner history",
                    "example": 217235853093,
                    "format": "int64"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "The name of the owner history",
                    "example": ""
                  },
                  {
                    "name": "ifcType",
                    "kind": "optional",
                    "type": "string",
                    "description": "The entity type of the owner history",
                    "example": "IfcOwnerHistory"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ifc-type-relation",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "rseSOn21p1HLJhF7esjch",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations \\\n     --header 'accept: application/json'"
        },
        {
          "id": "chdymIUiqnU-C00wWtb3Y",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "Bj4fA4I8VRr9Jka9BHdrb",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "-fxLnEOF-OcqspsAfr5U3",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/ifc/types/relations\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "rseSOn21p1HLJhF7esjch"
    },
    "results": {
      "languages": [
        {
          "id": "ZffV5S6qIv8ZoClnDcGSR",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"objectId\": 317235939074,\n    \"globalId\": \"4bJZO1Wyv3kBqbZkwgAALf\",\n    \"name\": \"Basic Wall:0-LBA\",\n    \"ifcType\": \"IfcWallType\",\n    \"products\": [\n      {\n        \"url\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/717235939038\",\n        \"objectId\": 717235939038,\n        \"globalId\": \"6K4519Zt51AQBUMqG6OuG1\",\n        \"name\": \"Basic Wall:0-LBA:1328157\",\n        \"ifcType\": \"IfcWall\"\n      }\n    ],\n    \"ownerHistory\": {\n      \"url\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/ownerhistory/217235853093\",\n      \"objectId\": 217235853093,\n      \"name\": \"\",\n      \"ifcType\": \"IfcOwnerHistory\"\n    }\n  }\n]"
        }
      ],
      "selectedLanguageId": "ZffV5S6qIv8ZoClnDcGSR"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}