Package version:

Interface FilterActivity

Filter and return results from input array based on the conditions.

interface FilterActivity {
    condition: Expression;
    dependsOn?: ActivityDependency[];
    description?: string;
    items: Expression;
    name: string;
    onInactiveMarkAs?: string;
    state?: string;
    type: "Filter";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

condition: Expression

Condition to be used for filtering the input.

dependsOn?: ActivityDependency[]

Activity depends on condition.

description?: string

Activity description.

items: Expression

Input array on which filter should be applied.

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.