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:

/api/v2/connection

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

/api/v2/connection/<id>

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

If you use the connection name in the URI and the connection name includes a space, replace the space with %20. For example:

/api/v2/connection/name/my%20connection

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. A maximum of 200 objects can be returned for one request. 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:

/api/v2/connection/source/<id>

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

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

/api/v2/connection/target/name/<name>

If you use the connection name in the URI and the connection name includes a space, replace the space with %20. For example:

/api/v2/connection/target/name/my%20connection

If you expect to receive a large number of objects, you might want to filter the results. To filter the results, include the connection ID and the searchPattern parameter. To use the searchPattern parameter, use the following URI:

/api/v2/connection/<source or target>/<id>?searchPattern=<pattern>

For example, the following request returns source objects that include "abc" in the object name:

/api/v2/connection/source/002D420000000J?searchPattern=abc

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:

/api/v2/connection/search?agentId=<agentId>&uiType=<uiType>

To request a list of connections by runtime environment ID and connection type, use the following URI:

/api/v2/connection/search?runtimeEnvironmentId=<runtimeEnvironmentId>&uiType=<uiType>

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:

/api/v2/connection/source/<connection ID>/metadata

/api/v2/connection/target/<connection ID>/metadata

The metadata is returned in the runtimeAttribute object which contains the following attributes:

• name
• dataType
• defaultValue
• label
• mandatory
• maxLength
• sessionVarAllowed
• possibleValues

Use the following connection request URI attributes:

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:

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 connector.
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.