Trimble · Schema

QueryEntitiesRequest

The request body used to query the model entities by one or more filter criteria passed through property set name, property name, property value, product name, product description and object type of the product. Each element of the `psets.items` array and `product` is treated as a separate filter criteria and only those entities are returned, which satisfy **all** the preceding filter criteria. If any filter criteria is not provided or is empty, that filter criteria is ignored, and the next filter criteria in the filters precedence order is evaluated. In addition, the request can also define the tolerance limit for comparing property values of every property type. These are passed as `absolute` for floating point types and as `compare` for string type. The service also maintains a default set of absolute tolerances for some of the property types. The tolerance specified as part of the request body will have a higher precedence over the service level default tolerances.

ConstructionTransportationGeospatialGPSMappingBIMFleet ManagementCollaborationAgriculture

Properties

Name Type Description
psets array The Property Set details to query the model.
product object
tolerances array The list of tolerances to be applied on various property type while comparing their values.
View JSON Schema on GitHub

JSON Schema

trimble-query-entities-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/trimble/json-schema/trimble-query-entities-request-schema.json",
  "title": "QueryEntitiesRequest",
  "description": "The request body used to query the model entities by one or more filter criteria passed through property set name, property name, property value, product name, product description and object type of the product. Each element of the `psets.items` array and `product` is treated as a separate filter criteria and only those entities are returned, which satisfy **all** the preceding filter criteria. If any filter criteria is not provided or is empty, that filter criteria is ignored, and the next filter criteria in the filters precedence order is evaluated. In addition, the request can also define the tolerance limit for comparing property values of every property type. These are passed as `absolute` for floating point types and as `compare` for string type. The service also maintains a default set of absolute tolerances for some of the property types. The tolerance specified as part of the request body will have a higher precedence over the service level default tolerances.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/trimble-connect-model-openapi.yml#/components/schemas/QueryEntitiesRequest",
  "type": "object",
  "properties": {
    "psets": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PropertySetQuery"
      },
      "description": "The Property Set details to query the model."
    },
    "product": {
      "$ref": "#/$defs/ProductQuery"
    },
    "tolerances": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tolerances"
      },
      "description": "The list of tolerances to be applied on various property type while comparing their values."
    }
  },
  "$defs": {
    "DateTimeCompareOptions": {
      "type": "object",
      "properties": {
        "maxDelta": {
          "type": "string",
          "description": "The acceptable duration tolerance when comparing datetime properties. If not specified a default tolerance is used.",
          "format": "iso8601",
          "pattern": "^P(?=\\d+[YMD])(\\d+Y)?(\\d+M)?(\\d+D)?(T(?=\\d+[HMS])(\\d+H)?(\\d+M)?(\\d+S)?)?$"
        }
      }
    },
    "NumberCompareOptions": {
      "type": "object",
      "properties": {
        "maxDelta": {
          "type": "number",
          "description": "The absolute tolerance when comparing numerical properties. If not specified a default tolerance is used specific for the property type.",
          "format": "double"
        }
      }
    },
    "ProductQuery": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name."
        },
        "description": {
          "type": "string",
          "description": "The description."
        },
        "objectType": {
          "type": "string",
          "description": "The object type."
        }
      },
      "description": "A structure used to query the model entities by its product name, description and object type. This filter can be specified individually i.e only (name or description or type) or as combination of two or more (name & description; name & type; name, description & type etc.). If more than one product property is specified then only entities having all the properties of the product are returned."
    },
    "Property": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name."
        },
        "value": {
          "type": "string",
          "description": "The value."
        }
      },
      "description": "A property of a model entity to search for by name and value."
    },
    "PropertySetQuery": {
      "type": "object",
      "properties": {
        "name": {
          "minLength": 1,
          "type": "string",
          "description": "The name of the Property Set. Only entities having this property set name will be returned."
        },
        "props": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Property"
          },
          "description": "The array containing the individual Property Items belonging to the Property Set."
        }
      },
      "description": "A structure used to query the model entities by property set name, property name and property value. This property filter can be specified as one of the following: Property Set Name; Property Set Name and Property Name; Property Set Name, Property Name and Property value; One or more Property Set Names; One or more Property Names within a Property Set; Zero or one Property Value for any Property Name within a Property Set. If only Property Set Name is specified, entities having properties belonging to that property set are returned If both Property Set Name and Property Name are specified, entities with valid values for those properties are returned. If a Property Value is also specified with a propertyName within a Property Set, the entities having the Property Value and Name exactly matching the one specified in the filter for the given Property Set, are returned."
    },
    "StringCompareOptions": {
      "type": "object",
      "properties": {
        "compare": {
          "type": "string",
          "description": "The case sensitivity rule to be applied for string properties comparison. if not specified a case sensitive comparison is used by default.",
          "enum": [
            "caseSensitive",
            "caseInsensitive"
          ],
          "default": "caseSensitive"
        }
      }
    },
    "Tolerances": {
      "type": "object",
      "properties": {
        "lengthMeasure": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "areaMeasure": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "volumeMeasure": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "massMeasure": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "angleMeasure": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "number": {
          "$ref": "#/$defs/NumberCompareOptions"
        },
        "string": {
          "$ref": "#/$defs/StringCompareOptions"
        },
        "dateTime": {
          "$ref": "#/$defs/DateTimeCompareOptions"
        }
      },
      "description": "A structure used to specify the comparison options (e.g. tolerances) for property values of various types. Comparison options specified in the request will override the default service level comparison options and tolerance value. If for a property type the tolerance value is not specified in the request, then for that type the service level default tolerance value will be applied."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/trimble-query-entities-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.