openapi: 3.1.0
info:
  title: CNH FieldOps Equipment Vehicle Telemetry API
  description: 'The CNH FieldOps API provides programmatic access to agronomic data and vehicle telemetry for both agronomic machinery and construction equipment connected to a FieldOps account. It replaces the previously available Ag Data and CONNECT Machine Data APIs and is offered to integration partners of CNH Industrial brands including Case IH, New Holland, STEYR, Case CE, and New Holland Construction. Vehicle telemetry follows the ISO 15143-3 specification and supports two profiles: CP (CAN Parameter) and MH (Machine Health). Authentication uses OAuth 2.0 with refresh and access tokens.'
  version: 1.0.0
  contact:
    name: CNH Developer Support
    url: https://develop.cnh.com/
  license:
    name: CNH Industrial Privacy Policy
    url: https://www.cnhindustrial.com/en-us/privacy/pages/default.aspx
servers:
- url: https://api.fieldops.cnh.com
  description: CNH FieldOps API
security:
- oauth2: []
tags:
- name: Vehicle Telemetry
  description: ISO 15143-3 vehicle telemetry, fault codes, and metrics.
paths:
  /telemetry/{vehicleId}:
    get:
      operationId: getVehicleTelemetry
      summary: Get vehicle telemetry (ISO 15143-3)
      description: 'Returns telemetry for a single vehicle following ISO 15143-3. Use the `profile` parameter to select CP (CAN Parameter, default) or MH (Machine Health) data. Supply `startDate` and `endDate` (recommended: one-day window) to constrain the response and improve performance.'
      tags:
      - Vehicle Telemetry
      parameters:
      - name: vehicleId
        in: path
        required: true
        schema:
          type: string
      - name: profile
        in: query
        schema:
          type: string
          enum:
          - CP
          - MH
          default: CP
      - name: startDate
        in: query
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Telemetry payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Telemetry'
        '400':
          description: Invalid date range
  /telemetry/{vehicleId}/fault-codes:
    get:
      operationId: getFaultCodes
      summary: Get fault codes for a vehicle
      tags:
      - Vehicle Telemetry
      parameters:
      - name: vehicleId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Fault codes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        severity:
                          type: string
                        timestamp:
                          type: string
                          format: date-time
                        description:
                          type: string
  /metrics/{vehicleId}:
    get:
      operationId: getVehicleMetrics
      summary: Get aggregated metrics for a vehicle
      description: Aggregated daily metrics including operating hours, idle hours, fuel remaining ratio, distance, and peak daily speed.
      tags:
      - Vehicle Telemetry
      parameters:
      - name: vehicleId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Metrics payload.
components:
  schemas:
    Telemetry:
      type: object
      properties:
        vehicleId:
          type: string
        profile:
          type: string
          enum:
          - CP
          - MH
        windowStart:
          type: string
          format: date-time
        windowEnd:
          type: string
          format: date-time
        location:
          $ref: '#/components/schemas/Location'
        operatingHours:
          type: number
        idleHours:
          type: number
        fuelRemainingRatio:
          type: number
        defRemaining:
          type: number
        peakDailySpeed:
          type: number
        errorTags:
          type: string
    Location:
      type: object
      properties:
        latitude:
          type: number
        longitude:
          type: number
        altitude:
          type: number
        gpsFix:
          type: boolean
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://develop.cnh.com/oauth/authorize
          tokenUrl: https://develop.cnh.com/oauth/token
          scopes:
            telemetry: Access vehicle telemetry data
            equipment: Access equipment metadata
            farm: Access farm setup
            prescriptions: Send prescription Rx files
            webhooks: Manage webhook subscriptions