Project

EntityDraftv1.0.0-rc.2

A project: a piece of work on one or more features, with its activities and groups. It refers to its features by id; the features themselves live in context.

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

Fields

Every entity also has the fields of the Entity base. The first row lists them.

From the Entity baseidnamedescriptionidentifierslinkscreatedAtupdatedAt
  • idRequired
    textnot empty

    The record's id: unique within the document. Fields that point at the record hold this id.

  • name
    text

    The name people use for the record.

  • description
    text

    What the record is, in words.

  • identifiers
    List ofDatatypeIdentifier

    Ids the record has in other systems.

  • links
    List ofDatatypeLink

    Open-ended links to other records.

  • createdAt
    date-time (RFC 3339)

    When the record was created, in its producer's system.

  • updatedAt
    date-time (RFC 3339)

    When the record last changed, in its producer's system.

Links

Holds Parts this record embeds, with the field that holds each.

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.

Examples

An id that another example defines opens that record.

Full example

{
  "id": "project-0412",
  "name": "Wellsite 04-12 compressor",
  "features": [
    "feature-wellsite",
    "feature-dwelling"
  ],
  "activities": [
    {
      "id": "activity-operation",
      "name": "Operation",
      "type": "operation"
    }
  ]
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "project-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/Project.json",
  "title": "Project",
  "description": "A project: a piece of work on one or more features, with its activities and groups. It refers to its features by id; the features themselves live in context.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "features": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Feature"
      },
      "description": "The features the project covers: its sites, the receptors it is assessed against and other features in its scope."
    },
    "activities": {
      "type": "array",
      "items": {
        "$ref": "Activity.json"
      },
      "description": "The activities the project defines, each once."
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "Group.json"
      },
      "description": "Features the project evaluates together."
    },
    "location": {
      "$ref": "Location.json",
      "description": "Where the record is, as one point."
    },
    "geometry": {
      "$ref": "Geometry.json",
      "description": "The project's area."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "project-1"
    },
    {
      "id": "project-0412",
      "name": "Wellsite 04-12 compressor",
      "features": [
        "feature-wellsite",
        "feature-dwelling"
      ],
      "activities": [
        {
          "id": "activity-operation",
          "name": "Operation",
          "type": "operation"
        }
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}