EMS.Services.IEMSResourceRequest.Get

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
EMS.Services.pas
EMS.Services.hpp
Unit: EMS.Services
Parent: IEMSResourceRequest

Delphi

function Get(const AContext: IEMSResourceRequestContext; const AResourceName: string;
const ASegments: TEMSResourceRequestSegments; const AQueryParams: TEMSResourceRequestQueryParams): IEMSResourceResponseContent;

C++

virtual _di_IEMSResourceResponseContent __fastcall Get(const _di_IEMSResourceRequestContext AContext, const System::UnicodeString AResourceName, const TEMSResourceRequestSegments ASegments, const TEMSResourceRequestQueryParams AQueryParams) = 0 ;

Description

Executes a GET resource request to retrieve the information that is identified by the resource request. The method type of the resource request is get.

The Get method receives the following input parameters:

  • AContext: Context of the GET resource request.
  • AResourceName: Resource name identifier to execute the resource request. The built-in resource names are Users, Groups, and Installations.
  • ASegments: Array of URL segments of the EMS Resource endpoint to execute the request.
  • AQueryParams: Query parameters used to execute a filtered GET resource request. Set AQueryParams to null to retrieve all data from the resource.

Get returns an IEMSResourceResponseContent with the response from the EMS Server.

See Also