Import documentation

02 Nov 2024
4 Minutes To Read
Contributors

Print
Share
Dark mode
Light
PDF

Import documentation

Updated On 02 Nov 2024
4 Minutes To Read
Contributors

Print
Share
Dark mode
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/v2/Project/Import

Sample requests:

POST /Import - Import documention from external zip file url { "source_documentation_url": "https://yourdomain/documentation.zip", // Document360 standard file only accepted "publish_article": true, // import article and publish
"import_by": "5a619a315481302d50b736d8" // Document360 user id }

Security

API Key

Header parameter nameapi_token

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

Body parameters

Import - Complete documention from external zip file url

To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.

{
  "source_documentation_url": "https://yourdomain/documentation.zip",
  "publish_article": true,
  "import_by": "5a619a315481302d50b736d8"
}

object

source_documentation_url

string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article

boolean

Import article and publish.

import_by

string | null

Document360 user-id

Import - Complete documention from external zip file url

To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.

{
  "source_documentation_url": "https://yourdomain/documentation.zip",
  "publish_article": true,
  "import_by": "5a619a315481302d50b736d8"
}

object

source_documentation_url

string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article

boolean

Import article and publish.

import_by

string | null

Document360 user-id

Import - Complete documention from external zip file url

To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.

{
  "source_documentation_url": "https://yourdomain/documentation.zip",
  "publish_article": true,
  "import_by": "5a619a315481302d50b736d8"
}

object

source_documentation_url

string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article

boolean

Import article and publish.

import_by

string | null

Document360 user-id

Import - Complete documention from external zip file url

To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.

{
  "source_documentation_url": "https://yourdomain/documentation.zip",
  "publish_article": true,
  "import_by": "5a619a315481302d50b736d8"
}

object

source_documentation_url

string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article

boolean

Import article and publish.

import_by

string | null

Document360 user-id

Responses

200

Success

Import Documentation - 200 Status response.

The below example shows the status response for import documentation. Here the import for a new documentation will be Queued.

{
  "id": "e39bf9be-67be-4658-b28d-45d5794b25b0",
  "status": "Queued",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

string | null

The ID of the import request. Use this ID to get the import details

status

string | null

Current status of the import

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 Invalid Url.

The below example shows the invalid DocumentationURL status respone. Kindly Verify your Zip file URL.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Invalid Source DocumentationURI, Document360 only accept .zip files.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Import Documentation - 400 Status response Not Authorized.

The below example shows that the import_by userId is invalid or Not Authorized to import this Document. Kindly Verify your import_by userId.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "You are not authorized to perform this activity.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Import Documentation - 400 Status response due to Null reference.

The below example shows that the import_by userId is empty, this field is required.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "ImportBy argument must not be null.",
      "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

Was this article helpful?

What's Next

Gets list of project versions