Trimble Viewpoints (BCF 2.1) API

APIs related to Viewpoints

GitHub OpenAPI

Operations 8

GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints GetViewpoints #
POST /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints CreateViewpoint #
GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId} GetViewpoint #
DELETE /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId} DeleteViewpoint #
GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/snapshot GetViewpointSnapshot #
GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/selection GetViewpointSelection #
GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/coloring GetViewpointColoring #
GET /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/visibility GetViewpointVisibility #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-viewpoints-bcf-2-1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-viewpoints-bcf-2-1-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Topics API with BCF 2.1 and 3.0…
  description: '# Overview

    A BCF 2.1 and BCF 3.0 compatible service.


    Documentation for this service is available on the Trimble Developer site.


    # Getting started

    **You must agree to the Terms of Service to use Connect services.**


    You need to complete the steps in the Getting started guide to be able to call the API.


    # Concepts

    Please see Common Concepts in the Connect Platform documentation.


    ## Paginated Responses (BCF 2.1)


    All endpoints that return collection of resources follow the same schema for query parameters and

    response structure to paginate the results.

    Pagination allows to limit the size of the large responses and aimed to improve the responsiveness and overall

    performance when fetching large result sets. The overall latency is improved

    by parallelization of data processing and transfer.


    The requests accept `top` and `skiptoken` query parameters.


    `skiptoken` is a token used for pagination, typically returned with the previous page, and should be used as-is without interpretation.

    If the `skiptoken` query parameter is not specified, the first page of the result set is returned.


    The `top` parameter informs the server on how many items client

    wants to receive in a single page. Server returns the requested number of items

    if they are available or less (for the last page in the result set).

    If `top` parameter is not specified then the server returns maximum page size by default.


    Additionally, the response header contains a `next` field, which is a URL that points to the next page of items.


    ## Paginated Responses (BCF 3.0)


    Pagination follows OData v4 standard.


    Service supports server-driven pagination in which it returns to the client the next page URL by providing `odata.nextLink` in the response header.


    ## Syncing Extensions


    In addition to BCF-API compatibility, the service provides Topics Syncing extensions that are useful in various cases,

    such as a temporary loss of internet connection.


    ## Limitations


    Currently, the following BCF-API standard features are not supported:

    - OData sorting and filtering data

    - Viewpoint Bitmaps

    - Topic BIM Snippets

    - OData pagination on the BCF 2.1 endpoints

    - Topics Events

    - Comments Events'
  version: v2
  contact:
    name: Trimble Connect Support
    url: https://connect.trimble.com
    email: connect-support@trimble.com
  license:
    name: Trimble Connect SDK Internal Use License
    url: https://developer.trimble.com/docs/connect/terms/SDK-IU-license-agreement
  termsOfService: https://developer.trimble.com/docs/connect/terms
servers:
- url: https://open11.connect.trimble.com
  description: Production North America
- url: https://open21.connect.trimble.com
  description: Production Europe
- url: https://open31.connect.trimble.com
  description: Production Asia-Pacific
- url: https://open32.connect.trimble.com
  description: Production Australia
- url: https://open11.stage.connect.trimble.com
  description: Staging North America
- url: https://open31.stage.connect.trimble.com
  description: Staging Asia-Pacific
security:
- Bearer: []
tags:
- name: Viewpoints (BCF 2.1)
  description: APIs related to Viewpoints
