This page documents an OPTIMADE Entrytype Definition. See https://schemas.optimade.org/ for more information.
ID: https://schemas.httk.org/defs/v0.1/entrytypes/records
Definition name: records
Entrytype name: httk records entry type
Description: A records entry carries the value of one formally declared property (a computed or measured quantity) as its own entry, so that multiple parallel determinations of the same quantity for the same system can coexist as separate entries linked via provenance relationships.
The value properties served on this entry type are declared per provider through property definitions and are not enumerated here.
This entrytype defines the following properties:
ID (property) - https://schemas.optimade.org/defs/v1.2/properties/core/id
A unique string referencing a specific entry in the database.
Requirements/Conventions:
null.type (property) - https://schemas.optimade.org/defs/v1.2/properties/core/type
The name of the type of an entry.
Requirements/Conventions:
null.immutable ID (immutable_id) (property) - https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id
The entry's immutable ID (e.g., a UUID).
Requirements/Conventions:
null.last modified (last_modified) (property) - https://schemas.optimade.org/defs/v1.2/properties/core/last_modified
Date and time representing when the entry was last modified.
Requirements/Conventions:
null.JSON definition:
{
"$id": "https://schemas.httk.org/defs/v0.1/entrytypes/records",
"$schema": "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition.json",
"type": "object",
"title": "httk records entry type",
"x-optimade-definition": {
"kind": "entrytype",
"format": "1.3",
"version": "0.1.0",
"name": "records",
"label": "records_entrytype_httk"
},
"description": "A records entry carries the value of one formally declared property (a computed or measured quantity) as its own entry, so that multiple parallel determinations of the same quantity for the same system can coexist as separate entries linked via provenance relationships.\nThe value properties served on this entry type are declared per provider through property definitions and are not enumerated here.",
"properties": {
"id": {
"$id": "https://schemas.optimade.org/defs/v1.2/properties/core/id",
"x-optimade-requirements": {
"support": "must",
"sortable": true,
"query-support": "all mandatory",
"response-level": "always"
},
"title": "ID",
"x-optimade-type": "string",
"x-optimade-definition": {
"label": "id_core",
"kind": "property",
"version": "1.2.0",
"format": "1.2",
"name": "id"
},
"type": [
"string"
],
"description": "A unique string referencing a specific entry in the database.\n\n**Requirements/Conventions:**\n\n- Taken together, the ID and entry type MUST uniquely identify the entry.\n- Reasonably short IDs are encouraged and SHOULD NOT be longer than 255 characters.\n- IDs MAY change over time.",
"examples": [
"db/1234567",
"cod/2000000",
"cod/2000000@1234567",
"nomad/L1234567890",
"42"
],
"x-optimade-unit": "inapplicable"
},
"type": {
"$id": "https://schemas.optimade.org/defs/v1.2/properties/core/type",
"x-optimade-requirements": {
"support": "must",
"sortable": true,
"query-support": "all mandatory",
"response-level": "always"
},
"title": "type",
"x-optimade-type": "string",
"x-optimade-definition": {
"label": "type_core",
"kind": "property",
"version": "1.2.0",
"format": "1.2",
"name": "type"
},
"type": [
"string"
],
"description": "The name of the type of an entry.\n\n**Requirements/Conventions:**\n\n- MUST be an existing entry type.\n- The entry of type <type> and ID <id> MUST be returned in response to a request for /<type>/<id> under the versioned or unversioned base URL serving the API.",
"examples": [
"structures"
],
"x-optimade-unit": "inapplicable"
},
"immutable_id": {
"$id": "https://schemas.optimade.org/defs/v1.2/properties/core/immutable_id",
"x-optimade-requirements": {
"support": "may",
"sortable": false,
"query-support": "all mandatory",
"response-level": "may"
},
"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": [
"string",
"null"
],
"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": [
"8bd3e750-b477-41a0-9b11-3a799f21b44f",
"fjeiwoj,54;@=%<>#32"
],
"x-optimade-unit": "inapplicable"
},
"last_modified": {
"$id": "https://schemas.optimade.org/defs/v1.2/properties/core/last_modified",
"x-optimade-requirements": {
"support": "should",
"sortable": false,
"query-support": "all mandatory",
"response-level": "must"
},
"title": "last modified",
"x-optimade-type": "timestamp",
"x-optimade-definition": {
"label": "last_modified_core",
"kind": "property",
"version": "1.2.0",
"format": "1.2",
"name": "last_modified"
},
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date and time representing when the entry was last modified.",
"examples": [
"2007-04-05T14:30:20Z"
],
"x-optimade-unit": "inapplicable"
}
}
}