Update Group

API Type

Web Services

Description

Updates information for a group.

Syntax

WFGroup UpdateGroup(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

An updated WFGroup.

Example

IWFAdminService svc = GetAdminService();
string GroupName = ...// for example, "TestGroup1"
string Description = ... // for example, "This is new description of
the user group"
string ResponsibleUser = ...// for example, "DEMO3\\Administrator"

try
	{
WFGroup updatedGroup = Svc.UpdateGroup(GroupName, Description,
ResponsibleUser, true);
	}

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

Supported Versions

3.2.0.4 and higher