Entity

BaseDraftv1.0.0-rc.2

The fields every ODS entity has. An entity schema extends it with $ref and closes itself; Entity is never used on its own.

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

Fields

  • 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

No other schema holds this one or points at it.

Examples

An id that another example defines opens that record.

Example 1

{
  "id": "feature-wellsite-1",
  "name": "Wellsite 04-12",
  "identifiers": [
    {
      "scheme": "ca.ab.aer_licence",
      "value": "0512345"
    }
  ],
  "createdAt": "2026-07-01T16:00:00Z"
}

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/Entity.json",
  "title": "Entity",
  "description": "The fields every ODS entity has. An entity schema extends it with `$ref` and closes itself; Entity is never used on its own.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The record's id: unique within the document. Fields that point at the record hold this id."
    },
    "name": {
      "type": "string",
      "description": "The name people use for the record."
    },
    "description": {
      "type": "string",
      "description": "What the record is, in words."
    },
    "identifiers": {
      "type": "array",
      "items": {
        "$ref": "Identifier.json"
      },
      "description": "Ids the record has in other systems."
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "Link.json"
      },
      "description": "Open-ended links to other records."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the record was created, in its producer's system."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the record last changed, in its producer's system."
    }
  },
  "required": [
    "id"
  ],
  "examples": [
    {
      "id": "feature-wellsite-1",
      "name": "Wellsite 04-12",
      "identifiers": [
        {
          "scheme": "ca.ab.aer_licence",
          "value": "0512345"
        }
      ],
      "createdAt": "2026-07-01T16:00:00Z"
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "base",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}