TreeINFO-For-M365 documentation
    Preparing search index...

    Class Instances

    Service for managing workflow instances.

    Implements

    • IWorkflowInstancesService
    Index

    Methods

    additionalApproval askQuestion start stop

    Methods

    • Starts instances of a workflow on specified items.

      Parameters

      Returns Promise<BackendResponse<StartInstanceResult[]>>

      const { workflow } = tisa;
      const workflow = "AssignTask_ParallelAllEqualTo";
      const itemIds = [
        { listId: "72b67e8c-b1c1-4d41-8eaa-69944b79a28c", itemId: 12 },
        { listId: "cff6a91b-7c58-474d-9623-8946f4eb5a47", itemId: 27 }
      ];
      await workflow.instances.start({ workflow, itemIds });

    • Stops specified instances. Supports two modes (can be combined in one request):

      • Mode 1: stop by instance IDs (instanceIds)
      • Mode 2: stop by workflow name + items (workflow + items)

      Parameters

      Returns Promise<BackendResponse<StopInstanceResult[]>>

      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 }]
      });

    Settings

    Member Visibility

    On This Page

    Methods