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
}
The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
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"
}Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB
Import article and publish.
Document360 user-id
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"
}Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB
Import article and publish.
Document360 user-id
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"
}Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB
Import article and publish.
Document360 user-id
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"
}Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB
Import article and publish.
Document360 user-id
Success
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": []
}The ID of the import request. Use this ID to get the import details
Current status of the import
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
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": []
}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": []
}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": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.