Type Alias StopBody

StopBody: StopBodyByInstanceIds | StopBodyByWorkflowItems

Request body for IWorkflowInstancesService.stop.

The union describes the supported two modes to target instances:

Mode 1 (instance GUIDs)
Mode 2 (workflow name + list/item ids)

Remarks

At least one mode must be populated.

Example: (Mode 1 - instance GUIDs)

const { workflow } = tisa;
await workflow.instances.stop({
  instanceIds: ["fca0bf0b-1fbb-4a74-ad32-25f5784e6c9a"]
});

Example: (Mode 2 - workflow name + list/item ids)

const { workflow } = tisa;
await workflow.instances.stop({
  workflow: "ApprovalWorkflow",
  items: [{ listId: "72b67e8c-b1c1-4d41-8eaa-69944b79a28c", itemId: 12 }]
});