Content Capture用のREST API

ドキュメントの削除

delete

/capture/api/v1.1/documents/{docId}

この操作は、docIdパラメータで指定されたドキュメントをキャプチャから削除します。

ノート: このリクエストで使用されるOAuthトークンは、このドキュメントが存在するステップへの攻撃アクセス権を付与されたアカウントを表す必要があります。アカウントが「管理者の取得」または「ユーザーの取得」を表す場合、違いは発生しません。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

docId: string

取得内の文書の一意の識別子。

ヘッダー・パラメータ

X-Requested-With: string

クロスサイト・リクエスト・フォージェリ(CSRF)攻撃を防ぐために使用されるヘッダー。サポートされている値はXMLHttpRequestのみです。

これは、削除する「ドキュメント」を表します。ドキュメント・オブジェクト全体を指定できますが、必要な属性はstateTokenのみです。削除操作を続行できることを確認する必要があります。

stateTokenの値は、現在の状態である削除対象のドキュメントの値である必要があります。 stateToken値がドキュメントの現在のstateToken値と一致しない場合、削除操作によってエラーが発生します。

ルート・スキーマ : schema

型: object

Show Source

stateToken: string

ドキュメントの特定の状態を表す生成された文字列値。

一般に、ドキュメントの変更を続行できるようにするために使用されます。本質的に言っているのだ... 「現在のstateTokenがこの値と一致する場合は、このドキュメントを削除」。値が一致しない場合、変更は許可されず、操作によってエラーが発生します。

{
    "type":"object",
    "properties":{
        "stateToken":{
            "type":"string",
            "description":"<p>A generated string value that represents a particular state of the document.</p>\n<p>In general, it is used to allow modifications of the document to proceed. It is essentially saying ...\n<u><i>delete this document if its current <code>stateToken</code> matches this value</i></u>. If the values do\nnot match, the modification is not permitted and the operation results in an error.</p>\n"
        }
    },
    "required":[
        "stateToken"
    ]
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

204レスポンス

内容なし

400レスポンス

不正リクエスト

情報が欠落しているか無効であるため(入力フィールドでの検証エラー、必須値の欠落など)、リクエストを処理できませんでした。レスポンスは「エラーの詳細」オブジェクトになります。

403レスポンス

禁止

リクエストは有効で、認識されましたが、サーバーはアクションを拒否しています。これは、リソースに必要な権限がないアカウント、または禁止されたアクション(たとえば、1つのみが許可されている重複アイテムの作成)を試みていることが原因である可能性があります。レスポンスは「エラーの詳細」オブジェクトになります。

404レスポンス

Not Found

リクエストに、存在しないリソースURIが含まれています。レスポンスは「エラーの詳細」オブジェクトになります。

409レスポンス

競合

このレスポンスは、リクエストがターゲット・リソースの現在の状態と競合することを示します。レスポンスは「エラーの詳細」オブジェクトになります。

通常、412 (Precondition Failed)のエラー・レスポンスが返されます。ただし、「競合」は、リソースに同時編集がある場合に発生する可能性があります。

412レスポンス

Precondition Failed

サーバーはリクエストの前提条件を満たしていません。レスポンスは「エラーの詳細」オブジェクトになります。

このエラー・レスポンスは、リクエスト本文で使用されているstateTokenがリソースの現在のstateTokenと一致しない場合、特に使用されます。

500レスポンス

内部サーバー・エラー

サーバーで予期しない状態が発生し、リクエストを処理できませんでした。レスポンスは「エラーの詳細」オブジェクトになります。

トップに戻る

例

例1:

次の例は、ドキュメントを削除する方法を示しています。

curl -X DELETE -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/content'

これにより、IDが'dcf65d45-4f53-4f82-998c-5e189de1b6a1'のドキュメントが削除されます。この操作が正常に完了してもレスポンス本文はありません。

リクエスト本文

{
  "stateToken": "340f804ff4118f2f419bc3ca87ef1213"
}

トップに戻る