Add Group

API Type

Web Services

Description

Adds a group to the AgilePoint system.

Syntax

public virtual WFGroup AddGroup(string GroupName, string Description, string ResponsibleUser, bool Enabled)

Parameters

Name	Description
GroupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.
Description	Definition: A free text description of an entity. Type string Allowed Values: A string that can contain spaces and special characters.
ResponsibleUser	Definition: The user name for the responsible user of this group. The responsible user must be a registered AgilePoint user. Type string Allowed Values: A valid user name.
Enabled	Definition: Enables or disables an entity. Type bool Allowed Values: True - Enables the entity. False - Disables the entity.

Output

WFGroup object represented the group that is added.

Example

IWFAdminService svc = GetAdminService();
string GroupName = ...;
string Description = ...;
string ResponsibleUser = @"[Domain Name]\[Account Name]", // Group
Lead User Name
bool Enabled = true;

try
    {
    WFGroup group = svc.AddGroup(GroupName, Description,
    ResponsibleUser, Enabled);
    }

catch( Exception ex )
    {
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
    }

Supported Versions

3.2.0.4 and higher