This section describes the syntax to create or update connections. See the connection type for details. You cannot use the connection resource to create or update Informatica Cloud Connector connections.
You can use an agent GET request to retrieve the Secure Agent ID required for some connection types. To retrieve connection IDs, you can use a connection GET request.
When you pass both the connection ID and the connection name, the connection ID takes precedence. For example, if you pass a connection ID of 234 and a connection name of "MSD1", Informatica Cloud looks for a connection with the 234 ID. If it finds it, it updates the connection name to MSD1 as well as any other parameter updates that you pass. If it does not find the connection ID, it creates a new connection based on the parameters that you pass.
To create or update a CSV Flat File connection, use the following syntax.
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=CSVFile&database=<directory>&dateFormat=<date format>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
CSV Flat File Parameter
Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
CSV Flat File Parameter
Required/ Optional
Description
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use CSVFile. database Required Directory where flat files are stored.
dateFormat Required Date format for date fields in the flat file. Use a valid format, such as MM/dd/yyyy HH:mm:ss.
codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte.
- MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update an FTP/SFTP connection, use the following syntax.
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=<FTP|SFTP>&username=<user name>&password=<password>&host=<host name>&port=<port>&database=<local directory>&remoteDirectory=<remote dir>&dateFormat=<date
format>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
FTP/SFTP Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use FTP or SFTP. username Required User name.
password Required Password.
host Required Name of the machine hosting the database server or FTP/SFTP host. For a FTP/SFTP connection, enter the host name or IP address.
port Required Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP and 22 for SFTP.
FTP/SFTP Parameter Required/ Optional
Description
database Required Directory on a local machine that stores the local file.
The local machine must also run the Secure Agent used to run the corresponding task. Enter a local directory or use the Browse button to select a local directory.
remoteDirectory Required Directory on the FTP/SFTP host that stores the remote flat file.
Depending on the FTP/SFTP server, you may have limited options to enter directories. For more information, see the FTP/SFTP server documentation.
dateFormat Required Date format for date fields in the flat file. Use a valid format, such as MM/dd/yyyy HH:mm:ss.
codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte.
- MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update a Microsoft Dynamics CRM connection, use the following syntax.
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=MSD&authenticationType=<auth type>&username<user name>&password=<password>&organizationName=<MSD org name>&domain=<domain>&serviceUrl=<service URL>&stsUrl=<sts URL>&agentId=<Secure Agent ID>&responseType=<xml|json>
Microsoft Dynamics CRM Parameter
Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use MSD.
authenticationType Required Authentication type for the connection. Select a valid authentication type. Use one of the following authentication types:
- LIVE. Microsoft Live. Use for data synchronization tasks or PowerCenter tasks.
- IFD. Internet Facing Development (IFD). Use for data synchronization tasks or PowerCenter tasks.
- AD. Active Directory. Use for PowerCenter tasks only. username Required Microsoft Dynamics CRM user name.
Microsoft Dynamics CRM Parameter
Required/ Optional
Description
password Required Microsoft Dynamics CRM password. organizationName Required Microsoft Dynamics CRM organization name. domain Optional
Required for IFD and Active Directory authentication
Microsoft Dynamics CRM domain name. IFD and Active Directory authentication only.
serviceUrl Required URL of the Microsoft Dynamics CRM service.
For Microsoft Live authentication, use the following format: https:// <orgname>.crm.dynamics.com
For IFD authentication, use the following format: https://<server.company.com>:<port> For Active Directory, use the following format: http://<server.company.com>:<port> stsUrl Optional
Required for IFD authentication
Microsoft Dynamics CRM security token service URL. For example, https:// sts1.company.com.
IFD authentication only. agentId Optional
Required for Active Directory authentication
Secure Agent ID.
Active Directory authentication only.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options:
- json. Returns information in JSON. - xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update a MS Access connection, use the following syntax.
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=MS_ACCESS&database=<DSN>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
MS Access Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use MS_ACCESS.
MS Access Parameter Required/ Optional
Description
database Required Data source name.
codepage Required The code page compatible with the MS Access database. Use one of the following options:
- UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update a MySQL connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=MySQL&username=<username>&password=<password>&host=<host>&port=<po rt>&database=<database>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
MySQL Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use MySQL. username Required User name for the database login. password Required Password for the database login.
host Required Name of the machine hosting the database server.
port Required Network port number used to connect to the database server. Default is 3306. database Required Database name for the MySQL database target. Database name is case sensitive if the
database is case sensitive.
Maximum length is 64 characters. Valid characters are alphanumeric and underscore. codepage Required The code page of the database server. Use one of the following options:
- UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1.
MySQL Parameter Required/ Optional
Description
agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update an ODBC connection, use the following format:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=ODBC&username=<user
name>&password=<password>&database<DSN>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
ODBC Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use ODBC. username Required User name for the database login. password Required Password for the database login. database Required Data source name.
schema Optional
Required to connect to IBM DB2
Schema used for the target connection.
Use uppercase letters when you specify the schema name for an Oracle database.
Required to connect to an IBM DB2 database.
codepage Required The code page of the database server or flat file defined in the connection. Use one of the following options:
- UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options:
- json. Returns information in JSON. - xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update an Oracle connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=Oracle&username=<user
name>&password=<password>&host=<host>&port=<port>&database=<service
name>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
Oracle Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use Oracle. username Required User name for the database login. password Required Password for the database login.
host Required Name of the machine hosting the database server.
port Required Network port number used to connect to the database server. Default is 1521.
database Required Service name that uniquely identifies the Oracle database. If the connection fails, contact the database administrator.
schema Optional Schema used for the target connection.
codepage Required The code page of the database server. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte.
- MS1252. MS Windows Latin1 (ANSI), superset of Latin1.
agentId Required Secure Agent that Informatica Cloud uses to access the database in the local area network.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update an Oracle CRM On Demand connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=OCOD&username=<user name>&password=<password>&serviceUrl=<service URL>&responseType=<xml|json> Oracle CRM On Demand Parameter Required/ Optional Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
Oracle CRM On Demand Parameter
Required/ Optional
Description
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use OCOD.
username Required Oracle CRM On Demand user name. Use the following format: <domain>/<user name>
For example: domain/[email protected]. password Required Oracle CRM On Demand password.
serviceUrl Required URL of the Oracle CRM On Demand service. For example: https:// securecompany.crmondemand.com.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update a Salesforce connection, use the following syntax.
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=Salesforce&username=<user
name>&password=<password>&securityToken=<security token>&serviceUrl=<serviceURL>&responseType=<xml| json>
Salesforce Parameter Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use Salesforce. username Required User name for the Salesforce account. password Required Password for the Salesforce account.
securityToken Optional Security token associated with the user name and password. serviceUrl Required URL of the Salesforce service. Maximum length is 100 characters.
Default service URL is:
Salesforce Parameter Required/ Optional
Description
https://www.salesforce.com/services/Soap/u/22.0
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update an SAP IDoc Writer connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=SAP_ALE_IDoc_Writer&username=<user
name>&password=<password>&database=<destination entry>&languageCode=<language code>&clientCode=<client code>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
SAP IDoc Writer Parameter
Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection.
type Required Connection type. Use SAP_ALE_IDoc_Writer.
username Required SAP user name with authorization on S_DATASET, S_TABU_DIS, S_PROGRAM, and B_BTCH_JOB objects.
password Required Password for the SAP user name. database Required Type A DEST entry in saprfc.ini.
languageCode Required Language code that corresponds to the SAP language. A two-letter code, such as en for English.
clientCode Required SAP client number. A three-letter code.
codepage Required The code page compatible with the SAP target. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte.
- MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
To create or update an SAP IDoc Reader connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=SAP_ALE_IDoc_Reader&database=<destination entry>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>
SAP ALE IDoc Reader Parameter
Required/ Optional
Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection.
type Required Connection type. Use SAP_ALE_IDoc_Reader. database Required Type R DEST entry in saprfc.ini.
The Program ID for this destination entry must be the same as the Program ID for the logical system you defined in SAP to receive IDocs or consume business content data. For business content integration, set to INFACONTNT.
codepage Required The code page compatible with the SAP source. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte.
- MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentId Required Secure Agent ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
To create or update a Microsoft SQL Server connection, use the following syntax:
connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection
name>&description=<description>&type=<SqlServer|SqlServer2005|SqlServer2008>&username=<user name>&password=<password>&host=<host>&port=<port>&instanceName=<instance
name>&database=<database>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json> Microsoft SQL Server Parameter Required/ Optional Description
icSessionId Required The Informatica Cloud REST API session ID. id Optional Connection ID.
name Required Connection name.
description Optional Description of the connection.
Microsoft SQL Server Parameter
Required/ Optional
Description
type Required Connection type. Use one of the following codes: - SqlServer. Use for SqlServer2000.
- SqlServer2005. - SqlServer2008.
username Required User name for the database login.