機械翻訳について
  1. Oracle Fusion Cloud Applications共通機能のためのREST API
  2. タスク
  3. スケジューラ

新規ジョブ・リクエストを送信

post

ess/rest/scheduler/v1/requests

指定したスケジュールに従って実行する既存のジョブ定義を使用して、新しいジョブ・リクエストを作成します。

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ : schema
このオブジェクトは、jobDefinitionまたはjobSetのリクエストの作成に使用する情報を指定します。 スケジュールとscheduleIdのいずれか1つのみを指定する必要があることに注意してください。
すべてに一致
Show Source
ネストされたスキーマ : RequestSystemProperties
タイプ: object
Show Source
  • 過去の実行時間を持つ繰返しリクエストのインスタンスを生成するかどうかを指定するプロパティ。 インスタンスは、リクエストされた開始時間より前またはリクエストされた終了時間より後に生成されません。 リクエストされたnullの開始時間は、デフォルトで現在の時間になります。 過去のインスタンスを生成するには、このプロパティをtrueに設定し、リクエストされた開始時間をインスタンスを生成する初期時間として指定する必要があります。 このプロパティの有効な値は次のとおりです: true -- リクエストされた開始時間からリクエストされた終了時間までに指定した範囲内にあるスケジュールで指定されたすべてのインスタンスは、生成時間に関係なく生成されます。過去(つまり生成時間より前)にスケジュールされた実行時間を持つfalseインスタンスは生成されません。 このプロパティが指定されていない場合、使用されるシステムのデフォルトはtrueです。
  • リクエスト処理優先度を指定するプロパティ。 優先度間隔は[0..9]で、0が最低の優先度、9が最高です。 このプロパティが指定されていない場合、使用されるシステムのデフォルト値は4です。
  • リクエストを発行したアプリケーション内の製品を指定するプロパティ。
  • リクエストのラベルを指定するプロパティ。 ラベルを使用すると、リソースの最適化のためにジョブ・リクエストをグループ化できます。
  • リクエスト・ロギングのログ・レベルを指定するプロパティ。 このプロパティの値はスケジューラによって内部的に使用されませんが、ジョブに渡して使用できます。
  • プロセッサが実行開始後に非同期を待機する時間を分単位で指定するプロパティ。 時間が経過すると、リクエストはタイムアウトとしてマークされます。 リクエストの状態にその他の直接的な影響はありません。 このプロパティが指定されていない場合、システムのデフォルトはタイムアウトになりません。
  • 失敗したリクエストの再試行制限を指定するプロパティ。 リクエストの実行が失敗した場合、リクエストが成功するまで、このプロパティで指定された回数までリクエストが再試行されます。 再試行制限がゼロ(0)の場合、失敗したリクエストは再試行されません。 このプロパティが指定されていない場合、使用されるシステムのデフォルトは0です。
ネストされたスキーマ : type
タイプ: object
Show Source
ネストされたスキーマ : CallbackSubscriptionRequest
タイプ: object
コールバック停止エンドポイントの呼出しに必要なプロパティの典型的なセット。 これらのプロパティは、securitySchemeに従って指定する必要があります。
Show Source
  • アイデンティティ・ストアからアクセス・トークンを取得するためのURL。 このプロパティは、通常、DIRECT_OAUTHセキュリティ・スキームに必要です。
  • RESTリソースの相対パスを指定するプロパティ。 ベース・リソースURLは、callbackUrlPrefixプロパティで指定されます。 このプロパティは、すべてのセキュリティ・スキームに必要です。
  • リソースの完全なURLを提供するためにcallbackResourcePathプロパティとともに使用できるRESTリソースのベースURLを指定するプロパティ。 このプロパティは、すべてのセキュリティ・スキームに必要です。
  • クライアント登録時にOAuthサーバーによって発行されるclientIdで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
  • クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
  • クライアントのCSFキーを設定するプロパティ。 Eg: "idcs.client.credentials". これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。 このプロパティは、通常、OWSM_LPAセキュリティ・スキームに必要です。
  • 許可された値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]
    "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"の中から1つ。 指定しない場合、デフォルトはOWSM_GPAとみなされます。 OWSM_LPAの場合、クライアントからアタッチされたデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。 "OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ" oracle.wsm.security "の下のCSFで構成されていることを確認する必要があります。 "DIRECT_OAUTHセキュリティ"スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバはclientIdおよびシークレットがIDCSで構成されていることを確認する必要があります。
