---
title: List groups relations
slug: model-api/list-groups-relations
docTags:
createdAt: 2024-06-10T16:48:45.445Z
---
{
"id": "cWLwySEJHYSPNvtIHO2W9",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.catenda.com/v2/projects/{project-id}/ifc/groups/relations",
"servers": [
{
"url": "https://api.catenda.com/v2/projects/{project-id}/ifc/groups/relations"
}
],
"name": "List groups relations",
"description": "List all the relations for all the groups in a project. A group is related to products, child groups, a parent group 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": "Default 100, max 1000
"
}
],
"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-group-relation[]",
"schema": [
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the group",
"example": 317236464192,
"format": "int64"
},
{
"name": "globalId",
"kind": "optional",
"type": "string",
"description": "A 22 character IfcGloballyUniqueId",
"example": "5Db9ZjqSKLKf3kfFSB$pnK"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "The name of the group",
"example": "Model Group:bal 3:5053794"
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the group",
"example": "IfcGroup"
},
{
"name": "products",
"kind": "optional",
"type": "array",
"description": "The products related to the group",
"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/417235853289"
},
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the product",
"example": 417235853289,
"format": "int64"
},
{
"name": "globalId",
"kind": "optional",
"type": "string",
"description": "A 22 character IfcGloballyUniqueId",
"example": "9dYMac7Ar51vpH7fe7CB7F"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "The name of the product",
"example": ""
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the product",
"example": "IfcWall"
}
]
},
{
"name": "children",
"kind": "optional",
"type": "array",
"description": "The related child groups",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "url",
"kind": "optional",
"type": "string",
"description": "The group resource URL",
"example": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417235853289"
},
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the group",
"example": 417235853289,
"format": "int64"
},
{
"name": "globalId",
"kind": "optional",
"type": "string",
"description": "A 22 character IfcGloballyUniqueId",
"example": "9dYMac7Ar51vpH7fe7CB7F"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "The name of the group",
"example": ""
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the group",
"example": "IfcGroup"
}
]
},
{
"name": "ownerHistory",
"kind": "optional",
"type": "object",
"description": "The owner history related to the group",
"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",
"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"
}
]
},
{
"name": "parent",
"kind": "optional",
"type": "object",
"description": "The related parent group",
"example": "",
"schema": [
{
"name": "url",
"kind": "optional",
"type": "string",
"description": "The group resource URL",
"example": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417235853289"
},
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the group",
"example": 417235853289,
"format": "int64"
},
{
"name": "globalId",
"kind": "optional",
"type": "string",
"description": "A 22 character IfcGloballyUniqueId",
"example": "9dYMac7Ar51vpH7fe7CB7F"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "The name of the group",
"example": ""
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the group",
"example": "IfcGroup"
}
]
}
],
"modelRef": "#/components/schemas/ifc-group-relation",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "VCepKzFO5C9KfS_gOTNII",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://api.catenda.com/v2/projects/{project-id}/ifc/groups/relations \\\n --header 'accept: application/json'"
},
{
"id": "RR7RzRPpvIk2cV6YmbOnN",
"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/groups/relations\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "BangVtDnUEHCnoCASjtjn",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects/{project-id}/ifc/groups/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": "BV7Uc2RGhRguo1a3Nvw65",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/ifc/groups/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": "VCepKzFO5C9KfS_gOTNII"
},
"results": {
"languages": [
{
"id": "S_iWP8Ex0CiilPxnLYYtt",
"language": "200",
"code": "// OK\n[\n {\n \"objectId\": 317236464192,\n \"globalId\": \"5Db9ZjqSKLKf3kfFSB$pnK\",\n \"name\": \"Model Group:bal 3:5053794\",\n \"ifcType\": \"IfcGroup\",\n \"products\": [\n {\n \"url\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417235853289\",\n \"objectId\": 417235853289,\n \"globalId\": \"9dYMac7Ar51vpH7fe7CB7F\",\n \"name\": \"\",\n \"ifcType\": \"IfcWall\"\n }\n ],\n \"children\": [\n {\n \"url\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417235853289\",\n \"objectId\": 417235853289,\n \"globalId\": \"9dYMac7Ar51vpH7fe7CB7F\",\n \"name\": \"\",\n \"ifcType\": \"IfcGroup\"\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 \"parent\": {\n \"url\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/ifc/products/417235853289\",\n \"objectId\": 417235853289,\n \"globalId\": \"9dYMac7Ar51vpH7fe7CB7F\",\n \"name\": \"\",\n \"ifcType\": \"IfcGroup\"\n }\n }\n]"
}
],
"selectedLanguageId": "S_iWP8Ex0CiilPxnLYYtt"
}
},
"children": [
{
"text": ""
}
]
}