Click or drag to resize

RuntimeServiceGetGlobalList Method

Gets a global list definition. 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.18.0.0 (7.18.0.20200311)
Syntax
public string GetGlobalList(
	string listName,
	string filterFields
)

Parameters

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

Return Value

Type: String
Returns the global list 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.

ListId (int)Specifies the Id of the global list to get. Supercedes the list name.
Sample filterFields XML to return the global list name:
XML
<GlobalList>
 <Name />
</GlobalList>
Complete filterFields XML
XML
<GlobalList>
 <Name />
 <ParticipantName />
 <Content />
</GlobalList>
Sample code:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();
RuntimeServiceWebService.GlobalListHeader myGlobalListHeader = new RuntimeServiceWebService.GlobalListHeader();
myRuntimeService.GlobalListHeaderValue = myGlobalListHeader;

myGlobalListHeader.ListId = listId;

string myGlobalListDefinition = myRuntimeService.GetGlobalList(listName, null);

See Also