REST APIリファレンス

前へ次へ

接続

このリソースを使用して、組織の接続の詳細を要求します。また、接続の作成、更新、テスト、削除も実行できます。

GET要求の詳細

接続のGET要求を使用して、次の詳細を要求できます。

組織のすべての接続の詳細。

組織の特定の接続に関する詳細。

特定の接続でソースまたはターゲットとして使用できるオブジェクトのリスト。

Secure Agentまたはランタイム環境と関連付けられる特定のタイプの接続のリスト。

指定した接続のメタデータの詳細。

「DI Data Preview_」で始まる名前の接続は使用しないでください。

組織内のすべての接続の詳細。: 組織内のすべての接続の詳細を要求するには、次のURIを使用します。
/api/v2/connection
特定の接続の詳細: 特定の接続の詳細を要求するには、URIに接続IDまたは名前を含めます。次のいずれかのURIを使用します。
/api/v2/connection/<id>

/api/v2/connection/name/<name>
URIに接続名を使用し、その接続名にスペースが含まれる場合は、スペースを
%20
で置き換えます。以下に例を示します。
/api/v2/connection/name/my%20connection
ソースまたはターゲットとして使用できるオブジェクトのリスト: ソースまたはターゲットとして使用できるオブジェクトを要求できます。ソースオブジェクトまたはターゲットオブジェクトを要求するには、URIに接続IDまたは接続名のいずれかを含めることができます。次のいずれかのURIを使用します。
/api/v2/connection/source/<id>

/api/v2/connection/target/<id>

/api/v2/connection/source/name/<name>

/api/v2/connection/target/name/<name>
URIに接続名を使用し、その接続名にスペースが含まれる場合は、スペースを
%20
で置き換えます。以下に例を示します。
/api/v2/connection/target/name/my%20connection; 多数のオブジェクトを受け取ることが想定される場合は、次のパラメータのいずれかを含めることができます。
searchPattern。searchPatternパラメータを使用して結果をフィルタリングし、指定した文字列がオブジェクト名に含まれるオブジェクトのみが応答として返されるようにします。searchPatternパラメータを使用するには、次のURIを使用します。
/api/v2/connection/<source or target>/<id>?searchPattern=<pattern>

例えば、次の要求では、オブジェクト名に「abc」が含まれるソースオブジェクトが返されます。
/api/v2/connection/source/002D420000000J?searchPattern=abc

maxRecordsCount。maxRecordsCountパラメータを使用して、返されるオブジェクトの最大数を設定します。maxRecordsCountを使用するには、次のURIを使用します。
/api/v2/connection/<source or target>/<id>?maxRecordsCount=<max number of objects>

例えば、次の要求は最大5000個のソースオブジェクトを返します。
/api/v2/connection/source/002D420000000J?maxRecordsCount=5000

maxRecordsCountパラメータを含めない場合、この要求により最大200個のオブジェクトが返されます。
Secure Agentまたはランタイム環境と関連付けられる特定のタイプの接続リスト: Secure Agent IDおよび接続タイプごとの接続リストを要求するには、次のURIを使用します。
/api/v2/connection/search?agentId=<agentId>&uiType=<uiType>; ランタイム環境IDおよび接続タイプごとの接続リストを要求するには、次のURIを使用します。
/api/v2/connection/search?runtimeEnvironmentId=<runtimeEnvironmentId>&uiType=<uiType>; agentIdとruntimeEnvironmentIdの両方を渡した場合は、サービスでruntimeEnvironmentIdが使用され、agentIdは無視されます。agentIdのみを渡した場合は、サービスでagentIdを対応するruntimeEnvironmentIdに変換してからリソースをリポジトリに保存します。
指定した接続のメタデータの詳細: 指定した接続のメタデータの詳細を要求するには、次のURIを使用します。
/api/v2/connection/source/<connection ID>/metadata

/api/v2/connection/target/<connection ID>/metadata
メタデータは、次の属性を含むruntimeAttributeオブジェクトに返されます。
name
dataType
defaultValue
label
mandatory
maxLength
sessionVarAllowed
possibleValues

次の接続要求URI属性を使用します。

フィールド	タイプ	必須	説明
agentId	String	-	Secure Agent ID
runtimeEnvironmentId	String	-	ランタイム環境ID。
uiType	String	○	接続タイプ。次のいずれかのオプションを使用します。 CSVFile。CSVフラットファイル。 FTP。 MS_ACCESS。 MSD。Microsoft Dynamics CRM。 MySQL。 ODBC。 Oracle。 OCOD。Oracle CRM On Demand。 Salesforce。 SFTP。セキュアFTP。 SAP_ALE_IDoc_Reader。SAP IDoc Reader。 SAP_ALE_IDoc_Writer。SAP IDoc Writer。 SqlServer。Microsoft SQL Server 2000。 SqlServer2005。Microsoft SQL Server 2005。 SqlServer2008。Microsoft SQL Server 2008。 SqlServer2012。Microsoft SQL Server 2012。 SqlServer2014。Microsoft SQL Server 2014。 SqlServer2016。Microsoft SQL Server 2016。 SqlServer2017。Microsoft SQL Server 2017。 TOOLKIT。Informatica Cloudコネクタ。NetSuite接続でも使用されます。 WebServicesConsumer。Webサービス。

