Trimble Object Link to Entity API

API related to 3d model object linkage to entity. Object link is a relationship between a 3d model (source) and a Trimble Connect entity or some external reference (target). The linked entity (target) could be a file, a TODO, a view, a clash item, or some external reference url. Moreover, the source object may contain additional information regarding the semantic of the link; for example, various 3d model object could be included in the source to provide linking of 3d model objects to target.

GitHub OpenAPI

Operations 6

GET /objectlink List linked entities for objects #
GET /objectlink/target List links for the given target entity #

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-object-link-to-entity-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-object-link-to-entity-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Object Link to Entity API
  description: '# Overview

    The Trimble Connect API allows you to read, write, and update data into and out of the Connect platform. Now, you can create folders, upload and download files, modify views, and do much more from any application.


    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

    All collections/lists support a Range header to fetch partial lists (HTTP 206) - the positions are zero-indexed & inclusive


    + Request Header

    ```

    Range: items=25-34

    ```


    + Response Header


    ```

    Content-Range: items 25-34/40

    ```


    ## If-Match Header

    Some APIs support the If-Match header, especially for changing data on objects. Using this, the API user can ensure that the changes are being done to the latest version.


    The APIs that support this header are:


    + **PATCH /folders**

    + **PATCH /files**


    ## Limits

    + There is a maximum length of 255 characters for project, company, folder, file, group, release, views, and clash names.

    + There is a maximum length of 40 characters for tag labels.'
  version: '2.0'
  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://app.connect.trimble.com/tc/api/2.0
  description: PROD US master region
- url: https://app21.connect.trimble.com/tc/api/2.0
  description: PROD EU region
- url: https://app22.connect.trimble.com/tc/api/2.0
  description: PROD UK region
- url: https://app31.connect.trimble.com/tc/api/2.0
  description: PROD AP region
- url: https://app32.connect.trimble.com/tc/api/2.0
  description: PROD AP2 region
- url: https://app.stage.connect.trimble.com/tc/api/2.0
  description: STAGE US master region
- url: https://app31.stage.connect.trimble.com/tc/api/2.0
  description: STAGE AP region
- url: https://app21.stage.connect.trimble.com/tc/api/2.0
  description: STAGE EU region
- url: https://app.connect.trimble.com/tc/api
  description: PROD US master region (v2.1)
- url: https://app21.connect.trimble.com/tc/api
  description: PROD EU region (v2.1)
- url: https://app22.connect.trimble.com/tc/api
  description: PROD UK region (v2.1)
- url: https://app31.connect.trimble.com/tc/api
  description: PROD AP region (v2.1)
- url: https://app32.connect.trimble.com/tc/api
  description: PROD AP2 region (v2.1)
- url: https://app.stage.connect.trimble.com/tc/api
  description: STAGE US master region (v2.1)
- url: https://app31.stage.connect.trimble.com/tc/api
  description: STAGE AP region (v2.1)
- url: https://app21.stage.connect.trimble.com/tc/api
  description: STAGE EU region (v2.1)
security:
- Bearer: []
tags:
- name: Object Link to Entity
  description: 'API related to 3d model object linkage to entity.

    Object link is a relationship between a 3d model (source) and a Trimble Connect entity or some external reference (target). The linked entity (target) could be a file, a TODO, a view, a clash item, or some external reference url. Moreover, the source object may contain additional information regarding the semantic of the link; for example, various 3d model object could be included in the source to provide linking of 3d model objects to target.'
paths:
  /objectlink:
    get:
      tags:
      - Object Link to Entity
      summary: List linked entities for objects
      description: This API returns the list of links based on the version Id of the 3d model and the object Id (or object source Id). Either id or versionId parameter must be provided.
      operationId: Listlinkedentitiesforobjects
      parameters:
      - name: id
        in: query
        description: source identifier. Currently could only be file id.  If id alone is passed then every linkage for that file (all versions) is returned.
        schema:
          type: string
          example: Dyfw481f323
      - name: versionId
        in: query
        description: file version identifier.  If versionId alone is passed then every linkage for the model identified by the versionId is returned.
        schema:
          type: string
          example: cFhCbaRN4t1
      - name: sourceId
        in: query
        description: Source identifier of the object of interest.
        schema:
          type: string
          example: PdtcatZR271
      - name: modifiedAfter
        in: query
        description: 'filter: only links modified after the given time are returned.'
        schema:
          type: string
          format: date-time
          example: 2017-01-20T13:51:37-0700
      - name: includeDeleted
        in: query
        description: flag to indicate whether deleted objects link should be included.
        schema:
          type: boolean
          example: false
      - name: detail
        in: query
        description: flag to indicate whether a full or mini version of the listing should be returned. Default is false.
        schema:
          type: boolean
          example: false
      - name: showOrphanLinks
        in: query
        description: flag to include orphan links (target without target id). Default is false.
        schema:
          type: boolean
          example: false
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectLinkResponse'
      deprecated: false
    post:
      tags:
      - Object Link to Entity
      summary: Create object link
      description: This API creates a single object link. New Target TOPIC is added which accepts Topic uuid as Id
      operationId: Createobjectlink
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateObjectLinkRequest'
        required: true
      responses:
        '201':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectLinkResponse'
      deprecated: false
  /objectlink/objectlinks:
    post:
      tags:
      - Object Link to Entity
      summary: Bulk create object links
      description: This api bulk creates a collection of object links. New Target TOPIC is added which accepts Topic uuid as Id
      operationId: Bulkcreateobjectlinks
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkCreateObjectLinksRequest'
              description: ''
              example:
              - source:
                  versionId: PdtcatZR272
                  data:
                  - type: BIMOBJECT
                    sourceId: 0mIQCEgIDCAf2Ue8DWdALk
                  - type: BIMOBJECT
                    sourceId: 1IBjXv001Ehp4pDpWuC38t
                target:
                  type: URL
                  id: https://connect.trimble.com
              - source:
                  versionId: PdtcatZR273
                  data:
                  - type: BIMOBJECT
                    sourceId: AIBjXv001Ehp4pDpWuC38t
                target:
                  type: FILE
                  id: aBy8aG1CQ5Q
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectLinkResponse'
                description: ''
                example:
                - id: 6eQUp6ozXQg
                  createdOn: 2015-05-27T13:51:37-0700
                  createdBy:
                    id: Dyfw481f324
                    firstName: John
                    lastName: Doe
                    email: johndoe@gt-global.com
                    status: ACTIVE
                  modifiedOn: 2015-05-27T13:51:37-0700
                  modifiedBy:
                    id: Dyfw481f325
                    firstName: John
                    lastName: Doe
                    email: johndoe@gt-global.com
                    status: ACTIVE
                  source:
                    id: PdtcatZR274
                    versionId: PdtcatZR275
                    data:
                    - type: BIMOBJECT
                      objectId: rDAnE54hakg
                      sourceId: 0mIQCEgIDCAf2Ue8DWdALk
                    - type: BIMOBJECT
                      objectId: hohC9LsM55U
                      sourceId: 1IBjXv001Ehp4pDpWuC38t
                  target:
                    type: URL
                    id: https://connect.trimble.com/1
                  status: 201
                - id: e8OLagWLlw8
                  createdOn: 2015-05-27T13:51:37-0700
                  createdBy:
                    id: Dyfw481f326
                    firstName: John
                    lastName: Doe
                    email: johndoe@gt-global.com
                    status: ACTIVE
                  modifiedOn: 2015-05-27T13:51:37-0700
                  modifiedBy:
                    id: Dyfw481f327
                    firstName: John
                    lastName: Doe
                    email: johndoe@gt-global.com
                    status: ACTIVE
                  source:
                    id: PdtcatZR276
                    versionId: PdtcatZR277
                    data:
                    - type: BIMOBJECT
                      objectId: oZLszX5enog
                      sourceId: 3DqSjXROfCKOfAMT5r24Iw
                  target:
                    type: FILE
                    id: aBy8aG1CQ5Q
                    versionId: aBy8aG1CQ5Q
                  status: 201
      deprecated: false
  /objectlink/target:
    get:
      tags:
      - Object Link to Entity
      summary: List links for the given target entity
      description: This API returns the set of object links for a given target. For versioned target, either id or versionId must be provided. For ISSUE target, contextId is required.
      operationId: Listlinksforthegiventargetentity
      parameters:
      - name: projectId
        in: query
        description: project id.
        required: true
        schema:
          type: string
          example: 4MUJs5SXO64
      - name: type
        in: query
        description: target type.
        required: true
        schema:
          type: string
          example: FILE
      - name: id
        in: query
        description: target id identifier.
        required: true
        schema:
          type: string
          example: FlPghBwyP-c
      - name: contextId
        in: query
        description: context Id (required for ISSUE target).
        schema:
          type: string
          example: trn:2:tc:us:projects:isOldRrinmE
      - name: versionId
        in: query
        description: target versionId, applicable to versioned target.
        required: true
        schema:
          type: string
          example: QaUAyoHLcA0
      - name: modifiedAfter
        in: query
        description: 'filter: only links modified after the given time are returned.'
        schema:
          type: string
          format: date-time
          example: 2017-01-20T13:51:37-0700
      - name: includeDeleted
        in: query
        description: include deleted links.
        required: true
        schema:
          type: boolean
          example: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectLinkResponse'
      deprecated: false
  /objectlink/{linkId}:
    patch:
      tags:
      - Object Link to Entity
      summary: Update object links
      operationId: Updateobjectlinks
      parameters:
      - name: linkId
        in: path
        description: id of the link
        required: true
        style: simple
        schema:
          type: string
          example: 6eQUp6ozXQg
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateObjectLinksRequest'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectLinkResponse'
      deprecated: false
    delete:
      tags:
      - Object Link to Entity
      summary: Delete an object link
      operationId: Deleteaobjectlink
      parameters:
      - name: linkId
        in: path
        description: id of the link
        required: true
        style: simple
        schema:
          type: string
          example: 6eQUp6ozXQg
      responses:
        '204':
          description: ''
          headers: {}
          content: {}
      deprecated: false
