EMS.Services.TEMSInternalAPI.UpdateGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function UpdateGroup(const AGroupName: string;  const AGroupFields: TJSONObject): IEMSResourceResponseContent; overload;

C++

_di_IEMSResourceResponseContent __fastcall UpdateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupFields)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
EMS.Services.pas
EMS.Services.hpp
EMS.Services TEMSInternalAPI

Description

Updates the fields from an EMS Group.

UpdateGroup updates the content of a given EMS Group in the EMS Server, adding, updating or deleting custom fields.

  • To add a new field, add a custom name/value pair to the TJSONObject.
  • To delete a field, pass a null value in the JSON object for that pair.
 {"SomeName":null}

The UpdateGroup method receives the following parameters:

  • AGroupName: EMS Group Name that identifies an existing EMS Group in the EMS Server.
  • AGroupFields: TJSONObject with the custom fields of an EMS Group.

UpdateGroup returns an IEMSResourceResponseContent to read the response from the EMS Server.

See Also