Click or drag to resize

RuntimeServiceGetWorkflowApplication Method

Gets a workflow application. Intended for web use only.

Namespace:  Advantys.Workflow.Web.Services.Processes.Runtime
Assembly:  Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 7.21.0.0 (7.21.0.20200909)
Syntax
public string GetWorkflowApplication(
	string applicationName,
	string filterFields
)

Parameters

applicationName
Type: SystemString
Name of the workflow application to get. Can be empty if ApplicationId is specified.
filterFields
Type: SystemString
Xml structure of a workflow application definition containing only the desired fields. If left null or empty, the entire definition will be returned.

Return Value

Type: String
Returns the application definition as a string.
Remarks
Available since WorkflowGen version: 6.2.0

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.

ApplicationId (int)Specifies the Id of the application to get. Supercedes the application name.
Sample filterFields XML to return the application name and type
XML
<Application>
  <Name /> 
  <Type />
</Application>
Complete filterFields XML Note: In some types of applications some nodes may not be applicable.
XML
<Application>
  <Name />
  <Description />
  <Type />                  <!-- ASSEMBLY, WCFSERVICE, WEBAPP, WEBPROC, WEBPROCASYNC, WEBSERVICE -->
  <Encoding />              <!-- application/x-www-form-urlencoded, multipart/form-data, application/xml; charset=UTF-8 -->
  <Url />
  <Wsdl />
  <Method />
  <Username />
  <Password />
  <Active />                <!-- Y,N -->
  <Assembly />
  <Class />
  <ContextSchema />         <!-- RECORDSET, WFCONTEXT -->
  <EmbeddedContextSchema /> <!-- Y, N -->
  <Parameters>
    <Parameter>
      <Name />
      <Description />
      <Datatype />          <!-- FILE, TEXT, NUMERIC -->
      <Direction />         <!-- IN, INOUT, OUT -->
      <Required />          <!-- Y,N -->
      <Default />           <!-- Y,N -->
    </Parameter>
  </Parameters>
</Application>
Sample code:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();
RuntimeServiceWebService.WorkflowApplicationHeader myWorkflowApplicationHeader = new RuntimeServiceWebService.WorkflowApplicationHeader();
myRuntimeService.WorkflowApplicationHeaderValue = myWorkflowApplicationHeader;

myWorkflowApplicationHeader.ApplicationId = applicationId;

string myWorkflowApplicationDefinition = myRuntimeService.GetWorkflowApplication(applicationName, null);

See Also