Project 📝
Official URL: https://bcgov.github.io/nr-pies/docs/spec/element/resource/project
JSON Schema URL: https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/resource/project.schema.json
A project serves as a grouping of related assets within the PIES system.
Scope
This resource type is transmitted within a Record message by setting asset_kind
to PROJECT. It is designed to describe the properties of the grouping of related assets within the PIES system. This
is typically framed from the perspective of the system that is declaring the asset, and may not reflect the perspective
of other systems.
Refer to Record for details on the message envelope pattern and how resource types are selected.
Structure
This structure contains no properties and is functionally equivalent to an empty object.
A Project extends the following data types and inherits all of their declared attributes:
The table below identifies the inherited data types (in parentheses) and lists the properties declared directly by Project.
| Name | Cardinality | Type | Description & Constraints |
|---|---|---|---|
| (Collection) | 1..1 | Collection | A collection serves as a common construct for describing resource data elements that group other data elements together. |
Specification
- Schema
- Source
- Example
{
"$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/resource/project.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Project",
"description": "A project serves as a grouping of related assets within the PIES system.",
"type": "object",
"properties": {},
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/collection.schema.json"
}
]
}
{}
Implementation Guidance
The Project resource type is an empty object and does not define any properties. Systems parsing projects should ignore any unexpected properties.
References
No references are defined for this resource type.