httk property definitionsProperty definitions using the OPTIMADE property definition format, hosted by httk
This page documents an OPTIMADE Entrytype Definition. See https://schemas.optimade.org/ for more information.
ID: https://schemas.httk.org/defs/v0.1/entrytypes/runs
Definition name: runs
Entrytype name: httk runs entry type
Description: A runs entry represents one specific, individual execution of a workflow or process that consumed and/or produced other entries.
Provenance edges (inputs, artifacts, outputs) are expressed as relationships, not properties.
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.Workflow declaration URI (workflow_declaration_uri) (property) - https://schemas.httk.org/defs/v0.1/properties/core/workflow_declaration_uri
A URI identifying the workflow declaration (the reusable process definition, as opposed to a specific execution) behind a runs entry.
No particular URI scheme, resolvability, or formalism is mandated.
Providers wanting two runs recognized as executions of the same declaration MUST use an identical URI.
Null is expected for ad-hoc scripts, interactive executions, and legacy data with no formal workflow identifier.
Requirements/Conventions:
null.Workflow definition URI (workflow_definition_uri) (property) - https://schemas.httk.org/defs/v0.1/properties/core/workflow_definition_uri
A URI identifying the workflow definition (the code that ran) behind a runs entry, as opposed to the workflow declaration identified by workflow_declaration_uri.
A typical value is a git URI pinned to a full commit hash, of the form git+https://host/path@<commit>#<subdir>.
No particular URI scheme or resolvability is mandated, but providers SHOULD use a URI that pins the exact code revision.
Null is expected when the executed code is unknown, e.g., for legacy data.
Requirements/Conventions:
null.source ID (source_id) (property) - https://schemas.httk.org/defs/v0.1/properties/core/source_id
The run's identifier in the system that executed it. For httk-workflow jobs, this is the workspace and job identity in the form
Requirements/Conventions:
null.name (property) - https://schemas.httk.org/defs/v0.1/properties/core/name
A human-readable name of the run. For httk-workflow jobs this is the job's name when one was given, otherwise its job key.
Requirements/Conventions:
null.run start time (started_at) (property) - https://schemas.httk.org/defs/v0.1/properties/core/started_at
When the run started: for httk-workflow jobs, the start of the first attempt of the job, as a timezone-aware timestamp.
Requirements/Conventions:
null.run finish time (finished_at) (property) - https://schemas.httk.org/defs/v0.1/properties/core/finished_at
When the run finished: for httk-workflow jobs, the end of the last attempt of the job, as a timezone-aware timestamp.
Requirements/Conventions:
null.JSON definition:
{
"$id": "https://schemas.httk.org/defs/v0.1/entrytypes/runs",
"$schema": "https://schemas.optimade.org/meta/v1.2/optimade/entrytype_definition.json",
"type": "object",
"title": "httk runs entry type",
"x-optimade-definition": {
"kind": "entrytype",
"format": "1.3",
"version": "0.1.0",
"name": "runs",
"label": "runs_entrytype_httk"
},
"description": "A runs entry represents one specific, individual execution of a workflow or process that consumed and/or produced other entries.\nProvenance edges (inputs, artifacts, outputs) are expressed as relationships, not properties.",
"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"
},
"workflow_declaration_uri": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/workflow_declaration_uri",
"x-optimade-requirements": {
"support": "must",
"sortable": false,
"query-support": "partial",
"query-support-operators": [
"=",
"!="
],
"response-level": "must"
},
"title": "Workflow declaration URI",
"x-optimade-type": "string",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "workflow_declaration_uri",
"label": "workflow_declaration_uri_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
],
"description": "A URI identifying the workflow declaration (the reusable process definition, as opposed to a specific execution) behind a runs entry.\nNo particular URI scheme, resolvability, or formalism is mandated.\nProviders wanting two runs recognized as executions of the same declaration MUST use an identical URI.\nNull is expected for ad-hoc scripts, interactive executions, and legacy data with no formal workflow identifier.",
"examples": [
"https://github.com/httk-workflows/vasp-relax/releases/tag/v1.0.0",
"https://schemas.httk.org/workflows/vasp-relax/v1.0"
]
},
"workflow_definition_uri": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/workflow_definition_uri",
"x-optimade-requirements": {
"support": "must",
"sortable": false,
"query-support": "partial",
"query-support-operators": [
"=",
"!="
],
"response-level": "must"
},
"title": "Workflow definition URI",
"x-optimade-type": "string",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "workflow_definition_uri",
"label": "workflow_definition_uri_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
],
"description": "A URI identifying the workflow definition (the code that ran) behind a runs entry, as opposed to the workflow declaration identified by `workflow_declaration_uri`.\nA typical value is a git URI pinned to a full commit hash, of the form `git+https://host/path@<commit>#<subdir>`.\nNo particular URI scheme or resolvability is mandated, but providers SHOULD use a URI that pins the exact code revision.\nNull is expected when the executed code is unknown, e.g., for legacy data.",
"examples": [
"git+https://github.com/httk/workflows-vasp@458aacb2493586faa2c9ac033334457569aeaf75#vasp-relax"
]
},
"source_id": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/source_id",
"x-optimade-requirements": {
"support": "may",
"sortable": true,
"query-support": "all mandatory",
"response-level": "may"
},
"title": "source ID",
"x-optimade-type": "string",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "source_id",
"label": "source_id_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
],
"description": "The run's identifier in the system that executed it. For httk-workflow jobs, this is the workspace and job identity in the form <workspace_id>:<job_id>. This property participates in httk content identity so re-collecting the same job deduplicates while distinct jobs remain distinct."
},
"name": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/name",
"description": "A human-readable name of the run. For httk-workflow jobs this is the job's name when one was given, otherwise its job key.",
"x-optimade-requirements": {
"support": "may",
"sortable": true,
"query-support": "all mandatory",
"response-level": "may"
},
"title": "name",
"x-optimade-type": "string",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "name",
"label": "name_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
]
},
"started_at": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/started_at",
"x-optimade-requirements": {
"support": "may",
"sortable": true,
"query-support": "all mandatory",
"response-level": "may"
},
"title": "run start time",
"x-optimade-type": "timestamp",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "started_at",
"label": "started_at_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the run started: for httk-workflow jobs, the start of the first attempt of the job, as a timezone-aware timestamp.",
"examples": [
"2007-04-05T14:30:20Z"
]
},
"finished_at": {
"$id": "https://schemas.httk.org/defs/v0.1/properties/core/finished_at",
"x-optimade-requirements": {
"support": "may",
"sortable": true,
"query-support": "all mandatory",
"response-level": "may"
},
"title": "run finish time",
"x-optimade-type": "timestamp",
"x-optimade-definition": {
"kind": "property",
"version": "0.1.0",
"format": "1.3",
"name": "finished_at",
"label": "finished_at_property_httk"
},
"x-optimade-unit": "inapplicable",
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the run finished: for httk-workflow jobs, the end of the last attempt of the job, as a timezone-aware timestamp.",
"examples": [
"2007-04-05T14:30:20Z"
]
}
}
}