rockwell-factorytalk TrendData API

openapi: 3.1.0
info:
  title: Rockwell FactoryTalk Optix REST Alarms TrendData API
  description: Rockwell Automation FactoryTalk Optix REST API provides programmatic access to HMI and SCADA visualization applications, enabling external system integration, tag read/write, alarm management, and runtime control of FactoryTalk Optix applications deployed in industrial automation environments.
  version: 1.5.0
  contact:
    name: Rockwell Automation Support
    url: https://www.rockwellautomation.com/en-us/support/
  license:
    name: Rockwell Automation Software License
    url: https://www.rockwellautomation.com/en-us/company/about-us/legal-notices/
servers:
- url: https://{host}/api/v1
  description: FactoryTalk Optix REST API
  variables:
    host:
      default: optix.example.com
      description: FactoryTalk Optix server hostname
security:
- oauth2: []
- apiKey: []
tags:
- name: TrendData
  description: Historical trend data retrieval
paths:
  /trends/{tagName}:
    get:
      operationId: getTrendData
      summary: Get Historical Trend Data
      description: Returns historical trending data for a tag within a time range.
      tags:
      - TrendData
      parameters:
      - $ref: '#/components/parameters/TagName'
      - name: startTime
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: resolution
        in: query
        description: Data resolution (e.g., 1s, 1m, 1h)
        schema:
          type: string
          default: 1m
      - name: limit
        in: query
        schema:
          type: integer
          default: 1000
          maximum: 10000
      responses:
        '200':
          description: Trend data points
          content:
            application/json:
              schema:
                type: object
                properties:
                  tagName:
                    type: string
                  dataPoints:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrendDataPoint'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: string
    TrendDataPoint:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        value:
          description: Tag value at this timestamp
        quality:
          type: string
          enum:
          - GOOD
          - BAD
          - UNCERTAIN
  parameters:
    TagName:
      name: tagName
      in: path
      required: true
      description: Tag name (may use dot notation for nested tags, e.g. Conveyor1.Speed)
      schema:
        type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://optix.example.com/auth/token
          scopes:
            optix.read: Read tag values and alarm data
            optix.write: Write tag values
            optix.admin: Manage recipes and project configuration
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: FactoryTalk Optix API key