RuntimeServiceGetGroup Method |
Returns a group 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.15.0.29499 (7.15.0.201904253)
SyntaxParameters
- groupName
- Type: SystemString
Name of the group to get. Can be empty if GroupId is specified. - filterFields
- Type: SystemString
XML structure of a group definition containing only the desired fields. If left null or empty, the entire definition will be returned. Element names are case sensitive.
Return Value
Type: StringGroup definition
RemarksAvailable since WorkflowGen version: 6.2.0
Sample filterFields XML to return the name and description:
Complete filterFields XML:
Sample code:
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.
| GroupId (int) | Id of the group to get. Supercedes the group name. |
| DirectoryName (int) | Specifies the directory name of the group to get. Can be empty if GroupId is specified or when there exists only one group with the same name in WorkflowGen. |
| DirectoryId (int) | Specifies the directory Id of the group to get. Can be empty if GroupId is specified or when there exists only one group with the same name in WorkflowGen. Supercedes the directory name. |
Sample filterFields XML to return the name and description:
XML
<Group> <Name /> <Description /> </Group>
Complete filterFields XML:
XML
<Group> <ID /> <Name /> <Description /> <DateCreation /> <DateUpdate /> <Directory /> <ReadOnly /> <Email /> <LDAP_ADsPath /> <DistinguishedName /> <CommonName /> <BuiltIn /> <Code /> <SystemIdentifier /> <Synchronized /> <DataSourceQuery /> <Users /> </Group>
Sample code:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService(); RuntimeServiceWebService.ExportGroupHeader myExportGroupHeader = new RuntimeServiceWebService.ExportGroupHeader(); myRuntimeService.ExportGroupHeaderValue = myExportGroupHeader; myExportProcessHeader.DirectoryId = directoryId; string groupDefinition = myRuntimeService.GetGroup(groupName, null);
See Also