Package version:

Interface ForEachActivity

This activity is used for iterating over a collection and execute given activities.

interface ForEachActivity {
    activities: ActivityUnion[];
    batchCount?: number;
    dependsOn?: ActivityDependency[];
    description?: string;
    isSequential?: boolean;
    items: Expression;
    name: string;
    onInactiveMarkAs?: string;
    state?: string;
    type: "ForEach";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

activities: ActivityUnion[]

List of activities to execute .

batchCount?: number

Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).

dependsOn?: ActivityDependency[]

Activity depends on condition.

description?: string

Activity description.

isSequential?: boolean

Should the loop be executed in sequence or in parallel (max 50)

items: Expression

Collection to iterate.

name: string

Activity name.

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

type

Polymorphic discriminator, which specifies the different types this object can be

userProperties?: UserProperty[]

Activity user properties.