Rockwell Automation Checksheet API

The Checksheets API is used to manage checksheet data.

Business capability
Quality Control Management BC-720.30

Operations 2

POST /quality/v1/checksheets Create Checksheet #
GET /quality/v1/checksheets/{id} Get Checksheet #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/rockwell-automation:rockwell-automation-checksheet-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rockwell-automation-checksheet-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Plex (Rockwell Automation) Connect Checksheet 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 API
  description: The Checksheets API is used to manage checksheet data.
paths:
  /quality/v1/checksheets:
    post:
      operationId: createChecksheet
      summary: Create Checksheet
      tags:
      - Checksheet API
      description: 'Checksheets are the realization of control plan lines and are used to collect real-time inspection data. Control plans may be classified as either part or process. Part control plans are available at quality/{version}/control-plans, while process control recipes are available at quality/{version}/process-control-plans. Specifications are similarly divided into part and process, and can be found at quality/{version}/specifications and quality/{version}/process-specifications, respectively.

        There are two primary types of checksheets: live and non-live.

        A live checksheet is completed by an inspector directly within the Plex control panel.

        A non-live checksheet is filled out outside the control panel, such as through Checksheet launchers in Plex.

        Sample Request for a Live Checksheet

        {

        "productionWorkcenterId": "AF05A9CC-83D6-4A95-A79D-0932906A7212",

        "operationId": "9C10C43A-4181-40CF-BE62-4B5ED0034F0D",

        "inspectionMode": "In Process (each container)",

        "measurements": [

        {

        "specificationId": "168E2C69-31AB-43B2-9B61-BC6A22BA0719",

        "value": 1

        }

        ]

        }


        Sample Request for a Non-Live Checksheet

        {

        "controlPlanId": "616f5aad-0d68-48be-af5a-39da2f932f9d",

        "approvedWorkcenterId": "57DFB705-7122-431D-B5B7-246DF6130BE7",

        "partId": "85989389-5CE1-4FDD-95D9-94A3CD663CE6",

        "operationId": "3C85A9B0-3B87-4FF5-95A6-1709D45986CE",

        "partOperationId": "a0a315d1-ef64-4e74-9d56-02b430ea5e1f",

        "inspectionMode": "Process Checks - Setup",

        "measurements": [

        {

        "specificationId": "497ABAB9-D86D-4674-99F6-9586ED8D1578",

        "value": 510

        }

        ]

        }


        Unsupported Functionality:


        Streams

        Piece Measurements


        This operation supports sending in a maximum of 100 specifications for a checksheet.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddChecksheetDto'
      responses:
        '201':
          description: Checksheet added successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddChecksheetResponse'
        '400':
          description: A validation error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
      x-source: https://developers.plex.com/api/documentation/checksheet-api/create-checksheet
  /quality/v1/checksheets/{id}:
    get:
      operationId: getChecksheet
      summary: Get Checksheet
      tags:
      - Checksheet API
      description: 'Disclaimer: Measurement details are not included in checksheet data.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
          example: 0
        description: The Checksheet Number.
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecksheetDto'
        '404':
          description: Resource not found.
      x-source: https://developers.plex.com/api/documentation/checksheet-api/get-checksheet
