IICS API Version V2 Connector Guide > IICS API Version V2 Connector Processes > Services in IICS API Version V2 Connector
  

Services in IICS API Version V2 Connector

IICS API Version V2 Connector uses the REST API to access the programs and activities in Informatica Cloud through these services to perform various tasks.
Activities that you can perform in Informatica Cloud are listed as services that you can configure in a Service step in a process. To configure a service, you need to identify and pass the input fields required for the service. You can also use the service output to perform other steps in the process.
Important: When you create a process, you must use the Login service as the first step after the Start milestone and Logout or Logout All as the last step before the End milestone.

Agent Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the Secure Agent details. For each Secure Agent, you can view the agent details such as name, ID, and host name.
The following table describes the agent services:
Service Name
Select service to ...
Get Agent
Get the details of an Secure Agent based on the agent ID that you specify.
List Agents
Get a list of all the Secure Agents in the organization.

Audit Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the audit log.
Select the Get Audit Log service to view the audit log, which tracks user operations such as login, create, update, and delete operations.
You can view the following input and output fields:
Input Fields
Output Fields
AuditLogResults process object. The process object contains log details such as ID, user name, object name, and entry time.

Authentication Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform authentication tasks.
The following table describes the authentication services:
Service Name
Select service to ...
Login
Login to Informatica Cloud using the username and password specified in the IICS API Version V2 connection.
Logout
Log out of Informatica Cloud.
Logout All
Log out of an organization and end all the REST API sessions for the user in the request.
Important: In a process, you must use the Login service as the first step after the Start milestone and Logout or Logout All as the last step before the End milestone.

Connection Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud and retrieve the connection details. For each connection, you can view the connection details such as name, description, and agent on which the connection is available.
The following table describes the connection services:
Service Name
Select the service to ...
Get Connection
Get the connection details based on the connection ID that you specify.
List Connections
Get a list of all the connections in the organization.
For more information about how to configure the Get Connection or List Connections service in a process, see Configuring the Get Connection and List Connections services.

Data Preview Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform data preview tasks.
Select the Data Preview service to preview data when you design a mapping. You can specify the object type as source or target, the object name and connection ID to preview the data types and values of the object.
Input Fields
Output Fields
DataPreview process object. The process object contains fields connection ID, object name, and field name. The process object also contains the Data process object, which contains the type and value fields.

DNB Workflow Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform DNB workflow tasks.
The following table describes the DNB workflow services:
Service Name
Select service to ...
Create DNB360 Workflow
Create a DNB360 workflow.
Delete DNB360 Workflow
Delete a DNB360 workflow based on workflow ID.
Get DNB360 Workflow
Get the details of a DNB360 workflow based on workflow ID.
List DNB360 Workflows
Get the details of all DNB360 workflows.
Update DNB360 Workflow
Update a DNB360 workflow based on workflow ID.

Field Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to view the field details of objects.
The following table describes the field services:
Service Name
Select service to ...
Get Source Fields
Get the field details for a source object. You can specify the source connection ID and object name to view field details.
Input Fields
  • - Source connection ID
  • - Source object name.
Output Fields
Field process object. The process object contains field details such as field name, data type, precision, and scale.
Get Target Fields
Get the field details of a target object. You can specify the target connection ID and object name to view field details.
Input Fields
  • - Target connection ID
  • - Target object name.
Output Fields
Field process object. The process object contains field details such as field name, data type, precision, and scale.

File Record Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Intelligent Cloud Services to upload or delete files.
The following table describes the field record services:
Service Name
Select service to ...
Create FileRecord
Upload an integration template XML file or image file to the organization. You can upload files in binary format and with UTF-8 encoding.
Input Fields
  • - File as an attachment.
  • - File type, which can be mapping or Image.
Output Fields
FileRecord process object. The process object contains file record details such as name, type, attachment type, and update time.
Delete FileRecord
Delete an integration template XML file or image file from the organization based on file ID.

Job Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to start or stop tasks in Informatica Cloud.
The following table describes the job services:
Service Name
Select service to ...
Start Job
Start a task in Informatica Cloud based on task type, and task ID or task name.
Input Fields
  • - Task ID
  • - Task type, which you can select from an existing list.
  • - Task name
Output Fields
  • - Job process object. The process object contains task details such as ID, name, type, and callback URL.
  • - Status
Stop Job
Stop a task in Informatica Cloud based on task type, and task ID or task name.
Input Fields
  • - Task ID
  • - Task type, which you can select from an existing list.
  • - Task name
Output Fields
  • - Job process object. The process object contains task details such as ID, name, type, and callback URL.
  • - Status

Mapping Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Intelligent Cloud Services to retrieve the mapping details. For each mapping, you can view details such as ID, name, and agent host on which the mapping is available.
The following table describes the mapping services:
Service Name
Select service to ...
Get Mapping
Get the mapping details based on the mapping ID that you specify.
List Mapping
Get a list of all the mappings in the organization.

Mapplet Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform mapplet-specific tasks.
The following table describes the mapplet services:
Service Name
Select service to ...
Create Mapplet
Create a mapplet based on a mapplet XML file you can upload, and the mapplet name and description that you specify.
Input Fields
  • - File as attachment. The file should be in binary format and with UTF-8 encoding.
  • - Mapplet name
  • - Mapplet description.
