Suspend Process Instance

API Type

Web Services


Suspends a process instance with the specified process instance ID.

Good to Know

  • The process instance status is changed to Suspended, and the statuses of all the work items (tasks) become Pending.
  • To call this method, the API account user must have the access right, Suspend and Resume a Process.
  • Only running process instances can be suspended.
  • If there is a parent-child hierarchy, and the parent process instance is suspended, the running child process instances are suspended automatically.


public virtual WFEvent SuspendProcInst(string processInstanceID)


Name Description


Specifies the unique ID of a process instance.
Accepted Values:
A valid process instance ID


WFEvent object that provides the status of the transaction. The possible statuses are:

  • Sent - Indicates event has been sent to engine for processing.
  • Failed - Indicates event failed to process.
  • Processed - Indicates event has been processed successfully.
  • Canceled - Indicates event was canceled.
  • Deferred - Indicates event does not need to be sent immediately.


// This is console application sample
IWFWorkflowService svc = GetWorkflowService();

    string processInstanceID = …// process instance to be suspended.
    WFEvent event = svc.SuspendProcInst(processInstanceID);

catch (Exception ex)
    Console.WriteLine("Failed: " + ShUtil.GetSoapMessage(ex));

Supported Versions and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.