components:
  schemas:
    SourceRequest:
      title: Source model information
      description: the source object. Source is mandatory in a Request but would be omitted in Response if detail parameter (default = false) is set to false.
      required:
      - versionId
      - data
      type: object
      properties:
        versionId:
          type: string
          description: The version the source object is referencing.
        data:
          type: array
          description: An array of supplemental data, usually objects in a 3D model.
          items:
            $ref: '#/components/schemas/SourceDataRequest'
      example:
        versionId: PdtcatZR282
        data:
        - type: BIMOBJECT
          sourceId: 0mIQCEgIDCAf2Ue8DWdALk
        - type: BIMOBJECT
          sourceId: 1IBjXv001Ehp4pDpWuC38t
    BulkCreateObjectLinksRequest:
      title: BulkCreateObjectLinksRequest
      required:
      - source
      - target
      type: object
      properties:
        source:
          $ref: '#/components/schemas/SourceRequest'
        target:
          $ref: '#/components/schemas/Target'
      example:
        source:
          versionId: PdtcatZR285
          data:
          - type: BIMOBJECT
            sourceId: 0mIQCEgIDCAf2Ue8DWdALk
          - type: BIMOBJECT
            sourceId: 1IBjXv001Ehp4pDpWuC38t
        target:
          type: URL
          id: https://web.connect.trimble.com
    SourceDataRequest:
      title: Source object information
      required:
      - type
      - sourceId
      type: object
      properties:
        type:
          type: string
          description: the type of supplemental data. Currently only 'BIMOBJECT' is supported.
        sourceId:
          type: string
          description: object source identifier. It is mandatory to have sourceId in data object.
      example:
        type: BIMOBJECT
        sourceId: 0mIQCEgIDCAf2Ue8DWdALk
    Target:
      title: object associated to source.
      required:
      - type
      - id
      type: object
      properties:
        type:
          type: string
          description: the type of associated object. It could be FILE, URL, TOPIC, TODO or ISSUE. Type is mandatory.
        name:
          type: string
          description: target name.
        id:
          type: string
          description: id of target, required unless the type of target intended to be created is an embedded file, indicated by embedded=true flag.
        versionId:
          type: string
          description: associated object version identifier.
        embedded:
          type: boolean
          description: (required if target id is null) - this field allows to create an objectlink with an embedded FILE as target without target id.
        contextId:
          type: string
          description: The unique identifier of the context in TRN format. Required for ISSUE targets.
      example:
        type: URL
        id: https://connect.trimble.com/2
    SourceResponse:
      title: Source model information
      description: the source object. Source is mandatory in a Request but would be omitted in Response if detail parameter (default = false) is set to false.
      required:
      - id
      - versionId
      - data
      type: object
      properties:
        id:
          type: string
          description: The identifier the source object is referencing.
        versionId:
          type: string
          description: The version the source object is referencing.
        type:
          type: string
          description: The source object type. Currently only FILE type is supported.
        data:
          type: array
          description: An array of supplemental data, usually objects in a 3D model.
          items:
            $ref: '#/components/schemas/SourceDataResponse'
      example:
        id: PdtcatZR280
        versionId: PdtcatZR281
        data:
        - type: BIMOBJECT
          objectId: woC32em2Fb0
          sourceId: 0mIQCEgIDCAf2Ue8DWdALk
        - type: BIMOBJECT
          objectId: woC32em2Fb0
          sourceId: 1IBjXv001Ehp4pDpWuC38t
    Company:
      title: Company
      required:
      - name
      - website
      - image
      - role
      - createdOn
      - modifiedOn
      - createdBy
      - modifiedBy
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        website:
          type: string
        image:
          type: string
        role:
          type: string
        createdOn:
          type: string
        modifiedOn:
          type: string
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
      example:
        name: Trimble.com
        website: gmail.com
        image: https://{baseURL}/tc/app/files/thumb?id=k-PEcTYK265&fc=COMPANYIMG#?1487053557000
        role: ADMIN
        createdOn: 2017-01-18T12:48:38+0000
        modifiedOn: 2017-02-14T06:25:57+0000
        createdBy:
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
        modifiedBy:
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
    ObjectLinkResponse:
      title: ObjectLinkResponse
      required:
      - id
      - createdOn
      - createdBy
      - modifiedOn
      - modifiedBy
      - source
      - target
      type: object
      properties:
        id:
          type: string
          description: The Object link identifier.
        createdOn:
          type: string
          description: (timestamp) - An ISO8601 date when the link was created
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedOn:
          type: string
          description: (timestamp) - An ISO8601 date when the link was modified
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        name:
          type: string
          description: name of link.
        source:
          $ref: '#/components/schemas/SourceResponse'
        target:
          $ref: '#/components/schemas/Target'
      example:
        id: 6eQUp6ozXQg
        createdOn: 2015-05-27T13:51:37-0700
        createdBy:
          id: Dyfw481f436
          firstName: John
          lastName: Doe
          email: johndoe@gt-global.com
          status: ACTIVE
        modifiedOn: 2015-05-27T13:51:37-0700
        modifiedBy:
          id: Dyfw481f437
          firstName: John
          lastName: Doe
          email: johndoe@gt-global.com
          status: ACTIVE
        source:
          id: PdtcatZR283
          versionId: PdtcatZR284
          data:
          - type: BIMOBJECT
            objectId: lG937X0ImXI
            sourceId: 0mIQCEgIDCAf2Ue8DWdALk
          - type: BIMOBJECT
            objectId: zOQNE-P3zq4
            sourceId: 1IBjXv001Ehp4pDpWuC38t
        target:
          type: URL
          id: https://connect.trimble.com/3
    UpdateObjectLinksRequest:
      title: UpdateObjectLinksRequest
      required:
      - target
      type: object
      properties:
        target:
          $ref: '#/components/schemas/Target'
      example:
        target:
          type: FILE
          id: aBy8aG1CQ5Q
          versionId: aBy8aG1CQ5Q
          embedded: true
    SourceDataResponse:
      title: Source object information
      required:
      - type
      - objectId
      - sourceId
      type: object
      properties:
        type:
          type: string
          description: the type of supplemental data. Currently only 'BIMOBJECT' is supported.
        sourceId:
          type: string
          description: object source identifier. It is mandatory to have sourceId in data object.
        objectId:
          type: string
          description: Object identitfier.
          deprecated: true
        xrefId:
          type: string
          description: external link identifier.
      example:
        type: BIMOBJECT
        objectId: woC32em2Fb0
        sourceId: 0mIQCEgIDCAf2Ue8DWdALk
    CreateObjectLinkRequest:
      title: CreateObjectLinkRequest
      required:
      - source
      - target
      type: object
      properties:
        source:
          $ref: '#/components/schemas/SourceRequest'
        target:
          $ref: '#/components/schemas/Target'
      example:
        source:
          versionId: PdtcatZR279
          data:
          - type: BIMOBJECT
            sourceId: 0mIQCEgIDCAf2Ue8DWdALk
          - type: BIMOBJECT
            sourceId: 1IBjXv001Ehp4pDpWuC38t
        target:
          type: URL
          id: https://www.trimble.com
    CreatedBy:
      title: CreatedBy
      required:
      - id
      - firstName
      - lastName
      - email
      - status
      type: object
      description: User details of who created this object
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        status:
          type: string
          description: User status. User's status is PENDING when a new user has been invited to a project and has not access Connect yet. Once the user has accessed Connect, the status becomes ACTIVE. REMOVED is a project specific status that is shown for users that have been removed from a project.
          enum:
          - ACTIVE
          - PENDING
          - REMOVED
        company:
          $ref: '#/components/schemas/Company'
        companies:
          type: array
          items:
            $ref: '#/components/schemas/Company'
        companyAdmin:
          type: boolean
      example:
        id: LWOf7rirztM
        tiduuid: b75d4e5c-e4c0-4a92-9963-fcc5d36dd6a6
        firstName: John
        lastName: Doe
        email: jdoe@trimble.com
        status: ACTIVE
    ModifiedBy:
      title: ModifiedBy
      required:
      - id
      - firstName
      - lastName
      - email
      - status
      type: object
      description: User details of who modified this object recently
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        status:
          type: string
          description: User status. User's status is PENDING when a new user has been invited to a project and has not access Connect yet. Once the user has accessed Connect, the status becomes ACTIVE. REMOVED is a project specific status that is shown for users that have been removed from a project.
          enum:
          - ACTIVE
          - PENDING
          - REMOVED
      example:
        id: LWOf7rirztM
        tiduuid: b75d4e5c-e4c0-4a92-9963-fcc5d36dd6a6
        firstName: John
        lastName: Doe
        email: jdoe@trimble.com
        status: ACTIVE
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT