Collection 📝

Official URL: https://bcgov.github.io/nr-pies/docs/spec/element/data/collection

JSON Schema URL: https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/collection.schema.json

Represents a collection. A collection serves as a common construct for describing resource data elements that group other data elements together.

Scope

This data type is intended to only be transmitted as a part of any resource data element focusing on grouping or aggregating other data elements together. A collection is defined as an independent, common composable data type and may be used in other message contexts.

Structure

This structure contains no properties at this time 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/data/collection.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Collection",
  "description": "Represents a collection.",
  "type": "object",
  "properties": {}
}

Example

{}

Implementation Guidance

The Collection data type is an empty object and does not define any properties. Systems parsing collections should ignore any unexpected properties.

References

No references are defined for this data type.