RESTの拡張
dataLoadDataSets RESTリソースが、次の処理のための新しいカスタム処理で拡張されました:
- データ・セットを処理するために発行された子プロセスのサブ・プロセス詳細の取得。
- データ・セットまたはデータ・セット内の個々のビジネス・オブジェクトの失敗した行のファイルの生成開始。
サブ・プロセス詳細の取得: HCMデータ・ローダーによって発行されたサブプロセスの詳細を、サブプロセス・カスタム処理を使用して取得できるようになりました。これには、データをインポートおよびロードするための個々のマルチスレッド・プロセスの詳細と、データ・セットの後に発行された後処理が含まれます。
サブプロセスのカスタム処理および属性の詳細:
| カスタム処理 |
http://:/hcmRestApi/resources/{version}/dataLoadDataSets/{RequestId}/ child/processes /{ProcessId}/subprocesses |
|---|---|
| サポートされるメソッド |
GET |
| 説明 |
特定のHCMデータ・ローダーのデータ・セット・プロセスによって発行されたサブプロセスの詳細が表示されます |
| エレメント | 説明 |
|---|---|
|
ProcessId |
プロセス・レコードの一意識別子。 |
|
ProcessCode |
プロセスのコード。 |
|
ProcessName |
プロセスの名前。 |
|
StartTime |
プロセス開始時間 |
|
EndTime |
プロセス終了時間 プロセスが終了した協定世界時(UTC)の日時。この値は、完全なISO 8601形式(YYYY-MM-DDThh:mm:ss.sTZD)で表示されます。 |
|
ElapsedTime |
プロセス実行時間。 プロセスが終了した協定世界時(UTC)の日時。この値は、完全なISO 8601形式(YYYY-MM-DDThh:mm:ss.sTZD)で表示されます。 |
|
RequestId |
要求の一意の識別子 |
|
ProcessStatus |
プロセスのステータス |
|
CreatedBy |
プロセスを発行したユーザーのユーザー名。 |
|
CreationDate |
プロセスが要求された日時。 |
|
LastUpdateDate |
プロセスの最終更新日時。 |
|
LastUpdatedBy |
プロセスを最後に更新したユーザーのユーザー名。 |
失敗した行のファイルの生成: dataLoadDataSetリソースとbusinessObjects子リソースの両方で使用可能なgenerateFailedLinesFileカスタム処理を使用するRESTを使用して、データ・セットまたはデータ・セット内の個々のビジネス・オブジェクトの失敗した行のファイルの生成を開始できるようになりました。
この機能拡張により、エラーが発生したHDLデータ・セットの失敗した行を含むファイルを抽出およびレビューできます。
dataLoadDataSets:generateFailedLinesFileカスタム処理、入力パラメータおよび応答の詳細:
| カスタム処理 |
http://<host>:<port>/hcmRestApi/resources/{version}/dataLoadDataSets/{requestId}/action/generateFailedLinesFile |
|---|---|
| サポートされるメソッド |
POST |
| 説明 |
エラーが発生したビジネス・オブジェクトの失敗した行およびMETADATAのファイルを生成するプロセスを発行します。 |
入力パラメータ:
| 属性名 | データ型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
|
includeMessagesFlag |
文字列 | いいえ | N |
生成されるファイルにエラー・メッセージを含めるかどうかを指定します。有効な値はYおよびNです。 |
| messageLanguage | 文字列 | いいえ | セッション言語 | 生成されるファイルに含めるエラー・メッセージの言語。セッション言語にデフォルト設定されます。 |
| fileEncryption |
文字列 |
はい |
生成されるdatファイルの暗号化タイプ。有効な値は、NONE、PGPSIGNEDおよびPGPUNSIGNEDです。 |
|
| encryptionKey |
文字列 |
If fileEncryption!=NONE |
失敗した行のファイルの暗号化時に使用する暗号化キー。有効なPGP証明書の名前を指定します。 fusion-key以外。 |
応答:
| 属性名 | データ型 | 説明 |
|---|---|---|
| Status | 文字列 | 要求のステータス - SUCCESSまたはERROR。 |
| RequestId | 整数 | 送信された要求の識別子。 |
|
ErrorFileContentId |
文字列 |
Oracle WebCenterで生成されたファイルを識別するコンテンツID。ファイルは、hcm$/dataloader$/export$フォルダに配置されます。 |
|
UserInfo |
文字列 |
エラー・メッセージまたは情報。 |
dataLoadDataSets/businessObjects:generateFailedLinesFileカスタム処理、入力パラメータおよび応答の詳細:
| カスタム処理 |
http://<host>:<port>/hcmRestApi/resources/{version}/dataLoadDataSets/{requestId}/child/businessObject/{dataSetBusObjectId}/action/generateFailedLinesFile |
|---|---|
| サポートされるメソッド |
POST |
| 説明 |
ビジネス・オブジェクトの失敗した行およびMETADATAのファイルを生成するプロセスを発行します。 |
入力パラメータ:
| 属性名 | データ型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
|
includeMessagesFlag |
文字列 | いいえ | N |
生成されるファイルにエラー・メッセージを含めるかどうかを指定します。有効な値はYおよびNです。 |
| messageLanguage | 文字列 | いいえ | セッション言語 |
生成されるファイルに含めるエラー・メッセージの言語。セッション言語にデフォルト設定されます。 |
| fileEncryption |
文字列 |
はい |
生成されるdatファイルの暗号化タイプ。有効な値は、NONE、PGPSIGNEDおよびPGPUNSIGNEDです。 |
|
| encryptionKey |
文字列 |
If fileEncryption!=NONE |
失敗した行のファイルの暗号化時に使用する暗号化キー。有効なPGP証明書の名前を指定します。 fusion-key以外。 |
応答:
| 属性名 | データ型 | 説明 |
|---|---|---|
| Status | 文字列 | 要求のステータス - SUCCESSまたはERROR。 |
| RequestId | 整数 | 送信された要求の識別子。 |
|
ErrorFileContentId |
文字列 |
Oracle WebCenterで生成されたファイルを識別するコンテンツID。ファイルは、hcm$/dataloader$/export$フォルダに配置されます。 |
|
UserInfo |
文字列 |
エラー・メッセージまたは情報。 |
有効化のステップ
REST APIガイドのRESTサービス定義を確認して利用してください(Oracle Help Center > 対象となるアプリケーション・サービス領域 > APIおよびスキーマからアクセスできます)。OracleのRESTサービスを初めて利用する場合は、クイック・スタートに関する項から開始してください。
HCMデータ・ローダーへのアクセスの構成チュートリアルにリストされているステップを使用して、HCMデータ・ローダーREST APIへのアクセスを設定します。
HCMデータ・ローダーREST APIチュートリアルを使用し、REST API処理を実行します。