REST API Reference > Data Integration REST API > Connections

Connections

Use this resource to request connection details for an organization. You can also use this resource to create, update, test, and delete a connection.

Details GET Request

You can request the following details using a connection GET request:

•Details of all connections in the organization.
•Details for a particular connection in the organization.
•List of objects that you can use as a source or target with a particular connection.
•List of connections of a specified type associated with a Secure Agent or runtime environment.
•Metadata details for a specified connection.

Note: Do not use connections with names that begin with "DI Data Preview_".

Details of all connections in the organization: To request the details of all connections in the organization, use the following URI:
Details of a particular connection: To request the details of a particular connection, include the connection ID or name in the URI. Use one of the following URIs:; If you use the connection name in the URI and the connection name includes a space, replace the space with %20. For example:
List of objects that you can use as a source or target: You can request the objects that you can use as a source or target. To request source or target objects, you can include either the connection ID or connection name in the URI. Use one of the following URIs:; If you use the connection name in the URI and the connection name includes a space, replace the space with %20. For example:; If you expect to receive a large number of objects, you might want to include one of the following parameters:
List of connections of a specified type associated with a Secure Agent or runtime environment: To request a list of connections by Secure Agent ID and connection type, use the following URI:; To request a list of connections by runtime environment ID and connection type, use the following URI:; If you pass both agentId and runtimeEnvironmentId, the service uses runtimeEnvironmentId and ignores agentId. If you pass only agentId, the service translates agentId into its corresponding runtimeEnvironmentId before it saves the resource to the repository.
Metadata details for a specified connection: To request metadata details for a specified connection, use the following URI:; The metadata is returned in the runtimeAttribute object which contains the following attributes:

Use the following connection request URI attributes:

Field	Type	Required	Description
agentId	String	-	Secure Agent ID
runtimeEnvironmentId	String	-	Runtime environment ID.
uiType	String	Yes	Connection type. Use one of the following options: - CSVFile. CSV flat file. - FTP. - MS_ACCESS. - MSD. Microsoft Dynamics CRM. - MySQL. - ODBC. - Oracle. - OCOD. Oracle CRM On Demand. - Salesforce. - SFTP. Secure 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 Connector. Also use for NetSuite connections. - WebServicesConsumer. Web Service.

Details GET Response

Returns the connection object for the requested connection ID. If you request information for all connections in the organization, returns a connection object for each connection in the organization.

If you request a list of connections based on the runtime environment ID and connection type, returns a connection object for each connection that matches the requirements.

If you request a list of source or target objects available for the requested connection ID, returns the connListItem object for each available object.

Returns the error object if errors occur.

The connection object includes different information based on connection type.

The following table describes attributes included in a connection object:

