Skip to content
API Standards

API Documentation

All API specifications:

  • MUST have an OpenAPI Description (OAD).
  • SHOULD use OpenAPI version 3.0 or higher. Specifications can be checked for conformance against the Standard using the official Spectral ruleset.
  • MAY include a custom OAD property, x-trimble-api-standard, within the OAD info object, indicating which Trimble API Standard Release the OAD document conforms to. OAD documents omitting this property will be tested against the latest set of Trimble API Standard linting rules. 
    openapi: 3.0
    info:
    title: Mass Haul API
    version: 1.2.0
    description: Manage and track the excavation of earth materials.
    x-trimble-api-standard: "R2023.1"