Tasks

Get Stubs

Retrieves multiple matching stubs. Useful for reporting, bulk workflows, dashboards, and cross-process data aggregation.

# Basic Usage

Task to find all stubs with "VIP" in the subject.

# Parameters

# fieldname

optional

string

The name of the field in the stub data to save the result data to: VIP_stubs

Leave it out, or set it to false, to only return the stubs in the task result without saving them to the stub.

# query

required

string | object

A MongoDB-formatted query, as a JSON string or an object, used to find all matching stubs: {"subject": {"$regex": "vip", "$options": "i"}}

Use a JSON string when the query uses $ operators, such as $regex or $in, so they are kept intact.

# projection

optional

string | object

A MongoDB-formatted projection, as a JSON string or an object, used to specify which stub fields to return.

Default: {"stubref": 1, "subject": 1}

# Result

# Properties

# fieldname

The fieldname parameter given, if any: VIP_stubs

# stubs

An array of stub data objects retrieved for all matching stubs. The projection parameter determines which fields are included in the results.