Field	Type	Description
id	String	Connection ID.
orgId	String	Organization ID.
name	String	Connection name.
description	String	Description of the connection.
createTime	Date/time	Time the connection was created.
updateTime	Date/time	Last time the connection was updated.
createdBy	String	User who created the connection.
updatedBy	String	User who last updated the connection.
agentId	String	Secure Agent ID for Flat File, FTP/SFTP, Microsoft SQL Server, MS Access, MySQL, ODBC, Oracle, and Web Service connections.
runtimeEnvironmentId	String	Runtime environment used by the connection. This is the Runtime Environment field in the user interface. In the response returned to the user interface, this attribute is named agentGroupId.
instanceName	String	Microsoft SQL Server instance name.
host	String	Host name for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections.
domain	String	Domain name for Microsoft Dynamics CRM connections that use IFD or Active Directory authentication, and Web Service connections.
dateFormat		Date format for Flat File, FTP, and SFTP connections.
database	String	Returns the following information: - For Microsoft SQL Server and MySQL connections, returns the database name. - For Flat File connections, returns the directory. - For FTP and SFTP connections, returns the local directory. - For MS Access and ODBC connections, returns the data source name. - For Oracle connections, returns the service name. - For SAP IDoc Writer and Reader connections, returns the destination entry. - For Web Service connections, returns the service URL.
codepage		Code page for Flat File, FTP, SFTP, Microsoft SQL Server, MySQL, MS Access, ODBC, Oracle, and SAP.
clientCode	String	Client code for SAP IDoc Writer connections.
authenticationType	String	Authentication type for Microsoft Dynamics CRM, Microsoft SQL Server, and Web Service connections.
adjustedJdbcHostName	String	Host name. Or host and instance name for Microsoft SQL Server connections.
accountNumber	String	Account ID for NetSuite connections.
languageCode	String	Language code for SAP IDoc Writer connections.
remoteDirectory	String	Remote directory for FTP/SFTP connections.
schema	String	Schema name for Microsoft SQL Server, ODBC, Oracle, and Web Service connections.
serviceUrl	String	Service URL for Microsoft Dynamics CRM, Oracle CRM On Demand, and Salesforce connections.
shortDescription	String	The first 50 letters of the description.
type	String	Connection type returns one of the following responses: - CSVFile. CSV flat file. - FTP. - MS_ACCESS. - MSD. Microsoft Dynamics CRM. - MySQL. - ODBC. - Oracle. - OCOD. Oracle CRM On Demand. - Salesforce. - SFTP. Secure 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 Connector. - WebServicesConsumer. Web Service. Note: The user interface field name on the Connections page varies depending on the connection. For example, for SQL Server, the user interface field name is SQL Server Version. Also note that for SQL Server, the REST API attribute that populates the value in the user interface is named subType.
port	Int	Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections.
password	String	Password for the connection.
username	String	User name for the connection.
securityToken	String	Security token for a Salesforce connection.
stsUrl	String	Security token service URL for Microsoft Dynamics CRM connections that use Active Directory authentication.
organizationName	String	Organization name for Microsoft Dynamics CRM connections.
timeout	Int	Timeout for Web Service connections.
trustCertificatesFile	String	Trust certificates file name for Web Service connections.
certificateFile	String	Certificates file name for Web Service connections.
certificateFilePassword	String	Certificates file password for Web Service connections.
certificateFileType	String	Certificates file type for Web Service connections.
privateKeyFile	String	Private key file name for Web Service connections.
privateKeyPassword	String	Private key password for Web Service connections.
privateKeyFileType	String	Private key file type for Web Service connections.
connParams	String	Parameters used in the connection. Includes connection attributes in the connParam object for SAP, NetSuite, Oracle CRM On Demand, ODBC, or other Informatica Cloud connectors.
federatedId	String	Global unique identifier for the connection.
internal	Boolean	Indicates whether the connection was created internally for data preview purposes only.
retryNetworkError	Boolean	Used for internal purposes only.
supportsCCIMultiGroup	Boolean	Used for internal purposes only.
connListItem		List of connections included in the connListItem object.
id	String	Included in the connListItem object. Source or target ID.
name	String	Included in the connListItem object. Source or target name.

Test GET Request

To test a connection, use the connection ID in the following URI:

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

Test GET Response

Returns the success object if the test succeeds.

Returns the error object if errors occur.

POST Request

You can create or update connections. To update a connection, use the connection ID with the following URI. To create a connection, omit the optional connection ID.

/api/v2/connection/<id>

You can submit a partial update using partial mode. To submit a request using partial mode, use a JSON request and include the following line in the header:

Update-Mode=PARTIAL

In a connection POST request, use the additional attributes in the connection object. The attributes used by Informatica Cloud Connector connections vary by connection type.

To create or update an Informatica Cloud Connector connection, consult the Informatica Cloud application for the attributes used by the connection. Enclose any attributes that are not listed in the following tables in a connParam object.

To get a list of connectors that are available to the organization and attribute information for a specific connector type, see Connectors.

For more information about attributes and data types used for creating connections through the REST API, see Connection user interface fields to REST API attributes mapping and Connector data types.

POST Response

If successful, returns the connection object for the connection that was created or updated.

Returns the error object if errors occur.

DELETE Request

To delete a connection, use the connection ID in the following URI.

/api/v2/connection/<id>

DELETE Response

Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example

To update an SAP Table connection, you might use the following request, enclosing SAP attributes in the connParam object:

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>

A successful request returns the connection object that you updated.

CSV Flat File Connections

