Click or drag to resize

RuntimeServiceGetParticipant Method

Returns a participant 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: (
public string GetParticipant(
	string participantName,
	string filterFields


Type: SystemString
Name of the participant to get.
Type: SystemString
Xml structure of a participant definition containing only the desired fields. If left null or empty, the entire definition will be returned.

Return Value

Type: String
Participant definition
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.

ParticipantId (int)Specifies the Id of the participant to get. Supercedes the participant name.
ProcessId (int)Specifies the Id of the process the participant is linked to. Supercedes a combination of process name and process version.
ProcessName (string)Specifies the name of the process the participant is linked to.
ProcessVersion (int)Specifies the version of the process the participant is linked to.
Sample filterFields XML to return a global participant's name, type and associations (via participantName parameter):
  <Name />
  <Type />
  <Associations />
Complete filterFields XML (via participantName, processName and processVersion parameters):
  <ID />
  <Name />
  <Description />
  <Type />                    <!-- HUMAN, ROLE, COORDINATOR -->
  <Scope />                   <!-- GLOBAL, PROCESS -->
  <Associations />
  <Process />
  <Role />                    <!-- REQUESTER, ACTOR, SUPERVISOR -->
  <ViewGraphics />            <!-- Y, N -->
  <ReassignAction />          <!-- Y, N -->
  <CancelRequest />           <!-- Y, N -->
  <ViewStatistics />          <!-- Y, N -->
  <CommentsPermissions />     <!-- R, RW  -->
  <DatasourceQuery />
Note: CommentsPermissions can also be empty or null, which indicates no comments permissions (neither read nor write)
Sample code:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();
RuntimeServiceWebService.ParticipantHeader myParticipantHeader = new RuntimeServiceWebService.ParticipantHeader();
myRuntimeService.ParticipantHeaderValue = myParticipantHeader;

myParticipantHeader.ParticipantId = participantId;
myParticipantHeader.ProcessId = processId;

string myParticipantDefinition = myRuntimeService.GetParticipant(participantName, null);

See Also