リクエスト実行のステータスを設定
post
ess/rest/scheduler/v1/requests/{requestId}/executionStatus
リクエスト実行のステータスを設定します。 これは、ジョブ・リクエストから起動して、その実行の結果をスケジューラに通知することを目的としています。 スケジューラは、リクエスト状態を遷移するためのインジケータとして使用します。
リクエスト
パス・パラメータ
- requestId(required): integer(int64)
ジョブ・リクエストID
サポートされているメディア・タイプ
- application/json
- application/vnd.oracle.resource+json
ルート・スキーマ : schema
タイプ:
Show Source
object
-
requestHandle: string
実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中インスタンスの不透明な識別子を表します。
-
status: string
許可された値:
[ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]
非同期ジョブのコールバック・ステータス。 非同期ステータスを戻しても、リクエストの状態が対応する値に変更されることは保証されません。 リクエストの新しい状態は、古い状態、非同期ステータス、および後続の処理で発生する可能性のあるエラーによって異なります。 SUCCESS -- ジョブは正常に実行されましたUPDATE -- 非同期ジョブが更新されますPAUSE -- サブリクエストWARNINGの実行でジョブが一時停止されました -- ジョブが警告エラーを発行しています -- ジョブで再試行可能なエラーCANCELが発生しました -- ジョブの実行が取り消されました。 通常、これはスケジューラAPI SUSPENDを使用してジョブを取り消すことから発生 -- ジョブ自体が中断されましたBUSINESS_ERROR -- ジョブで再試行不可能なエラーが発生しました -
statusMessage: string
ステータスがERRORまたはBUSINESS_ERRORの場合はエラー・メッセージ、ステータスがWARNINGの場合は警告メッセージ、ステータスがPAUSEDの場合は一時停止状態。 ステータスがSUCCESSまたはCANCELの場合、値は無視されます。
ルート・スキーマ : schema
タイプ:
Show Source
object
-
requestHandle: string
実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中インスタンスの不透明な識別子を表します。
-
status: string
許可された値:
[ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]
非同期ジョブのコールバック・ステータス。 非同期ステータスを戻しても、リクエストの状態が対応する値に変更されることは保証されません。 リクエストの新しい状態は、古い状態、非同期ステータス、および後続の処理で発生する可能性のあるエラーによって異なります。 SUCCESS -- ジョブは正常に実行されましたUPDATE -- 非同期ジョブが更新されますPAUSE -- サブリクエストWARNINGの実行でジョブが一時停止されました -- ジョブが警告エラーを発行しています -- ジョブで再試行可能なエラーCANCELが発生しました -- ジョブの実行が取り消されました。 通常、これはスケジューラAPI SUSPENDを使用してジョブを取り消すことから発生 -- ジョブ自体が中断されましたBUSINESS_ERROR -- ジョブで再試行不可能なエラーが発生しました -
statusMessage: string
ステータスがERRORまたはBUSINESS_ERRORの場合はエラー・メッセージ、ステータスがWARNINGの場合は警告メッセージ、ステータスがPAUSEDの場合は一時停止状態。 ステータスがSUCCESSまたはCANCELの場合、値は無視されます。
レスポンス
サポートされているメディア・タイプ
- application/json
- application/vnd.oracle.resource+json
200 レスポンス
OK
ネストされたスキーマ : リンク
タイプ:
Show Source
object
-
href(required): string
-
rel(required): string
許可された値:
[ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]
400 レスポンス
入力が無効です
ルート・スキーマ : SimpleExceptionDetail
タイプ:
Show Source
object
-
detail: string
詳細エラー・メッセージ
-
errorCode: string
ESS固有のエラー・コード。 たとえば、ESS-00500です。
-
status: integer
HTTPステータス・コード
-
title(required): string
要約エラー・メッセージ
-
type(required): string
URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。
403 レスポンス
この操作には使用できません
ルート・スキーマ : SimpleExceptionDetail
タイプ:
Show Source
object
-
detail: string
詳細エラー・メッセージ
-
errorCode: string
ESS固有のエラー・コード。 たとえば、ESS-00500です。
-
status: integer
HTTPステータス・コード
-
title(required): string
要約エラー・メッセージ
-
type(required): string
URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。
404 レスポンス
リクエストIDが見つかりません
ルート・スキーマ : SimpleExceptionDetail
タイプ:
Show Source
object
-
detail: string
詳細エラー・メッセージ
-
errorCode: string
ESS固有のエラー・コード。 たとえば、ESS-00500です。
-
status: integer
HTTPステータス・コード
-
title(required): string
要約エラー・メッセージ
-
type(required): string
URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。
500 レスポンス
スケジューリング・サブシステム・エラーが発生しました。
ルート・スキーマ : SimpleExceptionDetail
タイプ:
Show Source
object
-
detail: string
詳細エラー・メッセージ
-
errorCode: string
ESS固有のエラー・コード。 たとえば、ESS-00500です。
-
status: integer
HTTPステータス・コード
-
title(required): string
要約エラー・メッセージ
-
type(required): string
URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。