paths:
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpoints
      description: 'Retrieve a collection of all viewpoints related to the specified Topic.


        The view point contains resized snapshot data and a URL to the full snapshot.'
      operationId: ListAllViewpoints
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic
        required: true
        schema:
          type: string
      - name: top
        in: query
        description: The maximum number of items to be returned on a single page
        schema:
          type: integer
          format: int32
          default: 500
          maximum: 500
      - name: skiptoken
        in: query
        description: The token used for pagination. Typically returned with the response in the previous page and should be used as-is without interpretation.
        schema:
          type: string
      responses:
        '200':
          description: An array of Viewpoints for this Project.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Viewpoint'
        '204':
          description: No Viewpoints have been defined yet for the topic.
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Viewpoints (BCF 2.1)
      summary: CreateViewpoint
      description: Creates a new Viewpoint for the specified Trimble Connect Project and Topic. This will also add viewpoint info to the Topic including a snapshot thumbnail for the first viewpoint.
      operationId: CreateNewViewpoint
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic
        required: true
        schema:
          type: string
      requestBody:
        description: The Viewpoint to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateViewpointDto'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateViewpointDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateViewpointDto'
      responses:
        '201':
          description: The newly created Viewpoint including a resized small snapshot and a url to the full snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Viewpoint'
        '400':
          description: Request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpoint
      description: Retrieve a specific viewpoint.
      operationId: ListViewpointByViewpointId
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested viewpoint including a resized small snapshot and a url to the full snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Viewpoint'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Viewpoints (BCF 2.1)
      description: API to delete the viewpoint
      operationId: DeleteViewpointByviewpointId
      summary: DeleteViewpoint
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic.
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        description: The id of the viewpoint to be deleted.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The viewpoint was deleted successfully.
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/snapshot:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpointSnapshot
      description: API to fetch the snapshot of viewpoint
      operationId: ListViewpointSnapshot
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The snapshot image of the viewpoint.
          content:
            image/png:
              schema:
                type: string
                format: binary
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/selection:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpointSelection
      description: Retrieve a collection of all selected components in the viewpoint.
      operationId: ListViewpointSelection
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The collection of selected components in the viewpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentsSelection'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/coloring:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpointColoring
      description: Retrieve a collection of all colored components in the viewpoint.
      operationId: GetViewpointColoring
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The collection of colored components in the viewpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentsColoring'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}/viewpoints/{viewpointId}/visibility:
    get:
      tags:
      - Viewpoints (BCF 2.1)
      summary: GetViewpointVisibility
      description: Retrieve visibility of components in the viewpoint.
      operationId: ListViewPointsVisibility
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        required: true
        schema:
          type: string
      - name: viewpointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The visibility of components in the viewpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentsVisibility'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId/viewpointId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Coloring:
      required:
      - color
      - components
      type: object
      properties:
        color:
          minLength: 6
          description: The color must be in ARGB format represented as 6 or 8 hexadecimal digits.
          type: string
        components:
          type: array
          items:
            $ref: '#/components/schemas/Component'
      additionalProperties: false
    Point:
      required:
      - x
      - y
      - z
      type: object
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        z:
          type: number
          format: double
      additionalProperties: false
    Bitmap:
      required:
      - bitmap_data
      - bitmap_type
      - location
      - normal
      - up
      - height
      type: object
      properties:
        guid:
          type:
          - string
          - 'null'
          format: uuid
        bitmap_type:
          minLength: 1
          type: string
        bitmap_data:
          minLength: 1
          type: string
        location:
          $ref: '#/components/schemas/Location'
        normal:
          $ref: '#/components/schemas/Direction'
        up:
          $ref: '#/components/schemas/Direction'
        height:
          type: number
          format: double
      additionalProperties: false
    ViewSetupHints:
      type: object
      properties:
        spaces_visible:
          type:
          - boolean
          - 'null'
        space_boundaries_visible:
          type:
          - boolean
          - 'null'
        openings_visible:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    ComponentsSelection:
      type: object
      properties:
        selection:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Component'
      additionalProperties: false
    Component:
      required:
      - ifc_guid
      type: object
      properties:
        ifc_guid:
          minLength: 1
          type: string
        originating_system:
          type:
          - string
          - 'null'
        authoring_tool_id:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateViewpointDto:
      type: object
      properties:
        index:
          type: integer
          format: int32
        orthogonal_camera:
          $ref: '#/components/schemas/OrthogonalCamera'
        perspective_camera:
          $ref: '#/components/schemas/PerspectiveCamera'
        lines:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Line'
        clipping_planes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ClippingPlane'
        bitmaps:
          type:
          - array
          - 'null'
          description: Note that this property is currently not supported.
          items:
            $ref: '#/components/schemas/Bitmap'
        snapshot:
          $ref: '#/components/schemas/Snapshot'
        components:
          $ref: '#/components/schemas/Components'
        files:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Files'
      additionalProperties: false
    Files:
      type: object
      properties:
        file_name:
          type:
          - string
          - 'null'
        file_identifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    OrthogonalCamera:
      required:
      - camera_direction
      - camera_up_vector
      - camera_view_point
      - view_to_world_scale
      type: object
      properties:
        camera_view_point:
          $ref: '#/components/schemas/Point'
        camera_direction:
          $ref: '#/components/schemas/Direction'
        camera_up_vector:
          $ref: '#/components/schemas/Direction'
        view_to_world_scale:
          type: number
          format: double
      additionalProperties: false
    ClippingPlane:
      required:
      - direction
      - location
      type: object
      properties:
        location:
          $ref: '#/components/schemas/Location'
        direction:
          $ref: '#/components/schemas/Direction'
      additionalProperties: false
    ComponentsVisibility:
      type: object
      properties:
        visibility:
          $ref: '#/components/schemas/Visibility'
      additionalProperties: false
    Direction:
      required:
      - x
      - y
      - z
      type: object
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        z:
          type: number
          format: double
      additionalProperties: false
    Viewpoint:
      type: object
      required:
      - guid
      properties:
        guid:
          type: string
        view_id:
          type:
          - string
          - 'null'
        index:
          type: integer
          format: int32
        orthogonal_camera:
          $ref: '#/components/schemas/OrthogonalCamera'
        perspective_camera:
          $ref: '#/components/schemas/PerspectiveCamera'
        lines:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Line'
        clipping_planes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ClippingPlane'
        bitmaps:
          type:
          - array
          - 'null'
          description: Note that this property is currently not supported.
          items:
            $ref: '#/components/schemas/Bitmap'
        snapshot:
          $ref: '#/components/schemas/Snapshot'
        components:
          $ref: '#/components/schemas/Components'
      additionalProperties: false
    ComponentsColoring:
      type: object
      properties:
        coloring:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Coloring'
      additionalProperties: false
    PerspectiveCamera:
      required:
      - camera_direction
      - camera_up_vector
      - camera_view_point
      - field_of_view
      type: object
      properties:
        camera_view_point:
          $ref: '#/components/schemas/Point'
        camera_direction:
          $ref: '#/components/schemas/Direction'
        camera_up_vector:
          $ref: '#/components/schemas/Direction'
        field_of_view:
          type: number
          format: double
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          minLength: 1
          description: The textual error code.
        message:
          type: string
          description: The error message.
      additionalProperties: false
      description: The error response body. Defines a standard for reporting errors to the client.
    Visibility:
      type: object
      properties:
        default_visibility:
          type: boolean
        exceptions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Component'
        view_setup_hints:
          $ref: '#/components/schemas/ViewSetupHints'
      additionalProperties: false
    Components:
      type: object
      properties:
        selection:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Component'
        coloring:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Coloring'
        visibility:
          $ref: '#/components/schemas/Visibility'
      additionalProperties: false
    Location:
      required:
      - x
      - y
      - z
      type: object
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        z:
          type: number
          format: double
      additionalProperties: false
    Snapshot:
      required:
      - snapshot_data
      - snapshot_type
      type: object
      properties:
        snapshot_type:
          type: string
          enum:
          - jpg
          - png
        snapshot_data:
          type: string
          description: Base64 encoded string of the snapshot image.
        snapshot_url:
          type:
          - string
          - 'null'
      additionalProperties: false
    Line:
      required:
      - end_point
      - start_point
      type: object
      properties:
        start_point:
          $ref: '#/components/schemas/Point'
        end_point:
          $ref: '#/components/schemas/Point'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT