1. REST API for Documents
  2. Tasks
  3. Folders

Abort a Bulk Download Job

delete

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

Abort a bulk download job.

Request

Supported Media Types
Path Parameters

  • Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for folderId is self.

  • Globally unique identifier (GUID) for the bulk download job.

Back to Top

Response

Supported Media Types

200 Response

The job was aborted.

Body
Example Response (application/json)
{
    "errorCode":0,
    "type":"folder"
}

400 Response

The request is invalid as described by the error returned.

Back to Top

Examples

The following example deletes the specified job. If the job is currently running when the call is issued, the background job will be stopped:

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

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

The following example attempts to delete the specified job owned by a different user. The error returned is not very detailed to prevent data exposure:

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

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 404

JSON Response

{
    "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"
}
Back to Top