ネストされたスキーマ : RequestExecutionContextIn
タイプ: object
現在のジョブ・リクエストのリクエスト実行コンテキスト。 この識別子は、サブリクエストの作成時にのみ使用されます。
Show Source
  • 実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中インスタンスの不透明な識別子を表します。 この値は、実行の開始時にジョブ・リクエストに指定された情報から取得できます。
  • この操作を起動しているリクエストの識別子です。 実行の開始時にジョブ・リクエストに指定された情報から取得できます。
ネストされたスキーマ : requestParameters
タイプ: array
リクエスト送信パラメータ
Show Source
ネストされたスキーマ : ScheduleBase
タイプ: object
Show Source
ネストされたスキーマ : RequestParameter
タイプ: object
リクエスト・パラメータ。
Show Source
ネストされたスキーマ : 除外
タイプ: array
Show Source
ネストされたスキーマ : 包含
タイプ: array
Show Source
ネストされたスキーマ : 繰り返し
タイプ: array
一連の繰返し。 生成されるスケジュールのオカレンスは、個々の繰り返しによって生成されるオカレンスの和になります。
Show Source
ネストされたスキーマ : 繰返し
タイプ: object
Show Source
  • この繰り返しオブジェクトの終了日時を設定します。 オブジェクトは、秒までの時間のみを抽出します。 ミリ秒精度はサポートされていません。 値はISO 8601形式の文字列です。
  • スケジュールで使用する繰返しパターンを定義します。 文字列はRFC 5445 RRULEに準拠している必要があります。 UNTIL、COUNT、BYSETPOS、WKSTなどの制限はサポートされていません。 RRULEのBY*句(Rotors)には、最小値 -1を指定できます。たとえば、BYDAY=-2MO(second to last monday)はサポートされていません。 BYMONTHおよびBYWEEKNOは、1つのRECUR式に存在できません。 BYDAY、BYMONTHDAYおよびBYYEARDAYは、1つのRECUR式に存在できません。
  • この繰り返しオブジェクトの開始日時を設定します。 オブジェクトは、秒までの時間のみを抽出します。 ミリ秒精度はサポートされていません。 値はISO 8601形式の文字列です。
リクエスト本文 - application/vnd.oracle.resource +json ()
ルート・スキーマ : schema
このオブジェクトは、jobDefinitionまたはjobSetのリクエストの作成に使用する情報を指定します。 スケジュールとscheduleIdのいずれか1つのみを指定する必要があることに注意してください。
すべてに一致
Show Source
ネストされたスキーマ : RequestSystemProperties
タイプ: object
Show Source
  • 過去の実行時間を持つ繰返しリクエストのインスタンスを生成するかどうかを指定するプロパティ。 インスタンスは、リクエストされた開始時間より前またはリクエストされた終了時間より後に生成されません。 リクエストされたnullの開始時間は、デフォルトで現在の時間になります。 過去のインスタンスを生成するには、このプロパティをtrueに設定し、リクエストされた開始時間をインスタンスを生成する初期時間として指定する必要があります。 このプロパティの有効な値は次のとおりです: true -- リクエストされた開始時間からリクエストされた終了時間までに指定した範囲内にあるスケジュールで指定されたすべてのインスタンスは、生成時間に関係なく生成されます。過去(つまり生成時間より前)にスケジュールされた実行時間を持つfalseインスタンスは生成されません。 このプロパティが指定されていない場合、使用されるシステムのデフォルトはtrueです。
  • リクエスト処理優先度を指定するプロパティ。 優先度間隔は[0..9]で、0が最低の優先度、9が最高です。 このプロパティが指定されていない場合、使用されるシステムのデフォルト値は4です。
  • リクエストを発行したアプリケーション内の製品を指定するプロパティ。
  • リクエストのラベルを指定するプロパティ。 ラベルを使用すると、リソースの最適化のためにジョブ・リクエストをグループ化できます。
  • リクエスト・ロギングのログ・レベルを指定するプロパティ。 このプロパティの値はスケジューラによって内部的に使用されませんが、ジョブに渡して使用できます。
  • プロセッサが実行開始後に非同期を待機する時間を分単位で指定するプロパティ。 時間が経過すると、リクエストはタイムアウトとしてマークされます。 リクエストの状態にその他の直接的な影響はありません。 このプロパティが指定されていない場合、システムのデフォルトはタイムアウトになりません。
  • 失敗したリクエストの再試行制限を指定するプロパティ。 リクエストの実行が失敗した場合、リクエストが成功するまで、このプロパティで指定された回数までリクエストが再試行されます。 再試行制限がゼロ(0)の場合、失敗したリクエストは再試行されません。 このプロパティが指定されていない場合、使用されるシステムのデフォルトは0です。
