ドキュメント用REST API

機械翻訳について

一括ダウンロード・ジョブの中断

delete

/documents/api/1.2/folders/{folderId}/_download/{jobId}

一括ダウンロード・ジョブを中止します。

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

フォルダのグローバル一意識別子(GUID)。参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。
jobId: string

一括ダウンロード・ジョブのグローバル一意識別子(GUID)。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

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

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

400レスポンス

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

トップに戻る

例

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

DELETE .../documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例2

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

DELETE .../documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csBulkdownloadUnableToAbortJob",
    "errorMessage": "Unable to abort bulkdownload job.",
    "errorType": "folder",
    "parentID": "FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "title": "Unable to abort bulkdownload job.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る