GET応答の詳細

要求された接続IDの接続オブジェクトを返します。組織内のすべての接続に関する情報を要求すると、組織内の各接続に対する接続オブジェクトを返します。

ランタイム環境IDおよび接続タイプに基づく接続のリストを要求すると、要件に一致する各接続の接続オブジェクトを返します。

要求した接続IDで使用できるソースオブジェクトまたはターゲットオブジェクトのリストを要求すると、各使用可能なオブジェクトでconnListItemオブジェクトを返します。

エラーが発生した場合にエラーオブジェクトを返します。

接続オブジェクトには、接続タイプごとに異なる情報が含まれています。

次の表で、接続オブジェクトに含まれる属性について説明します。

フィールド	タイプ	説明
id	String	接続ID。
orgId	String	組織ID。
name	String	接続名。
description	String	接続の説明。
createTime	Date/Time	接続が作成された時刻。
updateTime	Date/Time	接続の最終更新時刻。
createdBy	String	接続を作成したユーザー。
updatedBy	String	接続を最後に更新したユーザー。
agentId	String	フラットファイル、FTP/SFTP、Microsoft SQL Server、MS Access、MySQL、ODBC、Oracle、Webサービス接続のSecure Agent ID。
runtimeEnvironmentId	String	接続で使用されるランタイム環境。これは、ユーザーインタフェースの［ランタイム環境］フィールドです。ユーザーインタフェースに返される応答では、この属性にagentGroupIdという名前が付いています。
instanceName	String	Microsoft SQL Serverインスタンス名。
host	String	FTP/SFTP、Microsoft SQL Server、MySQL、Oracle接続のホスト名。
domain	String	IFDまたはActive Directory認証を使用するMicrosoft Dynamics CRM接続、およびWebサービス接続のドメイン名。
dateFormat		フラットファイル、FTP、およびSFTP接続の日付形式。
database	String	以下の情報を返します。 Microsoft SQL ServerおよびMySQL接続では、データベース名を返します。フラットファイル接続では、ディレクトリを返します。 FTPおよびSFTP接続では、ローカルディレクトリを返します。 MS AccessおよびODBC接続では、データソース名を返します。 Oracle接続では、サービス名を返します。 SAP IDoc WriterおよびReader接続では、接続先エントリを返します。 Webサービス接続では、サービスURLを返します。
codepage		フラットファイル、FTP、SFTP、Microsoft SQL Server、MySQL、MS Access、ODBC、Oracle、SAPのコードページ。
clientCode	String	SAP IDoc Writer接続のクライアントコード。
authenticationType	String	Microsoft Dynamics CRM、Microsoft SQL Server、およびWebサービス接続の認証タイプ。
adjustedJdbcHostName	String	ホスト名。または、Microsoft SQL Server接続のホスト名およびインスタンス名。
accountNumber	String	NetSuite接続のアカウントID。
languageCode	String	SAP IDoc Writer接続の言語コード。
remoteDirectory	String	FTP/SFTP接続のリモートディレクトリ。
schema	String	Microsoft SQL Server、ODBC、Oracle、およびWebサービス接続のスキーマ名。
serviceUrl	String	Microsoft Dynamics CRM、Oracle CRM On Demand、およびSalesforce接続のサービスURL。
shortDescription	String	説明の最初の50文字。
type	String	接続タイプでは、次の応答のいずれかを返します。 CSVFile。CSVフラットファイル。 FTP。 MS_ACCESS。 MSD。Microsoft Dynamics CRM。 MySQL。 ODBC。 Oracle。 OCOD。Oracle CRM On Demand。 Salesforce。 SFTP。セキュアFTP。 SAP_ALE_IDoc_Reader。SAP IDoc Reader。 SAP_ALE_IDoc_Writer。SAP IDoc Writer。 SqlServer。Microsoft SQL Server 2000。 SqlServer2005。Microsoft SQL Server 2005。 SqlServer2008。Microsoft SQL Server 2008。 SqlServer2012。Microsoft SQL Server 2012。 SqlServer2014。Microsoft SQL Server 2014。 SqlServer2016。Microsoft SQL Server 2016。 TOOLKIT。Informatica Cloudコネクタ。 WebServicesConsumer。Webサービス。［接続］ページに表示されるユーザーインタフェースのフィールド名は、接続によって異なります。例えば、SQL Serverの場合、ユーザーインタフェースのフィールド名は［SQL Server Version］です。また、SQL Serverでは、ユーザーインタフェースに値を入力するREST API属性の名前がsubTypeとなります。
port	Int	FTP/SFTP、Microsoft SQL Server、MySQL、Oracle接続のポート番号。
password	String	接続のパスワード。
username	String	接続のユーザー名。
securityToken	String	Salesforce接続のセキュリティトークン。
stsUrl	String	Active Directory認証を使用するMicrosoft Dynamics CRM接続のセキュリティトークンサービスURL。
organizationName	String	Microsoft Dynamics CRM接続の組織名。
timeout	Int	Webサービス接続のタイムアウト。
trustCertificatesFile	String	Webサービス接続のトラスト証明書ファイル名。
certificateFile	String	Webサービス接続の証明書ファイル名。
certificateFilePassword	String	Webサービス接続の証明書ファイルのパスワード。
certificateFileType	String	Webサービス接続の証明書ファイルタイプ。
privateKeyFile	String	Webサービス接続のプライベートキーファイル名。
privateKeyPassword	String	Webサービス接続のプライベートキーのパスワード。
privateKeyFileType	String	Webサービス接続のプライベートキーファイルタイプ。
connParams	String	接続で使用されるパラメータ。 SAP、NetSuite、Oracle CRM On Demand、ODBC、またはその他のInformatica CloudコネクタのconnParamオブジェクトの接続属性が含まれます。
federatedId	String	接続のグローバル一意識別子。
内部	Boolean	接続がデータプレビューの目的でのみ内部的に作成されたかどうかを示します。
retryNetworkError	Boolean	内部目的でのみ使用されます。
supportsCCIMultiGroup	Boolean	内部目的でのみ使用されます。
connListItem		connListItemオブジェクトに含まれる接続のリスト。
id	String	connListItemオブジェクトに含まれています。ソースIDまたはターゲットID。
name	String	connListItemオブジェクトに含まれています。ソース名またはターゲット名。

