Trimble Batch Operations API

Batch Operations

GitHub OpenAPI

Operations 1

POST /models/{modelId}/batch-get Returns resources (entities and property set definitions) by a list of… #

Documentation

Specifications

Schemas & Data

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-batch-operations-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-batch-operations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Model Batch Operations API
  description: '# Overview

    The Trimble Connect Model Service allows you to execute queries over Building Information Models (BIM). 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 overview. ## Files and Models


    Models are files in the project that are recognized by the system as 2D or 3D models and have TrimBIM representation attached. The "modelId" equals to the "fileId" and represent the same identifier in in the context of the Model APIs or File APIs respectively. Typically models are discovered by selecting a project from a list of projects available to user, then listing files in a project and selecting a file that represents are model. The Project and File APIs are part of the Trimble Connect API surface. ## Model Entity Identifiers

    Entities can be referred to by their external (source) Id, as well as by their internal (runtime) Id. The external (source) Id is assigned to each entity by the authoring application and can take the form of

    a GUID, a string or even a number. The internal (runtime) Id is the numeric index of the entity within the model, ranging from 0 to N-1, where N is the

    number of entities in the model. Some authoring applications do not use external (source) Ids, in which case they will not be available. Internal (runtime) Ids can always be used. In cases when external (source) identifier is missing a so called "not persistent" identifier can be generated by the service from the entity geometry. The "not persistent" identifier is not guaranteed to be constant, but in most cases it is until entity geometry changes. Such identifiers (external if it exists or generated if external is missing) are referred to as "connect" identifiers. When passing an entity identifier to an endpoint, it

    can be prefixed with `id:` to explicitly specify that it is an external (source)

    Id, or with the `idx:` prefix to specify that it is an internal (runtime) Id

    (index). The `idc:` prefix can be used to specify that it is a "connect" identifier (meaning that it might be generated if proper source identifier is missing). Some endpoints also allow passing an index explicitly (which should

    always be the internal/runtime Id and needs no prefix). The entity Id prefixes

    can be useful to resolve the ambiguity between the two type of entity identifiers

    in the case when both the external (source) Ids and internal (runtime) Ids are

    numbers. If a prefix is not given, the service will attempt to determine the

    type of the Id. If this cannot be done based on the value of the Id (eg. when

    it is a number), the service will assume that it''s an external (source) Id. Examples:

    * an entity identifier with the value `id:123` will be considered an external (source) Id. * an entity identifier with the value `idx:123` will be considered an internal (runtime) Id. * an entity identifier with the value `idc:ABC123` will be considered an "connect" identifier that might be equal to external id or generated from geometry. * an entity identifier with the value `123` will be primarily considered an "connect" identifier, but if the service

    determines that there are no entities with such "connect" identifiers exist, then it will attempt to use it as an internal (runtime) Id (index). ## Eventual Read Consistency

    The service does not perform any write operations and therefore has no database of its own. The API responses are eventually consistent with the file operations performed with Trimble Connect

    File APIs and file processing. When you read data from the service, the response might not reflect the results of the most recently completed write operation in FileService

    and file processing. The response might include some stale data due to caching

    in place.'
  version: v1
  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://model-api11.connect.trimble.com
  description: PROD NA
- url: https://model-api21.connect.trimble.com
  description: PROD EU
- url: https://model-api22.connect.trimble.com
  description: PROD UK
- url: https://model-api31.connect.trimble.com
  description: PROD AP
- url: https://model-api32.connect.trimble.com
  description: PROD AU
security:
- Bearer: []
tags:
- name: Batch Operations
  description: Batch Operations
