Create viewpoint

POST

https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints

Add a new topic viewpoint. A viewpoint doesn't have to contain any camera data and can be used to add an arbitrary image to a topic. A viewpoint can then be referenced from a topic comment by its guid allowing comments with images.

Path Parameters

topic-board-idstringrequired
Example
e18a2d10-1595-4e52-a941-22d43bf8d7ad
Description
Id of the topic board
topic-idstringrequired
Example
18d0273d-e15c-4924-97b3-6f47b233eebe
Description
Topic id

Query Parameters

includeAuthorizationboolean
Description
Include authorization field in response

Body Parameters

bodyobject
- guidstring
  Example
  52959166-dbd2-44eb-81bb-74f955f30e0f
  Description
  Id of the viewpoint
- bimsync_modelsobject[]
  Description
  List of models
  - modelRefstring
    Example
    11a9bb2984ee4a999875c4cd9560f319
    Description
    Id of the model
  - revisionRefstring
    Example
    eed6ae36-5fe0-4f1f-89da-fba8efcf8b97
    Description
    Id of the model revision
- orthogonal_cameraobject
  Description
  Details of orthogonal camera
  - camera_view_pointobjectrequired
    Description
    Location of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera location
    - ynumber
      Example
      100
      Description
      Y coordinate of camera location
    - znumber
      Example
      100
      Description
      Z coordinate of camera location
  - camera_directionobjectrequired
    Description
    Direction of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera direction
    - ynumber
      Example
      100
      Description
      Y coordinate of camera direction
    - znumber
      Example
      100
      Description
      Z coordinate of camera direction
  - camera_up_vectorobjectrequired
    Description
    Normalized vector describing the camera orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - view_to_world_scalenumberrequired
    Example
    14
    Description
    The scale factor between the camera and the scene
  - aspect_rationumberrequired
    Example
    1
    Description
    Aspect ratio of the scene
- perspective_cameraobject
  Description
  Details of perspective camera
  - camera_view_pointobjectrequired
    Description
    Location of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera location
    - ynumber
      Example
      100
      Description
      Y coordinate of camera location
    - znumber
      Example
      100
      Description
      Z coordinate of camera location
  - camera_directionobjectrequired
    Description
    Direction of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera direction
    - ynumber
      Example
      100
      Description
      Y coordinate of camera direction
    - znumber
      Example
      100
      Description
      Z coordinate of camera direction
  - camera_up_vectorobjectrequired
    Description
    Normalized vector describing the camera orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - field_of_viewnumberrequired
    Example
    60
    Description
    Field of view of the camera in degrees
  - aspect_rationumberrequired
    Example
    1
    Description
    Aspect ratio of the scene
- linesobject[]
  Description
  List of graphical lines
  - start_pointobjectrequired
    Description
    Start point of the line
    - xnumber
      Example
      100
      Description
      X coordinate of start point
    - ynumber
      Example
      100
      Description
      Y coordinate of start point
    - znumber
      Example
      100
      Description
      Z coordinate of start point
  - end_pointobjectrequired
    Description
    End point of the line
    - xnumber
      Example
      200
      Description
      X coordinate of end point
    - ynumber
      Example
      200
      Description
      Y coordinate of end point
    - znumber
      Example
      200
      Description
      Z coordinate of end point
- clipping_planesobject[]
  Description
  List of clipping planes
  - locationobjectrequired
    Description
    Location of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of location
    - ynumber
      Example
      100
      Description
      Y coordinate of location
    - znumber
      Example
      100
      Description
      Z coordinate of location
  - directionobjectrequired
    Description
    Direction of the camera
    - xnumber
      Description
      X coordinate of direction
    - ynumber
      Description
      Y coordinate of direction
    - znumber
      Example
      1
      Description
      Z coordinate of direction
