Get Group
API Type
Web Services
Description
Retrieves a group object with the specified AgilePoint group name.
Syntax
public virtual WFGroup GetGroup(string groupName)
Parameters
| Name | Description |
|---|---|
groupName |
|
Output
WFGroup object. If the specified group does not exist, the output is null.
Example
IWFAdminService svc = GetAdminService();
string groupName = ...// for example, "Administrators";
try
{
WFGroup grpInfo = svc.GetGroup(groupName);
Console.WriteLine("Group Name:{0}; Group Lead:{1}", grpInfo.Name,
grpInfo.ResponsibleUser);
}
catch (Exception ex)
{
Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
}
/*
This example produces the following results:
Group Name:Administrators; Group Lead:\Administrator
*/
Supported Versions
3.2.0.4 and higher
Code Examples in the AgilePoint NX Documentation
The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:
- AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
- Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
- Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.