user-site

Get

/v1/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

string Required

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

new_versions

integer

categories

integer

articles

integer

languages

string

messages

Array of object

object

message_type

integer

Valid values[0,1,2]

message

string

status

string

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

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

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

new_versions

integer