- bitmapsobject[]
  Description
  List of embedded images
  - bitmap_typestring<jpg | png>required
    Example
    png
    Description
    Type of the bitmap, valid values are "jpg" and "png"
  - bitmap_datastringrequired
    Example
    data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC
    Description
    Image date as base64 encoded string
  - locationobjectrequired
    Description
    Location of the center of the bitmap
    - xnumber
      Example
      100
      Description
      X coordinate of location
    - ynumber
      Example
      100
      Description
      Y coordinate of location
    - znumber
      Example
      100
      Description
      Z coordinate of location
  - normalobjectrequired
    Description
    Normalized vector describing the bitmap direction
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Example
      1
      Description
      Y coordinate of vector
    - znumber
      Description
      Z coordinate of vector
  - upobjectrequired
    Description
    Normalized vector describing the bitmap orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - heightnumberrequired
    Example
    20
    Description
    Height of bitmap in the scene
- snapshotobject
  - snapshot_typestring<jpg | png>required
    Example
    png
    Description
    Format of snapshot, valid values are "jpg" and "png"
  - snapshot_datastringrequired
    Example
    data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC
    Description
    Image date as base64 encoded string
- componentsobject
  Description
  Components of the viewpoint
  - selectionobject[]
    Description
    List of selected components
    - ifc_guidstring
      Example
      3BY5alwwL00QXHtY2qmHYZ
      Description
      IFC guid of the component
    - originating_systemstring
      Description
      Originating system of the component
    - authoring_tool_idstring
      Description
      Id of the component in the authoring tool
  - coloringobject[]
    Description
    List of colored components
    - colorstringrequired
      Example
      #dddddd
      Description
      Color of the components
    - componentsobject[]required
      - ifc_guidstring
        Example
        3BY5alwwL00QXHtY2qmHYZ
        Description
        IFC guid of the component
      - originating_systemstring
        Description
        Originating system of the component
      - authoring_tool_idstring
        Description
        Id of the component in the authoring tool
  - visibilityobjectrequired
    - default_visibilityboolean
      Example
      true
      Description
      Visibility of exception components, default is false
    - exceptionsobject[]
      Description
      Exception components
      - ifc_guidstring
        Example
        3BY5alwwL00QXHtY2qmHYZ
        Description
        IFC guid of the component
      - originating_systemstring
        Description
        Originating system of the component
      - authoring_tool_idstring
        Description
        Id of the component in the authoring tool
    - view_setup_hintsobject
      - spaces_visibleboolean
        Example
        true
        Description
        Visibility of spaces, default is false
      - space_boundaries_visibleboolean
        Example
        true
        Description
        Visibility of space boundaries, default is false
      - openings_visibleboolean
        Example
        true
        Description
        Visibility of openings, default is false

Responses

200OK

viewpoint
- guidstring
  Example
  52959166-dbd2-44eb-81bb-74f955f30e0f
  Description
  Represented as compacted UUID using 32 hexadecimal characters
- orthogonal_cameraobject
  Description
  Details of orthogonal camera if applicable
  - camera_view_pointobject
    Description
    Location of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera location
    - ynumber
      Example
      100
      Description
      Y coordinate of camera location
    - znumber
      Example
      100
      Description
      Z coordinate of camera location
  - camera_directionobject
    Description
    Direction of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera direction
    - ynumber
      Example
      100
      Description
      Y coordinate of camera direction
    - znumber
      Example
      100
      Description
      Z coordinate of camera direction
  - camera_up_vectorobject
    Description
    Normalized vector describing the camera orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - view_to_world_scalenumber
    Example
    14
    Description
    The scale factor between the camera and the scene
  - aspect_rationumber
    Example
    1
    Description
    Aspect ratio of the scene
- perspective_cameraobject
  Description
  Details of perspective camera if applicable
  - camera_view_pointobject
    Description
    Location of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera location
    - ynumber
      Example
      100
      Description
      Y coordinate of camera location
    - znumber
      Example
      100
      Description
      Z coordinate of camera location
  - camera_directionobject
    Description
    Direction of the camera
    - xnumber
      Example
      100
      Description
      X coordinate of camera direction
    - ynumber
      Example
      100
      Description
      Y coordinate of camera direction
    - znumber
      Example
      100
      Description
      Z coordinate of camera direction
  - camera_up_vectorobject
    Description
    Normalized vector describing the camera orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - field_of_viewnumber
    Example
    60
    Description
    Field of view of the camera in degrees
  - aspect_rationumber
    Example
    1
    Description
    Aspect ratio of the scene
