Tasks

Get Stub

Retrieves data for a specific stub. Useful for cross-stub lookups, reporting, related-process automation, and integration payloads.

# Basic Usage

Task to retrieve the data of a specific stub.

# Parameters

# fieldname

optional

string

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

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

# query

required

string | object

A MongoDB-formatted query, as a JSON string or an object, used to find a specific stub: {"stubref": "1970-01-01-XXXX-1234"}

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

If more than one stub matches, only the first is returned.

# 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: my_first_stub

# stub

The stub data object retrieved. The projection parameter determines which fields are included in the results.