Requirement

The typed behavior imposed by the rule, such as a limit, test, examination, heat treatment, document field, prohibition, or decision procedure.

$defs.requirement · object

Definition JSON

This fragment is shown exactly as published. Use the chevrons to fold objects and arrays; linked $ref values return to their targets in the complete schema.

{    "type": "object",
    "required": [        "kind"    ],
    "properties": {        "kind": {            "enum": [                "property_limit",
                "composition_limit",
                "computed_limit",
                "required_condition",
                "required_test",
                "required_examination",
                "required_heat_treatment",
                "required_product_form",
                "required_manufacturing_route",
                "required_document",
                "required_report_field",
                "required_traceability",
                "required_marking",
                "prohibited",
                "allowed_only",
                "relationship_constraint",
                "reference_compliance",
                "purchaser_defined",
                "decision_procedure",
                "other",
                "service_limit",
                "required_qualification",
                "required_procedure",
                "sampling_requirement",
                "test_acceptance",
                "required_reporting",
                "figure_lookup",
                "table_lookup",
                "material_compatibility",
                "design_property_restriction"            ]        },
        "property": {            "type": "string"        },
        "operator": {            "enum": [                "eq",
                "ne",
                "gt",
                "gte",
                "lt",
                "lte",
                "between",
                "in",
                "not_in"            ]        },
        "value": {},
        "minimum": {},
        "maximum": {},
        "unit": {            "type": "string"        },
        "values": {            "type": "array"        },
        "text": {            "type": "string"        },
        "document": {            "type": "string"        },
        "fields": {            "type": "array",
            "items": {                "type": "string"            }        },
        "calculation": {            "$ref": "#/$defs/calculation"        },
        "value_from_requisition": {            "type": "string",
            "description": "ID of the purchaser/project value that must be obtained from the material requisition; does not store the project value in the MatReq."        },
        "referenced_standard": {            "$ref": "#/$defs/reference_target"        },
        "method": {            "type": [                "string",
                "object"            ]        },
        "frequency": {            "type": [                "string",
                "object"            ]        },
        "sampling": {            "type": [                "string",
                "object",
                "array"            ]        },
        "acceptance_criteria": {},
        "procedure": {            "type": [                "string",
                "object",
                "array"            ]        },
        "timing": {            "type": [                "string",
                "object"            ]        },
        "location": {            "type": [                "string",
                "object",
                "array"            ]        },
        "scope": {            "type": [                "string",
                "object",
                "array"            ]        },
        "reporting": {            "type": [                "string",
                "object",
                "array"            ]        },
        "specimen": {            "type": [                "string",
                "object",
                "array"            ]        },
        "alternatives": {            "type": "array"        },
        "lookup": {            "type": "object"        },
        "basis": {            "type": [                "string",
                "object"            ]        },
        "subject": {            "type": [                "string",
                "array"            ]        }    },
    "additionalProperties": false}

Fields

FieldTypeStatusMeaning
kindenum — "property_limit", "composition_limit", "computed_limit", "required_condition", "required_test", "required_examination", …RequiredTyped requirement behavior that tells a checker how the remaining requirement fields should be interpreted.
propertystringOptionalNamed material property, document field, condition, or characteristic controlled by the requirement.
operatorenum — "eq", "ne", "gt", "gte", "lt", "lte", …OptionalComparison operator used for the stated value or limit.
valueschemaOptionalSingle required value when the requirement is not a range.
minimumschemaOptionalMinimum required value or lower bound.
maximumschemaOptionalMaximum permitted value or upper bound.
unitstringOptionalUnit for the stated requirement values.
valuesarrayOptionalPermitted, prohibited, or otherwise enumerated values associated with the requirement.
textstringOptionalSource-preserved or human-readable requirement text when full executable structure is not available or when explanation is needed.
documentstringOptionalIdentity and publication metadata for the governing document represented by this MatReq file.
fieldsarrayOptionalFields that must appear in an MTR, CMTR, report, certificate, requisition, or other evidence document.
calculationCalculationOptionalA machine-readable formula, required inputs, units, and result semantics.
value_from_requisitionstringOptionalID of the purchaser/project value that must be obtained from the material requisition; does not store the project value in the MatReq.
referenced_standardReference targetOptionalExternal standard or scoped part with which compliance is required.
methodstring or objectOptionalRequired test, examination, calculation, fabrication, or qualification method.
frequencystring or objectOptionalRequired testing, examination, sampling, or reporting frequency.
samplingstring or object or arrayOptionalPopulation, lot, heat, piece, weld length, location, or sample-selection rules.
acceptance_criteriaschemaOptionalCriteria used to decide whether the test, examination, qualification, or material is acceptable.
procedurestring or object or arrayOptionalRequired procedure or procedural controls.
timingstring or objectOptionalPoint in the manufacturing or fabrication sequence when the requirement must be performed.
locationstring or object or arrayOptionalPhysical or documentary location at which the requirement applies or evidence is taken.
scopestring or object or arrayOptionalExtent of items, surfaces, welds, lots, or records covered by the requirement.
reportingstring or object or arrayOptionalResults, certifications, traceability, or records that must be provided.
specimenstring or object or arrayOptionalTest-specimen preparation, dimensions, orientation, or source location.
alternativesarrayOptionalAlternative methods or acceptance paths permitted by the source.
lookupobjectOptionalTable, figure, curve, chart, or decision aid required to resolve the rule.
basisstring or objectOptionalBasis for the stated limit, selection, calculation, or source decision.
subjectstring or arrayOptionalMaterial, component, weld, document, or evidence item controlled by the rule.