Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

connector

connector

Use this resource to request a list of connectors that are available to an organization along with connector details. You can also use this resource to get attribute information for a specific connector type. You can use the list of attributes that this resource provides when you create a connection for a specific connector type since you need to provide these attributes when you create a connection of a certain type.

GET Request and Response for Available Connectors

To request a list of connectors available for an organization, submit a GET request using the following URI:
/api/v2/connector
For example, you might use the following request:
GET <serverUrl>/api/v2/connector Content-Type: application/xml Accept: application/xml icSessionId: <icSessionId>
A successful response returns the following attributes in the connector object:
Field
Type
Description
name
String
Name of the connector.
type
String
Type of connector. Includes the following values:
  • Salesforce
  • Oracle
  • SqlServer
  • MySQL
  • CSVFile
  • ODBC
  • MS_ACCESS
  • FTP
  • SAP
  • WebServicesConsumer
  • MSD
publisher
String
Name of the entity that published the connector.
connectorVersion
Int
Connector version.
shortName
String
Connector short name.
isPublic
Boolean
Whether the connector is a public or private connector. If you are interested in a connector that is private, contact Informatica Global Customer Support.

GET Request and Response for Connector Metadata

To get metadata for a specific connector type, submit a GET request using the following URI:
/api/v2/connector/metadata?connectorName=<connectorName>
For example, you might use the following request:
GET <serverUrl>/api/v2/connectorName=SQLServer Content-Type: application/xml Accept: application/xml icSessionId: <icSessionId>
A successful response returns the following attributes in the connectorMetadata object:
Field
Type
Description
type
String
Type of connector, such as Salesforce or Oracle.
isStandardConnType
Boolean
Whether the connector is standard or custom. A "True" value indicates the connector is standard.
attributes
Connector attributes for the specified connector type. Includes information in the attribute object for each connector object.
name
String
Included in the attribute object.
Name of the attribute, such as database or codePage.
label
String
Included in the attribute object.
Label.
id
String
Included in the attribute object.
ID.
value
String
Included in the attribute object.
Value of the attribute.
type
Int
Included in the attribute object.
Data type. For values, see Connector data types.
isMandatory
Boolean
Included in the attribute object.
Whether the attribute is mandatory.
visible
Boolean
Included in the attribute object.
Whether the attribute is visible.
list
String
Included in the attribute object.
A list of types for the selected connector type. For example, SQL Server includes the types SqlServer2000, SqlServer2005, SqlServer2008, and so on.


Updated May 03, 2021