--- title: List viewpoints slug: topic-api/list-viewpoints docTags: createdAt: 2024-06-10T16:49:07.009Z --- { "id": "KxP-gm0Yol1oAbsDF4LWI", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints", "servers": [ { "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints" } ], "name": "List viewpoints", "description": "List all topic viewpoints.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "topic-board-id", "type": "string", "example": "e18a2d10-1595-4e52-a941-22d43bf8d7ad", "description": "Id of the topic board" }, { "kind": "required", "name": "topic-id", "type": "string", "example": "18d0273d-e15c-4924-97b3-6f47b233eebe", "description": "Topic id" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "includeAuthorization", "type": "boolean", "description": "Include authorization field in response" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "viewpoint[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Represented as compacted UUID using 32 hexadecimal characters", "example": "52959166-dbd2-44eb-81bb-74f955f30e0f" }, { "name": "orthogonal_camera", "kind": "optional", "type": "object", "description": "Details of orthogonal camera if applicable", "example": "", "schema": [ { "name": "camera_view_point", "kind": "optional", "type": "object", "description": "Location of the camera", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of camera location", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of camera location", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of camera location", "example": 100 } ] }, { "name": "camera_direction", "kind": "optional", "type": "object", "description": "Direction of the camera", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of camera direction", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of camera direction", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of camera direction", "example": 100 } ] }, { "name": "camera_up_vector", "kind": "optional", "type": "object", "description": "Normalized vector describing the camera orientation", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of vector", "example": 0 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of vector", "example": 0 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of vector", "example": 1 } ] }, { "name": "view_to_world_scale", "kind": "optional", "type": "number", "description": "The scale factor between the camera and the scene", "example": 14 }, { "name": "aspect_ratio", "kind": "optional", "type": "number", "description": "Aspect ratio of the scene", "example": 1 } ] }, { "name": "perspective_camera", "kind": "optional", "type": "object", "description": "Details of perspective camera if applicable", "example": "", "schema": [ { "name": "camera_view_point", "kind": "optional", "type": "object", "description": "Location of the camera", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of camera location", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of camera location", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of camera location", "example": 100 } ] }, { "name": "camera_direction", "kind": "optional", "type": "object", "description": "Direction of the camera", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of camera direction", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of camera direction", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of camera direction", "example": 100 } ] }, { "name": "camera_up_vector", "kind": "optional", "type": "object", "description": "Normalized vector describing the camera orientation", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of vector", "example": 0 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of vector", "example": 0 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of vector", "example": 1 } ] }, { "name": "field_of_view", "kind": "optional", "type": "number", "description": "Field of view of the camera in degrees", "example": 60 }, { "name": "aspect_ratio", "kind": "optional", "type": "number", "description": "Aspect ratio of the scene", "example": 1 } ] }, { "name": "lines", "kind": "optional", "type": "array", "description": "List of graphical lines", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "start_point", "kind": "optional", "type": "object", "description": "Start point of the line", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of start point", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of start point", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of start point", "example": 100 } ] }, { "name": "end_point", "kind": "optional", "type": "object", "description": "End point of the line", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of end point", "example": 200 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of end point", "example": 200 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of end point", "example": 200 } ] } ] }, { "name": "clipping_planes", "kind": "optional", "type": "array", "description": "List of clipping planes", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "location", "kind": "optional", "type": "object", "description": "Location of the clipping plane", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of location", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of location", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of location", "example": 100 } ] }, { "name": "direction", "kind": "optional", "type": "object", "description": "Direction of the clipping plane", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of direction", "example": 0 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of direction", "example": 0 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of direction", "example": 1 } ] } ] }, { "name": "bitmaps", "kind": "optional", "type": "array", "description": "List of embedded images", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Id of the bitmap", "example": "8c2f8818-e413-49d4-8978-7f7d95d2b27e" }, { "name": "bitmap_type", "kind": "optional", "type": "string", "description": "Type of the bitmap, valid values are \"jpg\" and \"png\"", "example": "png" }, { "name": "location", "kind": "optional", "type": "object", "description": "Location of the center of the bitmap", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of location", "example": 100 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of location", "example": 100 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of location", "example": 100 } ] }, { "name": "normal", "kind": "optional", "type": "object", "description": "Normalized vector describing the bitmap direction", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of vector", "example": 0 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of vector", "example": 1 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of vector", "example": 0 } ] }, { "name": "up", "kind": "optional", "type": "object", "description": "Normalized vector describing the bitmap orientation", "example": "", "schema": [ { "name": "x", "kind": "optional", "type": "number", "description": "X coordinate of vector", "example": 0 }, { "name": "y", "kind": "optional", "type": "number", "description": "Y coordinate of vector", "example": 0 }, { "name": "z", "kind": "optional", "type": "number", "description": "Z coordinate of vector", "example": 1 } ] }, { "name": "height", "kind": "optional", "type": "number", "description": "Height of bitmap in the scene", "example": 20 } ] }, { "name": "snapshot", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "snapshot_type", "kind": "optional", "type": "string", "description": "Format of snapshot, valid values are \"jpg\" and \"png\"", "example": "png" } ] }, { "name": "authorization", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "viewpoint_actions", "kind": "optional", "type": "array", "description": "List of viewpoint actions", "example": "[\"delete\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/viewpoint", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "K-8LNVfBHb3Dkk_i7W9dM", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints \\\n --header 'accept: application/json'" }, { "id": "X2q_Tuy2nnbqE32RBea1Y", "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/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ELfBzb-jn6FMNhDehhSdJ", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints\")\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": "9-tka2Jue09ifL2IrEvSi", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints\"\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": "K-8LNVfBHb3Dkk_i7W9dM" }, "results": { "languages": [ { "id": "fUVLOC8iIIajkfJvaypxc", "language": "200", "code": "// OK\n[\n {\n \"guid\": \"52959166-dbd2-44eb-81bb-74f955f30e0f\",\n \"orthogonal_camera\": {\n \"camera_view_point\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"camera_direction\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"camera_up_vector\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 1\n },\n \"view_to_world_scale\": 14,\n \"aspect_ratio\": 1\n },\n \"perspective_camera\": {\n \"camera_view_point\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"camera_direction\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"camera_up_vector\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 1\n },\n \"field_of_view\": 60,\n \"aspect_ratio\": 1\n },\n \"lines\": [\n {\n \"start_point\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"end_point\": {\n \"x\": 200,\n \"y\": 200,\n \"z\": 200\n }\n }\n ],\n \"clipping_planes\": [\n {\n \"location\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"direction\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 1\n }\n }\n ],\n \"bitmaps\": [\n {\n \"guid\": \"8c2f8818-e413-49d4-8978-7f7d95d2b27e\",\n \"bitmap_type\": \"png\",\n \"location\": {\n \"x\": 100,\n \"y\": 100,\n \"z\": 100\n },\n \"normal\": {\n \"x\": 0,\n \"y\": 1,\n \"z\": 0\n },\n \"up\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 1\n },\n \"height\": 20\n }\n ],\n \"snapshot\": {\n \"snapshot_type\": \"png\"\n },\n \"authorization\": {\n \"viewpoint_actions\": [\n \"\"\n ]\n }\n }\n]" } ], "selectedLanguageId": "fUVLOC8iIIajkfJvaypxc" } }, "children": [ { "text": "" } ] }