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

注:

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

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

• デジタル化の結果 (ドキュメント オブジェクト モデル、テキスト、最適化された PDF)
• 分類結果と抽出結果
• 検証タスクと分類タスク (ユーザー入力に基づく)

この API を使用すると、すべての関連データをドキュメントからクリーンアップすることができ、7 日間で自動的に期限切れになるまで待つ必要がありません。

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

POST /projects/{projectId}/document/{documentId}/

この呼び出しの後、削除要求を確定するために、応答メッセージ「202 Accepted」が表示されます。 削除を確定するには、次の呼び出しを使用します。

GET /digitization/{documentId}

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

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

forceDeleteValidationData: true or false (default)

forceDeleteValidationData パラメーターは、関連する未実行の検証タスクまたは分類タスクも削除するかどうかを制御します。

• true に設定すると、タスクは削除され、アクセスできなくなります。
• false に設定すると、未実行のタスクが存在する場合、API は以下を返します。

  403 Forbidden
  Cannot delete document with ID {documentId}, as it has open validation tasks – either complete the created tasks or set the forceDeleteValidationData option to “true”.