指定した開始期間と終了期間およびインポートまたはエクスポートのオプションに基づいて、Oracle Hyperion Financial Data Quality Management, Enterprise Editionデータ・ロード・ルールを実行します。
前提条件
データ・ルール: データ・ロード・ルールでは、統合によってファイルからデータをロードする方法を定義します。データをロードするには、データ・ロード・ルールを事前に定義しておく必要があります。
特定のデータ・ルールの実行に必要が権限が必要です。
RESTリソース
POST /aif/rest/{api_version}/jobs
リクエスト
サポートされているメディア・タイプ: application/json
パラメータ
次の表に、クライアント・リクエストをまとめます。
表B-1 パラメータ
名前 | 説明 | タイプ | 必須 | デフォルト |
---|---|---|---|---|
api_version |
使用しているAPIのバージョン(V1など) | パス | あり | なし |
jobType |
"DATARULE"に設定します | あり | なし | |
jobName |
FDMEEに定義されているデータ・ロード・ルールの名前。ルール名に空白が含まれる場合は、引用符で囲む必要があります。 | あり | なし | |
startPeriod |
データがロードされる最初の期間。この期間名は、FDMEEの期間マッピングに定義されている必要があります。 | あり | なし | |
endPeriod |
データがロードされる最後の期間。この期間名は、FDMEEの期間マッピングに定義されている必要があります。 | あり | なし | |
importMode |
データをFDMEEにインポートする方法を決定します。 使用可能な値は次のとおりです。
|
あり | なし | |
exportMode |
データをFDMEEにエクスポートする方法を決定します。 Oracle Hyperion Planningアプリケーションに使用可能な値は次のとおりです。
Oracle Financial Consolidation and Close CloudおよびOracle Tax Reporting Cloudアプリケーションに使用可能な値は次のとおりです。
|
あり | なし | |
fileName |
オプションのファイル名。ファイル名を指定しないと、このAPIによって、データ・ロード・ルールに指定されたファイル名に含まれるデータがインポートされます。データ・ファイルは、データ・ルールの実行前に受信ボックスにすでに存在している必要があります。 | あり | なし |
URLの例
https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/aif/rest/V1/jobs
リクエスト本体の例
{"jobType":"DATARULE", "jobName":"aso to bso dr", "startPeriod":"Dec-18", "endPeriod":"Dec-18", "importMode":"REPLACE", "exportMode":"NONE", "fileName":"" }
レスポンス
サポートされているメディア・タイプ: application/json
表B-2 パラメータ
名前 | 説明 |
---|---|
|
ジョブのステータス: -1 = 進行中、0 = 成功、1 = エラー、2 = 保留の取消し、3 = 取消し済、4 = 無効なパラメータ |
jobStatus |
ジョブ・ステータスのテキスト表現で、次の値のいずれかです: "RUNNING"、"SUCCESS"。"FAILED" |
jobId |
FDMEEでジョブに対して生成されたプロセスID |
logFileName |
この実行のエントリが含まれるログ・ファイル。 |
outputFileName |
出力ファイルが生成された場合はそのファイル名。 |
processType |
実行されたプロセスのタイプ。すべてのデータ・ルールを実行する場合は、"COMM_LOAD_BALANCES"です |
executedBy |
ルールの実行に使用されたユーザーのログイン名。 |
details |
アプリケーション・エラーの場合は例外スタック・トレースを返します |
レスポンス本体の例
次に、JSON形式のレスポンス本体の例を示します。
{ "jobStatus": "RUNNING" "jobId": 2019 "logFileName": "\outbox\logs\Account Reconciliation Manager_2019.log" "outputFileName": null "processType": "COMM_LOAD_BALANCES" "executedBy": "admin" "status": -1 "links": [1] 0: { "rel": "self" "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/aif/rest/V1/jobs/2019" "action": "GET" } "details": null }