paths:
  /models/{modelId}/batch-get:
    post:
      tags:
      - Batch Operations
      summary: Returns resources (entities and property set definitions) by a list of…
      operationId: BatchGet
      description: The identifiers (external and internal) follow the standard Model Service naming convention.
      parameters:
      - name: modelId
        in: path
        description: The model Id.
        required: true
        schema:
          type: string
          minLength: 1
      - name: versionId
        in: query
        description: The file version identifier, if not specified the latest version of the file is assumed.
        schema:
          type: string
          minLength: 1
      - name: include
        in: query
        description: 'Properties additionally to be included in the response. To include the property set names, both `pset` and `pset.name` must be passed.


          This query parameter is deprecated, use `fields` instead.'
        deprecated: true
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - idx
            - idc
            - psets
            - psets.name
            - boundingBox
            - product
            - hierarchyInfo
            - layerIds
        explode: false
      - name: fields
        in: query
        description: If specified only properties listed in this query parameter are included into response. The `id` property is always returned unless `idx` is explicitly specified. To include the property set names, both `psets` and `psets.name` must be passed otherwise only property values are returned. If not specified, then `idx` and `type` properties are returned by default. The `include` query parameter is ignored if `fields` query parameter is present. Comparing to `include` allows to return only identifiers, without including `type` property.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - idx
            - idc
            - type
            - psets
            - psets.name
            - boundingBox
            - product
            - hierarchyInfo
            - layerIds
        explode: false
      requestBody:
        description: Request Body.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGetRequest'
      responses:
        '200':
          description: Success
          headers:
            X-ModelVersionId:
              schema:
                type: string
              description: The actual model version identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetResponse'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '400':
          description: 'Input validation Error: value is missing/null/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 modelId/versionId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Session is invalid/Gateway timeout.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BatchGetResponse:
      type: object
      properties:
        responses:
          $ref: '#/components/schemas/BatchGetResponses'
        errors:
          $ref: '#/components/schemas/BatchGetErrors'
      description: The response wrapper class of the batch request to return resources by a list of identifiers.
    ModelEntity:
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The entity's source (AKA external) identifier.
        idc:
          minLength: 1
          type: string
          description: The entity's connect identifier. Equal to source identifier if it exists, otherwise generated from the geometry. The generated identifier is not guaranteed to be stable, but in most cases it is.
        idx:
          type: integer
          description: The entity's index (AKA internal or runtime identifier).
        type:
          minLength: 1
          type: string
          description: The Entity type.
        product:
          $ref: '#/components/schemas/Product'
        psets:
          type: array
          items:
            $ref: '#/components/schemas/PropertySet'
          description: The property sets for the entity.
        boundingBox:
          $ref: '#/components/schemas/BoundingBox'
        hierarchyInfo:
          type: array
          items:
            $ref: '#/components/schemas/HierarchyInfo'
          description: The Array of all the hierarchy types the entity is part of and the count of children under each type.
        layerIds:
          type: array
          items:
            type: integer
          description: The Ids of layers to which the entity belongs. Note that if the collection of layer Ids can also be used to determine whether the entity has geometry (at least one layer Id exists) or not (the collection of layer Ids is empty).
      description: A model entity, which is the basic group of information in a model. It can represent a 3D construction element (such as a wall, column, pipe, etc.) as well as invisible grouping elements, hierarchies, etc.
    InternalIdentifier:
      type: object
      required:
      - idx
      properties:
        idx:
          type: integer
          description: The index (AKA internal or runtime identifier).
      description: Represents an internal identifier.
    PropertySetDefinition:
      required:
      - idx
      - name
      - props
      type: object
      properties:
        idx:
          type: integer
          description: The identifier of the pset definition.
        name:
          minLength: 1
          type: string
          description: The property set name.
        props:
          type: array
          items:
            $ref: '#/components/schemas/PropertyDefinition'
          description: The ordered collection of property items belonging to a property set.
      description: A property set definition, which is a data schema of the property set.
    BatchGetErrorIdx:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: The textual error code.
        message:
          type: string
          description: The error message.
        identifier:
          $ref: '#/components/schemas/InternalIdentifier'
      description: The error response corresponding to a specific identifier object to the client.
    BoundingBox:
      required:
      - center
      - extents
      - max
      - min
      type: object
      properties:
        min:
          $ref: '#/components/schemas/Vector3'
        max:
          $ref: '#/components/schemas/Vector3'
        extents:
          $ref: '#/components/schemas/Vector3'
        center:
          $ref: '#/components/schemas/Vector3'
      description: A bounding box in the 3D space. A bounding box can be specified either with the lower bounds and upper bounds (minimum corner and maximum corner) or with the center point and the extents.
    Product:
      required:
      - historyIdx
      - name
      - ownerIdx
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: The name.
        description:
          type: string
          description: The description.
        objectType:
          type: string
          description: The object type.
        ownerIdx:
          type: integer
          description: The owner index (the internal Id or runtime Id of the owner) of the product.
        historyIdx:
          type: integer
          description: The index (the internal Id or runtime Id) of the history event the product is related to.
      description: Product information.
    BatchGetResponses:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/ModelEntity'
          description: The collection of entities.
        psetdefs:
          type: array
          items:
            $ref: '#/components/schemas/PropertySetDefinition'
          description: The collection of property set definitions.
      description: The response body of the batch request to return resources by a list of identifiers.
    HierarchyInfo:
      required:
      - type
      - count
      type: object
      properties:
        type:
          minLength: 1
          type: string
          description: The hierarchy type.
        count:
          type: integer
          description: The count of entities below this(child entities count) in the hierarchy tree.
      description: Hierarchy type information.
    Vector3:
      type: object
      required:
      - x
      - y
      - z
      properties:
        x:
          type: number
          description: The X coordinate.
          format: double
        y:
          type: number
          description: The Y coordinate.
          format: double
        z:
          type: number
          description: The Z coordinate.
          format: double
      description: A vector in the 3D space.
    BatchGetErrors:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/BatchGetErrorEntity'
          description: The collection of errored entities.
        psetdefs:
          type: array
          items:
            $ref: '#/components/schemas/BatchGetErrorIdx'
          description: The collection of errored property set definitions.
      description: The collection of error in the BatchGet response.
    BatchGetRequest:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/EntityIdentifier'
          description: The collection of entity identifiers. The maximum number of supported items in a single request is 1000.
        psetdefs:
          type: array
          items:
            $ref: '#/components/schemas/InternalIdentifier'
          description: The collection of property set definition identifiers. The maximum number of supported items in a single request is 30000.
      description: The request body of the batch request to return resources by a list of identifiers.
    EntityIdentifier:
      type: object
      properties:
        id:
          type: string
          description: The source (AKA external) identifier. Might have `id:` or `idx:` prefix.
        idx:
          type: integer
          description: The index (AKA internal or runtime identifier).
      description: Represents an identifier (internal and external).
    PropertyDefinition:
      type: object
      required:
      - name
      - type
      properties:
        name:
          type: string
          description: The property name.
          minLength: 1
        type:
          type: string
          description: The property data type.
          enum:
          - lengthMeasure
          - areaMeasure
          - volumeMeasure
          - massMeasure
          - angleMeasure
          - string
          - integer
          - number
          - boolean
        format:
          type: string
          description: The optional modifier for a property type.
          enum:
          - date-time
        nullable:
          type: boolean
          description: The optional modifier for a property type.
          default: false
      description: A single property schema definition including the name of the property and a data type.
    BatchGetErrorEntity:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: The textual error code.
        message:
          type: string
          description: The error message.
        identifier:
          $ref: '#/components/schemas/EntityIdentifier'
      description: The error response corresponding to a specific identifier object to the client.
    PropertySet:
      required:
      - idx
      - name
      - values
      type: object
      properties:
        idx:
          type: integer
          description: The pset index (internal identifier).
        name:
          type: string
          description: The pset name.
        values:
          type: array
          items:
            type: string
          description: The ordered collection of property values in a property set. The position of the value in the array corresponds the position of property in the property set definition.
      description: A property set values.
    ErrorResponse:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          minLength: 1
          description: The textual error code.
        message:
          type: string
          description: The error message.
      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