Get status of the delete file operation

Updated on Dec 24, 2024

2 minute(s) read

Anand Murali

Prev Next

Get

/v2/Drive/Folders/DeleteFile/Status/{taskId}

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters

taskId

stringRequired

The task ID of the file deleted

Responses

200

Success

Success status response

This example shows the status response for deleting a file operation that has been completed.

{
  "task_status": {
    "task_id": "65868a00c536f34594713fec",
    "is_complete": true,
    "status": 2
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

task_status

object | null

task_id

string | null

The task ID of the file deleted

is_complete

boolean

Indicates whether the task associated with the file deletion is complete

status

integer (int32)

0 - Queued, 1 - Initiated, 2 - InProgress, 3 - Completed, 4 - Error, 5 - Cancelled

Valid values[ 0, 1, 2, 3, 4, 5 ]

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

Bad response

This example shows that the given status is invalid. Perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?