動的マッピングタスク
REST APIを使用して動的マッピングタスクを作成し、同じマッピングに基づくジョブをまとめることができます。タスクを実行して、ジョブの詳細を取得することもできます。
動的マッピングタスクには、次のリソースを使用します。
- •Login。Informatica Intelligent Cloud Servicesにログインし、動的タスクREST API呼び出しで使用するセッションIDを取得するために使用します。
- •dynamictask。動的マッピングタスクを作成、表示、更新、または削除するために使用します。
- •job。動的マッピングタスク実行インスタンスの開始、停止、または詳細の取得に使用します。
これらのリソースを使用するときには、次のルールに注意してください。
- •JSON形式を使用する。
- •次のURLを使用します。
<serverUrl>/batch-mapping/api/v1/<API name>
- •次の要求ヘッダー形式を使用します。
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>
サーバーのURLには、組織が使用するPODの名前とリージョン、およびInformatica Intelligent Cloud Servicesドメインのinformaticacloud.comが含まれます。組織のPODの名前とリージョンがわからない場合は、ユーザーインタフェースを使用してInformatica Intelligent Cloud Servicesにログインして見つけることができます。POD情報は、ブラウザのアドレスバーにあります。
次の例では、https://usw3.dm-us.informaticacloud.comがサーバーのURLです。
https://usw3.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/home
サーバーURLをREST API呼び出しのヘッダーのベースURLとして使用します。
注: HTTPバージョンを自動的に含めるPostmanなどのツールを使用する場合は、URLにHTTPバージョンを入力しないでください。HTTPバージョンがURLに2回出現すると、要求が失敗します。
ログインしています
呼び出しのヘッダーにIDS-SESSION-IDを必要とするリソースを使用する場合に、このリソースを使用してInformatica Intelligent Cloud Servicesにログインします。正常なログイン応答には、IDS-SESSION-IDが含まれます。
POST要求
次のURLを使用します。
<login URL>/identity-service/api/v1/Login
ログインURLには、組織が所在するリージョンとInformatica Intelligent Cloud Servicesドメインのinformaticacloud.comが含まれます。Informatica Intelligent Cloud Servicesログインページを開くと、組織のログインリージョンを見つけることができます。リージョンのログインURLは、Informatica Intelligent Cloud Servicesにログインする前のブラウザのアドレスバーにあります。
次の例では、https://dm-us.informaticacloud.comがリージョンURLです。
https://dm-us.informaticacloud.com/identity-service/home
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
username | String | ○ | Informatica Intelligent Cloud Servicesのユーザー名。 最大長は255文字です。 |
password | String | ○ | Informatica Intelligent Cloud Servicesのパスワード。 最大長は255文字です。 |
POST応答
要求が成功すると、ユーザーオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
後続の要求の応答で返されたセッションIDを使用します。
ユーザーオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
|---|
sessionId | String | 現在のセッションのREST APIセッションID。最も正確なREST API要求ヘッダーに使用します。 |
sessionExpireTime | String | セッションが期限切れになる時間。 |
id | String | ユーザーID。 |
name | String | Informatica Intelligent Cloud Servicesのユーザー名。 |
currentOrgId | String | 現在の組織ID。 |
currentOrgName | String | 現在の組織の名前。 |
parentOrgId | String | 親組織のID。 |
orgId | String | ユーザーが属する組織のID。 |
orgName | String | ユーザーが属する組織の名前。 |
groups | String | ユーザーグループ。 |
effectiveRoles | String | ユーザーに割り当てられたロール。 |
effectivePrivileges | String | ユーザーに割り当てられた特権。 |
status | String | ユーザーのステータス。 |
timeZoneId | String | ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、 タイムゾーンのコードを参照してください。 |
authenticator | String | ユーザー認証方法。 |
動的マッピングタスクの詳細の取得
このリソースを使用して、動的マッピングタスクの詳細を要求します。動的マッピングタスクを作成、更新、または削除することもできます。
詳細を要求するか既存の動的タスクを更新するには、タスクIDが必要です。V3ルックアップリソースを使用してタスクのIDを取得できます。V3ルックアップリソースでオブジェクトの詳細をルックアップするには、次のURIを使用します。
/saas/public/core/v3/lookup
次の例に示すように、オブジェクトタイプとしてBATCH_MAPPINGを含めます。
{
"objects": [
{
"path": "Default/DMT_API",
"type": "BATCH_MAPPING"
}
]
}
次の例に示すように、応答はパス内のオブジェクトに関する詳細を返します。
{
"objects": [
{
"id": "7H67JPHH9Y4g7Hm7JyL5K2",
"path": "Default/DMT_API",
"type": "BATCH_MAPPING",
"description": "",
"updatedBy": "rl.ma",
"updateTime": "2021-08-27T23:45:14Z"
}
]
}
V3ルックアップリソースの使用方法の詳細については、
ルックアップを参照してください。
データ統合ユーザーインタフェースでタスクを開いて、タスクIDを見つけることもできます。URLの最後の文字列がタスクIDです。
例えば、次のURLのタスクIDは771b8ZpTcfreXm8n5RZUQ5です。
https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/dynamicmapping/771b8ZpTcfreXm8n5RZUQ5
GET要求
動的マッピングタスクの詳細を要求するには、タスクIDを使用します。
次のURIを使用して、動的マッピングタスクの詳細を要求します。
/batch-mapping/api/v1/dynamictask/<id>
GET応答
要求されたタスクIDのdynamictaskオブジェクトを返します。
エラーが発生した場合にエラーオブジェクトを返します。
次の表にdynamictaskオブジェクトの属性を示します。
フィールド | タイプ | 説明 |
|---|
name | String | 動的マッピングタスクの名前。 |
mappingId | String | タスクで使用されるマッピングのID。 |
mappingDocType | String | タスクで使用されるマッピングのタイプ。 |
runtimeEnvironmentId | String | タスクに使用されるランタイム環境。 |
groups | | 動的マッピングタスクのグループ。 |
groupName | String | グループオブジェクトに含まれます。 グループの名前。 |
enabled | Boolean | グループオブジェクトに含まれます。 グループが有効かどうかを示します。 グループが有効な場合はtrueを返します。 |
parameters | | 動的マッピングタスクのパラメータ。 |
name | String | パラメータオブジェクトに含まれます。 パラメータの名前。 |
type | String | パラメータオブジェクトに含まれます。 パラメータのタイプ。 |
txName | String | パラメータオブジェクトに含まれます。 パラメータを使用するトランスフォーメーションの名前。 |
uniqueName | String | パラメータオブジェクトに含まれます。 トランスフォーメーション名とパラメータ名。トランスフォーメーション名が存在しない場合は、パラメータ名。 |
scope | String | パラメータオブジェクトに含まれます。 パラメータのスコープ（DEFAULTまたはLOCAL）。 |
label | String | パラメータオブジェクトに含まれます。 パラメータラベル。 |
description | String | パラメータオブジェクトに含まれます。 パラメータの説明。 |
retentionPolicy | String | パラメータオブジェクトに含まれます。 入出力パラメータに適用できます。タスクが現在のパラメータ値を保持するタイミングを決定します。 |
aggregationType | String | パラメータオブジェクトに含まれます。 入出力パラメータに適用できます。パラメータが実行する計算のタイプ。 |
job | | 動的マッピングタスクのジョブ。 |
jobName | String | ジョブオブジェクトに含まれます。 ジョブの名前。 |
jobType | String | ジョブオブジェクトに含まれます。 ジョブのタイプ（USERまたはDEFAULT）。 |
enabled | Boolean | ジョブオブジェクトに含まれます。 ジョブを有効にするかどうかを決定します。 デフォルトはfalseです。 |
stopOnError | Boolean | ジョブオブジェクトに含まれます。 エラーが発生したときにジョブを停止します。 デフォルトはfalseです。 |
stopOnWarning | Boolean | ジョブオブジェクトに含まれます。 警告が発生したときにジョブを停止します。 デフォルトはfalseです。 |
preProcessingCmds | String | ジョブオブジェクトに含まれます。 タスクの前に実行するコマンドのリスト。 |
postProcessingCmds | String | ジョブオブジェクトに含まれます。 タスクの後に実行するコマンドのリスト。 |
advSessionProperties | マップ | ジョブオブジェクトに含まれます。 ジョブに設定されている詳細セッションプロパティのマップ。 |
group | String | ジョブオブジェクトに含まれます。 ユーザーが属しているグループの名前。 |
paramValueBindings | | ジョブオブジェクトに含まれます。 ジョブのパラメータ属性。 |
paramDefnRef | String | paramValueBindingsオブジェクトに含まれます。 パラメータの一意の名前。 |
type | String | paramValueBindingsオブジェクトに含まれます。 パラメータのタイプ。値には次のいずれかのタイプを指定できます。 - - 接続
- - 文字列
- - ソース
- - ターゲット
- - INOUT
- - シーケンス
|
connection | | 接続タイプパラメータの属性。 |
connectionId | String | paramValueBindingsオブジェクトに含まれます。 接続ID。 |
connectionType | String | paramValueBindingsオブジェクトに含まれます。 接続タイプ。 |
runtimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 接続のランタイム属性。 |
oprRuntimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
source | | ソースタイプパラメータの属性。 |
sourceObject | Object | paramValueBindingsオブジェクトに含まれます。 ソースオブジェクト。 |
advancedFilterExpression | String | paramValueBindingsオブジェクトに含まれます。 詳細フィルタ条件。 |
filterFields | オブジェクトのリスト | paramValueBindingsオブジェクトに含まれます。 フィルタフィールドのリスト。 |
sortFields | オブジェクトのリスト | paramValueBindingsオブジェクトに含まれます。 ソートフィールドのリスト。 |
srcFFAttrs | Object | paramValueBindingsオブジェクトに含まれます。 フラットファイル属性。 |
ccmDataFormat | Object | paramValueBindingsオブジェクトに含まれます。 データ形式 |
customQuery | String | paramValueBindingsオブジェクトに含まれます。 カスタムクエリ |
handleSpecialChars | Boolean | paramValueBindingsオブジェクトに含まれます。 タスクが特殊文字を使用できるかどうかを決定します。 |
runtimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 ランタイム属性 |
oprRuntimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
string | | 文字列タイプパラメータの属性。 |
text | String | paramValueBindingsオブジェクトに含まれます。 パラメータのテキスト値。 |
target | | ターゲットタイプパラメータの属性。 |
objectName | String | paramValueBindingsオブジェクトに含まれます。 既存のターゲットオブジェクトの名前。 |
objectLabel | String | paramValueBindingsオブジェクトに含まれます。 既存のターゲットオブジェクトのラベル。 |
newObjectName | String | paramValueBindingsオブジェクトに含まれます。 新しいターゲットファイルの名前。 |
truncateTarget | Boolean | paramValueBindingsオブジェクトに含まれます。 データ統合がターゲットを切り詰めるかどうかを決定します。 |
bulkApiDBTarget | Boolean | paramValueBindingsオブジェクトに含まれます。 Bulk APIを使用するかどうかを決定します。 |
operationType | String | paramValueBindingsオブジェクトに含まれます。 タスク操作。 |
tgtFFAttrs | String | paramValueBindingsオブジェクトに含まれます。 フラットファイル属性。 |
tgtObjectAttributes | マップ | paramValueBindingsオブジェクトに含まれます。 ターゲットオブジェクト属性。 |
runtimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 ランタイム属性 |
oprRuntimeAttrs | マップ | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
ccmDataFormat | Object | paramValueBindingsオブジェクトに含まれます。 CCIターゲットのデータ形式。 |
dynamicFileName | Boolean | paramValueBindingsオブジェクトに含まれます。 ターゲットファイル名が動的であるかどうかを決定します。 |
handleSpecialChars | Boolean | paramValueBindingsオブジェクトに含まれます。 ターゲットオブジェクトが特殊文字を処理するかどうかを決定します。 |
INOUT | | INOUTタイプパラメータの属性。 |
initialValue | String | paramValueBindingsオブジェクトに含まれます。 入出力パラメータの初期値。 |
datatype | String | paramValueBindingsオブジェクトに含まれます。 パラメータのデータ型。 |
precision | String | paramValueBindingsオブジェクトに含まれます。 パラメータの精度。 |
scale | String | paramValueBindingsオブジェクトに含まれます。 パラメータの位取り。 |
retentionPolicy | String | paramValueBindingsオブジェクトに含まれます。 タスクが現在のパラメータ値を保持するタイミングを決定します。 |
aggregationType | String | paramValueBindingsオブジェクトに含まれます。 パラメータが実行する計算のタイプ。 |
currentValue | String | paramValueBindingsオブジェクトに含まれます。 入出力パラメータの現在の値。 |
シーケンス | | シーケンスタイプパラメータの属性。 |
txName | String | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの名前。 |
initialValue | String | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの初期値。 |
value | String | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの現在の値。 |
POST要求
動的マッピングタスクを作成するには、次のURIを使用します。
/batch-mapping/api/v1/dynamictask
タスクに場所を指定する場合、要求にコンテナIDをクエリパラメータとして含めます。コンテナIDが要求に含まれていない場合、タスクはDefaultフォルダに作成されます。データ統合ユーザーインタフェースでプロジェクトまたはフォルダのコンテナIDを検索できます。［エクスプローラ］ページで、フォルダを選択します。URLのコンテナIDの最後の文字列。
例えば、次のURLのコンテナIDはdH2DuGJYda7ijgW4Sm32sRです。
https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/Explore/dH2DuGJYda7ijgW4Sm32sR
次の表に、dynamictaskオブジェクトに含めることができる属性を示します。
フィールド | タイプ | 必須 | 説明 |
|---|
name | String | ○ | 動的マッピングタスクの名前。 |
mappingId | String | ○ | タスクで使用されるマッピングのID。 |
mappingDocType | String | ○ | タスクで使用されるマッピングのタイプ。次のいずれかのタイプを含めます。 - - MAPPING。詳細モード以外のマッピングに使用します。
- - AT_SCALE_MAPPING。詳細モードのマッピングに使用します。
|
runtimeEnvironmentId | String | ○ | タスクに使用されるランタイム環境。 |
groups | | | 動的マッピングタスクのグループ。 |
groupName | String | ○ | グループオブジェクトに含まれます。 グループの名前。 |
enabled | Boolean | | グループオブジェクトに含まれます。 グループが有効かどうかを示します。 |
parameters | | | 動的マッピングタスクのパラメータ。 |
name | String | ○ | パラメータオブジェクトに含まれます。 マッピングのパラメータの名前。 |
type | String | ○ | パラメータオブジェクトに含まれます。 パラメータのタイプ。次のいずれかのタイプを含めます。 - - SOURCE_CONNECTION
- - SOURCE_OBJECT
- - TARGET_CONNECTION
- - TARGET_OBJECT
- - LOOKUP_CONNECTION
- - LOOKUP_OBJECT
- - TRANSFORM_CONNECTION
- - STRING
- - GROUPBY
- - FIELD
- - EXPRESSION
- - EXPRESSION_FIELDS
- - CONDITION
- - FIELD_MAPPING
- - SORTLIST
- - INOUT_INT
- - INOUT_BIGINT
- - INOUT_STRING
- - INOUT_TEXT
- - INOUT_DECIMAL
- - INOUT_DOUBLE
- - INOUT_DATETIME
- - SEQUENCE
|
txName | String | | パラメータオブジェクトに含まれます。 パラメータを使用するトランスフォーメーションの名前。 |
uniqueName | String | ○ | パラメータオブジェクトに含まれます。 トランスフォーメーション名とパラメータ名。トランスフォーメーション名が存在しない場合は、パラメータ名。 |
Scope | String | ○ | パラメータオブジェクトに含まれます。 パラメータのスコープ（defaultまたはlocal）。 |
label | String | | パラメータオブジェクトに含まれます。 パラメータラベル。 |
description | String | | パラメータオブジェクトに含まれます。 パラメータの説明。 |
retentionPolicy | String | | パラメータオブジェクトに含まれます。 入出力パラメータに適用できます。タスクが現在のパラメータ値を保持するタイミングを決定します。 以下のいずれかの値を使用します。 - - ON_SUCCESS_OR_WARNING
- - ON_SUCCESS
- - ON_WARNING
- - NEVER
|
aggregationType | String | | パラメータオブジェクトに含まれます。 入出力パラメータに適用できます。パラメータが実行する計算のタイプ。 以下のいずれかの値を使用します。 |
job | | | 動的マッピングタスクのジョブ。 |
jobName | String | ○ | ジョブオブジェクトに含まれます。 ジョブの名前。 |
jobType | String | ○ | ジョブオブジェクトに含まれます。 ジョブのタイプ。USERまたはDEFAULTのいずれかを使用します。 |
enabled | Boolean | | ジョブオブジェクトに含まれます。 ジョブを有効にするかどうかを決定します。 デフォルトはfalseです。 |
stopOnError | Boolean | | ジョブオブジェクトに含まれます。 エラーが発生したときにジョブを停止します。 デフォルトはfalseです。 |
stopOnWarning | Boolean | | ジョブオブジェクトに含まれます。 警告が発生したときにジョブを停止します。 デフォルトはfalseです。 |
preProcessingCmds | String | | ジョブオブジェクトに含まれます。 タスクの前に実行するコマンドのリスト。 |
postProcessingCmds | String | | ジョブオブジェクトに含まれます。 タスクの後に実行するコマンドのリスト。 |
advSessionProperties | マップ | | ジョブオブジェクトに含まれます。 ジョブに設定されている詳細セッションプロパティのマップ。 |
group | String | ○ | ジョブオブジェクトに含まれます。 ユーザーが属しているグループの名前。 |
paramValueBindings | | | 各ジョブのパラメータ属性。 |
paramDefnRef | String | はい | paramValueBindingsオブジェクトに含まれます。 パラメータの一意の名前。 |
type | String | ○ | paramValueBindingsオブジェクトに含まれます。 パラメータのタイプ。次のいずれかのタイプを使用します。 - - 接続
- - 文字列
- - ソース
- - ターゲット
- - INOUT
- - シーケンス
|
connection | | | 接続タイプパラメータの属性。 |
connectionId | String | | paramValueBindingsオブジェクトに含まれます。 接続ID。 |
connectionType | String | | paramValueBindingsオブジェクトに含まれます。 接続タイプ。次のいずれかのタイプを使用します。 - - SOURCE
- - TARGET
- - LOOKUP
- - TRANSFORM
|
runtimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 接続のランタイム属性。 |
oprRuntimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
source | | | ソースタイプパラメータの属性。 |
sourceObject | Object | | paramValueBindingsオブジェクトに含まれます。 ソースオブジェクト。 |
advancedFilterExpression | String | | paramValueBindingsオブジェクトに含まれます。 詳細フィルタ条件。 |
filterFields | オブジェクトのリスト | | paramValueBindingsオブジェクトに含まれます。 フィルタフィールドのリスト。 |
sortFields | オブジェクトのリスト | | paramValueBindingsオブジェクトに含まれます。 ソートフィールドのリスト。 |
srcFFAttrs | Object | | paramValueBindingsオブジェクトに含まれます。 フラットファイル属性。 |
ccmDataFormat | Object | | paramValueBindingsオブジェクトに含まれます。 CCIソースのデータ形式。 |
customQuery | String | | paramValueBindingsオブジェクトに含まれます。 カスタムクエリ。 |
handleSpecialChars | Boolean | | paramValueBindingsオブジェクトに含まれます。 タスクが特殊文字を使用できるかどうかを決定します。 |
runtimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 ソースのランタイム属性。 |
oprRuntimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
string | | | 文字列タイプパラメータの属性。 |
text | String | | paramValueBindingsオブジェクトに含まれます。 パラメータのテキスト値。 |
target | | | ターゲットタイプパラメータの属性。 |
objectName | String | | paramValueBindingsオブジェクトに含まれます。 既存のターゲットオブジェクトの名前。 |
objectLabel | String | | paramValueBindingsオブジェクトに含まれます。 既存のターゲットオブジェクトのラベル。 |
newObjectName | String | | paramValueBindingsオブジェクトに含まれます。 新しいターゲットファイルの名前。 |
truncateTarget | Boolean | | paramValueBindingsオブジェクトに含まれます。 データ統合がターゲットを切り詰めるかどうかを決定します。 |
bulkApiDBTarget | Boolean | | paramValueBindingsオブジェクトに含まれます。 Bulk APIを使用するかどうかを決定します。 |
operationType | String | | paramValueBindingsオブジェクトに含まれます。 タスク操作。 |
tgtFFAttrs | String | | paramValueBindingsオブジェクトに含まれます。 フラットファイル属性。 |
tgtObjectAttributes | マップ | | paramValueBindingsオブジェクトに含まれます。 ターゲットオブジェクト属性。 |
runtimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 ランタイム属性。 |
oprRuntimeAttrs | マップ | | paramValueBindingsオブジェクトに含まれます。 読み取り/書き込みランタイム属性。 |
ccmDataFormat | Object | | paramValueBindingsオブジェクトに含まれます。 CCIターゲットのデータ形式。 |
dynamicFileName | Boolean | | paramValueBindingsオブジェクトに含まれます。 ターゲットファイル名が動的であるかどうかを決定します。 |
handleSpecialChars | Boolean | | paramValueBindingsオブジェクトに含まれます。 ターゲットオブジェクトが特殊文字を処理するかどうかを決定します。 |
INOUT | | | INOUTタイプパラメータの属性。 |
initialValue | String | | paramValueBindingsオブジェクトに含まれます。 入出力パラメータの初期値。 |
datatype | String | | paramValueBindingsオブジェクトに含まれます。 パラメータのデータ型。 |
precision | String | | paramValueBindingsオブジェクトに含まれます。 パラメータの精度。 |
scale | String | | paramValueBindingsオブジェクトに含まれます。 パラメータの位取り。 |
retentionPolicy | String | | paramValueBindingsオブジェクトに含まれます。 タスクが現在のパラメータ値を保持するタイミングを決定します。以下のいずれかの値を使用します。 - - ON_SUCCESS_OR_WARNING
- - ON_SUCCESS
- - ON_WARNING
- - NEVER
|
aggregationType | String | | paramValueBindingsオブジェクトに含まれます。 パラメータが実行する計算のタイプ。以下のいずれかの値を使用します。 |
currentValue | String | | paramValueBindingsオブジェクトに含まれます。 入出力パラメータの現在の値。 |
シーケンス | | | シーケンスタイプパラメータの属性。 |
txName | String | | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの名前。 |
initialValue | String | | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの初期値。 |
value | String | | paramValueBindingsオブジェクトに含まれます。 シーケンストランスフォーメーションの現在の値。 |
POST応答
成功した場合、作成または更新したdynamictaskオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
PUT要求
動的マッピングタスクを更新するには、次の例に示すように、タスクIDを含めます。
/batch-mapping/api/v1/dynamictask/<Id>
動的マッピングタスクを更新するときは、POST要求と同じ属性を含めます。
PUT応答
次の例に示すように、タスクID、状態、および検証エラーを返します。
{
"frsId": "1JVMWZjVPMhKY4SdxcGd60",
"state": "VALID",
"validationErrors": []
}
DELETE要求
動的マッピングタスクを削除するには、次のURIのタスクIDを使用します。
/batch-mapping/api/v1/dynamictask/<id>
DELETE応答
要求に成功した場合に200の応答コードを返します。
エラーが発生した場合にエラーオブジェクトを返します。
POSTの例
REST APIで新しい動的マッピングタスクを作成するには、次の要求を使用できます。
POST https://na1.dm-us.informaticacloud.com/batch-mapping/api/v1/dynamictask
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: jpaybAKQMsmdt7vLJ02z0s
{
"orgId": "2ij4X7Pd63ibnquEQyy9wA",
"name": "DMT_API",
"description": "",
"mappingId": "01003Y1700000000005X",
"mappingDocType": "MAPPING",
"runtimeEnvironmentId": "01003Y25000000000004",
"scheduleId": null,
"state": "VALID",
"groups": [
{
"groupName": "Group_1",
"enabled": true
},
{
"groupName": "Group_2",
"enabled": false
}
],
"parameters": [
{
"uniqueName": "Source:SrcCon",
"name": "SrcCon",
"txName": "Source",
"type": "SOURCE_CONNECTION",
"scope": "DEFAULT",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Source:SrcObj",
"name": "SrcObj",
"txName": "Source",
"type": "SOURCE_OBJECT",
"scope": "LOCAL",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Target:TrgCon",
"name": "TrgCon",
"txName": "Target",
"type": "TARGET_CONNECTION",
"scope": "DEFAULT",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Target:TrgObj",
"name": "TrgObj",
"txName": "Target",
"type": "TARGET_OBJECT",
"scope": "LOCAL",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Lookup:Lkcon",
"name": "Lkcon",
"txName": "Lookup",
"type": "LOOKUP_CONNECTION",
"scope": "DEFAULT",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Lookup:lkObj",
"name": "lkObj",
"txName": "Lookup",
"type": "LOOKUP_OBJECT",
"scope": "DEFAULT",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "Lkp",
"name": "Lkp",
"txName": null,
"type": "EXPRESSION",
"scope": "LOCAL",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
},
{
"uniqueName": "ExParam",
"name": "ExParam",
"txName": null,
"type": "EXPRESSION",
"scope": "LOCAL",
"label": null,
"description": "",
"retentionPolicy": null,
"aggregationType": null
}
],
"jobs": [
{
"jobUUID": "ae1lR3k2ccYgXNeFQe4DIT",
"jobName": "<Default>",
"jobType": "DEFAULT",
"enabled": false,
"stopOnError": false,
"stopOnWarning": false,
"preProcessingCmds": [],
"postProcessingCmds": [],
"advSessionProperties": {},
"paramValueBindings": [
{
"type": "Connection",
"paramDefnRef": "Source:SrcCon",
"connectionId": "01003Y0B000000000006",
"connectionType": null,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
},
{
"type": "Connection",
"paramDefnRef": "Target:TrgCon",
"connectionId": "01003Y0B00000000001Q",
"connectionType": null,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
},
{
"type": "Connection",
"paramDefnRef": "Lookup:Lkcon",
"connectionId": "01003Y0B00000000001Q",
"connectionType": null,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
},
{
"type": "Source",
"paramDefnRef": "Lookup:lkObj",
"sourceObject": {
"name": "EMP",
"label": "EMP",
"metadataUpdated": false
},
"advancedFilterExpression": null,
"userDefinedJoin": null,
"filterFields": [],
"sortFields": [],
"srcFFAttrs": null,
"overriddenFields": [],
"ccmDataFormat": null,
"customQuery": null,
"handleSpecialChars": false,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
}
],
"group": null
},
{
"jobUUID": "21rswJo8MnOgUTtfCq96AR",
"jobName": "Job_1",
"jobType": "USER",
"enabled": true,
"stopOnError": false,
"stopOnWarning": false,
"preProcessingCmds": [],
"postProcessingCmds": [],
"advSessionProperties": {},
"paramValueBindings": [
{
"type": "Source",
"paramDefnRef": "Source:SrcObj",
"sourceObject": {
"name": "employee.csv",
"label": "employee.csv",
"metadataUpdated": false
},
"advancedFilterExpression": null,
"userDefinedJoin": null,
"filterFields": [],
"sortFields": [],
"srcFFAttrs": null,
"overriddenFields": [],
"ccmDataFormat": null,
"customQuery": null,
"handleSpecialChars": false,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
},
{
"type": "Target",
"paramDefnRef": "Target:TrgObj",
"objectName": "CONTACT",
"objectLabel": "CONTACT",
"newObjectName": null,
"truncateTarget": false,
"bulkApiDBTarget": false,
"operationType": null,
"tgtFieldRefs": {},
"targetUpdateColumns": [],
"tgtFFAttrs": null,
"tgtObjectAttributes": {},
"runtimeAttrs": {},
"oprRuntimeAttrs": {},
"handleSpecialChars": false,
"ccmDataFormat": null,
"dynamicFileName": false
},
{
"type": "String",
"paramDefnRef": "Lkp",
"text": " EMP_ID||EMP_NAME"
},
{
"type": "String",
"paramDefnRef": "ExParam",
"text": " IsNull(EMP_ID)"
}
],
"group": "Group_1"
},
{
"jobUUID": "6pavcOH4kwZewe1XL1khoF",
"jobName": "Job_2",
"jobType": "USER",
"enabled": true,
"stopOnError": false,
"stopOnWarning": false,
"preProcessingCmds": [],
"postProcessingCmds": [],
"advSessionProperties": {},
"paramValueBindings": [
{
"type": "Source",
"paramDefnRef": "Source:SrcObj",
"sourceObject": {
"name": "Boston_Customers.csv",
"label": "Boston_Customers.csv",
"metadataUpdated": false
},
"advancedFilterExpression": null,
"userDefinedJoin": null,
"filterFields": [],
"sortFields": [],
"srcFFAttrs": null,
"overriddenFields": [],
"ccmDataFormat": null,
"customQuery": null,
"handleSpecialChars": false,
"runtimeAttrs": {},
"oprRuntimeAttrs": {}
},
{
"type": "Target",
"paramDefnRef": "Target:TrgObj",
"objectName": "CUSTINFO_TYPE",
"objectLabel": "CUSTINFO_TYPE",
"newObjectName": null,
"truncateTarget": false,
"bulkApiDBTarget": false,
"operationType": null,
"tgtFieldRefs": {},
"targetUpdateColumns": [],
"tgtFFAttrs": null,
"tgtObjectAttributes": {},
"runtimeAttrs": {},
"oprRuntimeAttrs": {},
"handleSpecialChars": false,
"ccmDataFormat": null,
"dynamicFileName": false
},
{
"type": "String",
"paramDefnRef": "Lkp",
"text": "NAME=Firstname"
},
{
"type": "String",
"paramDefnRef": "ExParam",
"text": "Firstname||Lastname"
}
],
"group": "Group_2"
}
]
}
動的マッピングタスクの実行
REST APIを使用して動的マッピングタスクを実行する場合、REST APIバージョン1のジョブリソースを使用して、ジョブを開始または停止します。また、ジョブの詳細を取得することもできます。
動的マッピングタスクのステータスを取得する場合は、プラットフォームREST APIバージョン2のジョブリソースは使用しないでください。
組織でプロジェクトやフォルダを使用している場合は、REST APIバージョン3のルックアップリソースを使用してタスクIDを取得します。これにより、フェデレーションタスクIDが返されます。POST要求にはこのIDを含める必要があります。
GET要求
動的マッピングタスクの詳細を取得するには、次のタスクURIを使用します。
/batch-mapping/api/v1/Job/monitor/task/<Id>/run/<runId>
GET応答
成功した場合、ジョブのステータスを返します。
失敗すると、応答にエラーの理由が含まれます。
例えば、完了した動的マッピングタスクの詳細を要求すると、次の応答が返される場合があります。
{
"taskId": "jUJNIX39Z6ZbR8KZCm2ieS",
"taskFrsId": "k2AE77O06oYg6NvrOtKt6t",
"taskName": "Dynamic Mapping Task2",
"instanceId": 1,
"startedBy": "user@informatica.com",
"startTime": "2021-08-26T16:28:11.000Z",
"updateTime": "2021-08-26T16:28:35.000Z",
"endTime": "2021-08-26T16:28:35.000Z",
"runtimeEnvironment": "test1",
"runtimeEnvironmentId": "01000025000000000002",
"status": "COMPLETED",
"successRows": 3,
"errorRows": 0,
"saasMappingId": "01000017000000000007",
"mappingName": "dsst__copy_data_new_tgt_With_SortList",
"mappingFrsId": "5A90bRPboO0dpMQ8F2nkgy",
"mappingDocType": "MAPPING",
"runContext": "API",
"scheduleName": null,
"jobs": [
{
"jobName": "Job_1",
"jobUUID": "78OZ7JlUNSCd09kwQWXbUf",
"groupName": "Group_1",
"saasJobRunId": 52,
"saasLogId": "010000C100000000040H",
"startTime": "2021-08-26T16:28:18.000Z",
"updateTime": "2021-08-26T16:28:33.000Z",
"endTime": "2021-08-26T16:28:33.000Z",
"errorMessage": null,
"status": "COMPLETED",
"failedSourceRows": 0,
"successSourceRows": 3,
"failedTargetRows": 0,
"successTargetRows": 3,
"enabled": true,
"sessionLogUrl": null
}
]
}
POST要求の開始
動的マッピングタスクを作成するには、次のURIを使用します。
/batch-mapping/api/v1/Job
次の例のように、フェデレーションタスクIDを要求に含めます。
{
"taskFrsId": "k2AE77O06oYg6NvrOtKt6t"
}
POST応答の開始
実行IDとフェデレーションタスクIDを返します。
例えば、動的マッピングタスクを2回実行すると、次の応答が返されます。
{
"runId": 2,
"taskFrsId": "k2AE77O06oYg6NvrOtKt6t"
}
POST要求の停止
動的マッピングタスクの実行を停止するには、次のURIを使用します。
/batch-mapping/api/v1/Job/stop
次の例に示すように、タスクID属性とジョブ実行ID属性をジョブオブジェクトに含めます。
{
"taskFrsId": "gScmpuSzjSdcbNPFNYbbcg",
"runId": 10
}
POST応答の停止
要求が成功すると、200 Successオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。