- linesobject[]
  Description
  List of graphical lines
  - start_pointobject
    Description
    Start point of the line
    - xnumber
      Example
      100
      Description
      X coordinate of start point
    - ynumber
      Example
      100
      Description
      Y coordinate of start point
    - znumber
      Example
      100
      Description
      Z coordinate of start point
  - end_pointobject
    Description
    End point of the line
    - xnumber
      Example
      200
      Description
      X coordinate of end point
    - ynumber
      Example
      200
      Description
      Y coordinate of end point
    - znumber
      Example
      200
      Description
      Z coordinate of end point
- clipping_planesobject[]
  Description
  List of clipping planes
  - locationobject
    Description
    Location of the clipping plane
    - xnumber
      Example
      100
      Description
      X coordinate of location
    - ynumber
      Example
      100
      Description
      Y coordinate of location
    - znumber
      Example
      100
      Description
      Z coordinate of location
  - directionobject
    Description
    Direction of the clipping plane
    - xnumber
      Description
      X coordinate of direction
    - ynumber
      Description
      Y coordinate of direction
    - znumber
      Example
      1
      Description
      Z coordinate of direction
- bitmapsobject[]
  Description
  List of embedded images
  - guidstring
    Example
    8c2f8818-e413-49d4-8978-7f7d95d2b27e
    Description
    Id of the bitmap
  - bitmap_typestring<jpg | png>
    Example
    png
    Description
    Type of the bitmap, valid values are "jpg" and "png"
  - locationobject
    Description
    Location of the center of the bitmap
    - xnumber
      Example
      100
      Description
      X coordinate of location
    - ynumber
      Example
      100
      Description
      Y coordinate of location
    - znumber
      Example
      100
      Description
      Z coordinate of location
  - normalobject
    Description
    Normalized vector describing the bitmap direction
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Example
      1
      Description
      Y coordinate of vector
    - znumber
      Description
      Z coordinate of vector
  - upobject
    Description
    Normalized vector describing the bitmap orientation
    - xnumber
      Description
      X coordinate of vector
    - ynumber
      Description
      Y coordinate of vector
    - znumber
      Example
      1
      Description
      Z coordinate of vector
  - heightnumber
    Example
    20
    Description
    Height of bitmap in the scene
- snapshotobject
  - snapshot_typestring<jpg | png>
    Example
    png
    Description
    Format of snapshot, valid values are "jpg" and "png"
- authorizationobject
  - viewpoint_actionsstring[]
    Example
    [ "delete" ]
    Description
    List of viewpoint actions

curl

curl --request POST \
     --url https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "orthogonal_camera": {
     "camera_view_point": {},
     "camera_direction": {},
     "camera_up_vector": {},
     "view_to_world_scale": 14,
     "aspect_ratio": 1
     },
     "perspective_camera": {
     "camera_view_point": {},
     "camera_direction": {},
     "camera_up_vector": {},
     "field_of_view": 60,
     "aspect_ratio": 1
     },
     "lines": [
     {
     "start_point": {},
     "end_point": {}
     }
     ],
     "clipping_planes": [
     {
     "location": {},
     "direction": {}
     }
     ],
     "bitmaps": [
     {
     "bitmap_type": "png",
     "bitmap_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC",
     "location": {},
     "normal": {},
     "up": {},
     "height": 20
     }
     ],
     "snapshot": {
     "snapshot_type": "png",
     "snapshot_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC"
     },
     "components": {
     "coloring": [
     {
     "color": "#dddddd",
     "components": [
     {}
     ]
     }
     ],
     "visibility": {}
     }
     }'

javascript

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

