ドキュメント用REST API

機械翻訳について

抽出ジョブの中止

delete

/documents/api/1.2/files/{fileId}/_extract/{jobId}

抽出ジョブを中止します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

フォルダに抽出されるZIPファイルのグローバル一意識別子(GUID)。
jobId: string

抽出ジョブのグローバル一意識別子(GUID)。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

ジョブは中断されました。

レスポンスの例(application/json)

{
    "errorCode":0,
    "type":"file"
}

400レスポンス

返されたエラーの説明に従い、リクエストは無効です。

404レスポンス

抽出ジョブが見つかりません。

トップに戻る

例

次の例では、指定されたジョブを削除します。コールが発行されたときにジョブが現在実行中である場合、バックグラウンド・ジョブは停止します。

DELETE .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-E83150A29A911D33321FE8A9A6C5814F1643066913096

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "type": "file"
}

例2

次の例では、別のユーザーが所有する指定されたジョブを削除します。返されるエラーは、データの露出を防ぐためにあまり詳細ではありません:

DELETE .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-930F35D291CEA348255D1974A84CB3571643127919210

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csExtractionUnableToAbortJob",
    "errorMessage": "Unable to abort extraction job.",
    "errorType": "file",
    "parentID": "DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317",
    "title": "Unable to abort extraction job.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る