Group

PartDraftv1.0.0-rc.2

A group: features that a project evaluates together as one unit, such as wellsites close to each other. A group has no sources of its own: its members carry them.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Group.json

Fields

  • id
    textnot empty

    The record's id: unique within the document.

  • name
    text

    The name people use for the record.

  • description
    text

    What the record is, in words.

  • type
    One ofthe codes below

    Who made the group.

    saved
    A stakeholder made and named the group.
    derived
    The evaluation made the group, by the rule in `basis`.
  • basis
    text

    Why the features are grouped, such as their distance from each other.

  • membersRequired
    List ofId ofFeature

    The features in the group.

  • location
    DatatypeLocation

    Where the record is, as one point.

  • geometry
    DatatypeGeometry

    The area the members cover.

Links

Points at Records whose ids this record holds, with the field that holds each.

Held by Records that embed this one, with their field that holds it.

Pointed at by Records that hold this one's id, with their field that holds it.

Examples

An id that another example defines opens that record.

Example 2

{
  "id": "group-1",
  "name": "Pad 04-12",
  "type": "derived",
  "basis": "Within 1.5 km of each other",
  "members": [
    "feature-wellsite",
    "feature-wellsite-2"
  ]
}
Show 1 more example

Example 1

Changes and file

Changes

  1. 0.1.0 First version.

Schema file

Show the JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Group.json",
  "title": "Group",
  "description": "A group: features that a project evaluates together as one unit, such as wellsites close to each other. A group has no sources of its own: its members carry them.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The record's id: unique within the document."
    },
    "name": {
      "type": "string",
      "description": "The name people use for the record."
    },
    "description": {
      "type": "string",
      "description": "What the record is, in words."
    },
    "type": {
      "type": "string",
      "enum": [
        "saved",
        "derived"
      ],
      "description": "Who made the group.",
      "x-ods-options": [
        {
          "value": "saved",
          "title": "Saved",
          "description": "A stakeholder made and named the group."
        },
        {
          "value": "derived",
          "title": "Derived",
          "description": "The evaluation made the group, by the rule in `basis`."
        }
      ]
    },
    "basis": {
      "type": "string",
      "description": "Why the features are grouped, such as their distance from each other."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Feature"
      },
      "description": "The features in the group."
    },
    "location": {
      "$ref": "Location.json",
      "description": "Where the record is, as one point."
    },
    "geometry": {
      "$ref": "Geometry.json",
      "description": "The area the members cover."
    }
  },
  "required": [
    "members"
  ],
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "members": [
        "feature-wellsite",
        "feature-wellsite-2"
      ]
    },
    {
      "id": "group-1",
      "name": "Pad 04-12",
      "type": "derived",
      "basis": "Within 1.5 km of each other",
      "members": [
        "feature-wellsite",
        "feature-wellsite-2"
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "part",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}