Header 📝
Standard message header attributes present for all PIES message data types. All defined attributes are needed for identification and attribution.
Scope
This data type is intended to define all expected attributes that a message datatype must contain at minimum. This data structure is not intended for standalone use.
Structure
| Name | Cardinality | Type | Description & Constraints |
|---|---|---|---|
| transaction_id | 1..1 | string | A unique UUIDv7 assigned for this specific message. |
| version | 1..1 | string | The PIES specification version this message complies to. Value shall be a valid semantic version formatted string. |
| kind | 1..1 | string | The specific kind of PIES message data type this message represents. |
| system_id | 1..1 | Code | A valid NRIDS IT Service Management code which identifies the source system, service or asset that the data originates from. |
| record_id | 1..1 | string | The record or primary key representing what the data this message is directly associated to. |
| record_kind | 1..1 | string | The kind of record the source system stores this record as (i.e. Permit, Project, Submission or Tracking). |
Specification
- Schema
- Source
- Example
Loading ....
{
"$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/data/header.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Header",
"description": "Represents a set of standardized attributes needed for identification and attribution.",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"description": "A unique UUIDv7 assigned for this specific message.",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"version": {
"type": "string",
"description": "The PIES specification version this message complies to. Value shall be a valid semantic version formatted string.",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"kind": {
"type": "string",
"description": "The specific kind of PIES message data type this message represents.",
"enum": [
"RecordLinkage",
"ProcessEventSet"
]
},
"system_id": {
"type": "string",
"description": "A valid NRIDS IT Service Management code which identifies the source system, service or asset that the data originates from.",
"pattern": "^ITSM-\\d{4,5}$"
},
"record_id": {
"type": "string",
"description": "The record or primary key representing what the data this message is directly associated to."
},
"record_kind": {
"type": "string",
"description": "The kind of record the source system stores this record as (i.e. Permit, Project, Submission or Tracking).",
"enum": [
"Permit",
"Project",
"Submission",
"Tracking"
]
}
},
"required": [
"transaction_id",
"version",
"kind",
"system_id",
"record_id",
"record_kind"
]
}
{
"transaction_id": "01950719-b154-72f5-8437-5572df032a69",
"version": "0.1.0",
"kind": "ProcessEventSet",
"system_id": "ITSM-5917",
"record_id": "06bc53dc-3e4f-420b-801c-bd9cc0ea01b2",
"record_kind": "Permit"
}
Implementation Notes
All header attributes are mandatory. A valid PIES message datagram must define all of the header attributes.