REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources

• Up to Parent: TEMSClientAPI

Delphi

procedure QueryModuleResources(const AModuleID: string; const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryModuleResources(const AModuleID: string; const AQuery: array of string; const AJSONArray: TJSONArray;  out AResources: TArray<TModuleResource>); overload;

C++

void __fastcall QueryModuleResources(const System::UnicodeString AModuleID, const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryModuleResources(const System::UnicodeString AModuleID, const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TModuleResource> &AResources)/* overload */;

Properties

Type	Visibility	Source	Unit	Parent
procedure function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Description

Queries the EMS server for a list of module resources.

QueryModuleResources receives the following parameters:

• AQuery is an array of strings where each string must contain a key-value pair separated by an equal sign, such as "my_parameter=my_value". QueryModuleResources adds those key-value pairs to the request as parameters.
• QueryModuleResources fills AJSONArray with the results from the EMS server.

You may optionally provide an array of instances of TModuleResource (AModuleResources), so that QueryModuleResources fills the array with the module resources that the EMS server returns.

Exceptions

Exception	Message	Description
EEMSClientAPIError	JSON object expected	You passed QueryModuleResources an array of instances of TModuleResource (AModuleResources), but QueryModuleResources cannot fill that array because the structure of the JSON data received from the EMS server is unexpected. The expected structure of the received JSON data is a JSON array of JSON objects. Each one of those objects represents a user. The actual structure of the received JSON data is a JSON array that contains one or more items that are not JSON objects.
	MasterSecret required	Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string.
	Session token required	Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string.

See Also

• REST.Backend.EMSApi.TEMSClientAPI.UnregisterModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResourcesFields

• REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
• REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
• REST.Backend.EMSApi.TEMSClientAPI.QueryModules
• REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations

• REST.Backend.EMSApi.TEMSClientAPI.QueryResource

• REST.Backend.EMSServices.TEMSQueryAPI.Query