Skip to main content

WorkflowManagerAPI

The WorkflowManagerAPI class provides methods for managing workflows within the system, including creating, starting, and continuing workflows, as well as retrieving user approvals and process requests.

Methods

NameDescription
GetUserFlowApprovals(projectName, flowName, loadOptions, telemetryCollectorHolder)Retrieves user flow approvals for the specified project and flow.
GetWaitingProcessRequests(processId, telemetryCollectorHolder)Retrieves the waiting process requests for the specified process.
Create(initialOptions, telemetryCollectorHolder)Creates a new workflow instance with the specified initial options.
Create(projectName, flowName, processId, requestId, telemetryCollectorHolder)The Create method is used to provide access to an instance of a specific flow.
StartWorkflow(projectName, flowName, eventId, documentName, documentValues, documentOptions, telemetryCollectorHolder)Creates a workflow instance and if an event is specified, continues its execution based on that event.
GetDocumentProcessId(documentId, telemetryCollectorHolder)Retrieves the process ID for the specified document.
DeleteProcess(processId, telemetryCollectorHolder)Deletes the specified process.
GetUserApprovals(projectName, loadOptions, telemetryCollectorHolder)Retrieves user approvals for the specified project.
Create(projectName, flowName, documentOptions, processId, requestId, telemetryCollectorHolder)The Create method is used to provide access to an instance of a specific flow.
GetUserApprovalCounts(telemetryCollectorHolder)Retrieves the count of user approvals.
StartWorkflow(projectName, flowName, eventId, telemetryCollectorHolder)Starts a workflow with the specified project and flow names.
HasWaitingApprovalRequestForUser(processId, userId, telemetryCollectorHolder)Checks if there is a waiting approval request for the specified user and process.
StartWorkflow(projectName, flowName, documentOptions, eventId, telemetryCollectorHolder)Creates a workflow instance and if an event is specified, continues its execution based on that event.
ContinueWorkflow(projectName, flowName, processId, eventId, telemetryCollectorHolder)Continues a workflow with the specified project and flow names.
ContinueWorkflow(projectName, flowName, processId, eventId, documentName, documentValues, telemetryCollectorHolder)Continues a workflow with the specified project and flow names, updating document values.
StartWorkflow(projectName, flowName, eventId, documentName, documentValues, telemetryCollectorHolder)Creates a workflow instance and if an event is specified, continues its execution based on that event.
GetCurrentProcessRequest(documentId, userId, telemetryCollectorHolder)Retrieves the current process request for the specified document and user.