Rockwell Automation Checksheet Type API

openapi: 3.2.0
info:
  title: Plex (Rockwell Automation) Connect Checksheet Type 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: Checksheet Type API
  description: The Checksheet Types API is used to manage checksheet type data.
paths:
  /quality/v1/checksheet-types:
    get:
      operationId: listChecksheetTypes
      summary: List Checksheet Types
      tags:
      - Checksheet Type API
      description: Retrieve a list of checksheet types.
      parameters:
      - name: description
        in: query
        required: false
        schema:
          type: string
          example: string
        description: A list of Checksheet Type descriptions.
      - name: preselectedSpecifications
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Determines if Customer Specified or Dock Audit specifications are preselected on the checksheet setup form when Specifications is set to Multiple Part Specs.
      - name: inProcess
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if the checksheet type is used for production checksheets launched from the Control Panel.
      - name: pieces
        in: query
        required: false
        schema:
          type: integer
          format: int32
          example: 0
        description: The default number of measurements on the checksheet setup form.
      - name: container
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if container serial numbers are used on the checksheet form. Used in conjunction with the setting Container Text Standalone Display to enable the SPC Checksheet Container Text field on the checksheet form.
      - name: operation
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if the operation field is enabled on the checksheet form.
      - name: workcenter
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if workcenters are used on the checksheet setup.
      - name: subgroupSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
          example: 0
        description: The subgroup size.
      - name: subgroup
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if subgroups are used on the checksheet.
      - name: process
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if the checksheet type is used for Process Control checksheets.
      - name: statusRequired
        in: query
        required: false
        schema:
          type: boolean
          example: false
        description: Designation if the Status and Days Until Expiration fields are enabled on the checksheet.
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChecksheetTypeResponseDto'
      x-source: https://developers.plex.com/api/documentation/checksheet-type-api/list-checksheet-types
components:
  schemas:
    GetChecksheetTypeResponseDto:
      type: object
      description: The data structure representing a checksheet type.
      properties:
        description:
          type: string
          description: The description of the Checksheet Type.
          example: string
        specifications:
          type: string
          description: Determines the configuration of specifications on the checksheet setup form. When 'Single Part Spec', a single part specification for the part on the checksheet may be selected. When 'Multiple Part Specs', multiple part specifications may be selected. When 'Enter Single Spec', any single part specification may be selected.
          example: string
        preselectedSpecifications:
          type: string
          description: Determines if Customer Specified or Dock Audit specifications are preselected on the checksheet setup form when Specifications is set to Multiple Part Specs.
          example: string
        inProcess:
          type: boolean
          description: Designation if the checksheet type is used for production checksheets launched from the Control Panel.
          example: false
        pieces:
          type: integer
          format: int32
          description: The default number of measurements on the checksheet setup form.
          example: 0
        container:
          type: boolean
          description: Designation if container serial numbers are used on the checksheet form. Used in conjunction with the setting Container Text Standalone Display to enable the SPC Checksheet Container Text field on the checksheet form.
          example: false
        operation:
          type: boolean
          description: Designation if the operation field is enabled on the checksheet form.
          example: false
        workcenter:
          type: boolean
          description: Designation if workcenters are used on the checksheet setup.
          example: false
        subgroupSize:
          type: integer
          format: int32
          description: The subgroup size.
          example: 0
        subgroup:
          type: boolean
          description: Designation if subgroups are used on the checksheet.
          example: false
        process:
          type: boolean
          description: Designation if the checksheet type is used for Process Control checksheets.
          example: false
        statusRequired:
          type: boolean
          description: Designation if the Status and Days Until Expiration fields are enabled on the checksheet.
          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'