Get Process Instance

API Type

Web Services


Retrieves information about a specified process instance.


public virtual WFBaseProcessInstance GetProcInst(string processInstanceID)


Name Description


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


WFBaseProcessInstance object that contains basic information about a process instance. It returns null if the process instance ID does not exist.


// This is sample code for console application
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = …// process instance ID

    //Returns an instance of WFBaseProcessInstance type.
    WFBaseProcessInstance processInstance =

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.