REST APIリファレンス

前へ次へ

マッピング

このリソースを使用して、組織内の1つのマッピングの詳細またはすべてのマッピングの詳細を要求します。

GET要求

マッピングするGET要求を使用して次の情報を要求できます。

組織内のすべてのマッピングの詳細。

特定のマッピングの詳細。

マッピングのイメージ。

組織内のすべてのマッピングの詳細。: 組織内のすべてのマッピングの詳細を要求するには、次の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>
マッピングのイメージ: マッピングのイメージを要求するには、マッピングIDと、マッピングをデプロイするかどうかを指定します。次のURIを使用します。
/api/v2/mapping
/<id>
/image?deployed=<true|false>
以下に例を示します。
/api/v2/mapping/N0A1700000000001J/image?deployed=true

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の例

組織内のすべてのマッピングの詳細を要求するには、次の要求を使用できます。

GET <serverUrl>/api/v2/mapping 
Accept: application/xml
icSessionId: <icSessionId>

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

マッピング

マッピング

GET要求

GET応答

GETの例