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

Represents a project. 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

A project shall contain every Collection data property.

This structure contains no properties and is functionally equivalent to an empty object.

Specification

Schema

Loading ....

Source

{
  "$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": "Represents a project.",
  "type": "object",
  "properties": {},
  "allOf": [
    {
      "$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/collection.schema.json"
    }
  ]
}

Example

{}

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.