「REST.Backend.EMSApi.TEMSClientAPI.QueryResource」の版間の差分
(ページの作成:「{{#lst:API:REST.Backend.EMSApi.TEMSClientAPI.QueryResource|api}} ==説明== {{#lsth:API:REST.Backend.EMSApi.TEMSClientAPI.QueryResource|説明}}」) |
細 (1版: LOC-19588/2015.23.07.DocWikiPages_JA) |
||
| 1行目: | 1行目: | ||
{{#lst:API:REST.Backend.EMSApi.TEMSClientAPI.QueryResource|api}} | {{#lst:API:REST.Backend.EMSApi.TEMSClientAPI.QueryResource|api}} | ||
| + | |||
==説明== | ==説明== | ||
| − | {{# | + | |
| + | {{#ifeq: {{PAGENAME}} | REST.Backend.EMSApi.TEMSClientAPI.QueryResource | |{{InheritsFrom|REST.Backend.EMSApi.TEMSClientAPI.QueryResource}}}} | ||
| + | |||
| + | <section begin="short" />指定されたリソース タイプのリソースのリストを EMS サーバーに問い合わせます。<section end="short" /> | ||
| + | |||
| + | [[REST.Backend.EMSApi.TEMSClientAPI.QueryResource|QueryResource]] が受け取るパラメータは次のとおりです。 | ||
| + | |||
| + | * {{Arg|AResource}}: [[REST.Client.TRESTRequest.Resource|対象となるリソース タイプ]]です。 | ||
| + | * {{Arg|AQuery}}: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする[[System.UnicodeString|文字列]]配列です。[[REST.Backend.EMSApi.TEMSClientAPI.QueryResource|QueryResource]] では、これらのキー/値ペアを[[REST.Client.TCustomRESTRequest.AddParameter|パラメータ]]として[[REST.Backend.EMSApi.TEMSClientAPI.Request|要求]]に追加します。 | ||
| + | * {{Arg|AJSONArray}}: [[REST.Backend.EMSApi.TEMSClientAPI.QueryResource|QueryResource]] で EMS サーバーから取得された結果の格納先です。 | ||
| + | * {{Arg|AReset}}: [[REST.Backend.EMSApi.TEMSClientAPI.QueryResource|QueryResource]] で要求パラメータをリセットするか({{True}})、それとも、前回の要求のパラメータを基に新しい要求を作成するか({{False}})を指定します。<p> たとえば、パラメータが同じで対象リソースだけが異なる問い合わせを 1 つの行で数回実行する場合は、{{Arg|AReset}} として {{False}} を渡してパフォーマンスを向上させることができます。</p> | ||
| + | |||
| + | * {{Arg|AAddParameters}}(任意指定): [[REST.Client.TRESTRequest|要求]]の更新に使用できる[[System.SysUtils.TProc|パラメータなしの手続き]]です。たとえば、要求に[[REST.Client.TCustomRESTRequest.AddParameter|パラメータを追加]]できます。 | ||
| + | |||
| + | ===例外=== | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! 例外 | ||
| + | ! メッセージ | ||
| + | ! 説明 | ||
| + | |- valign="top" | ||
| + | | rowspan="2" | | ||
| + | [[REST.Backend.EMSApi.EEMSClientAPIError|EEMSClientAPIError]] | ||
| + | | | ||
| + | MasterSecret が必要です | ||
| + | | | ||
| + | [[REST.Backend.EMSApi.TEMSClientAPI.Authentication|Authentication]] が [[REST.Backend.EMSApi.TEMSClientAPI.TAuthentication|TAuthentication.MasterSecret]] で、[[REST.Backend.EMSApi.TEMSClientAPI.ConnectionInfo|ConnectionInfo]].[[REST.Backend.EMSApi.TEMSClientAPI.TConnectionInfo.MasterSecret|MasterSecret]] が空の文字列になっています。 | ||
| + | |- valign="top" | ||
| + | | | ||
| + | セッション トークンが必要です | ||
| + | | | ||
| + | [[REST.Backend.EMSApi.TEMSClientAPI.Authentication|Authentication]] が [[REST.Backend.EMSApi.TEMSClientAPI.TAuthentication|TAuthentication.Session]] で、かつ、[[REST.Backend.EMSApi.TEMSClientAPI.Login|ログイン]]が行われなかったか、[[REST.Backend.EMSApi.TEMSClientAPI.Login|Login]] の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 | ||
| + | |} | ||
| + | |||
| + | ===関連項目=== | ||
| + | |||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.AddResource|REST.Backend.EMSApi.TEMSClientAPI.AddResource]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.PutResource|REST.Backend.EMSApi.TEMSClientAPI.PutResource]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.DeleteResource|REST.Backend.EMSApi.TEMSClientAPI.DeleteResource]] | ||
| + | |||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.QueryUsers|REST.Backend.EMSApi.TEMSClientAPI.QueryUsers]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.QueryGroups|REST.Backend.EMSApi.TEMSClientAPI.QueryGroups]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.QueryModules|REST.Backend.EMSApi.TEMSClientAPI.QueryModules]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources]] | ||
| + | * [[REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations|REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations]] | ||
| + | |||
| + | [[Category:API ドキュメント]] | ||
| + | [[Category:XE8]] | ||
2015年8月1日 (土) 14:19時点における最新版
Delphi
procedure QueryResource(const AResource: string; const AQuery: array of string; const AJSONArray: TJSONArray; AReset: Boolean; const AAddParameters: TProc = nil);
C++
void __fastcall QueryResource(const System::UnicodeString AResource, System::UnicodeString const *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, bool AReset, const System::Sysutils::_di_TProc AAddParameters = System::Sysutils::_di_TProc());
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたリソース タイプのリソースのリストを EMS サーバーに問い合わせます。
QueryResource が受け取るパラメータは次のとおりです。
AResource: 対象となるリソース タイプです。AQuery: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする文字列配列です。QueryResource では、これらのキー/値ペアをパラメータとして要求に追加します。AJSONArray: QueryResource で EMS サーバーから取得された結果の格納先です。AReset: QueryResource で要求パラメータをリセットするか(True)、それとも、前回の要求のパラメータを基に新しい要求を作成するか(False)を指定します。たとえば、パラメータが同じで対象リソースだけが異なる問い合わせを 1 つの行で数回実行する場合は、
AResetとしてFalseを渡してパフォーマンスを向上させることができます。
AAddParameters(任意指定): 要求の更新に使用できるパラメータなしの手続きです。たとえば、要求にパラメータを追加できます。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |