Skip to main content

Interface: $Properties

Properties of a PauseActivityExecutionRequest.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

The ID of the activity to target.

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity.

reason?​

optional reason?: string | null

Reason to pause the activity.

requestId?​

optional requestId?: string | null

Used to de-dupe pause requests.

resourceId?​

optional resourceId?: string | null

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

runId?​

optional runId?: string | null

Run ID of the workflow or standalone activity. If empty, targets the latest run.

workflowId?​

optional workflowId?: string | null

If provided, pause a workflow activity (or activities) for the given workflow ID. If empty, targets a standalone activity.