ネストされたスキーマ : type
タイプ: object
Show Source
ネストされたスキーマ : CallbackSubscriptionRequest
タイプ: object
コールバック停止エンドポイントの呼出しに必要なプロパティの典型的なセット。 これらのプロパティは、securitySchemeに従って指定する必要があります。
Show Source
  • アイデンティティ・ストアからアクセス・トークンを取得するためのURL。 このプロパティは、通常、DIRECT_OAUTHセキュリティ・スキームに必要です。
  • RESTリソースの相対パスを指定するプロパティ。 ベース・リソースURLは、callbackUrlPrefixプロパティで指定されます。 このプロパティは、すべてのセキュリティ・スキームに必要です。
  • リソースの完全なURLを提供するためにcallbackResourcePathプロパティとともに使用できるRESTリソースのベースURLを指定するプロパティ。 このプロパティは、すべてのセキュリティ・スキームに必要です。
  • クライアント登録時にOAuthサーバーによって発行されるclientIdで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
  • クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
  • クライアントのCSFキーを設定するプロパティ。 Eg: "idcs.client.credentials". これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。 このプロパティは、通常、OWSM_LPAセキュリティ・スキームに必要です。
  • 許可された値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]
    "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"の中から1つ。 指定しない場合、デフォルトはOWSM_GPAとみなされます。 OWSM_LPAの場合、クライアントからアタッチされたデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。 "OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ" oracle.wsm.security "の下のCSFで構成されていることを確認する必要があります。 "DIRECT_OAUTHセキュリティ"スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバはclientIdおよびシークレットがIDCSで構成されていることを確認する必要があります。
ネストされたスキーマ : RequestExecutionContextIn
タイプ: object
現在のジョブ・リクエストのリクエスト実行コンテキスト。 この識別子は、サブリクエストの作成時にのみ使用されます。
Show Source
  • 実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中インスタンスの不透明な識別子を表します。 この値は、実行の開始時にジョブ・リクエストに指定された情報から取得できます。
  • この操作を起動しているリクエストの識別子です。 実行の開始時にジョブ・リクエストに指定された情報から取得できます。
ネストされたスキーマ : requestParameters
タイプ: array
リクエスト送信パラメータ
Show Source
ネストされたスキーマ : ScheduleBase
タイプ: object
Show Source
ネストされたスキーマ : RequestParameter
タイプ: object
リクエスト・パラメータ。
Show Source
ネストされたスキーマ : 除外
タイプ: array
Show Source
ネストされたスキーマ : 包含
タイプ: array
Show Source
ネストされたスキーマ : 繰り返し
タイプ: array
一連の繰返し。 生成されるスケジュールのオカレンスは、個々の繰り返しによって生成されるオカレンスの和になります。
Show Source
ネストされたスキーマ : 繰返し
タイプ: object
Show Source
  • この繰り返しオブジェクトの終了日時を設定します。 オブジェクトは、秒までの時間のみを抽出します。 ミリ秒精度はサポートされていません。 値はISO 8601形式の文字列です。
  • スケジュールで使用する繰返しパターンを定義します。 文字列はRFC 5445 RRULEに準拠している必要があります。 UNTIL、COUNT、BYSETPOS、WKSTなどの制限はサポートされていません。 RRULEのBY*句(Rotors)には、最小値 -1を指定できます。たとえば、BYDAY=-2MO(second to last monday)はサポートされていません。 BYMONTHおよびBYWEEKNOは、1つのRECUR式に存在できません。 BYDAY、BYMONTHDAYおよびBYYEARDAYは、1つのRECUR式に存在できません。
  • この繰り返しオブジェクトの開始日時を設定します。 オブジェクトは、秒までの時間のみを抽出します。 ミリ秒精度はサポートされていません。 値はISO 8601形式の文字列です。
