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());
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | protected | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたリソースの削除要求を EMS サーバーに送信します。
DeleteResource が受け取るパラメータは次のとおりです。
AResource
: 対象リソースの種類のエンドポイントのパスです。たとえば、"myresourcetypey" などです。AID
: 対象リソースの ID です。たとえば、AResource
が "myresourcetypey" でAID
が "myresource" であれば、対象エンドポイントは "myresourcetypey/myresource" になります。AAddParameters
(任意指定): 要求の更新に使用できるパラメータなしの手続きです。たとえば、要求にパラメータを追加できます。
例外
例外 | メッセージ | 説明 |
---|---|---|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |