ArchAstro. V1. AutomationRuns
(archastro v0.2.0)
Copy Markdown
AutomationRun API resource.
Summary
Functions
@spec get(ArchAstro.Client.t(), String.t()) :: {:ok, ArchAstro.Types.AutomationRun.t()} | {:error, ArchAstro.Error.reason()}
Retrieve an automation run
Returns a single automation run by ID.
Public v1 path: GET /api/v1/automation_runs/:automation_run.
Developer app-scoped path (legacy shape, same module):
GET /protected/api/v1/developer/apps/:app/automations/runs/:automation_run.
Any automation type is accepted (trigger, scheduled, or invoked).
Resolution is viewer-scoped (AppScope + OrgScope): a run the caller cannot
see returns 404.
The requested automation run.
journal(client, automation_run, params \\ %ArchAstro.Types.Operations.GetApiV1AutomationRunsAutomationRunJournal.Params{})
@spec journal( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.GetApiV1AutomationRunsAutomationRunJournal.Params.t() ) :: {:ok, ArchAstro.Types.RunJournalPage.t()} | {:error, ArchAstro.Error.reason()}
List an automation run journal
Returns durable workflow journal entries for an automation run.
Public v1 path: GET /api/v1/automation_runs/:automation_run/journal.
Developer app-scoped path (legacy shape, same module):
GET /protected/api/v1/developer/apps/:app/automations/runs/:automation_run/journal.
Any automation type is accepted. Resolution is viewer-scoped
(AppScope + OrgScope). An authorized run without a journal returns
journal: null and an empty data array with HTTP 200.
Forward-paginated automation run journal entries.
@spec stream(ArchAstro.Client.t(), String.t()) :: ArchAstro.SSE.Stream.t( ArchAstro.Types.Operations.GetApiV1AutomationRunsAutomationRunStream.StreamEvent.t() )
Stream automation run status
Opens a Server-Sent Events connection that emits a run_update event whenever
the invoked automation run's status changes, replaying the current status on
connect and closing on a terminal status (completed, failed, cancelled)
or after the max stream duration.
Server-Sent Events stream