REST.Backend.EMSServices.TEMSUsersAPI.QueryUsers

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray;
out AMetaArray: TArray<TBackendEntityValue>); overload;

C++

void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<Rest::Backend::Metatypes::TBackendEntityValue> &AMetaArray)/* overload */;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSUsersAPI


Beschreibung

Fragt den EMS-Server nach einer Benutzerliste ab.

QueryUsers übernimmt die folgenden Parameter:

  • AQuery ist ein Array mit Strings, wobei jeder String ein durch ein Gleichheitszeichen getrenntes Schlüssel/Wertepaar enthält, z. B. "my_parameter=my_value". QueryUsers fügt der Anforderung diese Schlüssel/Wertepaare als Parameter hinzu.
  • QueryUsers füllt AJSONArray mit den Ergebnissen vom EMS-Server.

Sie können optional ein Array mit TBackendEntityValue-Instanzen (AMetaArray) angeben, damit QueryUsers das Array mit den vom EMS-Server zurückgegebenen Benutzern füllt.

Exceptions

Exception Meldung Beschreibung

EEMSClientAPIError

JSON-Objekt erwartet

Sie haben an QueryUsers ein Array mit TBackendEntityValue-Instanzen (AMetaArray) übergeben, aber QueryUsers kann dieses Array nicht füllen, weil die vom EMS-Server erhaltenen JSON-Daten eine unerwartete Struktur haben.

Die erwartete Struktur der erhaltenen JSON-Daten ist ein JSON-Array mit JSON-Objekten.

Die tatsächliche Struktur der erhaltenen JSON-Daten ist ein JSON-Array, das mindestens einen Eintrag enthält, der kein JSON-Objekt ist.

MasterSecret erforderlich

Der Authentifizierungstyp ist TAuthentication.MasterSecret, und die Eigenschaft MasterSecret der Verbindungsinformationen des zugrunde liegenden EMS-Backend-Dienstes ist ein leerer String.

Sitzungs-Token erforderlich

Der Authentifizierungstyp ist TAuthentication.Session, und Sie haben sich nicht angemeldet.

Siehe auch