Document — MatRecordJSON Reference

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",
    "additionalProperties": false,
    "properties": { … },        "id": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$",
            "minLength": 1,
            "description": "Record-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package."        },
        "file_ref": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "document_type": { … },            "enum": [ … ]                "material_test_report",
                "certified_material_test_report",
                "mill_test_certificate",
                "material_certificate",
                "certificate_of_compliance",
                "inspection_certificate",
                "test_certificate",
                "laboratory_report",
                "mechanical_test_report",
                "impact_test_report",
                "heat_treatment_report",
                "heat_treatment_chart",
                "nde_report",
                "pressure_test_report",
                "dimensional_report",
                "u_bend_report",
                "traceability_record",
                "third_party_inspection_report",
                "supplier_certificate",
                "processor_certificate",
                "review_copy",
                "drawing",
                "other"            ]        },
        "title": { … },            "type": "string",
            "minLength": 1        },
        "document_number": { … },            "type": "string"        },
        "revision": { … },            "type": "string"        },
        "issue_date": { … },            "type": "string",
            "format": "date"        },
        "issuer_party_ref": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "submitter_party_ref": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "page_ranges": { … },            "type": "array",
            "items": { … },                "$ref": "#/$defs/page_range"            },
            "minItems": 1        },
        "certificate_classification": { … },            "$ref": "#/$defs/certificate_classification"        },
        "copy_status": { … },            "enum": [ … ]                "original",
                "certified_true_copy",
                "copy",
                "revised",
                "superseded",
                "electronic_original",
                "unknown"            ]        },
        "language": { … },            "type": "array",
            "items": { … },                "type": "string"            },
            "uniqueItems": true        },
        "subject_material_refs": { … },            "type": "array",
            "items": { … },                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"            },
            "uniqueItems": true        },
        "statement": { … },            "type": "string"        },
        "evidence_refs": { … },            "type": "array",
            "items": { … },                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"            },
            "minItems": 1,
            "uniqueItems": true        },
        "extensions": { … }            "$ref": "#/$defs/extensions"        }    },
    "required": [ … ],        "id",
        "file_ref",
        "document_type",
        "title",
        "issuer_party_ref",
        "page_ranges",
        "evidence_refs"    ],
    "description": "Logical document within a physical file. A package can contain source mill certificates, processor certificates, laboratory reports, and reviewer copies."}

Fields

Field	Type	Status	Meaning
`id`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Required	Record-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package.
`file_ref`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Required	File ref used by this schema object.
`document_type`	enum — "material_test_report", "certified_material_test_report", "mill_test_certificate", "material_certificate", "certificate_of_compliance", "inspection_certificate", …	Required	Document type used by this schema object.
`title`	string	Required	Short human-readable name displayed in documentation and review tools.
`document_number`	string	Optional	Document number used by this schema object.
`revision`	string	Optional	Revision used by this schema object.
`issue_date`	string	Optional	Issue date used by this schema object.
`issuer_party_ref`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Required	Issuer party ref used by this schema object.
`submitter_party_ref`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Optional	Submitter party ref used by this schema object.
`page_ranges`	array — at least 1 item(s)	Required	Page ranges used by this schema object.
`certificate_classification`	Certificate classification	Optional	Certificate classification used by this schema object.
`copy_status`	enum — "original", "certified_true_copy", "copy", "revised", "superseded", "electronic_original", …	Optional	Copy status used by this schema object.
`language`	array	Optional	Language used by this schema object.
`subject_material_refs`	array	Optional	Subject material refs used by this schema object.
`statement`	string	Optional	Statement used by this schema object.
`evidence_refs`	array — at least 1 item(s)	Required	Evidence refs used by this schema object.
`extensions`	Extensions	Optional	Namespaced implementation-specific data outside the profile conformance surface.