Immutable ID (property)

This page documents an OPTIMADE Property Definition. See for more information.

Definition name: immutable_id

Property name: Immutable ID
Description: The entry's immutable ID (e.g., a UUID).
Type: string



Formats: [JSON] [MD]

JSON definition:

    "$id": "",
    "$schema": "",
    "title": "Immutable ID",
    "x-optimade-type": "string",
    "x-optimade-definition": {
        "label": "immutable_id_core",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "immutable_id"
    "type": [
    "description": "The entry's immutable ID (e.g., a UUID).\n\n**Requirements/Conventions:**\n\n- This is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants.\n- This ID maps to the version-specific record, in case it changes in the future.",
    "examples": [
    "x-optimade-unit": "inapplicable"