Skip to main content
Version: v5.7.0

Activity

Included from Basic tier

An activity is one row of the merged activity feed — changes and workflow runs read as a single denormalised union (node background tasks join on an explicit opt-in). It is a read-only projection: rows appear and progress as their underlying runs do, and the row's id is the underlying change, workflow run or task id. The feed backs the GUI home screen and the CLI run listings. Served by the v2 ActivityService (ListActivities, plus ListWaitingGates for the caller's own approval queue); it is PostgreSQL-backed and answers unimplemented under the embedded store.

Activity​

Activity is one row of the merged feed: the denormalised columns both arms share, typed.

FieldTypeMeaning
actionstringThe feed's action column; empty when the row has none.
activity_typeActivityTypeWhich arm the row comes from: change, workflow run or node background task (vocabulary below).
commit_shastringThe change's resolved git commit sha; empty on workflow_run and task rows.
created_attimestampWhen the record was created.
created_bystringUsername of the creating identity.
error_messagestringThe task's failure message — a node-background-task field, set only on task rows.
finished_attimestampWhen the run finished; unset while it is still in flight.
git_remote_namestringThe change's git identity; empty on workflow_run and task rows (and on changes carrying none).
git_revstringThe change's requested git revision (branch, tag or sha); empty on workflow_run and task rows.
idstringThe underlying change or workflow run id.
metadata_jsonstringThe row's metadata document as JSON text ("" on task rows).
node_pathstringThe target node's path.
parentsarray of ActivityParentThe target node's parent trail, root first — ACTIVITY_VIEW_WITH_PARENTS only.
pause_statestringpausing while a paused run's active steps are still finishing, paused once fully held, none when the run is not paused.
pausedbooleanWhether the run is currently paused.
paused_by_jsonstringThe pause/resume trail as JSON text ("" on task rows, "[]" when never paused).
project_namestringThe owning project's display name.
request_numberintegerThe task's request number — a node-background-task field, set only on task rows.
scheduledbooleanWhether a scheduled activity spawned the run.
started_attimestampWhen the run started executing; unset while queued.
status_codestringThe run's serialized status code (queued, running, waiting, success, error, cancelled, …).
task_typestringNode-background-task fields; set only on ACTIVITY_TYPE_NODE_BACKGROUND_TASK rows, whose id is the task id (the ReadLogLines/NBT handle).
updated_attimestampWhen the record was last updated.
workflow_codestringThe workflow's code; empty on change rows.
workflow_namestringThe workflow's display name; empty on change rows.
workflow_versionintegerThe workflow version number the run executes; 0 on change and task rows.

ActivityParent​

ActivityParent is one node of a row's parent trail: the v1 parents entry, typed. Template fields are empty when the node is untemplated.

FieldTypeMeaning
codestringThe record's code.
idstringThe record's identity.
kindstring"project" | "environment" | "asset" | …
namestringDisplay name.
node_pathstringThe parent node's canonical path.
template_codestringThe template backing the node; empty when the node is untemplated.
template_namestringThe backing template's display name; empty when untemplated.
template_versionstringThe node's active template version label; empty when untemplated.

ActivityFilter​

ActivityFilter is the typed activity vocabulary. All fields combine with AND (node_scopes internally any-of); empty fields do not restrict.

FieldTypeMeaning
actionstringExact action to keep (the dashboard drill-down contract); a row with no action never matches.
action_presentbooleanKeep only rows whose action is present (drops approval-root changes the way the GUI feed does).
activity_typeActivityTypeRestrict the union to one arm (vocabulary below); unspecified keeps both standing arms.
commit_shastringExact commit sha to keep (the dashboard hot-commits drill-down); excludes every workflow_run row.
created_aftertimestampKeep rows created strictly after this instant.
created_beforetimestampKeep rows created strictly before this instant.
created_byarray of stringCreating usernames to keep — any-of (the GUI user picker).
finished_aftertimestampKeep rows finished strictly after this instant; a row with no finished_at matches no bound.
finished_beforetimestampKeep rows finished strictly before this instant; a row with no finished_at matches no bound.
free_textarray of stringFree-text search terms: a row matches when any term matches any of the feed's searchable fields (id, project, action, creator, git identity, status, metadata), case-insensitively.
git_remote_name_containsstringCase-insensitive substring over the change arm's git identity (the v1 git_remote_name_cont/git_rev_cont ILIKE predicates); either excludes every workflow_run row, whose columns are NULL.
git_rev_containsstringCase-insensitive substring over the change arm's requested git revision (the same contract as git_remote_name_contains); excludes every workflow_run row.
idsarray of stringExact activity ids to keep — any-of (the GUI's uuid lookup and the batched parent-trail hydration).
include_background_tasksbooleanAlso include node background tasks (actions refreshes) in the union — the "show background tasks" opt-in, default off: unset, the feed is exactly the change/workflow_run union of today.
metadata_containsstringCase-insensitive substring over the row's metadata document rendered as text (the v1 metadata_text_cont ransacker).
node_scopesarray of NodeScopeTarget-node scopes, any-of.
pausedbooleanKeep only paused (true) or unpaused (false) rows.
project_codesarray of stringProject codes to keep — any-of.
scheduledbooleanKeep only scheduled (true) or unscheduled (false) rows.
scheduled_activity_idstringThe spawning scheduled activity's id (exact, case-insensitive — the v1 uuid-cast _eq: an unparseable value matches nothing).
started_aftertimestampKeep rows started strictly after this instant; a row with no started_at matches no bound.
started_beforetimestampKeep rows started strictly before this instant; a row with no started_at matches no bound.
status_codesarray of stringSerialized status codes to keep — any-of.
updated_aftertimestampStrict root-step timestamp windows (the v1 _gt/_lt bounds): a row with no such timestamp (SQL NULL) matches no bound.
updated_beforetimestampKeep rows updated strictly before this instant (the same strict-bound semantics as updated_after).
workflow_codestringThe workflow's code (exact; excludes every change row).
workflow_versionsarray of integerWorkflow version numbers to keep — any-of (the v1 version_in set); excludes every change row, whose version is NULL.

ActivityOrder​

ActivityOrder selects the feed's sort column (always descending).

Values: ACTIVITY_ORDER_UNSPECIFIED, ACTIVITY_ORDER_UPDATED_AT, ACTIVITY_ORDER_CREATED_AT.

ActivityOutcome​

ActivityOutcome is the dashboard's outcome rollup vocabulary over the serialized status codes.

Values: ACTIVITY_OUTCOME_UNSPECIFIED, ACTIVITY_OUTCOME_SUCCEEDED, ACTIVITY_OUTCOME_FAILED, ACTIVITY_OUTCOME_CANCELLED, ACTIVITY_OUTCOME_IN_PROGRESS, ACTIVITY_OUTCOME_OTHER.

ActivityType​

ActivityType restricts the union to one arm.

Values: ACTIVITY_TYPE_UNSPECIFIED, ACTIVITY_TYPE_CHANGE, ACTIVITY_TYPE_WORKFLOW_RUN, ACTIVITY_TYPE_NODE_BACKGROUND_TASK.

ActivityView​

ActivityView selects how much of each row ListActivities resolves (named views, never field masks).

Values: ACTIVITY_VIEW_UNSPECIFIED, ACTIVITY_VIEW_BASIC, ACTIVITY_VIEW_WITH_PARENTS.

  • opschain docs resources/change — the change arm's full row.
  • opschain docs resources/workflow_run — the workflow-run arm's full row.
  • opschain docs resources/task — the node-background-task arm's row.
  • opschain docs events — the event stream the pause/resume trail is built from.