Add endpoint to get translucency

buildingSMART · May 6, 2024 · e363bd9 · e363bd9
1 parent 2e9a2fb
commit e363bd9
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/swagger.yaml b/swagger.yaml
@@ -1202,6 +1202,44 @@ paths:
                         }
                     }
                 }
+  /bcf/{version}/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/translucency:
+    parameters:
+    - $ref:  "#/components/parameters/version"
+    - $ref:  "#/components/parameters/project_id"
+    - $ref:  "#/components/parameters/topic_id"
+    - $ref:  "#/components/parameters/viewpoint_id"
+    get:
+      summary: Get Translucency
+      description: Retrieve translucency of components in a viewpoint.
+      tags:
+        - Viewpoints      
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/translucency_GET'
+              example:
+                    {
+                      "translucency": {
+                        "default_translucency": true,
+                        "exceptions": [
+                            {
+                                "ifc_guid": "2MF28NhmDBiRVyFakgdbCT",
+                                "originating_system": "Example CAD Application",
+                                "authoring_tool_id": "EXCAD/v1.0"
+                            }, {
+                                "ifc_guid": "3$cshxZO9AJBebsni$z9Yk",
+                            }
+                        ],
+                        "translucency_setup_hints": {
+                            "spaces_translucent": true,
+                            "space_boundaries_translucent": false,
+                            "openings_translucent": true
+                        }
+                      }
+                    }
   /bcf/{version}/projects/{project_id}/topics/{topic_id}/related_topics:
     parameters:
     - $ref:  "#/components/parameters/version"