マッピング
このリソースを使用して、1つのマッピングの詳細、組織内のすべてのマッピングの詳細またはマッピングのイメージを要求します。また、マッピング内のすべてのトランスフォーメーションまたは特定のトランスフォーメーションタイプの詳細プロパティやシーケンスジェネレータの詳細など、トランスフォーメーションの詳細を取得する要求も送信できます。
マッピング詳細の取得
組織内のすべてのマッピングの詳細や特定のマッピングの詳細を取得できます。
GET要求
マッピングの詳細を取得するには、次のURIのいずれかを使用します。
- 組織内のすべてのマッピングの詳細
- 組織内のすべてのマッピングの詳細を要求するには、次のURIを使用します。
/api/v2/mapping
- 特定のマッピングの詳細
- 特定のマッピングの詳細を要求するには、URIにマッピングIDまたはマッピング名を含めます。次のいずれかのURIを使用します。
/api/v2/mapping/<id>
/api/v2/mapping/name/<name>
- URIのマッピング名を使用して、マッピング名の値にスペースが含まれる場合、そのスペースを%20に置き換えます。以下に例を示します。
/api/v2/mapping/name/my%20mapping
- 次のURIがある名前によって特定のマッピングを要求することもできます。
/api/v2/mapping/search?name=<name>
GET応答
正常に実行された場合、要求したマッピングのマッピングオブジェクトを返します。
すべてのマッピングの詳細を要求した場合、パラメータの詳細を除く組織内のすべてのマッピングのマッピングオブジェクトを返します。
エラーが発生した場合にエラーオブジェクトを返します。
マッピングオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
|---|
id | String | マッピングID。 |
orgId | String | 組織ID。 |
name | String | マッピング名。 |
description | String | マッピングの説明。 |
createTime | Date/Time | マッピングが作成された日時。 |
updateTime | Date/Time | マッピングの最終更新日時。 |
createdBy | String | マッピングを作成したユーザー。 |
updatedBy | String | マッピングを最後に更新したユーザー。 |
bundleObjectId | String | マッピングを含むバンドルのID(該当する場合)。 |
bundleVersion | String | マッピングを含むバンドルのバージョン(該当する場合)。 |
templateId | String | マッピングを表示するために内部で作成したテンプレートのID。 |
deployTime | Date/Time | マッピングがデプロイされた日時。 |
hasParameters | Boolean | マッピングにパラメータが含まれるかどうかを示します。trueまたはfalseを返します。 |
valid | Boolean | マッピングが有効かどうかを示します。trueまたはfalseを返します。 |
fixedConnection | Boolean | マッピングに固定された接続があるかどうかを示します。trueまたはfalseを返します。 |
hasParametersDeployed | Boolean | マッピングにデプロイされたパラメータがあるかどうかを示します。trueまたはfalseを返します。 |
fixedConnectionDeployed | Boolean | マッピングにデプロイされた固定された接続があるかどうかを示します。trueまたはfalseを返します。 |
deployedTemplateId | String | デプロイされたマッピングを表示するために内部で作成されたテンプレートのID。 |
tasks | Int | マッピングを使用するタスクの数。 |
parameters | | マッピングで使用されるパラメータ。各パラメータのmtTaskParameterオブジェクトが含まれます。 |
id | Long | mtTaskParameterオブジェクトに含まれます。 パラメータID。 |
name | String | mtTaskParameterオブジェクトに含まれます。 パラメータ名。 |
type | String | mtTaskParameterオブジェクトに含まれます。 パラメータのタイプ。 |
description | String | mtTaskParameterオブジェクトに含まれます。 パラメータの説明。 |
customFuncId | String | マップレットタイプのパラメータのマップレットID。 |
uiProperties | String | mtParameterオブジェクトに含まれます。 パラメータのプロパティを表示します。以下の情報が含まれます。 - - cnxtype。パラメータの接続タイプ。
- - logcnx。論理接続。
- - order。表示順序。
- - wizstep。パラメータを表示するウィザードステップ。
- - default。デフォルト値。
- - visible。パラメータが表示可能かどうか。
- - editable。パラメータが編集可能かどうか。
- - required。パラメータが必要かどうか。
- - paramtype。文字列パラメータのUIコントロールタイプ。次のいずれかの応答を返します。
- - 条件。検索条件のプロンプト。
- - 式。式エディタのプロンプト。
- - フィールド。フィールド選択のプロンプト。
- - フィールドマップ。フィールドマッピングのプロンプト。以下の属性が含まれます。
- - lefttitle。フィールドマッピング表示の左側のタイトル。
- - righttitle。フィールドマッピング表示の右側のタイトル。
- - leftfs。フィールドマッピング表示の左側のテーブルに表示するフィールドのセット。
- - rightfs。フィールドマッピング表示の右側のテーブルに表示するフィールドのセット。
- - leftfilter。フィールドマッピング表示の左側のテーブルに表示されるフィールドを制限する正規表現。
- - rightfilter。フィールドマッピング表示の右側のテーブルに表示されるフィールドを制限する正規表現。
- - staticlist。フィールドマッピング表示の右側に表示するフィールドのリスト。
|
inOutParameters | | マッピングに使用される入出力パラメータ。各入出力パラメータのmtTaskInOutParameterオブジェクトが含まれます。 |
id | Long | mtTaskInOutParameterオブジェクトに含まれます。 パラメータID。 |
name | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータ名。 |
description | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータの説明。 |
initialValue | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータの初期値。 |
datatype | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータのデータ型。 |
precision | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータの精度。 |
scale | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータの位取り。 |
retentionPolicy | String | mtTaskInOutParameterオブジェクトに含まれます。 タスクがカレント値を保持するときを決定します。 |
aggregationType | String | mtTaskInOutParameterオブジェクトに含まれます。 タスクが実行されるパラメータの最後のカレント値を決定します。 |
currentValue | String | mtTaskInOutParameterオブジェクトに含まれます。 パラメータのカレント値。 |
mappingPreviewFileRecordId | String | マッピングのプレビュー時に使用されるイメージファイルのID。 |
deployedMappingPreviewFileRecordId | String | デプロイされたマッピングのプレビュー時に使用されるイメージファイルのID。 |
references | | リファレンス情報。参照オブジェクトを返します。次の属性が含まれます。 |
refObjectId | String | 参照オブジェクトに含まれます。 |
refType | String | 参照オブジェクトに含まれます。 |
トランスフォーメーションの詳細の取得
マッピング内のすべてのトランスフォーメーションの詳細やマッピング内の特定のタイプのトランスフォーメーションの詳細を取得できます。
GET要求
トランスフォーメーションの詳細を取得するには、次のURIのいずれかを使用します。
- マッピング内のすべてのトランスフォーメーションの詳細
- マッピング内のすべてのトランスフォーメーションの詳細を含めるには、次のいずれかのURIを使用します。
/api/v2/mapping/additionalTransformationInfo/<mapping ID>
/api/v2/mapping/additionalTransformationInfoByName/<mapping name>
- マッピング内の特定のトランスフォーメーションタイプのトランスフォーメーションの詳細
- 特定のトランスフォーメーションタイプのトランスフォーメーションの詳細を含めるには、次のようにURIに?txType=<transformation type>を含めます。
/api/v2/mapping/additionalTransformationInfoByName/m_MyMapping?txType=Sequence
GET応答
成功した場合、マッピングのトランスフォーメーションの詳細を返します。詳細には、トレースレベルや、シーケンストランスフォーメーションがマッピングに含まれている場合はシーケンス情報などの詳細プロパティが含まれることがあります。
注: トランスフォーメーションに詳細プロパティが指定されている場合、応答にはトランスフォーメーションのすべての詳細プロパティの値が含まれます。トランスフォーメーションに詳細プロパティが指定されていない場合、デフォルト値が使用されていても、応答には詳細プロパティの値は含まれません。
エラーが発生した場合にエラーオブジェクトを返します。
応答には次の属性が含まれます。
フィールド | タイプ | 説明 |
|---|
id | String | マッピングID。 |
orgId | String | 組織ID。 |
name | String | マッピング名。 |
description | String | マッピングの説明。 |
createTime | Date/Time | マッピングが作成された日時。 |
updateTime | Date/Time | マッピングの最終更新日時。 |
createdBy | String | マッピングを作成したユーザー。 |
updatedBy | String | マッピングを最後に更新したユーザー。 |
templateId | String | マッピングを表示するために内部で作成したテンプレートのID。 |
valid | Boolean | マッピングが有効かどうかを示します。trueまたはfalseを返します。 |
additionalAttributes | | 追加のマッピング属性。 |
specialCharacterSupport | ブール | additionalAttributesオブジェクトで返されます。 マッピングのフィールド名が特殊文字に対応しているかどうか、または特殊文字をアンダースコア(_)に置き換えるかどうか。 |
allowMaxFieldLength | ブール | additionalAttributesオブジェクトで返されます。 マッピングのフィールド名を最大255文字まで指定できるかどうか。255文字を超える名前は切り詰めされます。デフォルトはfalseです。 |
transformations | オブジェクト | 詳細トランスフォーメーションプロパティとシーケンスの詳細。 |
transformationProperties | オブジェクト | マッピング内の各トランスフォーメーションのプロパティ、または特定のトランスフォーメーションタイプのプロパティ(要求した場合)。 |
名前 | 文字列 | トランスフォーメーション名。 |
txType | 文字列 | トランスフォーメーションタイプ。 |
advancedProperties | オブジェクト | transformationPropertiesオブジェクトで返されます。 トランスフォーメーションの詳細プロパティ。応答に含まれるプロパティはトランスフォーメーションタイプや接続タイプによって異なります。 |
sequences | オブジェクト | マッピングにシーケンストランスフォーメーションが含まれている場合は、マッピングのシーケンス情報。 |
sequenceStateDefinition | オブジェクト | マッピング内の各シーケンストランスフォーメーションのプロパティ。 |
名前 | 文字列 | シーケンストランスフォーメーションの名前。 |
txType | 文字列 | トランスフォーメーションタイプ。 |
cycle | ブール | マッピングタスクがシーケンスの範囲でサイクル動作を実行するかどうか。 |
endValue | 文字列 | マッピングタスクが生成する最大値。 |
incrementBy | 文字列 | 生成されるシーケンスでの2つの連続する値の差。 |
numberOfCachedValues | 文字列 | マッピングタスクによって各実行でキャッシュされるシーケンス値の数。 |
reset | ブール | リセットが有効かどうか。 |
sharedSequenceId | 文字列 | 共有シーケンスのID(有効な場合)。 |
initialValue | 文字列 | シーケンスの初期値。 |
cycleStartValue | 文字列 | マッピングタスクが使用する生成シーケンスの開始値。 |
useSharedSequence | ブール | シーケンストランスフォーメーションが共有シーケンスを使用するかどうか。 |
GETの例
特定のマッピング内のすべてのトランスフォーメーションの詳細を要求するには、次の要求を使用できます。
GET <serverUrl>/api/v2/mapping/additionalTransformationInfoByName/m_Mapping26
Content-type: application/xml
Accept: application/xml
icSessionId: ABCdOrJmd6YUtmK123
成功した場合、次の例のような応答が返されます。
{
"@type": "mappingAdditionalInfo",
"id": "0100001700000000123G",
"orgId": "012300",
"name": "m_Mapping26",
"description": "",
"createTime": "2026-03-27T00:35:37.000Z",
"updateTime": "2026-03-27T00:35:37.000Z",
"createdBy": "orguser",
"updatedBy": "orguser",
"autoExpireObject": false,
"templateId": "stringIdentity:0100000X0000000123IY",
"valid": false,
"documentType": "MAPPING",
"additionalAttributes": {
"specialCharacterSupport": false,
"allowMaxFieldLength": false
},
"transformations": [
{
"@type": "transformationProperties",
"name": "Source",
"txType": "TmplSource",
"advancedProperties": {
"Tracing Level": "Verbose Data"
}
},
{
"@type": "transformationProperties",
"name": "Target",
"txType": "TmplTarget",
"advancedProperties": {
"Thousand Separator": ",",
"Datetime Format": "",
"Forward Rejected Rows": "true",
"Decimal Separator": ","
}
},
{
"@type": "transformationProperties",
"name": "Sequence",
"txType": "TmplGenerator",
"advancedProperties": {
"Tracing Level": "Verbose Data",
"Optional": "true"
}
},
{
"@type": "transformationProperties",
"name": "Expression",
"txType": "TmplExpression",
"advancedProperties": {
"Tracing Level": "Verbose Initialization",
"Optional": "true"
}
},
{
"@type": "transformationProperties",
"name": "Lookup",
"txType": "TmplLookup",
"advancedProperties": {
"Cache File Name Prefix": "",
"Lookup Index Cache Size": "AUTO",
"Optional": "true",
"Lookup cache persistent": "false",
"Lookup source is static": "false",
"Lookup Sql Override": "",
"Update Dynamic Cache Condition": "TRUE",
"Re-cache from lookup source": "false",
"Lookup caching enabled": "true",
"Insert Else Update": "false",
"Tracing Level": "Verbose Initialization",
"Lookup Data Cache Size": "AUTO",
"Subsecond Precision": "6",
"Lookup cache directory name": "$PMCacheDir",
"Output Old Value On Update": "false",
"Lookup Source Filter": "",
"Dynamic Lookup Cache": "false",
"Pre-build lookup cache": "AUTO",
"Synchronize dynamic cache": "false"
}
}
],
"sequences": [
{
"@type": "sequenceStateDefinition",
"name": "Sequence",
"txType": "TmplGenerator",
"cycle": false,
"endValue": "9223372036854775807",
"incrementBy": "3",
"numberOfCachedValues": "150",
"reset": false,
"sharedSequenceId": "",
"initialValue": "2",
"cycleStartValue": "0",
"useSharedSequence": false
}
]
}
マッピングのイメージの取得
マッピングのイメージを要求できます。
マッピングのイメージを要求するには、マッピングIDと、マッピングをデプロイするかどうかを指定します。次のURIを使用します。
/api/v2/mapping/<id>/image?deployed=<true|false>
例:
/api/v2/mapping/N0A1700000000001J/image?deployed=true