SOAP API 開発者ガイド
jdeleteByExample()
削除対象を指定するテンプレートとして sObject を使用して組織から Big Object データを削除する場合は、deleteByExample() を使用します。sObject テンプレートと一致する Big Object 内のすべてのデータが削除されます。
構文
ルールとガイドライン
データを削除する際は、次のルールやガイドラインを考慮する必要があります。
- 指定したオブジェクト内の個別のオブジェクトを削除するには、クライアントアプリケーションは、実行に十分なアクセス権限でログインする必要があります。詳細は、「データアクセスに影響する要素」を参照してください。
- 複数のオブジェクト種別のレコードは、いずれかのオブジェクト種別が Salesforce の [設定] 領域の機能に関連していると、1 回のコールで削除することはできません。唯一の例外は次のオブジェクトです。
- カスタム設定のオブジェクト。カスタムオブジェクトに類似しています。詳細は、Salesforce ヘルプの「カスタム設定の作成」を参照してください。
- GroupMember
- Group
- User
データ削除の基本手順
データは、次の基本手順に従って削除します。
- Big Object のインデックスを構成するすべての項目を使用して sObject を定義します。
- 各項目の値を指定します。
- deleteByExample() をコールし、作成した sObject を渡します。
- DeleteByExampleResult[] の結果を処理してレコードの削除が成功したかどうかを確認します。
サンプルコード — カスタム Big Object
このサンプルでは、カスタム Big Object 内のレコードを削除する方法を示します。この例では、Account__c、Game_Platform__c、Play_Date__c がカスタム Big Object のインデックスの一部です。Account__c が “001d000000Ky3xIAB”、Game_Platform__c が “iOS”、Play_Date__c が “2017-11-28T19:13:36.000z” のすべての行が削除されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| sObject | sObject[] | 削除のテンプレートとして使用する 1 つ以上の sObject の配列。 |