要求の応答スキーマ

非同期 API を使用して取得する結果は、処理中または成功のいずれかになるか、失敗する可能性があります。このページでは、getResult 呼び出しを実行した場合に、これらの両方の状況に対して一般的に返されるスキーマの概要を示します。これらの結果を解読する方法を理解することは、API を正しく管理およびトラブルシューティングするために重要です。

処理中

まだ処理中である場合、getResult 呼び出しは次の詳細情報を含むスキーマを返します。

• status: 要求の現在のステータスです。この場合、ステータスは Running になります。
• createdAt: 要求が開始された日時です。
• lastUpdatedAt: 要求が最後に更新された日時です。

Succeeded (成功)

要求が成功すると、getResult 呼び出しは次の詳細情報を含むスキーマを返します。

• status: 要求の現在のステータスです。この場合、ステータスは Succeeded になります。
• createdAt: 要求が開始された日時です。
• lastUpdatedAt: 要求が最後に更新された日時です。
• result: 要求の結果です。たとえば、抽出結果です (extractionResult と表示されます)。

失敗

要求が失敗すると、getResult 呼び出しは次の詳細情報を含むスキーマを返します。

• status: 要求の現在のステータスです。この場合、ステータスは Failed になります。
• createdAt: 要求が開始された日時です。
• lastUpdatedAt: 要求が最後に更新された日時です。
• error: エラーの原因と以下の詳細です。
  • message: エラーの内容を説明する詳細な説明です (例: "Internal Server Error. Please contact the UiPath support team.")。
  • severity: エラーの重要度です。この場合、重要度は一般的に Error になります。
  • code: エラーの種類を識別する特定のコードです (例: [UnexpectedInternalServerError])。
  • parameters: エラーに関連する追加情報が含まれます (該当する場合)。