Get the status of import
  • 25 Nov 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Get the status of import

  • Dark
    Light

Article Summary

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 (ImportAPILog)
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

The number of languages imported

messages
Array of object (ImportDocumentationLogAction)
object
message_type
integer (int32)
Valid values[ 0, 1, 2 ]
message
string

The content of the message

cancel_operation
boolean
status
string

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

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api response

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

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.

{
  "import_documentation_log": null,
  "status": null,
  "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
import_documentation_log
object (ImportAPILog)
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

The number of languages imported

messages
Array of object (ImportDocumentationLogAction)
object
message_type
integer (int32)
Valid values[ 0, 1, 2 ]
message
string

The content of the message

cancel_operation
boolean
status
string

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

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api response

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?