Trimble Document References (BCF 2.1) API

APIs related to Document References

GitHub OpenAPI

Operations 4

GET /bcf/2.1/projects/{projectId}/topics/{topicId}/document_references GetDocumentReferences #
POST /bcf/2.1/projects/{projectId}/topics/{topicId}/document_references CreateDocumentReference #
PUT /bcf/2.1/projects/{projectId}/topics/{topicId}/document_references/{documentReferenceId} UpdateDocumentReference #
DELETE /bcf/2.1/projects/{projectId}/topics/{topicId}/document_references/{documentReferenceId} DeleteDocumentReference #

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-document-references-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-document-references-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: Document References (BCF 2.1)
  description: APIs related to Document References
paths:
  /bcf/2.1/projects/{projectId}/topics/{topicId}/document_references:
    get:
      tags:
      - Document References (BCF 2.1)
      summary: GetDocumentReferences
      description: Retrieve a collection of all document references belonging to the specified topic.
      operationId: ListAllDocumentReferences
      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 document references for this topic.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentReferenceDto'
        '204':
          description: No document references have been defined yet for this Project.
        '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:
      - Document References (BCF 2.1)
      summary: CreateDocumentReference
      description: 'Creates a document reference. This can be a document inside the project (identified by the document_guid) or an external reference (identified by the url).


        You can also add a Trimble Connect clashset by prefixing the clashset id with ''CLASH-''.


        You can also add a Trimble Connect model object by prefixing the model object id with ''OBJECT-''.


        Note: ''url'' and ''document_guid'' are mutually exclusive


        Sample request (for a document belonging to the project):


        POST projects/{projectId}/topics/{topicId}/document_references

        {

        "document_guid": "LC0Ilxg7jtU",

        "description": "Sample file.txt"

        }

        Sample request (for a clashset belonging to the project):


        POST projects/{projectId}/topics/{topicId}/document_references

        {

        "document_guid": "CLASH-aA5cGgOKj24",

        "description": "Clashset Report 1"

        }

        Sample request (for a model object belonging to the project):


        POST projects/{projectId}/topics/{topicId}/document_references

        {

        "document_guid": "OBJECT-aA5cGgOKj24",

        "description": "I-Beam 01"

        }

        Sample request (for an external url):


        POST projects/{projectId}/topics/{topicId}/document_references

        {

        "url": "http://example.com/files/LegalRequirements.pdf",

        "description": "LegalRequirements.pdf"

        }'
      operationId: CreateDocumentReferenceForTopic
      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 document reference to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentReferenceDto'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentReferenceDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateDocumentReferenceDto'
      responses:
        '201':
          description: The created document reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentReferenceDto'
        '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}/document_references/{documentReferenceId}:
    put:
      tags:
      - Document References (BCF 2.1)
      summary: UpdateDocumentReference
      description: 'Updates the document reference.


        Note: ''url'' and ''document_guid'' are mutually exclusive.


        Note: ''guid'' is a required field and will replace the existing ''guid''.


        Sample request:


        PUT Projects/{projectId}/Topics/{topicId}/document_references/{documentReferenceId}

        {

        "guid": "0e367f48-3ff0-4523-81cc-2b7259d74f36",

        "document_guid": "472ab37a-6122-448e-86fc-86503183b520",

        "description": "The building owners global design parameters for buildings. - updated2"

        }'
      operationId: UpdateDocumentReferenceById
      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: documentReferenceId
        in: path
        description: The id of the document reference
        required: true
        schema:
          type: string
      requestBody:
        description: The document reference to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentReferenceDto'
          text/json:
            schema:
              $ref: '#/components/schemas/DocumentReferenceDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DocumentReferenceDto'
      responses:
        '201':
          description: The updated document reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentReferenceDto'
        '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/documentReferenceId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Document References (BCF 2.1)
      summary: DeleteDocumentReference
      description: Deletes the document reference
      operationId: DeleteDocumentReferenceById
      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: documentReferenceId
        in: path
        description: The id of the document reference to be deleted
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The document reference 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/documentReferenceId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreateDocumentReferenceDto:
      type: object
      properties:
        guid:
          type:
          - string
          - 'null'
        document_guid:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentReferenceDto:
      type: object
      required:
      - guid
      properties:
        version:
          type:
          - integer
          - 'null'
          format: int32
        guid:
          type: string
        document_guid:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
          description: Note that this property should be named `referenced_document` according to the [BCF standard v2.1](https://github.com/BuildingSMART/BCF-API/tree/v2.1#47-document-reference-services). However it is named `url` to match the new naming introduced in the [BCF standard v3.0](https://github.com/buildingSMART/BCF-API#37-document-reference-services).
        description:
          type:
          - string
          - 'null'
        created_by_uuid:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
          readOnly: true
      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.
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT