RuntimeServiceGetProcess Method |
Namespace: Advantys.Workflow.Web.Services.Processes.Runtime
Optional Parameters.
These parameters can be used in the query string or as parameters of the Headers object in the RuntimeService class instance. See example below.
ProcessId (int) | Specifies the Id of the process to get. Supercedes the Process name. |
ProcessVersion (int) | Specifies the version of the included ProcessName to get. |
ProcessStatus (string) | Specifies the status of the process to get. Gets the latest version of the process with the matching status. Accepted values: string.Empty, "DEV", "TEST", "ACTIVE" |
IncludeAssociatedFiles (bool) | Specifies whether or not to include associated files (e.g. FORM_HTML for form designer processes). Default = true. |
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService(); RuntimeServiceWebService.GetProcessHeader myGetProcessHeader = new RuntimeServiceWebService.GetProcessHeader(); myRuntimeService.GetProcessHeaderValue = myGetProcessHeader; myGetProcessHeader.ProcessId = processId; myGetProcessHeader.ProcessStatus = processStatus; myGetProcessHeader.ProcessVersion = processVersion; myGetProcessHeader.IncludeAssociatedFiles = includeFiles; string myProcessDefinition = myRuntimeService.GetProcess(processName);
Possible combination of parameters are as such (in order of priority): ProcessId, ProcessName and ProcessVersion, ProcessName and ProcessStatus, ProcessName. e.g. If processName and ProcessId are included. ProcessId will be used to retrieve the process.