Interface StartInstanceResult

Represents the API response returned after initiating a workflow instance.

interface StartInstanceResult {
    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 workflow instance.

itemId: number

Unique identifier of the specific item associated with the workflow.

listId: string

Unique identifier of the list where the workflow was started.

status: "Ok" | "Failed"

The result status of the start operation (e.g., "Ok", "Failed").