When you create or update a CSV flat file connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for CSV flat file connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use CSVFile.
database	Directory where flat files are stored. In the user interface, this attribute is the Directory field. In the REST API response that populates the value in the user interface, the name of this attribute is dirName.
dateFormat	Date format for date fields in the flat file. Use one of the following formats: - MM/dd/yyyy - MM-dd-yyyy - MM.dd.yyyy - dd/MM/yyyy - dd-MM-yyyy - dd.MM.yyyy - MM/dd/yyyy HH:mm - MM-dd-yyyy HH:mm - MM.dd.yyyy HH:mm - dd/MM/yyyy HH:mm - dd-MM-yyyy HH:mm - dd.MM.yyyy HH:mm - MM/dd/yyyy HH:mm:ss - MM-dd-yyyy HH:mm:ss - MM.dd.yyyy HH:mm:ss - dd/MM/yyyy HH:mm:ss - dd-MM-yyyy HH:mm:ss - dd.MM.yyyy HH:mm:ss - yyyy-MM-dd - yyyy-MM-dd HH:mm - yyyy-MM-dd HH:mm:ss - yyyy-MM-ddTHH:mm:ss.SSSZ - yyyy/MM/dd - yyyy/MM/dd HH:mm - yyyy/MM/dd HH:mm:ss - yyyyMMdd - MM/dd/yyyy HH24:mm:ss - MM/dd/yyyy HH24:mm:ss.ms - MM/dd/yyyy HH24:mm:ss.us - MM/dd/yyyy HH24:mm:ss.ns Default is MM/dd/yyyy HH:mm:ss.
codepage	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 Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.

FTP and SFTP Connections

When you create or update an FTP or SFTP connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for FTP or SFTP file connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use FTP or SFTP.
username	User name.
password	Password.
host	Name of the machine hosting the database server or FTP/SFTP host. For a FTP/SFTP connection, enter the host name of IP address.
port	Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP and 22 for SFTP.
database	Directory on a local machine that stores the local file. In the user interface, this attribute is the Directory field. In the REST API response that populates the value in the user interface, the name of this attribute is dirName. 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	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 directions. For more information, see the FTP/SFTP server documentation.
dateFormat	Date format for date fields in the flat file. Use one of the following formats: - MM/dd/yyyy - MM-dd-yyyy - MM.dd.yyyy - dd/MM/yyyy - dd-MM-yyyy - dd.MM.yyyy - MM/dd/yyyy HH:mm - MM-dd-yyyy HH:mm - MM.dd.yyyy HH:mm - dd/MM/yyyy HH:mm - dd-MM-yyyy HH:mm - dd.MM.yyyy HH:mm - MM/dd/yyyy HH:mm:ss - MM-dd-yyyy HH:mm:ss - MM.dd.yyyy HH:mm:ss - dd/MM/yyyy HH:mm:ss - dd-MM-yyyy HH:mm:ss - dd.MM.yyyy HH:mm:ss - yyyy-MM-dd - yyyy-MM-dd HH:mm - yyyy-MM-dd HH:mm:ss - yyyy-MM-ddTHH:mm:ss.SSSZ
codepage	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 Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

Microsoft Access Connections

When you create or update a Microsoft Access connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Microsoft Access connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use MS_ACCESS.
database	Data source name. In the user interface, this is the Data Source Name field.
codepage	The code page compatible with the MS Access database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

Microsoft Dynamics CRM Connections

When you create or update a Microsoft Dynamics CRM connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Microsoft Dynamics CRM connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use MSD.
authenticationType	Authentication type for the connection. Select a valid authentication type. Use one of the following authentication types: - LIVE. Microsoft Live. Use for synchronization tasks or PowerCenter tasks. - IFD. Internet Facing Development (IFD). Use for synchronization tasks or PowerCenter tasks. - AD. Active Directory. Use for PowerCenter tasks only.
username	Microsoft Dynamics CRM user name.
password	Microsoft Dynamics CRM password.
organizationName	Microsoft Dynamics CRM organization name.
domain	Microsoft Dynamics CRM domain name. Required for IFD and Active Directory authetication.
serviceURL	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	Microsoft Dynamics CRM security token service URL. For example, https:// sts1.company.com. Required for IFD authentication.
agentId	Secure Agent ID. Required for Active Directory authentication only.

