Tasks

Get Stubpost

Retrieves a single stubpost by its UUID, or by its reference within a stub. Useful for looking up what was posted on an earlier action, auditing, and reusing posted data in later steps.

# Basic Usage

Task to retrieve stubpost 4GZ0 on the current stub and save it to stub data.

Task to retrieve a stubpost by its UUID, only returning it in the task result.

# Parameters

Either stubpostuuid or stubpostref is required.

# stubpostuuid

optional

string

The UUID of the stubpost to retrieve. Required if stubpostref is not given.

# stubpostref

optional

string

The reference of the stubpost to retrieve: 4GZ0

Stubpost references are only unique within a stub, so a stubpostref is always looked up on a single stub, set by stubref.

# stubref

optional

string

The stub the stubpost belongs to.

Default: ~~stub.stubref (when only stubpostref is given; a stubpostuuid is not limited to one stub)

# fieldname

optional

string

The name of the field in the stub data to save the stubpost to: previous_post

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

# projection

optional

string | object

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

Default: All fields except tasks, task_stages, notifications, metadata, stubbucks, stomp and action_stage_timestamps

# Notes

• Only stubposts in the stub's own org can be retrieved.
• This task cannot run on a dashboard enabled action.

# Result

# Properties

# fieldname

The fieldname parameter given, if any: previous_post

# stubpost

The stubpost retrieved. The projection parameter determines which fields are included in the result.