- Print
- DarkLight
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 }
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
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
Bad Request
The below example shows the invalid DocumentationURL status respone. Kindly Verify your Zip file URL.
{
"id": null,
"status": null,
"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.
{
"id": null,
"status": null,
"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.
{
"id": null,
"status": null,
"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": []
}
The ID of the import request. Use this ID to get the import details
Current status of the import
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information