components:
  schemas:
    AddChecksheetDto:
      type: object
      description: The data structure representing a checksheet.
      properties:
        controlPlanId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Control Plan.

            Required for a non-live checksheet. If there are multiple process control recipes with the same PartId, OperationId, and InspectionMode, you must specify this.'
          example: 00000000-0000-0000-0000-000000000000
        productionWorkcenterId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Workcenter. This usually represents a live checksheet.

            Required for completing a live checksheet. The workcenter must be properly configured and have an operator logged in to Plex. The control plan must be designated as primary and must have an active control plan status ("Available For Use" flag set to true). Additionally, for part control plans, the Inspection Mode Manufacturing flag must be set to true, and the selected part operation must be active and not designated as a sub-operation. For process control recipes, the Inspection Mode Process Check flag must be set to true, the control plan type must have its process flag enabled, and it must belong to a process control recipe family.'
          example: 00000000-0000-0000-0000-000000000000
        jobOperationId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Job Operation.

            In live mode, if sent, should match the setup of the control panel. They can be found at scheduling/{version}/jobs.'
          example: 00000000-0000-0000-0000-000000000000
        partId:
          type: string
          format: uuid
          description: A unique identifier representing the Part.
          example: 00000000-0000-0000-0000-000000000000
        partOperationId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Part Operation.

            In live mode, if sent, should match the setup of the control panel. They can be found at mdm/{version}/part-operations. If ProductionWorkcenterId is specified, it is optional to send the PartId, PartOperationId, JobOperationId, and ControlPlanId. If JobOperationId is specified, it is optional to send the PartId and PartOperationId. Process control recipe validations differ slightly from those of part control plans. For part control plans, you can add the checksheet to either a live or non-live checksheet. For process control recipes, the configuration of the process control recipe family, along with the "Control Panel" group and the "All Process Checksheets Display" setting, determines whether the submitted checksheet is valid. If the recipe family is configured as workcenter-only, the checksheet may be added only in the live-mode to any part associated with the specified ProductionWorkcenterId, provided the operation matches that of the recipe family. If the recipe family is set up with both parts and workcenters, the checksheet can only be added to those specific combinations of parts, workcenters, and operations defined in the recipe family. If the "All Process Checksheets Display" setting is enabled, the restrictions for workcenter-only or part-specific assignments no longer apply. In this case, as long as the ProductionWorkcenterId and Operation are aligned, the checksheet may be added to any part only in live-mode.'
          example: 00000000-0000-0000-0000-000000000000
        operationId:
          type: string
          format: uuid
          description: A unique identifier representing the Operation.
          example: 00000000-0000-0000-0000-000000000000
        inspectionMode:
          type: string
          description: The Inspection Mode.
          example: string
        approvedWorkcenterId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Approved Workcenter for the Part and Operation.

            Relevant only for a non-live checksheet. For a part and operation, these are available in production/{version}/production-definitions/approved-workcenters'
          example: 00000000-0000-0000-0000-000000000000
        containerSerialNos:
          type: array
          description: A list of Container Serial Nos. The serial number sent must belong to the part and operation of the intended control plan line being sent.
          items:
            type: string
        note:
          type: string
          description: The note on the Measurement Group.
          example: string
        inspectorEmployeeId:
          type: string
          format: uuid
          description: 'A unique identifier representing the Inspector Employee.

            Do not specify this if you are providing the ProductionWorkcenterId. For a live checksheet, this field is automatically set to the primary operator logged into the workcenter. If no operator is specified, the inspector defaults to the Plex API user. Employee information is available at mdm/{version}/employees.'
          example: 00000000-0000-0000-0000-000000000000
        measurements:
          type: array
          description: A list of Measurements.
          items:
            type: object
            description: The data structure representing a Measurement.
            properties: {}
        spcChecksheetContainerText:
          type: string
          description: SPC Checksheet Container Text.
          example: string
        spcChecksheetHeatText:
          type: string
          description: SPC Checksheet Heat Text.
          example: string
        spcChecksheetProductionText:
          type: string
          description: SPC Checksheet Production Text.
          example: string
        specificationId:
          type: string
          format: uuid
          description: A unique identifier representing the Specification.
          example: 00000000-0000-0000-0000-000000000000
        value:
          type: number
          format: double
          description: "The Measurement Value.\n  Attribute specifications are qualitative part features that can only result in a count of non-conformances, \n  like the presence of a burrs on a part, leak or no leak etc.\n  You may collect attribute data against a variable spec by specifying the pass / fail condition on the control plan line form, \n  so if a specification can be measured on a continuous scale, then enter it as a variable spec.\n  Measurements for attribute type must specify either a 1 or a 0 signifying a pass or a fail scenario. \n\n\n  Variable specifications are something that is not an attribute specification. \n  It can be measured on a continuous scale, such as height, weight, diameter, temperature, etc.\n  These would be tolerance types such as:\n  Two Sided (10 mm +/- 0.05 mm)\n  One Sided Maximum (10 mm max)\n  Based on which tolerance type you select, the limits will be calculated. For example, for a Two Sided Tolerance, \n  fields for the target and +/- values will be needed.\n\n\n  A specification could have one or more bonus tolerances associated with it.\n  An example for when this is needed: You have a feature size between 10mm to 11mm or 10.5mm +/- .5mm. \n  In addition there is an allowable maximum material condition of .02 or bonus tolerance for straightness.\n  If the feature size was at it's maximum say 11mm, then the bonus tolerance would be .02mm.\n  The way this will be need to be defined in part specification would be as below :\n  - Create a Part Specification for the Feature Size of 10.5mm +/- .5mm.\n  - Create another Part Specification for the Bonus Tolerance. In this example we are using a Tolerance Type "One-Sided Maximum" and added the .02mm.\n  - Specify a Bonus Tolerance and add a Part Specification with the feature size of 10.5mm as the Dependent Specification. \n  - Make the Applied To as "Upper" and the Bonus Side as "Upper".\n  Finally create a Control Plan using these two Part Specifications. When you fillout a checksheet and add a dimenstion for the feature size, \n  the bonus specification will calculate in the target area automatically and you can enter a measurement as long as it meets the allowed target.\n  Note: The setting "Bonus Tolerance When Out of Spec Apply" will also contribute to the upper and lower bonus tolerance.\n  When turned on, bonus tolerance values will be calculated even when the bonus is based on a measurement that is out-of-spec. \n  When off, no bonus is applied from out-of-spec measurements.\n\n\n  Compare value specifications only apply to attribute Specifications. \n  It works in conjunction with the Control Plan line if you turn on the setting "Custom Checksheet Data Collection Type Display". \n  For specifying such compare value functions add the value on the note section of measurements."
          example: 0.1
        values:
          type: array
          description: The Measurement Values.
          items:
            type: number
            format: double
        gageId:
          type: string
          description: The Gage ID for the Measurement Group. Note this will be saved on the checksheet only if the Setting Control_Plans , Gage ID Store is set to true. This field will be required if the corresponding inspection mode requires it.
          example: string
      required:
      - operationId
      - inspectionMode
      - measurements
      - specificationId
      - values
    ChecksheetDto:
      type: object
      description: The checksheet details.
      properties:
        checksheetNumber:
          type: integer
          format: int32
          description: The Checksheet Number.
          example: 0
        inspectionMode:
          type: string
          description: The Inspection Mode.
          example: string
        operationId:
          type: string
          format: uuid
          description: A unique identifier representing the Operation.
          example: 00000000-0000-0000-0000-000000000000
        inspectionDateTime:
          type: string
          format: date-time
          description: The inspection Date and Time.
          example: '2026-10-20T12:03:01Z'
        partId:
          type: string
          format: uuid
          description: A unique identifier representing the Part.
          example: 00000000-0000-0000-0000-000000000000
        partNumber:
          type: string
          description: The Part Number.
          example: string
        partRevision:
          type: string
          description: The Part Revision.
          example: string
        partOperationId:
          type: string
          format: uuid
          description: A unique identifier representing the Part Operation.
          example: 00000000-0000-0000-0000-000000000000
        workcenterId:
          type: string
          format: uuid
          description: A unique identifier representing the Workcenter.
          example: 00000000-0000-0000-0000-000000000000
        jobId:
          type: string
          format: uuid
          description: A unique identifier representing the Job.
          example: 00000000-0000-0000-0000-000000000000
        jobOperationId:
          type: string
          format: uuid
          description: A unique identifier representing the Job Operation.
          example: 00000000-0000-0000-0000-000000000000
        spcChecksheetContainerText:
          type: string
          description: SPC Checksheet Container Text.
          example: string
        spcChecksheetHeatText:
          type: string
          description: SPC Checksheet Heat Text.
          example: string
        spcChecksheetProductionText:
          type: string
          description: SPC Checksheet Production Text.
          example: string
        containerSerialNumbers:
          type: array
          description: The list of containers associated with a Checksheet.
          items:
            type: string
        inspectorEmployeeId:
          type: string
          format: uuid
          description: A unique identifier representing the Inspector Employee.
          example: 00000000-0000-0000-0000-000000000000
        note:
          type: string
          description: The Checksheet Note.
          example: string
        outOfSpecification:
          type: boolean
          description: The Checksheet Out of Specification Flag.
          example: false
    AddChecksheetResponse:
      type: object
      properties:
        checksheetNo:
          type: integer
          format: int32
          description: A unique Checksheet No.
          example: 0
        outOfSpec:
          type: boolean
          description: Designation of whether the checksheet is out of spec or not. This is true if any of the measurements are out of spec.
          example: false
        createdAt:
          type: string
          format: date-time
          description: Created Date and Time of the checksheet.
          example: '2026-10-20T12:03:01Z'
    ValidationResponse:
      type: object
      properties:
        code:
          type: string
          example: string
        message:
          type: string
          example: string
        errors:
          type: array
          items:
            type: object
            properties: {}
  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'