Get the status of export
  • 29 May 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Get the status of export

  • Dark
    Light

Article Summary

Get
/v2/Project/Export/{exportId}
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
exportId
string Required

The ID of the export request

Responses
200

Success

Export Documentation - success Status response

The below example shows the status response for export documentation has successfully Completed.

{
  "status": "Completed",
  "download_url": "https://document.com//exp/.zip",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
status
string

Current status of the export and it can be either one of these status 'Initiated/InProgress/Completed/Error'

download_url
string

Exported .zip file URL. The download URL will be available when the export status is completed

extension_data
object
success
boolean

Status indication for customer API response

errors
Array of object

Errors in the customer API response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer API response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer API response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Export Documentation - 400 Status response.

The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.

{
  "status": null,
  "download_url": null,
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Invalid export id",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
status
string

Current status of the export and it can be either one of these status 'Initiated/InProgress/Completed/Error'

download_url
string

Exported .zip file URL. The download URL will be available when the export status is completed

extension_data
object
success
boolean

Status indication for customer API response

errors
Array of object

Errors in the customer API response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer API response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer API response

object
extension_data
description
string

status description for customer Api response information


Was this article helpful?