トップに戻る

レスポンス

サポートされているメディア・タイプ

201 レスポンス

OK
Headers
本文 ()
ルート・スキーマ : CreateRequestResponse
タイプ: object
Show Source

400 レスポンス

入力が無効です
本文 ()
ルート・スキーマ : SimpleExceptionDetail
タイプ: object
Show Source

403 レスポンス

この操作には使用できません
本文 ()
ルート・スキーマ : SimpleExceptionDetail
タイプ: object
Show Source

404 レスポンス

見つかりません
本文 ()
ルート・スキーマ : SimpleExceptionDetail
タイプ: object
Show Source

409 レスポンス

競合
本文 ()
ルート・スキーマ : SimpleExceptionDetail
タイプ: object
Show Source

500 レスポンス

スケジューリング・サブシステム・エラー
本文 ()
ルート・スキーマ : SimpleExceptionDetail
タイプ: object
Show Source
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行して、新しいジョブ・リクエストを作成する方法を示しています。

curl -i -u "<username>:<password>" -X POST http://servername.fa.us2.oraclecloud.com/ess/rest/scheduler/ess/rest/scheduler/v1/requests

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: HTTP/1.1 200 OK
Content-Type : application/json

レスポンス本文の例

次の例に、コールバック通知を有効にした送信リクエストのレスポンス本文のコンテンツ(JSON形式)を示します:

{
  "description": "Test request1",
  "jobDefinitionId": "JobDefinition://oracle/as/ess/test/FUNC_TEST_PROD/MyJavaSucJobDef",
  "application": "ESS_FUNCTIONAL_TESTS_LOGICAL_NAME",
  "product": "GENERAL-LEDGER",
  "requestParameters": [
    {
      "name": "Test_param",
      "paramType": "STRING",
      "value": "param1"
    }
  ],
  "callbackSubscription":
  {
      "callbackUrlPrefix": "http://servername.fa.us2.oraclecloud.com",
      "callbackResourcePath": "/nr/receiver/v1/receive"
  }
}

レスポンス本文の例

次の例は、コールバック通知を有効にしないリクエストを送信するためのJSON形式のレスポンス本文のコンテンツを示しています:

{
"description": "subrequest1",
"jobDefinitionId": "JobDefinition://oracle/as/ess/test/FUNC_TEST_PROD/MyJavaSucJobDef",
"application": "EssDemoApp",
"product": "GENERAL-LEDGER",
"requestExecutionContext": {
"requestHandle": "9b2272f2_08fc_4c59_9d92_29fa123f71a7",
"requestId": 2241
},
"requestParameters": [
{
"name": "Test_param",
"paramType": "STRING",
"value": "param1"
}
]
}

レスポンス本文の例

次の例に、コールバック通知が有効になっている繰返しリクエストを送信するためのJSON形式のレスポンス本文の内容を示します(繰返しのparentIdがレスポンスで返されます):

{
  "description": "Test request1",
  "jobDefinitionId": "JobDefinition://oracle/as/ess/test/FUNC_TEST_PROD/MyJavaSucJobDef",
  "application": "ESS_FUNCTIONAL_TESTS_LOGICAL_NAME",
  "product": "GENERAL-LEDGER",
  "requestParameters": [
    {
      "name": "Test_param",
      "paramType": "STRING",
      "value": "param1"
    }
  ],
  "callbackSubscription":
  {
      "callbackUrlPrefix": "http://servername.fa.us2.oraclecloud.com",
      "callbackResourcePath": "/nr/receiver/v1/receive"
  },
  "schedule": {
    "recurrences": [
      {
        "icalString": "FREQ=MINUTELY;INTERVAL=1;"
      }
    ]
  }
}
「トップに戻る」