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

Abort an Extraction Job

delete

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

Abort an extraction job.

Request

Supported Media Types
Path Parameters

  • Globally unique identifier (GUID) of the ZIP file to be extracted into a folder.

  • Globally unique identifier (GUID) for the extraction job.

Back to Top

Response

Supported Media Types

200 Response

The job was aborted.

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

400 Response

The request is invalid as described by the error returned.

404 Response

Extraction job is not found.

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 .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-E83150A29A911D33321FE8A9A6C5814F1643066913096

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

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 .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-930F35D291CEA348255D1974A84CB3571643127919210

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 404

JSON Response

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