CRMProcessController.RetrieveProcessInstance Method
The RetrieveProcessInstance method retrieves a workflow process instance.
Syntax
[Visual Basic .NET]
Public Function RetrieveProcessInstance(
ByVal Caller As CUserAuth,
ByVal ProcessInstanceId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveProcessInstance(
CUserAuth Caller,
string ProcessInstanceId,
string ColumnSetXML
);
[C++]
public: String* RetrieveProcessInstance(
CUserAuth* Caller,
String* ProcessInstanceId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadWorkflowProcessInstance privilege to perform this action. See CUserAuth.
ProcessInstanceId
Specifies the ID of the process instance that is to be retrieved.
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in wfprocessinstance.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the process instance. The XML schema is described by wfprocessinstance.xsd.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMProcessController proxy object
Microsoft.CRM.Proxy.CRMProcessController processcontroller = new Microsoft.CRM.Proxy.CRMProcessController();
processcontroller.Credentials = System.Net.CredentialCache.DefaultCredentials;
processcontroller.Url = strDir + "CRMProcessController.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strProcessInstanceId = "{A8CB383D-C9F2-2344-34KE-4A59F7569432}";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>processid</column>";
strColumnSetXml += "<column>parentid</column>";
strColumnSetXml += "<column>objectid</column>";
strColumnSetXml += "</columnset>";
// Retrieve the process instance information
string strResultsXml = processcontroller.RetrieveProcessInstance (userAuth, strProcessInstanceId, strColumnSetXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also