Microsoft SQL Server Connections

When you create or update a Microsoft SQL Server connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Microsoft SQL Server connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use one of the following codes: - SqlServer. Microsoft SQL Server 2000. - SqlServer2005. Microsoft SQL Server 2005. - SqlServer2008. Microsoft SQL Server 2008. - SqlServer2012. Microsoft SQL Server 2012. In the user interface, this attribute is the SQL Server Version field. In the REST API response that populates the value in the user interface, the name of this attribute is subType.
authenticationType	Authentication method for the connection. Use one of the following options: - Windows. Use Microsoft Windows authentication to access Microsoft SQL Server. Available when users access Data Integration in Windows. - SqlServer. Use Microsoft SQL Server authentication to access Microsoft SQL Server.
username	User name for the database login. Use when authenticationType is SqlServer.
password	Password for the database login. Use when authenticationType is SqlServer.
host	Name of the machine hosting the database server.
port	Network port number used to connect to the database server. Default port number is 1433.
instanceName	Instance name of the Microsoft SQL Server database.
database	Database name for the Microsoft SQL Server target. Database name is case sensitive if the database is case sensitive. Maximum length is 100 characters. Database names can include alphanumeric and underscore characters.
schema	Schema used for the target connection.
codepage	The code page of the Microsoft SQL Server database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

MySQL Connections

When you create or update a MySQL connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for MySQL connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use MySQL.
username	User name for the database login.
password	Password for the database login.
host	Name of the machine hosting the database server.
port	Network port number used to connect to the database server. Default is 3306.
database	Database name for the MySQL database target. Database name is case sensitive if the database is case sensitive.
codepage	The code page for the database server. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

NetSuite Connections

When you create or update a NetSuite connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for NetSuite connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use NetSuite.
username	NetSuite user name.
password	NetSuite password.
accountNumber	NetSuite account ID. To locate your account ID, log in to NetSuite and navigate to Setup > Integration > Web Services Preferences.
serviceURL	WSDL URL. If your NetSuite account does not use the default NetSuite WSDL URL, enter the WSDL URL used by your NetSuite account.

ODBC Connections

When you create or update an ODBC connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for OBDC connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use ODBC.
username	User name for the database login.
password	Password for the database login.
database	Data source name.
schema	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	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 Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.
ODBC_SUBTYPE	The ODBC connection subtype to connect to a specific database. Use one of the following options: - Azure DW - DB2 - Google BigQuery - PostgreSQL - Redshift - SAP IQ - Snowflake - Teradata - Other
authenticationType	The authentication method to connect to a database. Required for DB2. Use one of the following options: - Database - Kerberos
kerberosProperties	Additional connection properties to use Kerberos authentication to connect to DB2. If you specify more than one property, separate each key-value pair with a semicolon.

Oracle Connections

When you create or update an Oracle connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Oracle connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use Oracle.
username	User name for the database login.
password	Password for the database login.
host	Name of the machine hosting the database server.
port	Network port number used to connect to the database server. Default is 1521.
database	Service name that uniquely identifies the Oracle database. This attribute is the Service Name field in the user interface. If the connection fails, contact the database administrator.
schema	Schema used for the target connection. Optional.
codepage	The code page of the database server. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent that Data Integration uses to access the database in the local area network.

Oracle CRM On Demand Connections

When you create or update an Oracle CRM On Demand connection, you can configure additional attributes, such as the connection ID and the connection name.

The following tables describes attributes that you can use for Oracle CRM On Demand connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use OCOD.
username	Oracle CRM On Demand user name. Use the following format: <domain>/<user name> For example: domain/jsmith@companyname.com.
password	Oracle CRM On Demand password.
serviceUrl	URL of the Oracle CRM On Demand service. For example: https://securecompany.crmondemand.com.

Salesforce Connections

When you create or update a Salesforce connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Salesforce connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use Salesforce.
username	User name for the Salesforce account. <domain>/<user name> For example: domain/jsmith@companyname.com.
password	Password for the Salesforce account.
securityToken	Security token associated with the user name and password. Optional.
serviceUrl	URL of the Salesforce service. Maximum length is 100 characters.

