Interface StopInstanceResult

Represents the API response returned for a single workflow stop operation.

When stopping by instance IDs (Mode 1), instanceId identifies the stopped instance and listId/itemId are undefined.
When stopping by workflow name + items (Mode 2), listId and itemId identify the item the instance was running on; instanceId is the resolved instance (empty string if no running instance was found).

interface StopInstanceResult {
    error?: BackendError;
    instanceId: string;
    itemId?: number;
    listId?: string;
    status: "Ok" | "Failed";
}

Properties

Detailed error information if the operation failed; otherwise undefined.

instanceId: string

Unique identifier of the stopped workflow instance. Empty string if instance resolution failed in Mode 2.

itemId?: number

Unique identifier of the item (populated in Mode 2).

listId?: string

Unique identifier of the list (populated in Mode 2).

status: "Ok" | "Failed"

The result status of the stop operation.