Skip to main content
Version: v5.6.1

Asset

Included from Basic tierassets

An asset is a templated estate node under a project or an environment: it pins a template version, owns its properties and settings documents, and is the node changes execute against. Creating one requires the pinned template version to exist, be unarchived, resolved and not disabled; archiving one with active changes refuses. Served by the v2 AssetService (ListAssets, GetAsset, CreateAsset, UpdateAsset, DeleteAsset, ListTemplateVersionHistory); list rows carry the pinned template identity, and the get adds MintModel validity, child assets and the latest background tasks.

Asset​

Asset is the typed asset read shape: the v1 node serializer's asset attributes plus the pinned template identity (the v1 include=template,template_version read, resolved server-side) and the owned-document ids.

FieldTypeMeaning
archivedbooleanWhether the asset is archived. Toggled through UpdateAsset; a no-op toggle, or archiving while changes are active, refuses.
changes_executebooleanMay the caller execute changes under this node (execute on /changes).
codestringThe record's code.
created_bystringUsername of the creating identity.
descriptionstring"" when never set.
idstringThe record's identity.
latest_background_tasksarray of AssetBackgroundTaskThe asset's latest background tasks, newest first (the v1 include=latest_node_background_tasks list read) — populated on ListAssets rows; the asset show carries them on GetAssetResponse instead.
maintenanceNodeMaintenanceBadgeThe active-maintenance badge; unset while the node is open (the v1 maintenance attribute).
namestringDisplay name.
node_pathstringThe asset's node path.
parent_pathstringThe parent node's path (project or environment).
properties_idstringThe asset's owned properties/settings document ids.
settings_idstringThe asset's owned settings document id (the pair of properties_id).
task_activebooleanTrue while a background task (actions generation, concretisation) runs against the asset — the v1 task_active attribute.
template_codestringThe pinned template's code; "" when the pin is unresolvable.
template_idstringThe pinned template's identity; "" when the catalog read model is not composed or the pin is unresolvable.
template_namestringThe pinned template's display name; "" when the pin is unresolvable.
template_versionstringThe pinned template version's label (the pair of template_version_id).
template_version_has_mintmodelbooleanWhether the pinned version holds a MintModel; unset when the pin is unresolvable (the v1 template_version has_mintmodel conditional).
template_version_idstringThe pinned template version's row id and label.
template_version_statestringThe pinned version's state (initializing, ready, broken, …); "" when the pin is unresolvable (the v1 include=template_version list read's row detail).

AssetBackgroundTask​

AssetBackgroundTask is one latest-background-task row of an asset (the v1 node_background_task include's fields the GUI consumes).

FieldTypeMeaning
actions_countintegerHow many actions the task produced.
created_attimestampWhen the record was created.
created_bystringUsername of the creating identity.
error_messagestringThe failure message; "" when none.
idstringThe record's identity.
request_numberintegerThe task's request sequence number on its node.
status_codestringThe task's serialized status code (initialized, running, success, error, …).
task_typestringThe task family, e.g. "GenerateActionsRequest".
template_version_idstringThe template version the task ran against.
updated_attimestampWhen the record was last updated.

AssetFilter​

AssetFilter is the typed assets predicate vocabulary.

FieldTypeMeaning
archivedbooleanKeep only archived (true) or unarchived (false) assets; unset keeps both (the v1 filter[archived_eq] contract).
  • opschain docs resources/template — the template and version the asset pins.
  • opschain docs resources/task — the background-task rows behind latest_background_tasks.
  • opschain docs resources/environment — the usual parent node.
  • opschain docs entitlements — the assets entitlement that gates creating asset nodes.