Skip to content

Type Alias: WorkflowRunPageQuery ​

ts
type WorkflowRunPageQuery = object;

GET /workflow-runs filters. Array filters are sent as repeated parameters (a single value is accepted); from/to bound startedAt (inclusive) and are sent as ISO strings. search matches a run id prefix, a correlation id or a subject by external id or name; expand: ['subject'] adds the subject summary of each run.

Properties ​

definitionKey? ​

ts
optional definitionKey?: string;

expand? ​

ts
optional expand?: WorkflowRunExpand[];

from? ​

ts
optional from?: Date | string;

limit? ​

ts
optional limit?: number;

offset? ​

ts
optional offset?: number;

outcome? ​

ts
optional outcome?: 
  | DecisionOutcome
  | DecisionOutcome[];

ts
optional search?: string;

status? ​

ts
optional status?: 
  | WorkflowRunStatus
  | WorkflowRunStatus[];

subjectId? ​

ts
optional subjectId?: string;

to? ​

ts
optional to?: Date | string;

trigger? ​

ts
optional trigger?: RunTrigger | RunTrigger[];

Released under the Apache-2.0 License.