SpecificationDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/rockwell-automation/main/json-schema/rockwell-automation-specification-dto-schema.json",
  "title": "SpecificationDto",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rockwell-automation-plex-openapi.yml#/components/schemas/SpecificationDto",
  "type": "object",
  "properties": {
    "aboveUclR": {
      "type": "integer",
      "format": "int32",
      "description": "The subgroup above UCL on the range chart alert."
    },
    "aboveUclX": {
      "type": "integer",
      "format": "int32",
      "description": "The subgroup above UCL on the X chart alert."
    },
    "active": {
      "type": "boolean",
      "description": "The Active Flag for the specification."
    },
    "belowLclR": {
      "type": "integer",
      "format": "int32",
      "description": "The subgroup below LCL on the range chart alert."
    },
    "belowLclX": {
      "type": "integer",
      "format": "int32",
      "description": "The subgroup below LCL on the X chart alert."
    },
    "color": {
      "type": "string",
      "description": "The display color for the specification."
    },
    "createdBy": {
      "type": "integer",
      "format": "int32",
      "description": "The user who created the specification."
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the specification was created."
    },
    "customerSpecified": {
      "type": "boolean",
      "description": "Indicates whether or not the customer expects the part specification to be verified."
    },
    "description": {
      "type": "string",
      "description": "The description of the Part Specification."
    },
    "deviationRestricted": {
      "type": "boolean",
      "description": "The Deviation Restricted flag for the specification."
    },
    "dockAudit": {
      "type": "boolean",
      "description": "The Dock Audit flag for the specification."
    },
    "formula": {
      "type": "string",
      "description": "The specification formula.\nFormulas are used when a spec is calculated based on one or more other specs. For example, if a rectangular part includes specs for length and height, a calculated spec can be implemented to determine square inches:\n[60bdc4fa-67ea-4d25-b95c-06f67225db34] * [7acbf6bb-727b-4714-bf18-8c3f82a45f8c]\nDependent specifications are contained within brackets and referenced by ID.\nWhen entering functions into the formula, make sure you use the proper character for separating the parameters.\nMathematical Expressions\nFunctions\n\nAVG\nMAX\nMIN\nSUM\nSTDEV\nSIN\nCOS\nTAN\nARCSIN\nACOS\nARCCOS\nATAN\nARCTAN\nLN\nLOG\nSQRT\nABS\n\nConstants\n\nPI\nC\nE\n\nOperators\n\n*, +, -, /, ^\n%\nDIV\nMOD\n\nHere is an example formula using a combination of supported functions, constants and operators defined above:\nPi * min([60bdc4fa-67ea-4d25-b95c-06f67225db34], [7acbf6bb-727b-4714-bf18-8c3f82a45f8c])\nParameters to defined functions are separated by a comma, but this delimiter may also be overridden by the Plex setting List Delimiter (Lists Setting Group).\nAggregate Functions\nAggregate functions can be used in the formula to provide functionality across a set of measurements for a single specification. This is achieved by the use of any aggregate function (min, max, avg, sum) in conjunction with a "token parameter" to indicate which specification(s) are being used as aggregates.  The Formula Type assigned to the formula is used to specify One-To-One (the setting by which all existing formula work) or Many-To-One (used when aggregating a measurement set down to a single value).\nFor example, if specification A includes 3 measurements, a calculated specification B can utilize an aggregate formula to calculate a single value:\n| Specification | Measurements | ID | Formula | Formula Type |\n| ----| ---- | ---- | ---- | ---- |\n| A | 10, 20, 30 | 60bdc4fa-67ea-4d25-b95c-06f67225db34 | |\n| B | 20 | 7acbf6bb-727b-4714-bf18-8c3f82a45f8c | avg([60bdc4fa-67ea-4d25-b95c-06f67225db34:aggregate=true) | Many-To-One |\nA formula type of One-To-One is the existing behavior of a formula, but it can be used in conjunction with aggregate functions to allow a single sample measurement to be used to output multiple measurements:\n| Specification | Measurements | ID | Formula | Formula Type |\n| ----| ---- | ---- | ---- | ---- |\n| C | 10, 0, -10 | 7acbf6bb-727b-4714-bf18-8c3f82a45f8c | sum([7acbf6bb-727b-4714-bf18-8c3f82a45f8c:aggregate=true) - [60bdc4fa-67ea-4d25-b95c-06f67225db34] | One-To-One |\nHistorical Data\nSpecial token parameters can be used to pull measurement data from past checksheets. A number of past checksheets to be used must be supplised along with an aggregate function (if applicable). The number of past checksheets that can be used in a calculation is limited to 50.\nFor example, this formula is used to calculate the average value of a given specification for the last 5 submitted checksheets:\navg([60bdc4fa-67ea-4d25-b95c-06f67225db34:pastchecksheets=5 pastfunction=avg])\nIf an aggregate is not necessary, the pastfunction argument can be set to none:\navg([60bdc4fa-67ea-4d25-b95c-06f67225db34:pastchecksheets=5 pastfunction=none])\nNote: it is important to use the "none" aggregation option in formulas where f(x0,...,xn) does not equal f(f(x0,...,xn-1), xn). For example, min(4, 6, 5) is equivalent to min(min(4,6), 5), while stdev(4, 6, 5) is not equivalent to stdev(stdev(4,6), 5).\nOffsheet Historical Data\nHistorical data can also be referenced by using offsheet token parameters. This is used to pull aggregated measurements from data entered on any prior checksheet. The number of past checksheets must be specified as a separate checksheet specification measurement. This number is then referenced in subsequent formulas.\nFor example, to pull the average value of a specification from a specific number of other checksheets, where its specification ID is 7acbf6bb-727b-4714-bf18-8c3f82a45f8c, a new specification should be created referencing this ID (We'll call the specification Sample Size):\n[7acbf6bb-727b-4714-bf18-8c3f82a45f8c:offsheetcalc=samplesize]\nAssuming the ID of the above specification is 60bdc4fa-67ea-4d25-b95c-06f67225db34, we can then create a second specification called 'Average' with the following formula:\n[60bdc4fa-67ea-4d25-b95c-06f67225db34:offsheetcalc=avg]\nThe above specification value will be calculated using the past X number of prior checksheets, where X is equal to the Sample Size specification value.\nRestrictions\n\nThe number of checksheets for the sample size is limited to a maximum of 50.\nThe measurements are Container Serial specific.  This means that if a container is not specified then all checksheet measurements will be used.\nAs Serialized Checksheets are Container specific (per row), the container serial must be set.\n\nAttributes\nAttributes of a specification can be used as part of the formula. The supported attributes are tolerance, target, min, and max. Attribute usage in a formula will appear as follows:\n[60bdc4fa-67ea-4d25-b95c-06f67225db34:attribute=tolerance]"
    },
    "formulaType": {
      "type": "string",
      "description": "The specification formula type."
    },
    "formulaTypeId": {
      "type": "string",
      "format": "uuid",
      "description": "The Specification Formula Type ID."
    },
    "functionRequirementType": {
      "type": "string",
      "description": "The function requirement type of the part specification."
    },
    "gageType": {
      "type": "string",
      "description": "The Gage Type specification."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The Specification ID of the part specification."
    },
    "importance": {
      "type": "string",
      "description": "The importance of the specification."
    },
    "jobSheetInclude": {
      "type": "boolean",
      "description": "Indicates whether or not the specification is included in the job sheet."
    },
    "note": {
      "type": "string",
      "description": "A short description or name for the specification. This typically comes from the drawing."
    },
    "partId": {
      "type": "string",
      "format": "uuid",
      "description": "Specify the Part ID requiring specifications."
    },
    "partNumber": {
      "type": "string",
      "description": "Specify the part number requiring specifications."
    },
    "partRevision": {
      "type": "string",
      "description": "Specify the part revision requiring specifications."
    },
    "plcName": {
      "type": "string",
      "description": "The name of an associated programmable logic controller (PLC)."
    },
    "primaryImageNodeNo": {
      "type": "integer",
      "format": "int32",
      "description": "The primary image node number for the specification."
    },
    "processControlRecipeId": {
      "type": "string",
      "format": "uuid",
      "description": "The Process Control Recipe ID."
    },
    "runAboveMeanR": {
      "type": "integer",
      "format": "int32",
      "description": "Run above centerline on Range chart alert."
    },
    "runAboveMeanX": {
      "type": "integer",
      "format": "int32",
      "description": "Run above centerline on X chart alert."
    },
    "runBelowMeanR": {
      "type": "integer",
      "format": "int32",
      "description": "Run below centerline on Range chart alert."
    },
    "runBelowMeanX": {
      "type": "integer",
      "format": "int32",
      "description": "Run below centerline on X chart alert."
    },
    "runLengthR": {
      "type": "integer",
      "format": "int32",
      "description": "The length of the run on the Range chart."
    },
    "runLengthX": {
      "type": "integer",
      "format": "int32",
      "description": "The length of the run on the X chart."
    },
    "spcFlag": {
      "type": "boolean",
      "description": "The SPC enabled flag for the specification."
    },
    "specialSymbol": {
      "type": "string",
      "description": "The special symbol to use for the part specification."
    },
    "specificationDimensionType": {
      "type": "string",
      "description": "The specification dimension type of the part specification."
    },
    "specificationNumber": {
      "type": "string",
      "description": "The specification number of the part specification."
    },
    "specificationType": {
      "type": "string",
      "description": "The specification type."
    },
    "targetValueDisplay": {
      "type": "boolean",
      "description": "Indicates whether or not the target value is displayed."
    },
    "toleranceType": {
      "$ref": "#/$defs/ToleranceTypeDto"
    },
    "trend": {
      "type": "integer",
      "format": "int32",
      "description": "The Consecutive Trending alert."
    },
    "trendLength": {
      "type": "integer",
      "format": "int32",
      "description": "The trend length for alerts on the specification."
    },
    "updatedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The latest date this specification was updated."
    },
    "valueText": {
      "type": "string",
      "description": "The value text of the specification."
    },
    "workcenter": {
      "type": "string",
      "description": "The workcenter associated with the specification."
    },
    "workcenterId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the workcenter associated with the specification."
    }
  },
  "$defs": {
    "ToleranceTypeDto": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The tolerance type name."
        },
        "attribute": {
          "type": "boolean",
          "description": "The designation of this tolerance type is an attribute specification or not."
        },
        "target": {
          "type": "number",
          "format": "double",
          "description": "The target of the tolerance type."
        },
        "targetPlus": {
          "type": "number",
          "format": "double",
          "description": "The tolerance limit relating to value more than the target."
        },
        "targetMinus": {
          "type": "number",
          "format": "double",
          "description": "The tolerance limit relating to value less than the target."
        },
        "decimalPrecision": {
          "type": "integer",
          "format": "int32",
          "description": "Specify the number of decimal places to apply to measurements."
        },
        "unit": {
          "type": "string",
          "description": "The unit of the tolerance type."
        },
        "oneSidedMinimum": {
          "type": "number",
          "format": "double",
          "description": "The numeric value of the one sided minimum of the specification."
        },
        "oneSidedMaximum": {
          "type": "number",
          "format": "double",
          "description": "The numeric value of the one sided maximum of the specification."
        },
        "measurementText": {
          "type": "string",
          "description": "The supplemental text for the actual measurement displayed on the control plan."
        },
        "compareValue": {
          "type": "string",
          "description": "The text to display on the checksheet when compare value option is selected."
        },
        "referenceDisplayPopup": {
          "type": "boolean",
          "description": "To designate if a pop up message will be displayed when the measurement is out of spec."
        },
        "referencePopupMessage": {
          "type": "string",
          "description": "The informational message field on the checksheet when the measurement is out of spec."
        },
        "bonusTolerances": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {}
          }
        }
      }
    }
  }
}