Operation Name | Description |
Abort | Aborts the workflow process for specified process Id and adds comments as journal entry |
AssignRole | Sets assignment for a workflow process role. Assignee Type should be based on Assignee Type constant. Process Id, Role Id, Assignee Id and Assignee Type should be provided |
CompleteTask | Completes the specified work item. Work Item should be provided. Next Activity Id should be non-zero when next activity is user selected, otherwise zero. To Skip next activity, set SkipNextTask to true, otherwise false |
Continue | Continues the workflow by completing the first assigned work item. It automatically picks the next activity Id. Clearance decision should be provided when available, otherwise empty string |
CreateAdhocActivity | Creates Ad hoc Activity and Task for specified Ad hoc workflow process Id. Process Id, Task Name, Assignee Id, Assignee Type and Due Date should be provided. Assignee Type should be based on the Assignee Type constants. Returns Ad hoc Activity Id |
CreateAdhocProcess | Create Ad hoc workflow process for a folder. Workflow process can be either for folder, for an item or for an attachment. Folder Id should be provided. Reference Id, Reference Name and Reference Type should be provided for item or attachment workflows. Returns ad hoc workflow process Id |
DelegateTask | Delegates the work item to another assignee. Work Item Id, Assignee Id an Assignee Type should be provided. Assignee Type should be based on Assignee Type constants. Returns delegated task Id |
DeleteTask | Deletes task. Work Item Id should be provided |
GetConfiguredWorkflows | Returns the workflows configured for the case type in the office |
GetCurrentActivities | Gets the list of in progress ProcessActivity objects for the specified workflow process Id |
GetCurrentTasks | Gets the list of in progress WorkItem objects for the specified workflow process Id |
GetProcessActivity | Gets the ProcessActivity object for the specified workflow process Id and activity Id. Process Id and Activity Id should be provided. |
GetProcessRoles | Gets the list of dictionary of process role id and role name pairs |
GetTaskById | Gets a WorkItem object for the specified task (work item) Id |
IsLastActivity | Returns true if the specified activity Id is the last activity for the specified workflow process Id, otherwise returns false. Folder should be closed when it is last activity rather than completing the last activity |
Resume | Resumes suspended workflow process adds comments as journal entry |
SetActivityDueDate | Sets the planned due date for the specified activity and workflow process. Workflow process Id and activity Id should be provided. Due date should be set before tasks are created for the activity |
SetActivityDueDays | Sets the due days for the specified activity and workflow process. Workflow process Id and activity Id should be provided. Due days should be set before tasks are created for the activity |
StartWorkflow | Starts the workflow process. Folder Id and Workflow Id should be specified. If it is a item level or attachment level workflow then Reference Id, Reference Name and Reference Type should be specified, otherwise they should be set to empty strings. Reference Id should file GUID or record Id of item, Reference Name should be display name along with task name |
Suspend | Suspends the workflow process and adds comments as journal entry |
UpdateRoleAssignments | Updates the workflow process role assignments based on dynamic fields and assignment rules configuration for the specified workflow process Id |
Workflow Operation Procedures
- Published on Jan 29, 2026
- 2 minute(s) read
Was this article helpful?