REST.Backend.EMSServices.TEMSQueryAPI.Query

提供: RAD Studio API Documentation
移動先: 案内検索

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 */;

プロパティ

種類 可視性 ソース ユニット
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSQueryAPI


説明

指定された型のオブジェクトのリストを EMS サーバーに問い合わせます。

Query が受け取るパラメータは次のとおりです。

  • AClass: 問い合わせの対象となるオブジェクトのクラスを指定します。
  • AQuery: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする文字列配列です。Query では、これらのキー/値ペアをパラメータとして要求に追加します。
  • AJSONArrayQuery で EMS サーバーから取得された結果の格納先です。

ユーザー、グループ、インストールのいずれかを問い合わせる場合は、オプションで、TBackendEntityValue インスタンスの配列を引数(AObjects)として渡すこともできます。その場合、Query では、EMS サーバーから返されたオブジェクトをその配列に格納します。

メモ: Query では、ユーザー、グループ、インストールの場合にのみ、AObjects をサポートしています。モジュールやモジュール リソースの問い合わせには AObjects を使用できません。

例外

例外 メッセージ 説明

EEMSClientAPIError

JSON オブジェクトが必要です

QueryTBackendEntityValue インスタンスの配列AObjects)が渡されましたが、Query では、EMS サーバーから受け取った JSON データの構造が予期しないものであるため、その配列にデータを格納できません。

受け取る JSON データの構造としては、JSON オブジェクトJSON 配列が想定されています。

受け取る JSON データの実際の構造は、JSON オブジェクトでない項目が 1 つ以上含まれている JSON 配列です。

MasterSecret が必要です

認証の種類TAuthentication.MasterSecret で、基になる EMS バックエンド サービス接続情報MasterSecret プロパティが空の文字列になっています。

セッション トークンが必要です

認証の種類TAuthentication.Session で、かつ、ログインが行われませんでした。

サポートされていないバックエンド クエリ タイプです: <AClass.BackendDataType>

Query では、問い合わせ対象オブジェクトの指定クラスバックエンド データ型をサポートしていません。

関連項目