REST.Backend.EMSApi.TEMSClientAPI.DeleteResource
Delphi
function DeleteResource(const AResource, AID: string; const AAddParameters: TProc = nil): Boolean;
C++
bool __fastcall DeleteResource(const System::UnicodeString AResource, const System::UnicodeString AID, const System::Sysutils::_di_TProc AAddParameters = System::Sysutils::_di_TProc());
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | protected | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Sends a deletion request to the EMS server for the specified resource.
DeleteResource receives the following parameters:
AResource
is the path of the endpoint of the type of the target resource. For example, "myresourcetypey".AID
is the ID of the target resource. For example, ifAResource
is "myresourcetypey" andAID
is "myresource", the target endpoint is "myresourcetypey/myresource".AAddParameters
(optional) is a procedure without parameters that you can use to update the request. For example, you can add parameters to the request.
Exceptions
Exception | Message | Description |
---|---|---|
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. |