REST.Backend.EMSServices.TEMSQueryAPI.Query

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure Query(const AClass: TBackendMetaClass;  const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure Query(const AClass: TBackendMetaClass;  const AQuery: array of string; const AJSONArray: TJSONArray; out AObjects: TArray<TBackendEntityValue>); overload;

C++

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

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSQueryAPI


Description

Demande au serveur EMS une liste d'objets du type spécifié.

Query reçoit les paramètres suivants :

  • AClass détermine la classe des objets à demander.
  • AQuery est un tableau de chaînes dans lequel chaque chaîne doit contenir une paire clé-valeur séparée par un signe égal, par exemple "mon_paramètre=ma_valeur". Query ajoute ces paires clé-valeur à la requête en tant que paramètres.
  • Query remplit AJSONArray avec les résultats provenant du serveur EMS.

Si votre requête porte sur des utilisateurs, des groupes ou des installations, vous pouvez éventuellement fournir un tableau d'instances de TBackendEntityValue (AObjects) pour que Query remplisse le tableau avec les objets renvoyés par le serveur EMS.

Remarque : Query prend uniquement en charge AObjects pour les utilisateurs, groupes et installations. Vous ne pouvez pas utiliser AObjects pour les requêtes portant sur des modules ou des ressources de module.

Exceptions

Exception Message Description

EEMSClientAPIError

Objet JSON attendu

Vous avez transmis à Query un tableau d'instances de TBackendEntityValue (AObjects), mais Query ne peut pas remplir ce tableau car la structure des données JSON reçues du serveur EMS est inattendue.

La structure attendue des données JSON reçues est un tableau JSON d'objets JSON.

La structure réelle des données JSON reçues est un tableau JSON qui contient un ou plusieurs éléments qui ne sont pas des objets JSON.

MasterSecret requis

Le type d'authentification a la valeur TAuthentication.MasterSecret, et la propriété MasterSecret des informations de connexion du service backend EMS sous-jacent est une chaîne vide.

Token de session requis

Le type d'authentification a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté.

Type de requête backend non supporté : <AClass.BackendDataType>

Query ne prend pas en charge le type de données backend de la classe spécifiée des objets sur lesquels porte la requête.

Voir aussi