Output Fields
  • - Mapplet process object. The process object contains mapplet details such as name, ID create time, and Org ID.
  • - Status
Delete Mapplet
Delete a mapplet based on mapplet ID.
Get Mapplet
Get the details of a mapplet based on mapplet ID.
Input Fields
Mapplet ID
Output Fields
  • - Mapplet process object. The process object contains mapplet details such as name, ID create time, and Org ID.
  • - Status
List Mapplets
Get a list of PowerCenter mapplets. You can view mapplet details such as name, ID create time, and Org ID.
Update Mapplet
Update a mapplet based on the mapplet ID. You can update the mapplet XML file, name, or description.
Input Fields
  • - File as attachment. The file should be in binary format and with UTF-8 encoding.
  • - Mapplet name
  • - Mapplet description.
  • - Mapplet ID
Output Fields
  • - Mapplet process object. The process object contains mapplet details such as name, ID create time, and Org ID.
  • - Status

Master Template Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to view or delete integration templates.
The following table describes the master template services:
Service Name
Select service to ...
Delete Integration Template
Delete a integration template based on an integration template ID.
Get Integration Template
Get the details of an integration template based on an integration template ID.
List Integration Templates
Get a list of all the integration templates in the organization.

Monitor Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to view the details about Informatica Cloud activities.
The following table describes the monitor services:
Service Name
Select service to ...
Activity Monitor
Retrieve details about active tasks running in Informatica Cloud.
Get Activity Log
Retrieve the log details of all the tasks that are currently running in the runtime environment. You can specify the maximum number of rows to return.
Input Fields
Row limit
Output Fields
Activity log results process object. The process object contains activity details such as failed source rows, success source rows, runtime environment ID, and Agent ID.
Get Error Log
Get the error logs for a specific activity based on the activity log ID. You can view the error logs as attachments.

Org Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the organization details.
The following table describes the organization services:
Service Name
Select service to ...
Get Organization
Get the details of the Informatica Cloud organization.
Get SubOrganization
Get the details of a sub organization related to the organization based on a sub organization ID.

Runtime Environment Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the runtime environment details.
Select the Get Runtime Environment service to get the details of the runtime environments for an organization.

Salesforce Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the Salesforce version details.
Select the Get Salesforce Version service to get the version details of Salesforce used by Informatica Cloud.

Server Time Service

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to retrieve the timestamp details.
Select the Server Time service to view the local time on the Informatica Cloud server.

Task Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform tasks.
The following table describes the task services:
Service Name
Select service to ...
Create Mapping
Create a mapping task. You can provide the mapping name, agent ID, and mapping ID to create the mapping task. Or, you can specify the parameter details for the task.
Input Fields
CreateMappingTaskRequest process object. The process object contains mapping name, agent ID, mapping ID and the parameter process object.
Output Fields
  • - MappingConfigTask process object. The process object contains field details such as mapping ID, agent ID, and runtime environment ID.
  • - Status
Delete Mapping
Delete a mapping task based on the task ID.
Get Mapping
Get the details of a mapping task based on the task ID. You can view mapping details such as mapping ID, agent ID, and runtime environment ID.
List Mapping Task
Get a list of all the mapping tasks that use an integration template. You can specify the ID of the integration template to get the list of tasks.
Input Fields
Integration template ID
Output Fields
MappingConfigTask process object. The process object contains field details such as mapping ID, agent ID, and runtime environment ID.
List Tasks
Request the details of the tasks in the organization. You can filter the list based on task type such as mapping, synchronization, and workflow tasks. You can view task details such as name, type, and description.

Workflow Services

Application Integration uses the URL and session ID of the IICS API Version V2 connection to connect to Informatica Cloud to perform workflow tasks.
The following table describes the workflow services:
Service Name
Select service to ...
Create Task Flow
Create a task flow.
Input Fields
Taskflow process object. The process object contains fields such as Org ID, created by, and description. The process object contains other process objects such as SuccessTaskEmail, WarningTaskEmail, and ErrorTaskEmail.
Output Fields
  • - Taskflow process object. The process object contains fields such as Org ID, created by, and description. The process object contains other process objects such as SuccessTaskEmail, WarningTaskEmail, and ErrorTaskEmail.
  • - Status
Delete Task Flow
Delete a test flow based on task flow ID.
Get Task Flow
Request the details of a task flow based on task flow ID. The Taskflow process object is the output field.
List Task Flows
Request the details of all task flows in the organization. The Taskflow process object is the output field.
Update Task Flow
Update an existing task flow.
Input Fields
  • - Task flow ID
  • - Taskflow process object. The process object contains fields such as Org ID, created by, and description. The process object contains other process objects such as SuccessTaskEmail, WarningTaskEmail, and ErrorTaskEmail.
Output Fields
  • - Taskflow process object. The process object contains fields such as Org ID, created by, and description. The process object contains other process objects such as SuccessTaskEmail, WarningTaskEmail, and ErrorTaskEmail.
  • - Status