SAP IDoc Reader Connections

When you create or update an SAP IDoc Reader connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for SAP IDoc Reader connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use SAP_ALE_IDoc_Reader.
username	SAP user name with authorization on S_DATASET, S_TABU_DIS, S_PROGRAM, and B_BTCH_JOB objects.
password	Password for the SAP user name.
database	Type A DEST entry in the saprfc.ini file. This attribute is the Destination Entry field in the user interface.
codepage	The code page compatible with the SAP source. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

SAP IDoc Writer Connections

When you create or update an SAP IDoc Writer connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for SAP IDoc Writer connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use SAP_ALE_IDoc_Writer.
username	SAP user name with authorization on S_DATASET, S_TABU_DIS, S_PROGRAM, and B_BTCH_JOB objects.
password	Password for the SAP user name.
database	Type A DEST entry in the saprfc.ini file. This attribute is the Connection String field in the user interface.
languageCode	Language code that corresponds to the SAP language. A two-letter code, such as en for English.
clientCode	SAP client number. A three-letter code.
codepage	The code page compatible with the SAP target. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1. - ISO-8859-15. Latin 9, Western European. - ISO-8859-2. Eastern European. - ISO-8859-3. Southeast European. - ISO-8859-5. Cyrillic. - ISO-8859-9. Latin 5, Turkish. - IBM500. IBM EBCDIC International Latin-1.
agentId	Secure Agent ID.

Web Service Connections

When you create or update a Web Service connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Web Service connections:

Attribute	Description
id	Connection ID.
orgId	Organization ID.
name	Connection name.
description	Optional connection description.
type	Connection type. Use WebServicesConsumer.
username	SAP user name with authorization on S_DATASET, S_TABU_DIS, S_PROGRAM, and B_BTCH_JOB objects.
password	Password for the web service login. If the web service does not require a user name, leave this field empty. Optional.
domain	Domain for authentication. Optional.
serviceUrl	Endpoint URL for the web service that you want to access. The WSDL file specifies this URL in the location element. This attribute is the Endpoint URL field in the user interface. Optional.
timeout	Secure Agent ID. Number of seconds Informatica Intelligent Cloud Services waits for a connection to the web service provider before it closes the connection and fails the session. Also, the number of seconds the Informatica Intelligent Cloud Services waits for a SOAP response after sending a SOAP request before it fails the session. Default is 60. Optional.
trustCertificatesFile	File containing the bundle of trusted certificates that Informatica Intelligent Cloud Services uses when authenticating the SSL certificate of the web services provider. Default is ca-bundle.crt. Optional.
certificateFile	Client certificate that a web service provider uses when authenticating a client. You specify the client certificate file if the web service provider needs to authenticate Informatica Intelligent Cloud Services. Optional.
certificateFilePassword	Password for the client certificate. You specify the certificate file password if the web service provider needs to authenticate Informatica Intelligent Cloud Services. Optional.
certificateFileType	File type of the client certificate. You specify the certificate file type if the web service provider needs to authenticate the Integration Service. Use one of the following codes: - PEM - DER Optional.
privateKeyFile	Private key file for the client certificate. You specify the private key file if the web service provider needs to authenticate Informatica Intelligent Cloud Services. Optional.
privateKeyPassword	Password for the private key of the client certificate. You specify the key password if the web service provider needs to authenticate Informatica Intelligent Cloud Services. Optional.
privateKeyFileType	File type of the private key of the client certificate. You specify the key file type if the web service provider needs to authenticate Informatica Intelligent Cloud Services. If necessary, use PEM. Optional.
authenticationType	Authentication type to use when the web service provider does not return an authentication type to Informatica Intelligent Cloud Services. Use one of the following options: - Auto. The Integration Service attempts to determine the authentication type of the web service provider. - Basic. Based on a non-encrypted user name and password. - Digest. Based on an encrypted user name and password. - NTLM. Based on encrypted user name, password, and domain. Default is Auto. Optional.
agentId	ID for the Secure Agent that Informatica Intelligent Cloud Services uses to access the database in the local area network.