REST APIリファレンス > データ統合 REST API > Data Integration REST APIの補足情報

Data Integration REST APIの補足情報

このセクションには、ユーザーインタフェースのフィールドに対するコネクタのデータ型や接続REST API属性のマッピングなどの補足情報が含まれています。

コネクタのデータ型

コネクタメタデータの要求を送信する場合、データ型が応答に含まれます。コネクタ属性のデータ型は、数値を使用してREST API応答で返されます。

次の例は、タイプ値2を使用した応答を示しています。

{
"name": "database",
"label": "",
"id": "",
"value": "",
"type": 2,
"isMandatory": true,
"visible": false,
"list": []
},

タイプ値2とは、データベースの属性にアルファベットのみを含めることができることを意味します。

次の表に、応答に含めることのできる数値と対応するデータ型を一覧表示します。

値	データタイプ	説明
1	NUMERIC_TYPE	属性値には数字のみを含めることができます。
2	ALPHABET_TYPE	属性値にはアルファベットのみ含めることができます。
3	NUMERIC_TYPE/ALPHABET_TYPE	属性値には数字またはアルファベットのみを含めることができます。
4	SYMBOLS_TYPE	属性値には記号のみ含めることができます。
5	NUMERIC_TYPE/SYMBOLS_TYPE	属性値には数字と記号のみを含めることができます。
6	ALPHABET_TYPE/SYMBOLS_TYPE	属性値にはアルファベットと記号のみ含めることができます。
7	NUMERIC_TYPE/ALPHABET_TYPE/SYMBOLS_TYPE	属性値にはアルファベット、数字、および記号のみ含めることができます。
8	LIST_TYPE	属性値には事前定義済みリストの値のみ含めることができます。
9	NUMERIC_TYPE/LIST_TYPE	属性値には事前定義済みリストにある数字のみ含めることができます。
10	ALPHABET_TYPE/LIST_TYPE	属性値には事前定義済みリストにある数字のみ含めることができます。
11	NUMERIC_TYPE/ALPHABET_TYPE/LIST_TYPE	属性値には事前定義済みリストにあるアルファベットと数字のみ含めることができます。
12	SYMBOLS_TYPE/LIST_TYPE	属性値には事前定義済みリストにある記号のみ含めることができます。
13	NUMERIC_TYPE/SYMBOLS_TYPE/LIST_TYPE	属性値には事前定義済みリストにある数字および記号のみ含めることができます。
14	ALPHABET_TYPE/SYMBOLS_TYPE/LIST_TYPE	属性値には事前定義済みリストにあるアルファベットおよび記号のみ含めることができます。
15	NUMERIC_TYPE/ALPHABET_TYPE/SYMBOLS_TYPE/LIST_TYPE	属性値には事前定義済みリストにあるアルファベット、数字、および記号のみ含めることができます。
16	BOOLEAN	属性値はbooleanです。
32	PASSWORD	属性値はpasswordです。

コネクタメタデータの要求に関する詳細については、コネクタを参照してください。

REST APIの属性マッピングに対する接続のユーザーインタフェースフィールド

ユーザーインタフェースの接続フィールド名の中には、接続リソースの対応するREST API属性に直観的にマップされないものがあります。また、接続リソースのREST API GETおよびPOSTメソッドに使用される属性名の中には、ユーザーインタフェースに表示される値を入力するREST API応答で使用する属性名と一致しないものがあります。

次の表では、混乱する可能性のある相関を持つユーザーインタフェースのフィールド、REST API GET呼び出しとPOST呼び出しで使用される属性、およびユーザーインタフェースに対するREST API応答で使用される属性を対応付けています。

接続	UIフィールド名	REST API GETおよびPOSTの属性名	UIに対する応答の属性名
すべての接続	ランタイム環境	runtimeEnvironmentId	agentGroupId
CSVフラットファイル	ディレクトリ	database	dirName
FTPおよびSFTP	ディレクトリ	database	dirName
Microsoft Access	データソース名	database	database
Microsoft SQL Server	SQL Serverのバージョン	type	subType
Oracle	サービス名	database	database
SAP IDoc Reader	接続先エントリ	database	database
SAP IDoc WriterおよびSAP RFC/BAPI	接続文字列	database	database
Web Service Consumer	エンドポイントURL	serviceUrl	serviceUrl