Document Data の削除サービスを使用する

注:

制御を向上させるため、Du.Deletion.Api にアクセスできるのは、以下のスコープを持つ外部アプリケーションだけです。認証を行う前に、必ずこのスコープをアプリケーションに追加してください。

DELETE API を使用すると、指定した documentId に関連する実行時のデータすべて (監視データを除く) を削除できます。

この API を使用すると、自動的に期限切れになるまで待たなくても、すべての関連データをドキュメントからクリーンアップすることができます。

ドキュメント データを削除する

ドキュメントにリンクされているすべてのデータの削除を開始するには、次の呼び出しを使用します。

DELETE /projects/{projectId}/document/{documentId}/

注:

削除操作は非同期であるため、更新がすぐに表示されない場合があります。確認する前に少しお待ちください。

curl -X 'DELETE' \
  '{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/document/<Document_ID>/api-version=1.1' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json' \
  -d '{
  "removeValidationDataFromStorage": true
}'

削除の呼び出しを実行する際に、次の任意の入力パラメーターを使用することもできます。

removeValidationDataFromStorage: true or false (default)

removeValidationDataFromStorage パラメーターは、関連するストレージ バケット ファイルも削除するかどうかを制御します。

• true に設定すると、関連するファイルが Orchestrator のストレージ バケットから削除されます。

削除の呼び出しの後に、「202 Accepted」という応答メッセージが表示されます。

削除を確定する

削除を確定するには、次の呼び出しを使用します。

GET /projects/{projectId}/digitization/result/{documentId}

curl -X 'GET' \
  '{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/digitization/result/<Document_ID>?api-version=1.1' \
  -H 'accept: text/plain'

削除が完了すると、メッセージ「404 Not Found」が返されます。