Get the status of import

  • Updated on Dec 24, 2024
  • 2 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Get
/v2/Project/Import/{importId}
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
importId
stringRequired

The ID of import request

Responses
200

Success

Import Documentation - 200 Status response.

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

{
  "import_documentation_log": null,
  "status": "Completed",
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Element 'ImportLog' not found.",
      "error_code": "",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
import_documentation_log
object | null

Details about the import

new_versions
integer (int32)

The number of versions imported

categories
integer (int32)

The number of categories imported

articles
integer (int32)

The number of articles imported

languages
string | null

The number of languages imported

messages
Array of object (ImportDocumentationLogAction) | null
object
message_type
integer (int32)

0 - Error; 1 - Warning; 2 - Info

Valid values[ 0, 1, 2 ]
message
string | null

The content of the message

cancel_operation
boolean
status
string | null

Current status of the import and it can be either one of these statuses 'Queued/InProgress/Completed/Error'

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

Import Documentation - 400 Status response.

The below example shows that the given importId is Invalid. Track you import Id from /V2/Project/Import.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Invalid import id",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "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