Returns no response if the request is successful. Returns the error object if errors occur.
GET Example
To request the details about the Secure Agent with an ID of 000H1L080000000000001, to be returned in JSON format, you might use the following request:
GET <serverUrl>/api/v2/agent/000H1L080000000000001 HTTP/1.0 Accept:application/json
icSessionId: <icSessionId>
A successful request returns the agent object.
connection
Use this resource to request the details of a connection or the details of all connections in the organization. You can request a list of available sources or targets for a connection. You can also request a list of connections of a specified type associated with a Secure Agent. You can create or update a connection, and you can delete a connection.
GET Request
To request the details of a connection, use the following URI. To request the details of all connections in the organization, omit the optional connection ID.
/api/v2/connection/<id>
To request the objects that you can use as a source available through the specified connection, use the source connection ID in the following URI:
/api/v2/connection/source/<id>
To request the objects that you can use as a target available through the specified connection, use the source connection ID in the following URI:
/api/v2/connection/target/<id>
To request a list of connections by Secure Agent ID and connection type, use the following URI:
/api/v2/connection/search?agentId=<agent ID>&uiType=<uiType>
Use the following attributes in the URI:
connection Request URI Attribute
Required/ Optional
Description
agentId Required Secure Agent ID.
uiType Required 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.
- TOOLKIT. Informatica Cloud Connector. Also use for NetSuite connections. - WebServicesConsumer. Web Service.
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 Secure Agent 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.
A connection object includes the following attributes. The connection object includes different information based on connection type. For NetSuite connections, only name, orgId and connectionId information is returned.
connection Object Response Attribute
Description
id Connection ID.
orgId Organization ID. name Connection name.
description Description of the connection. createTime Time the connection was created. updateTime Last time the connection was updated.
connection Object Response Attribute
Description
createdBy User who created the connection. updatedBy User who last updated the connection.
agentId Secure Agent ID for Flat File, FTP/SFTP, Microsoft SQL Server, MS Access, MySQL, ODBC, Oracle, and Web Service connections.
instanceName Microsoft SQL Server instance name.
host Host name for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. escapeChar Escape character for Flat File, FTP, and SFTP connections.
enclosingChar Text qualifier for Flat File, FTP, and SFTP connections.
domain Domain name for Microsoft Dynamics CRM connections that use IFD or Active Directory authentication, and Web Service connections.
delimiter Delimiter for Flat File, FTP, and SFTP connections. dateFormat Date format for Flat File, FTP, and SFTP connections. database 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 Client code for SAP IDoc Writer connections.
authenticationType Authentication type for Microsoft Dynamics CRM and Web Service connections. adjustedJdbcHostName Host name. Or host and instance name for Microsoft SQL Server connections. accountNumber Account ID.
languageCode Language code for SAP IDoc Writer connections. remoteDirectory Remote directory for FTP/SFTP connections.
schema Schema name for Microsoft SQL Server, ODBC, Oracle, and Web Service connections. serviceUrl Service URL for Microsoft Dynamics CRM, Oracle CRM On Demand, and Salesforce
connections.
shortDescription The first 50 letters of the description.
connection Object Response Attribute
Description
type 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. - TOOLKIT. Informatica Cloud Connector. - WebServicesConsumer. Web Service.
port Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. password Password for the connection.
username User name for the connection.
securityToken Security token for a Salesforce connection.
stsUrl Security token service URL for Microsoft Dynamics CRM connections that use Active Directory authentication.
organizationName Organization name for Microsoft Dynamics CRM connections. timeout Timeout for Web Service connections.
trustCertificatesFile Trust certificates file name for Web Service connections. certificateFile Certificates file name for Web Service connections. certificateFilePassword Certificates file password for Web Service connections. certificateFileType Certificates file type for Web Service connections. privateKeyFile Private key file name for Web Service connections. privateKeyPassword Private key password for Web Service connections. privateKeyFileType Private key file type for Web Service connections.
The connListItem object includes the following attributes:
connListItem Object Response Attribute Description
id Source or target ID.
name Source or target name.
POST Request
You can create or update any connection type except the Informatica Cloud Connector.
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>
With this URI, use the additional attributes in the connection object. For a list of attributes based on the connection type, see the connection type table below.
The following table lists the attributes that you can use to create or update a CSV Flat File connection.
CSV Flat File Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use CSVFile. database Required Directory where flat files are stored.
CSV Flat File Attribute Required/ Optional
Description
dateFormat Required 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 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.
The following table lists the attributes that you can use to create or update an FTP or SFTP connection.
FTP/SFTP Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization 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.
FTP/SFTP Attribute Required/ Optional
Description
port Required Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP and 22 for SFTP.
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 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 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.
The following table lists the attributes that you can use to create or update a Microsoft Dynamics CRM connection.
Microsoft Dynamics CRM Attribute
Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. name Required Connection name.
Microsoft Dynamics CRM Attribute
Required/ Optional
Description
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.
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.
The following table lists the attributes that you can use to create or update a Microsoft SQL Server connection.
Microsoft SQL Server Attribute
Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. name Required Connection name.
Microsoft SQL Server Attribute
Required/ Optional
Description
description Optional Description of the connection.
type Required Connection type. Use one of the following codes: - SqlServer. Microsoft SQL Server 2000. - SqlServer2005. Microsoft SQL Server 2005. - SqlServer2008. Microsoft SQL Server 2008. 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 port number is 1433.
instanceName Optional Instance name of the Microsoft SQL Server database.
database Required 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 Optional
Required for Microsoft SQL Server 2005 and 2008
Schema used for the target connection.
Required for Microsoft SQL Server 2005 and Microsoft SQL Server 2008 databases.
codepage Required The code page of the Microsoft SQL Server 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.
The following table lists the attributes that you can use to create or update an MS Access connection.
MS Access Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. name Required Connection name.
description Optional Description of the connection. type Required Connection type. Use MS_ACCESS. database Required Data source name.
MS Access Attribute Required/ Optional
Description
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.
The following table lists the attributes that you can use to create or update a MySQL connection.
MySQL Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization 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. agentId Required Secure Agent ID.
The following table lists the attributes that you can use to create or update an ODBC connection.
ODBC Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID.
ODBC Attribute Required/ Optional
Description
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.
The following table lists the attributes that you can use to create or update an Oracle connection.
Oracle Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization 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.
Oracle Attribute Required/ Optional
Description
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.
The following table lists the attributes that you can use to create or update an Oracle CRM On Demand connection.
Oracle CRM On Demand Attribute
Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. 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.
The following table lists the attributes that you can use to create or update a Salesforce connection.
Salesforce Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization 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.
Salesforce Attribute Required/ Optional
Description
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.
The following table lists the attributes that you can use to create or update an SAP IDoc Writer connection.
SAP IDoc Writer Attribute Required/ Optional
Description
id Required Connection ID. orgId Required Organization 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.
The following table lists the attributes that you can use to create or update an SAP IDoc Reader connection.
SAP ALE IDoc Reader Attribute
Required/ Optional
Description
id Required Connection ID. orgId Required Organization ID. name Required Connection name.
SAP ALE IDoc Reader Attribute
Required/ Optional
Description