- 09 Mar 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Get the status of import
- Updated on 09 Mar 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Id of import request
Success
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": []
}
Current status of the import and it can be either one of these statuses 'Queued/InProgress/Completed/Error'
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 resonse
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 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": []
}
Current status of the import and it can be either one of these statuses 'Queued/InProgress/Completed/Error'
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 resonse
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