Rockwell Automation Control Plans API

openapi: 3.2.0
info:
  title: Plex (Rockwell Automation) Connect Control Plans API
  version: '2026-10-20'
  description: Plex Smart Manufacturing Platform REST APIs, converted mechanically from the structured operation documents the Plex Developer Portal (developers.plex.com, a Rockwell Automation property) serves at /api/documentation/{api}/{operation}. No operations were authored by hand.
  x-generated-from: provider-documentation-json
  x-source: https://developers.plex.com/api/documentation/info
servers:
- url: https://connect.plex.com
  description: Production
- url: https://test.connect.plex.com
  description: Test (from https://developers.plex.com/api/sandbox/url)
security:
- PlexConnectApiKey: []
tags:
- name: Control Plans API
  description: The Control Plans API is used to manage control plan data.
paths:
  /quality/v1/control-plans/{id}/control-plan-lines/{lineId}:
    get:
      operationId: getControlPlanLine
      summary: Get Control Plan Line
      tags:
      - Control Plans API
      description: Retrieve a control plan line.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      - name: lineId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetControlPlanLineResponseDto'
        '404':
          description: Resource not found.
      x-source: https://developers.plex.com/api/documentation/control-plans-api/get-control-plan-line
  /quality/v1/control-plans/{id}:
    get:
      operationId: getControlPlan
      summary: Get Control Plan
      tags:
      - Control Plans API
      description: Retrieve a control plan.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetControlPlanResponseDto'
        '404':
          description: Resource not found.
      x-source: https://developers.plex.com/api/documentation/control-plans-api/get-control-plan
  /quality/v1/control-plans/{id}/control-plan-lines:
    get:
      operationId: listControlPlanLines
      summary: List Control Plan Lines
      tags:
      - Control Plans API
      description: Retrieve a list of control plan lines.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      - name: ids
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: A list of IDs representing the Control Plan Line.
      - name: jobOpId
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: ID representing the job op on the deviation.
      - name: specificToWorkcenterId
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: ID representing the workcenter.
      - name: partOperationId
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: ID representing the part operation.
      - name: inspectionMode
        in: query
        required: false
        schema:
          type: string
          example: string
        description: The inspection mode.
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetControlPlanLineResponseDto'
        '404':
          description: Resource not found.
      x-source: https://developers.plex.com/api/documentation/control-plans-api/list-control-plan-lines
  /quality/v1/control-plans:
    get:
      operationId: listControlPlans
      summary: List Control Plans
      tags:
      - Control Plans API
      description: Retrieve a list of active control plans.
      parameters:
      - name: ids
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: A list of IDs representing the Control Plan.
      - name: controlPlanNo
        in: query
        required: false
        schema:
          type: number
          format: double
          example: 0.1
        description: The Control Plan No.
      - name: controlPlanTypes
        in: query
        required: false
        schema:
          type: string
          example: string
        description: A list of Control Plan types.
      - name: partId
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: ID representing the Control Plan part number.
      - name: primary
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: The primary flag.
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetControlPlanResponseDto'
      x-source: https://developers.plex.com/api/documentation/control-plans-api/list-control-plans
components:
  schemas:
    GetControlPlanResponseDto:
      type: object
      description: The data structure representing a control plan.
      properties:
        id:
          type: string
          format: uuid
          description: ID representing the Control Plan.
          example: 00000000-0000-0000-0000-000000000000
        buildingCode:
          type: string
          description: The Control Plan building code.
          example: string
        buildingId:
          type: string
          format: uuid
          description: ID representing the Control Plan building.
          example: 00000000-0000-0000-0000-000000000000
        controlPlanNo:
          type: number
          format: double
          description: The Control Plan number.
          example: 0.1
        controlPlanStatus:
          type: string
          description: The Control Plan status.
          example: string
        controlPlanType:
          type: string
          description: The Control Plan type.
          example: string
        description:
          type: string
          description: The Control Plan description.
          example: string
        externalDocumentId:
          type: string
          description: The Control Plan external document ID.
          example: string
        externalDocumentRevisionLevel:
          type: string
          description: The revision level of the external document.
          example: string
        originalDate:
          type: string
          format: date-time
          description: The original date of the Control Plan.
          example: '2026-10-20T12:03:01Z'
        partId:
          type: string
          format: uuid
          description: ID representing the Control Plan part number.
          example: 00000000-0000-0000-0000-000000000000
        partNo:
          type: string
          description: The Control Plan part number.
          example: string
        partRevision:
          type: string
          description: The Control Plan part revision.
          example: string
        partName:
          type: string
          description: The Control Plan part name.
          example: string
        primary:
          type: boolean
          description: The primary flag.
          example: false
        revisionDate:
          type: string
          format: date-time
          description: The Control Plan revision date.
          example: '2026-10-20T12:03:01Z'
    GetControlPlanLineResponseDto:
      type: object
      description: The data structure representing a control plan line.
      properties:
        id:
          type: string
          format: uuid
          description: ID representing the Control Plan Line.
          example: 00000000-0000-0000-0000-000000000000
        controlPlanId:
          type: string
          format: uuid
          description: ID representing the control plan.
          example: 00000000-0000-0000-0000-000000000000
        controlPlanLineStatus:
          type: string
          description: The status of the control plan line.
          example: string
        inspectionMode:
          type: string
          description: The inspection mode.
          example: string
        partId:
          type: string
          format: uuid
          description: ID representing the part.
          example: 00000000-0000-0000-0000-000000000000
        partNo:
          type: string
          description: The part no.
          example: string
        partRevision:
          type: string
          description: The part revision.
          example: string
        partOperationId:
          type: string
          format: uuid
          description: ID representing the part operation.
          example: 00000000-0000-0000-0000-000000000000
        operationId:
          type: string
          format: uuid
          description: ID representing the operation.
          example: 00000000-0000-0000-0000-000000000000
        operationCode:
          type: string
          description: The operation code.
          example: string
        specificationId:
          type: string
          format: uuid
          description: ID representing the specification.
          example: 00000000-0000-0000-0000-000000000000
        description:
          type: string
          description: The description of the control plan line.
          example: string
        passAnswer:
          type: string
          description: The pass answer.
          example: string
        failAnswer:
          type: string
          description: The fail answer.
          example: string
        note:
          type: string
          description: The note on the control plan line.
          example: string
        gageType:
          type: string
          description: The gage type of the control plan line.
          example: string
        gageNote:
          type: string
          description: The gage note of the control plan line.
          example: string
        partSpecificGages:
          type: array
          description: A list of part-specific gages.
          items:
            type: object
            properties: {}
        samplePlan:
          type: string
          description: The sample plan.
          example: string
        customChecksheetDataCollectionType:
          type: string
          description: The custom checksheet data collection type.
          example: string
        reactionPlan:
          type: string
          description: The reaction plan.
          example: string
        reactionPlanOwner:
          type: string
          description: The reaction plan owner.
          example: string
        specificToWorkcenterId:
          type: string
          format: uuid
          description: ID representing the workcenter.
          example: 00000000-0000-0000-0000-000000000000
        specificToWorkcenterCode:
          type: string
          description: The workcenter code of the workcenter.
          example: string
        defaultAttributeAnswerPass:
          type: boolean
          description: The designation if the attribute answer defaults to the pass value.
          example: false
        deviationId:
          type: string
          format: uuid
          description: ID representing the deviation that is currently effective with the most recent effective date that has an approved deviation status if deviation statuses are used.
          example: 00000000-0000-0000-0000-000000000000
        sortOrder:
          type: number
          format: double
          description: The sort order.
          example: 0.1
        checksheetSortOrder:
          type: number
          format: double
          description: The sort order.
          example: 0.1
        symbol:
          type: string
          description: The special symbol association with the specification.
          example: string
        symbolAbbreviation:
          type: string
          description: The special symbol abbreviation.
          example: string
        trackFailureModes:
          type: boolean
          description: The designation if failure modes are tracked. Requires the Control Plan setting "Specification Tool Linking Use" be enabled.
          example: false
  securitySchemes:
    PlexConnectApiKey:
      type: apiKey
      in: header
      name: X-Plex-Connect-Api-Key
      description: 'Subscription key (Consumer Key of an app created in the Plex Developer Portal). Source: https://developers.plex.com/getstarted'