GET要求のテスト

接続をテストするには、次のURIに接続IDを使用します。

/api/v2/connection/test/<id>

GET応答のテスト

テストに成功したら、成功したオブジェクトを返します。

エラーが発生した場合にエラーオブジェクトを返します。

POST要求

接続を作成または更新できます。接続を更新するには、次のURIで接続IDを使用します。接続を作成するには、オプションの接続IDを省略します。

/api/v2/connection/<id>

部分モードを使用して部分的な更新を送信できます。部分モードを使用して要求を送信するには、JSON要求を使用してヘッダーに次の行を含めます。

Update-Mode=PARTIAL

接続のPOST要求では、接続オブジェクトに追加の属性を使用します。Informatica Cloudコネクタ接続で使用される属性は、接続タイプごとに異なります。

Informatica Cloudコネクタ接続を作成または更新するには、接続で使用する属性にInformatica Cloudアプリケーションを検討します。connParamオブジェクトで次の表に記載されていない属性をすべて囲みます。

組織で使用可能な接続のリストおよび特定のコネクタタイプに対する属性情報を取得するには、コネクタを参照してください。

REST APIを使用した接続の作成に使用される属性およびデータ型の詳細については、REST APIの属性マッピングに対する接続のユーザーインタフェースフィールドおよびコネクタのデータ型を参照してください。

POST応答

正常に完了したら、作成または更新された接続の接続オブジェクトを返します。

エラーが発生した場合にエラーオブジェクトを返します。

DELETE要求

接続を削除するには、次のURIの接続IDを使用します。

/api/v2/connection/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。

エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

SAP Table接続を更新するには、次の要求でconnParamオブジェクトのSAP属性を囲んで使用できます。

POST <serverUrl>/api/v2/connection/0002D420000000J
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<connection>
  <id>0002D420000000J</id>
  <orgId>00342000</orgId>
  <name>test dir</name>
  <type>TOOLKIT</type>
  <agentId>00001Y08000000000002</agentId>
  <username>username</username>
  <password>password</password>
  <instanceName>SAPTableConnector</instanceName>
  <connParams>
     <agentId>00001Y08000000000002</agentId>
     <username>username</username>
     <password>password</password>
     <client>800</client>
     <language>EN</language>
     <Saprfc Ini Path>C:\\Windows\\SysWOW64</Saprfc Ini Path>
     <Destination>GE6</Destination>
  </connParams>
  <runtimeEnvironmentId>00000C25000000000002</runtimeEnvironmentId>
</connection>

成功した要求は、更新した接続オブジェクトを返します。

Microsoft Dynamics CRM接続

Microsoft SQL Server接続

Oracle CRM On Demand接続