document-understanding
latest
false
- Getting Started
- Examples Using the Document Understanding™ Cloud API
- Licensing
- Troubleshooting
- Requests response schemas
- Document Understanding Cloud APIs error response codes
Document Understanding API Guide
Last updated Nov 21, 2024
Requests response schemas
The result we retrieve from using Asynchronous APIs can be processing, successful, or may
encounter failures. This page outlines the commonly returned schemas for both these
situations when a
getResult call is made. Learning to decipher these
results is key to successful API management and troubleshooting.
When still processing, the
getResult call returns a schema with the
following details:
status: the current status of the request. In this case, the status isRunning.createdAt: date and time of when the request was initiated.lastUpdatedAt: date and time of when the request was last updated.
When the request is successful, the
getResult call returns a schema
with the following details:
status: the current status of the request. In this case, the status isSucceeded.createdAt: date and time of when the request was initiated.lastUpdatedAt: date and time of when the request was last updated.result: outcome of the request, for example the extraction result (displayed asextractionResult).
When the request failed, the
getResult call returns a schema with
the following details:
status: the current status of the request. In this case, the status isFailed.createdAt: date and time of when the request was initiated.lastUpdatedAt: date and time of when the request was last updated.error: the cause of errors with the following details:message: detailed explanation that describes what the error is about, for example"Internal Server Error. Please contact the UiPath support team."severity: the failure severity. In this case, the severity is most commonlyError.code: specific code that identifies the type of error, for example[UnexpectedInternalServerError].parameters: contains additional error-related information, if applicable.