var raw = JSON.stringify({
   "orthogonal_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "view_to_world_scale": 14,
      "aspect_ratio": 1
   },
   "perspective_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "field_of_view": 60,
      "aspect_ratio": 1
   },
   "lines": [
      {
         "start_point": {},
         "end_point": {}
      }
   ],
   "clipping_planes": [
      {
         "location": {},
         "direction": {}
      }
   ],
   "bitmaps": [
      {
         "bitmap_type": "png",
         "bitmap_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC",
         "location": {},
         "normal": {},
         "up": {},
         "height": 20
      }
   ],
   "snapshot": {
      "snapshot_type": "png",
      "snapshot_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC"
   },
   "components": {
      "coloring": [
         {
            "color": "#dddddd",
            "components": [
               {}
            ]
         }
      ],
      "visibility": {}
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints", 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/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "orthogonal_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "view_to_world_scale": 14,
      "aspect_ratio": 1
   },
   "perspective_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "field_of_view": 60,
      "aspect_ratio": 1
   },
   "lines": [
      {
         "start_point": {},
         "end_point": {}
      }
   ],
   "clipping_planes": [
      {
         "location": {},
         "direction": {}
      }
   ],
   "bitmaps": [
      {
         "bitmap_type": "png",
         "bitmap_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC",
         "location": {},
         "normal": {},
         "up": {},
         "height": 20
      }
   ],
   "snapshot": {
      "snapshot_type": "png",
      "snapshot_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC"
   },
   "components": {
      "coloring": [
         {
            "color": "#dddddd",
            "components": [
               {}
            ]
         }
      ],
      "visibility": {}
   }
})

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

python

import requests
import json

url = "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/viewpoints"

payload = json.dumps({
   "orthogonal_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "view_to_world_scale": 14,
      "aspect_ratio": 1
   },
   "perspective_camera": {
      "camera_view_point": {},
      "camera_direction": {},
      "camera_up_vector": {},
      "field_of_view": 60,
      "aspect_ratio": 1
   },
   "lines": [
      {
         "start_point": {},
         "end_point": {}
      }
   ],
   "clipping_planes": [
      {
         "location": {},
         "direction": {}
      }
   ],
   "bitmaps": [
      {
         "bitmap_type": "png",
         "bitmap_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC",
         "location": {},
         "normal": {},
         "up": {},
         "height": 20
      }
   ],
   "snapshot": {
      "snapshot_type": "png",
      "snapshot_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC"
   },
   "components": {
      "coloring": [
         {
            "color": "#dddddd",
            "components": [
               {}
            ]
         }
      ],
      "visibility": {}
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// OK
{
  "guid": "52959166-dbd2-44eb-81bb-74f955f30e0f",
  "orthogonal_camera": {
    "camera_view_point": {
      "x": 100,
      "y": 100,
      "z": 100
    },
    "camera_direction": {
      "x": 100,
      "y": 100,
      "z": 100
    },
    "camera_up_vector": {
      "x": 0,
      "y": 0,
      "z": 1
    },
    "view_to_world_scale": 14,
    "aspect_ratio": 1
  },
  "perspective_camera": {
    "camera_view_point": {
      "x": 100,
      "y": 100,
      "z": 100
    },
    "camera_direction": {
      "x": 100,
      "y": 100,
      "z": 100
    },
    "camera_up_vector": {
      "x": 0,
      "y": 0,
      "z": 1
    },
    "field_of_view": 60,
    "aspect_ratio": 1
  },
  "lines": [
    {
      "start_point": {
        "x": 100,
        "y": 100,
        "z": 100
      },
      "end_point": {
        "x": 200,
        "y": 200,
        "z": 200
      }
    }
  ],
  "clipping_planes": [
    {
      "location": {
        "x": 100,
        "y": 100,
        "z": 100
      },
      "direction": {
        "x": 0,
        "y": 0,
        "z": 1
      }
    }
  ],
  "bitmaps": [
    {
      "guid": "8c2f8818-e413-49d4-8978-7f7d95d2b27e",
      "bitmap_type": "png",
      "location": {
        "x": 100,
        "y": 100,
        "z": 100
      },
      "normal": {
        "x": 0,
        "y": 1,
        "z": 0
      },
      "up": {
        "x": 0,
        "y": 0,
        "z": 1
      },
      "height": 20
    }
  ],
  "snapshot": {
    "snapshot_type": "png"
  },
  "authorization": {
    "viewpoint_actions": [
      ""
    ]
  }
}