Asset 📝
Official URL: https://bcgov.github.io/nr-pies/docs/spec/element/data/asset
JSON Schema URL: https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/asset.schema.json
Standard message asset 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 required to identify and attribute a message, at minimum. This data structure is not intended for standalone use.
Structure
| Name | Cardinality | Type | Description & Constraints |
|---|---|---|---|
| asset_id | 1..1 | string | The asset or primary key representing what the data this message is directly associated to. |
| asset_kind | 1..1 | Code | A valid Asset Kind code that specifies the precise type of asset contained in this message. |
| system_id | 1..1 | string | A valid CSNR IT Service Management code identifying the originating source system, service, or asset. |
Specification
- Schema
- Source
- Example
Loading ....
{
"$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/asset.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Asset",
"description": "Represents a set of standardized attributes needed for identification and attribution.",
"type": "object",
"properties": {
"asset_id": {
"type": "string",
"description": "The asset or primary key representing what the data this message is directly associated to."
},
"asset_kind": {
"type": "string",
"description": "A valid Asset Kind code that specifies the precise type of asset contained in this message.",
"enum": [
"ANCHOR",
"PERMIT",
"PROJECT"
]
},
"system_id": {
"type": "string",
"description": "A valid CSNR IT Service Management code identifying the originating source system, service, or asset.",
"pattern": "^ITSM-\\d{4,5}$"
}
},
"required": [
"asset_id",
"asset_kind",
"system_id"
]
}
{
"system_id": "ITSM-5917",
"asset_id": "06bc53dc-3e4f-420b-801c-bd9cc0ea01b2",
"asset_kind": "PERMIT"
}
Implementation Guidance
All asset attributes are mandatory. A valid PIES message datagram must define all of the asset attributes.