REST APIジョブの同期実行タイムアウト時のエラーレスポンスと終了ステータス「-20005」について

[質問1]

REST APIジョブの同期実行で29秒のタイムアウトが発生した場合、エラーレスポンスの内容をカスタマイズできますか？

[回答1]

REST APIジョブへ同期実行をリクエストした際、29秒のタイムアウトが発生した場合のレスポンスをAPIプロジェクトで設定することはできません。

タイムアウト発生時は以下のレスポンスが返されます。

{"message": "Endpoint request timed out"}

このレスポンスには、resultStatus等の詳細情報は含まれません。

REST APIジョブの実行結果を確認したい場合は、FAQ記事「REST APIジョブで実行したスクリプトの実行結果を、クライアント側で確認する方法について」をご参照の上、REST APIジョブを非同期実行した後に、ポーリング用のREST APIジョブより別途実行結果を取得する方法をご検討ください。

[質問2]

スクリプトの終了ステータス「-20005」が返ってくるのは具体的にどのようなケースでしょうか？

[回答2]

**-10000以下**

システム定義エラーを表す値です。

システム定義エラー時の終了ステータスとして予約されています。

**-20005**

スクリプトが終了する前に、タイムアウトに指定した時間を経過したときに返される終了ステータスです。

しかしながら、調査の結果、HULFT Squareでは現状、終了ステータス「-20005」を返すケースは確認されませんでした。

ただし、「-20005」はシステム内部で予約されているステータスコードとなっているため、マニュアルに記載されております。

なお、「-20005」はシステム予約ステータスコードではありますが、スクリプトのEnd処理の「戻り値」に「-20005」を設定することは可能となっておりますので、その場合には終了ステータスが「-20005」になります。

※同期実行の29秒のタイムアウト発生時には、終了ステータス「-20005」は返されません。

参考：REST APIジョブのエラーレスポンス

参考：スクリプトの終了ステータス