Informatica® Cloud

Spring 2017

Developer Guide
Informatica Cloud Developer Guide
Spring 2017
January 2018
© Copyright Informatica LLC 1993, 2018

This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be
reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC.

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial
computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the
extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License.

Informatica, Informatica Cloud, PowerCenter, and the Informatica logo are trademarks or registered trademarks of Informatica LLC in the United States and many
jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at https://www.informatica.com/trademarks.html. Other company
and product names may be trade names or trademarks of their respective owners.

Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product.

The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at
[email protected].

Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE
INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.

Publication Date: 2018-01-12

Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Cloud Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Cloud Communities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Cloud Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Cloud Connector Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Cloud Trust Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 1: Informatica Cloud REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Informatica Cloud REST API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
XML Schema Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Header and Body Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Request Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Request Body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Return Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
JSON Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
XML Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Update Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Date/Time Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Object IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Session IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
REST API Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Success Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Error Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
REST API Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Resource Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 2: Informatica Cloud REST API Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . 31

activityLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
activityMonitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
auditlog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
bundleObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
bundleObjectLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Table of Contents 3
 CSV Flat File Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
FTP and SFTP Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Microsoft Access Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Microsoft Dynamics CRM Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Microsoft SQL Server Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
MySQL Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
NetSuite Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
ODBC Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Oracle Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Oracle CRM On Demand Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Salesforce Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
SAP IDoc Reader Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
SAP IDoc Writer Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Web Service Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
connector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
customFunc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
dataPreview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
expressionValidation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
fileRecord. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
fwConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
licenseInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
logoutall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
loginSaml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
masterTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
mttask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Mask Rule Parameter Attributes for Masking Techniques. . . . . . . . . . . . . . . . . . . . . . . . 134
Mask Rule Parameter Attribute Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
org. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
runtimeEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
salesforceVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
serverTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
usergroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

4 Table of Contents
workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Appendix A: REST API Codes and Supplemental Information. . . . . . . . . . . . . . . . 185

REST API Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
REST API Codes Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
State Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Country Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Time Zone Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Connector Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Connection User Interface Fields to REST API Attributes Mapping. . . . . . . . . . . . . . . . . . . . . . 197

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Table of Contents 5
Preface
Welcome to Informatica Cloud, Informatica’s hosted applications. Informatica Cloud uses functionality from
PowerCenter and Informatica Data Quality to provide easy-to-use, web-based applications.

The Informatica Cloud Developer Guide explains how developers can use the Informatica Cloud Connector
Toolkit and the Informatica Cloud REST API.

Some of the features and functionality mentioned in this guide might not be available to your organization
due to licensing.

Informatica Resources

Informatica Documentation
To get the latest documentation for your product, browse the Informatica Knowledge Base at
https://kb.informatica.com/_layouts/ProductDocumentation/Page/ProductDocumentSearch.aspx.

If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation
team through email at [email protected].

Informatica Cloud Web Site

You can access the Informatica Cloud web site at http://www.informatica.com/cloud. This site contains
information about Informatica Cloud editions and applications.

Informatica Cloud Communities

Use the Informatica Cloud Community to discuss and resolve technical issues in Informatica Cloud. You can
also find technical tips, documentation updates, and answers to frequently asked questions.

Access the Informatica Cloud Community at:

https://network.informatica.com/community/informatica-network/products/cloud-integration

To find resources on using Cloud Application Integration (the Informatica Cloud Real Time service), access
the community at:

https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-
application-integration/content

Developers can learn more and share tips at the Cloud Developer community:

6
 https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-
developers

Informatica Cloud Marketplace

Visit the Informatica Marketplace to try and buy Informatica Cloud Connectors, templates, and mapplets:

https://marketplace.informatica.com/community/collections/cloud_integration

Informatica Cloud Connector Documentation

You can access documentation for Informatica Cloud Connectors at the Informatica Cloud Community:
https://network.informatica.com/cloud/index.htm

You can also download individual connector guides: https://network.informatica.com/docs/DOC-15333.

Informatica Knowledge Base

Use the Informatica Knowledge Base to search Informatica Network for product resources such as
documentation, how-to articles, best practices, and PAMs.

To access the Knowledge Base, visit https://kb.informatica.com. If you have questions, comments, or ideas
about the Knowledge Base, contact the Informatica Knowledge Base team at
[email protected].

Informatica Cloud Trust Site

Subscribe to the Informatica trust site for upgrade, maintenance, and incident notifications.

Status.Informatica.com displays the production status of all the Informatica cloud products. All maintenance
updates are posted to this status page, and during an outage, it will have the most current information. To
ensure you are notified of updates and outages, you can subscribe to a single component, a single incident,
or the site as a whole. Subscribing to the site as a whole is the best way to be certain you never miss an
update. To subscribe, go to http://status.informatica.com and click SUBSCRIBE TO UPDATES. You can then
choose to receive notifications sent as emails, SMS text messages, webhooks, RSS feeds, or any
combination of the four.

Informatica Global Customer Support

You can contact a Customer Support Center by telephone or online.

For online support, click Submit Support Request in Informatica Cloud. You can also use Online Support to
log a case. Online Support requires a login. You can request a login at
https://network.informatica.com/welcome.

The telephone numbers for Informatica Global Customer Support are available from the Informatica web site
at https://www.informatica.com/services-and-training/support-services/contact-us.html.

Preface 7
Chapter 1

Informatica Cloud REST API

This chapter includes the following topics:

• Informatica Cloud REST API Overview, 8

• XML Schema Definition, 11
• Header and Body Configuration, 11
• Update Modes, 15
• Date/Time Values, 16
• Object IDs, 17
• Session IDs, 17
• REST API Responses, 18
• Success Object, 18
• Error Object, 18
• Error Messages, 19
• REST API Guidelines, 21
• Resource Quick Reference, 21

Informatica Cloud REST API Overview

Use the Informatica Cloud REST API to access information from your Informatica Cloud organization. You
can also perform tasks such as create, update, and delete connections, schedules, mapplets, and task flows.

Use version 2 of the REST API for all development. Version 1 is no longer supported.

To use the Informatica Cloud REST API, you need a valid Informatica Cloud login and an understanding of
REST API guidelines.

To configure a request using the REST API, use the appropriate resource and method, along with the
applicable attributes. Informatica Cloud returns the requested information, performs the requested task, or
returns an error object and related messages.

The Informatica Cloud REST API includes the following resources:

activityLog

Returns job details from the Informatica Cloud activity log.

activityMonitor

Returns job details from the Informatica Cloud activity monitor.

8
agent

Returns the details of a Secure Agent or the details of all Secure Agents in the organization. Also deletes
a Secure Agent.

auditlog

Returns audit log entries.

bundleObject

Returns the details of a bundle. Returns the details of all bundles installed on or published by the
organization. Pushes a published private bundle to sub-organizations.

bundleObjectLicense

Returns the license information for a bundle. Returns the license information for all bundles installed on
or available to the organization. Installs a bundle and uninstalls a bundle.

connection

Returns the details of a connection or the details of all connections in the organization. Returns available
source or target objects for a specified connection. Returns all connections of a specified type
associated with a Secure Agent. Creates, updates, tests, and deletes a connection.

connector

Returns list of connectors available to an organization. Returns attribute values for a connector type.

customFunc

Returns the details of a mapplet or of all mapplets in the organization. Uploads a PowerCenter mapplet.
Also deletes a mapplet.

dataPreview

Returns up to ten rows of source or target data for the specified object.

expressionValidation

Returns a message that states the expression is valid or returns an error.

field

Returns the field details for a source or target object.

fileRecord

Uploads an integration template XML file or image file. Also deletes an integration template XML file or
image file.

fwConfig

Returns the details of fixed-width formats. Creates or updates a fixed-width format. Also deletes a fixed-
width format.

job

Starts or stops a task or taskflow and optionally returns job status.

licenseInfo

Returns the license information for the organization that you are logged in to. Updates license
information for a sub-organization.

login

Logs in to an Informatica Cloud organization with Informatica Cloud or Salesforce credentials. Returns a
two hour REST API session ID that you can use for subsequent REST API requests.

Informatica Cloud REST API Overview 9

 loginSaml

Logs in to an Informatica Cloud organization using SAML single sign-on credentials. Returns a two hour
REST API session ID that you use for subsequent REST API requests. Also logs out of a SAML single
sign-on session.

logout

Logs out of the organization and ends the REST API session specified in the request.

logoutall

Logs out of the organization and ends all REST API sessions for the organization.

mapping

Returns the details of a mapping or the details of all mappings in the organization.

masterTemplate

Returns the details of an integration template or the details of all integration templates in the
organization. Creates, updates, or deletes an integration template.

mttask

Returns the details of a Mapping Configuration task. Creates, updates, or deletes a Mapping
Configuration task.

org

Returns the details of an organization or related sub-organization. Updates an organization or related

sub-organization. Also deletes a related sub-organization.

permission

Returns user group permissions details for specific entities. Updates permission levels for specific user
groups and overwrites permissions set in the user interface.

register

Creates a Informatica Cloud organization or sub-organization using organization details. Also creates an
organization using Salesforce credentials. (Available for Informatica Cloud partners only.)

runtimeEnvironment

Returns the details of a runtime environment.

schedule

Returns the details of a schedule or the details of all schedules in the organization. Creates or updates a
schedule. Also deletes a schedule.

serverTime

Returns the local time of the Informatica Cloud server.

task

Returns a list of tasks of the specified type.

user

Returns the details of a user account or the details of all user accounts in the organization. Creates,
updates, or deletes a user account.

usergroup

Returns the details for a user group or all user groups in the organization.

10 Chapter 1: Informatica Cloud REST API

 workflow

Returns the details of a taskflow or the details of all taskflows in the organization. Creates, updates, or
deletes a taskflow.

XML Schema Definition

You can access the xml schema definition (XSD) for the Informatica Cloud REST API at the following URL:
https://app.informaticaondemand.com/saas/xsd/ics_api_v2.xsd
To use the XSD URL, log into Informatica Cloud, then enter the XSD URL.

Header and Body Configuration

Configure the request header and request body as required.

Request Header
When you construct a REST API request header, use the following format:
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/<json | xml>
Accept: application/<json | xml>
icSessionId: <icSessionId>
The following list describes the attributes of the above format:

METHOD

Required.

Method you want to use, such as GET, POST, or DELETE.

serverUrl

Required for most resources.

Base URL for all resources except login, loginSf, logoutall, register, and registerSf.

Use a placeholder for serverUrl, and replace the placeholder with the Informatica Cloud URL returned by
the login resource.

For the login, loginSf, logoutall, register, and registerSf resources, use the URL listed in the resource.

URI

Required for most resources.

Resource URI.

For the login, loginSf, logoutall, register, and registerSf resources, use the URL listed in the resource.

HTTP version

Required.

HTTP version that you are using.

XML Schema Definition 11

 Content-Type

Required for POST requests

Format of the request. Use one of the following options:

• application/json. Reads request as JSON.

• application/xml. Reads request as XML.

Default is json.

Accept

Optional.

Request format that you want. Use one of the following options:

• application/json. Sends response as JSON.

• application/xml. Sends response as XML.

Default is json.

icSessionId

Informatica Cloud session ID.

Required for all resources except login, loginSf, logoutall, register, and registerSf.

Use a placeholder for icSessionId, and replace the placeholder with the session ID returned by the login
resource.

Request Body
Use the request body to pass additional attributes for the resource. When you pass attributes in a request
body, you pass the attributes as part of an object.

For example, to log in with the login resource, you pass the required username and password attributes in a
login object.

Some requests include sub-objects for attributes. Declare the sub-objects before listing the related attributes.

JSON Format
When you use the JSON format, define a request object with the @type attribute, as follows:
{
"@type": "<request object>",
"<attribute1>": "<value1>",
"<attribute2>": "<value2>",
}
When an attribute includes an object, state the attribute and use the object name as follows:
{
"@type": "<request object>",
"<attribute1>": "<value1>",
"<attribute2>": {
"@type": "<attribute object>",
"<attributeA>": "<valueA>",
"<attributeB>": "<valueB>",}
"@type": "<attribute object>",
"<attributeD>": "<valueD>",
"<attributeE>": "<valueE>",}
"<attribute3>": "<value3>",
}

12 Chapter 1: Informatica Cloud REST API

 XML Format
When you use the XML format, define a request object as an enclosing set of tags, as follows:
<request object>
<attribute1>value1</attribute1>
<attribute2>value2</attribute2>
</request object>
When an attribute includes an object, enclose the attribute object within the attribute tags as follows:
<request object>
<attribute1>value1</attribute1>
<attribute2>
<attribute object>
<attributeA>valueA</attributeA>
<attributeB>valueB</attributeB>
</attribute object>
<attribute object>
<attributeC>valueC</attributeC>
<attributeD>valueD</attributeD>
</attribute object>
</attribute2>
<attribute3>value3</attribute3>
</request object>

Return Lists
When the REST API returns a series of objects in XML, it encloses the list in the root tag, as follows:
<root>
<return object 1>
<attribute1>value1</attribute1>
<attribute2>value2</attribute2>
</return object 1>
<return object 2>
<attribute1>value1</attribute1>
<attribute2>value2</attribute2>
</return object 2>
</root>
In JSON, no additional attributes are used. The REST API encloses the list in square brackets ( [ ] ), as
follows:
[
{
"@type": "<return object1>",
"<attribute1>": "<value1>",
"<attribute2>": "<value2>",
}{
"@type": "<return object2>",
"<attribute1>": "<value1>",
"<attribute2>": "<value2>",
}
]

JSON Example
To log in using JSON, you might use the following request header and body:
POST https://app.informaticaondemand.com/ma/api/v2/user/login HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"@type": "login",
"username": "[email protected]",

Header and Body Configuration 13

 "password": "mypassword"
}
The login might return the following information:
{
"@type" : "user",
"id" : "00000B03000000000001",
"orgId" : "00000B",
"name" : "[email protected]",
"description" : null,
"createTime" : "2012-06-14T15:00:00.000Z",
"updateTime" : "2012-06-14T15:00:00.000Z",
"createdBy" : "System",
"updatedBy" : "[email protected]",
"sfUsername" : null,
"firstName" : "Firstname",
"lastName" : "Lastname",
"title" : "Senior Software Engineer",
"password" : "********",
"phone" : "11111111111111111111",
"emails" : null,
"timezone" : "America/Los_Angeles",
"serverUrl" : "https://example.informatica.com/saas",
"icSessionId" : "IV4wOrJmd6YUtmKa8t"
}
You can then use the icSessionId and the serverUrl to construct a request to delete a schedule with the
schedule ID of 000001D0000000000001:
DELETE http://example.informatica.com/saas/api/v2/schedule/000001D0000000000001 HTTP/1.0
Accept: application/xml
icSessionId: IV4wOrJmd6YUtmKa8t
Note that Content-Type is not required because the DELETE method does not have additional attributes to
pass in the request body.

XML Example
To log in using XML, you might use the following header and body:
POST https://app.informaticaondemand.com/ma/api/v2/user/login HTTP/1.0
Content-Type: application/xml
Accept: application/xml

<login>
<username>[email protected]</username>
<password>mypassword</password>
</login>
The login might return the following information:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<user>
<id>00000B03000000000001</id>
<orgId>00000B</orgId>
<name>[email protected]</name>
<createTime>2012-06-14T15:00:00.000Z</createTime>
<updateTime>2012-06-14T15:00:00.000Z</updateTime>
<createdBy>System</createdBy>
<updatedBy>[email protected]</updatedBy>
<firstName>Firstname</firstName>
<lastName>Lastname</lastName>
<title>Senior Software Engineer</title>
<password>********</password>
<phone>11111111111111111111</phone>
<timezone>America/Los_Angeles</timezone>
<serverUrl>http://example.informatica.com/saas</serverUrl>
<icSessionId>IV4wOrJmd6YUtmKa8t</icSessionId>
</user>

14 Chapter 1: Informatica Cloud REST API

 You can then use the icSessionId and the serverUrl to construct a request to delete a schedule as follows.
The schedule ID is 000001D0000000000001.
DELETE http://example.informatica.com/saas/api/v2/schedule/000001D0000000000001 HTTP/1.0
Accept: application/xml
icSessionId: IV4wOrJmd6YUtmKa8t
Note that Content-Type is not required because the DELETE method does not have additional attributes to
pass in the request body.

Update Modes
You can submit a POST request using full update mode or partial update mode.

Use partial mode to submit a POST request that only includes the changed object fields, instead of including
all of the object fields. For example, if you want to update the connection in an mttask object, you can submit
a POST request using partial mode that might look like the following example:
POST api/v2/mttask/<taskId> HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>
Update-Mode: PARTIAL
{
"@type": "mtTask",
"parameters": [
{
"@type": "mtTaskParameter",
"name": "$NewSource$",
"type": "EXTENDED_SOURCE",
"sourceConnectionId": "<sourceConnectionId>"
}
]
}
If you do not use partial mode, you need to include the entire object in the request. By default, the REST API
uses full mode.

Partial mode is available for the following resources:

• connection
• fwConfig
• masterTemplate
• mttask
• schedule
• workflow

When you submit a POST request in partial mode, format the request using JSON and include the following
line in the header:
Update-Mode=PARTIAL
Include the @type attribute for the updated object in the body.

Update Modes 15
 Some fields are grouped in collections. To update a field that resides in a collection, include the key field for
the collection in the POST request. The following table lists the collections and corresponding key fields:

Resource Collection Key Field

fwConfig fwColumn name

masterTemplate mtParameter name

type

mttask mtTaskInOutParameter name

mttask sequenceDefinition txName

mttask mtTaskOverriddenField name

mttask mtTaskParameter name

type

workflow workflowTask taskId

Date/Time Values
With the REST API, Informatica Cloud uses the UTC date format to pass all date/time values.

Use the following UTC date format for all date/time values that you pass in requests. The same format is
used for all date/time values returned from Informatica Cloud.
<yyyy>-<MM>-<dd>T<HH>:<mm>:<ss>.<SSS>Z
The following list describes the attributes of the UTC date format:

yyyy

Year expressed in four digits.

MM

Month expressed in two digits.

dd

Date of the month expressed in two digits.

Indicates the time portion of the format.

HH

Hour in the 24-hour format. For example, 0 for 12:00:00 a.m. and 23 for 11:00:00 p.m.

mm

Minutes expressed in two digits.

ss

Seconds expressed in two digits.

16 Chapter 1: Informatica Cloud REST API

 SSS

Microseconds expressed in three digits.

UTC time indicator.

For example, the following date string represents 3:00 pm on December 14, 2012:
2012-12-14T15:00:00.000Z

Object IDs
Many requests require an object ID, such as a connection ID or task flow ID. To find the object ID that you
need, you can use the related GET request.

For example, to determine the task flow ID that you need to update a task flow, you can use a workflow GET
request to view the details of all task flows in the organization. The return list of task flow details includes
the task flow ID. Similarly, to determine the ID of a user, you can perform a user GET request.

Object IDs are not readily available through the Informatica Cloud application.

Session IDs
When you log in to an Informatica Cloud organization using the REST API, the login resource returns the REST
API session ID in the icSessionId attribute. You include this session ID in subsequent REST API requests
during the session. The session ID is valid for two hours.

You can submit a POST request to determine the status of a session ID. Use the following URI to submit the
request:
/api/v2/user/validSessionId
Include the following attributes in the request:

• icToken. The session ID.

• userName. Your Informatica Cloud user name.

For example, you might use the following request:

POST https://app.informaticaondemand.com/saas/api/v2/user/validSessionId HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"@type": "validatedToken",
"userName": "[email protected]",
"icToken": "<icSessionId>"
}
The response returns whether the session ID is valid or not. The response also includes the number of
minutes left before the session ID expires.

Object IDs 17
REST API Responses
The following table describes the responses to REST API requests:

REST API Request Successful Response Failure Response

GET For an information request, HTTP 403 error, including a REST API error
returns the requested object or object.
an array of objects when
applicable.
For an action request, returns
the HTTP 200 success code.
Can also return the REST API
success object.

POST The object that you created or HTTP 403 error, including a REST API error
updated. object.

DELETE HTTP 200 success code. Can HTTP 403 error, including a REST API error
also return the REST API object.
success object.

For example, if you use a GET request to view a schedule, a successful response is the schedule object that
you requested. Or, if you use a POST request to update the time that the schedule runs, a successful
response is the schedule object that you updated, including the update. If you use a DELETE request to delete
a schedule that is no longer being used, a successful response is the 200 success code.

Success Object
When the REST API successfully performs an action, it returns a 200 success response. It might also return a
success object.

The success object has the following structure:

<xs:complexType name="success">
<xs:sequence>
<xs:element name="description" type="xs:string"/>
</xs:sequence>
</xs:complexType>

Error Object
When the REST API encounters an error, it returns HTTP 403 error, including a REST API error object.

The error object has the following structure:

<xs:complexType name="error">
<xs:sequence>
<xs:element name="code" type="xs:string"/>
<xs:element name="description" type="xs:string"/>
<xs:element name="statusCode" type="xs:int"/>

18 Chapter 1: Informatica Cloud REST API

 </xs:sequence>
</xs:complexType>

Error Messages
The REST API provides the following error messages:

Error Code Response Key Response Text

13400 REST_UNKNOWN The REST API encountered an error: <info>.

13401 REST_PARAMETERS_ARE_WRONG Wrong parameters <info>.

13402 REST_ERROR_PARSING_JSON_OBJECT Error parsing JSON object.

13403 REST_ERROR_WRITING_JSON_OBJECT Error writing JSON object.

13404 REST_INVALID_OBJECT_ID Object identifier is invalid or missing, property is

(<info>).

13405 REST_NO_OBJECTS Connection has no objects.

13406 REST_INVALID_SUBORG_ID Sub org identifier is invalid, property is (<info>).

13407 REST_REGISTRATION_ERROR Error during user registration.

13408 REST_INSUFFICIENT_SUBORG_PRIVILEGE Insufficient privileges to create suborg. User must

have org hierarchy license and update org privilege to
create suborg.

13409 REST_MAX_SUBORG_LIMIT Maximum subOrgLimit reached.

13410 REST_PARENT_ORG_HAS_PARENT_ORG Parent org which already has a parent org could not
create a subOrg.

13411 REST_INSUFFICIENT_VIEW_USER_PRIVILEGE Insufficient privileges to view user.

13412 REST_INSUFFICIENT_DELETE_USER_PRIVILEGE Insufficient privileges to delete user.

13413 REST_DNB_EMPTY_ID_UNAME Empty value for id and uname.

13414 REST_INVALID_CONN_ID Invalid connection ID.

13415 REST_INVALID_CONN_ID_TYPE Enter a valid connectionId with a valid connection

type <type> for the application type <type>.

13416 REST_INVALID_SCHEDULE_ID Invalid schedule ID.

13417 REST_INVALID_USERNAME Invalid user name. It must be a valid email address.

13418 REST_INVALID_PASSWORD Invalid password.

13419 REST_INVALID_FIRSTNAME Invalid first name.

Error Messages 19
 Error Code Response Key Response Text

13420 REST_INVALID_LASTNAME Invalid last name.

13421 REST_INVALID_PHONE Invalid phone.

13422 REST_INVALID_EMAIL Invalid email.

13423 REST_INVALID_TIMEZONE Invalid time zone.

13424 REST_INVALID_LICENSE You cannot use the REST API. You must have a valid
REST API license to use the REST API. Contact
Informatica Global Customer Support.

13425 REST_INVALID_TASK_TYPE Invalid taskType.

13426 REST_INVALID_AGENT_ID Invalid Secure Agent ID.

13427 REST_INVALID_CODE_PAGE Invalid codepage. It must be UTF-8 or MS1252.

13428 REST_INVALID_TYPE Invalid type <type>.

13429 REST_INVALID_TASK_ID Invalid taskId <id>.

13430 REST_INVALID_TASK_NAME Invalid task name <name>.

13431 REST_INVALID_RUN_TASK Invalid privileges when running <task> task with id

<id>.

13434 REST_INVALID_CERTIFICATE_FILE_TYPE Invalid certificateFileType.

13435 REST_INVALID_AUTHENTICATION_TYPE Invalid authenticationType.

13436 REST_INVALID_PRIVATE_KEY_FILE_TYPE Invalid privateKeyFileType.

13437 REST_INVALID_DATE_FORMAT Invalid date format. Valid values are <info>.

13438 REST_INVALID_COUNTRY_CODE Invalid country code.

13439 REST_INVALID_STATE_CODE Invalid state code.

13440 REST_INVALID_TITLE Invalid title.

13441 REST_NETSUITE_NOT_SUPPORTED NetSuite connection type not supported for create or

update.

13442 REST_TOOLKIT_NOT_SUPPORTED TOOLKIT connection type not supported for create or

update.

20 Chapter 1: Informatica Cloud REST API

REST API Guidelines
Use the following guidelines when working with Informatica Cloud REST API:

• Use the login resource to start a two-hour REST API session. Best practice is to log out before the session
ends. To continue work with the REST API, start a new session.
• Use the logout resource to log out of the Informatica Cloud session included in the request header. Use
the logoutall resource to log out of all REST API sessions started by the user in the request body.
• Construct a request using the JSON or XML format.
• Specify the format of the request and response in the header. Use the Content-Type attribute to specify
the request format and the Accept attribute to specify the response format.
• If a request or response type is not configured, Informatica Cloud uses JSON by default.
• Use a placeholder for the icSessionId in request headers for all resources except login, loginSf, logoutall,
register, and registerSf. Replace the placeholder with the icSessionId data returned when you log in to a
session.
The login, loginSf, logoutall, register, and registerSf resources do not require the icSessionId in the request
header.
• For all resources except login, loginSf, logoutall, register, and registerSf, use a placeholder for the base
URL. Replace the placeholder with the serverUrl data returned by the login resource.
• For POST requests, you must include all fields in the request object unless you submit the request in
JSON format using partial mode. By default, the REST API uses full mode.
• All resources and attributes are case-sensitive.
• Where indicated, enclose POST request attributes in the specified object. When no object is specified,
include attributes in the request body.
• For requests in JSON, use the @type attribute to define an object. For requests in XML, use an enclosing
<object name> tag to define an object.
• XML responses that include a list of objects return the objects enclosed in the <root> tag.

Documentation Conventions
Informatica Cloud REST API documentation uses the following conventions:

• Methods are in capital letters, such as GET.

• Request syntax uses the following conventions:
- Variables are enclosed in angle brackets ( < > ), such as <id> for a user ID.

- When listing a choice of attribute values, options are separated by a pipe ( | ).

- Optional attributes are in italics.

Resource Quick Reference

The following list contains the syntax and a brief description of the Informatica Cloud REST API resources:

activityLog GET

Returns information from the activity log.

REST API Guidelines 21

 Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/activity/activityLog/<id>
/api/v2/activity/activityLog?rowLimit=<row limit>
/api/v2/activity/activityLog?offset=<offset>
/api/v2/activity/activityLog?taskId=<taskId>
/api/v2/activity/activityLog?runId=<runId>
You can also use the activityLog to download error logs and session logs from the server.

Use the serverUrl from the login response for one of the following URIs:
/api/v2/activity/errorLog/<id>
/api/v2/activity/activityLog/<Top_Level_Log_Entry_Id>/sessionLog?itemId=<child-log-
entry-item-id>&childItemId=<child-log-entry-item-id>
activityMonitor GET

Returns information from the activity monitor.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/activity/activityMonitor?details=<true|false>
agent GET

Returns the details of a Secure Agent or of all Secure Agents in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/agent/<id>
/api/v2/agent/name/<name>
agent DELETE

Deletes a Secure Agent.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/agent/<id>
auditlog GET

Returns audit log entries.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/auditlog
/api/v2/auditlog?batchId=<batchId>&batchSize=<batchSize>
bundleObject GET

Returns the details of a bundle or the details of all published or installed bundles in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/bundleObject/<id>
/api/v2/bundleObject/name/<name>
/api/v2/bundleObject/?published=true
/api/v2/bundleObject/?published=true&installed=false
/api/v2/bundleObject/?installed=true
/api/v2/bundleObject/?published=false&installed=true
bundleObject POST

Pushes a published private bundle to sub-organizations.

Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObject/push/<bundleId>
bundleObjectLicense GET

Returns the details of all bundles available to or installed on the organization.

22 Chapter 1: Informatica Cloud REST API

 Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense/<bundleObjectId>
bundleObjectLicense POST
Installs a bundle.

Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense/
Use a bundleObjectLicense object to define attributes. Include the following required attribute: bundleId.

bundleObjectLicense DELETE
Uninstalls a bundle.

Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>
connection GET

Returns information related to connections in the organization.

You can request the following information:

• Connection details. You can request the details of a connection or of all connections in the
organization. Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<id>
/api/v2/connection/name/<name>
• Connection objects. You can request a list of objects that you can use as a source or target for the
specified connection. Use the serverUrl from the login response as the base URL for one of the
following URIs:
/api/v2/connection/source/<id>
/api/v2/connection/target/<id>
• Connection details by runtime environment. You can request a list of all connections in the
organization that use a particular runtime environment. Use the serverUrl from the login response as
the base URL for the following URI:
/api/v2/connection/<runtimeEnvironmentId>
• Connections by Secure Agent and connection type. You can request a list of connections by Secure
Agent ID and connection type. Use the serverUrl from the login response as the base URL for the
following URI:
/api/v2/connection/search?agentId=<agent ID>&uiType=<uiType>
• Metadata details. To request metadata details for a connection, use the following URI:
/api/v2/connection/<source or target>/<id>/ metadata
• Test connection. To test a connection, use the serverUrl from the login response as the base URL for
the following URI:
/api/v2/connection/test/<id>
connection POST

Creates or updates a connection.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connection/<id>
Use a connection object to define attributes.

connection DELETE

Deletes a connection.

Resource Quick Reference 23

 Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connection/<id>
connector GET
Returns a list of connectors available to the organization or attribute values for a specified connector
type.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connector
/api/v2/connector/metadata?connectorType=<connectorType>
customFunc GET

Returns the details of a mapplet or of all mapplets in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/customFunc/<id>
/api/v2/customFunc/name/<name>
customFunc POST

Uploads a PowerCenter mapplet.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/customFunc/<id>
Define attributes in the request body and encode the request body as multipart/form-data. Include the
following required attributes: file, name.

customFunc DELETE

Deletes a mapplet.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/customFunc/<id>
dataPreview GET

Use this resource to preview data during mapping design. Returns up to ten rows of source or target
data for a specified object.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<connId>/datapreview/<object name>
/api/v2/connection/<source or target>/name/<name>/datapreview/<object name>
expressionValidation POST

Validates expressions and returns a success or error response.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/expression/validate
field GET

Returns the field details for a source or target object.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<id>/field/<objectName>
/api/v2/connection/<source or target>/name/<name>/field/<object name>
/api/v2/connection/<source or target>/<id>/fields?objectName=<objectName>
field POST

Updates the flat file attributes for a source or target object.

24 Chapter 1: Informatica Cloud REST API

 Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<id>/field/<objectName>
The flat file attributes provided in the request override the default attributes specified in the connection
object.

fileRecord POST

Upload an integration template XML file or image file.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fileRecord
Define attributes in the request body and encode the request body as multipart/form-data. Include the
following required attributes: file, name.

fileRecord DELETE

Delete an integration template file or image file.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fileRecord/<id>
fwConfig GET

Returns the details of a fixed-width format.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/fwConfig/<id>
/api/v2/fwConfig/name/<name>
fwConfig POST

Uploads a fixed-width format.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fwConfig/<id>
fwConfig DELETE

Delete a fixed-width format.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fwConfig/<id>
job POST

Starts or stops a task or task flow and optionally provides job status. You can perform the following
actions:

• To start a task or task flow, use the serverUrl from the login response as the base URL for the
following URI:
/api/v2/job
• To stop a task or task flow, use the serverUrl from the login response as the base URL for the
following URI:
/api/v2/job/stop
Use a job object to define attributes. Include the following required attributes: taskId or taskName, and
taskType.

licenseInfo GET

Returns the license details for the organization that you are logged in to or a specified sub-organization.

Resource Quick Reference 25

 Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/licenseInfo/org/<id>
licenseInfo POST
Updates license information for a sub-organization.

Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/licenseInfo/org/<id>
Use the orgLicenseInfo object to update license information.

login POST
Logs into an organization and returns a session ID that you can use for other resource calls.

You can log in using the following credentials:

• Informatica Cloud. To log in to an organization with your Informatica Cloud user account, use the
following URL:
https://app.informaticaondemand.com/ma/api/v2/user/login
Omit icSessionId from the request header.
Use a login object for attributes. Include the following required attributes: username, password.
• Salesforce. To log in to an organization with a Salesforce session ID and Salesforce server URL:
https://app.informaticaondemand.com/ma/api/v2/user/loginSf
Use a login object to define attributes. Include the following required attributes: sfSessionId,
sfServerUrl.

loginSAML POST

For SAML single sign-on users, logs into an organization and returns a session ID that you can use for
other resource calls.

To log in to an organization, use the following URL:

https://app.informaticaondemand.com/ma/api/v2/user/loginSAML
Omit icSessionId from the request header. Include the following required attributes in the login object:
orgId, samlToken.

logout POST

Logs out of an organization and ends the REST API session included in the request header.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/logout
logoutall POST

Logs out of an organization and ends all REST API sessions for the organization.

Use the following URL:

https://app.informaticaondemand.com/ma/api/v2/user/logoutall
Use a logout object to define attributes. Include the following required attributes: username, password.

Omit icSessionId from the request header.

mapping GET

Returns the details of a mapping or of all mappings in the organization. Can also return an image of a
mapping.

26 Chapter 1: Informatica Cloud REST API

 Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/mapping/<id>
/api/v2/mapping/name/<name>
/api/v2/mapping/search?name=<name>
/api/v2/mapping/<id>/image?deployed=<true|false>
masterTemplate GET

Returns information about integration templates. You can request the following information:

• Integration templates. You can request the details of an integration template or of all integration
templates in the organization. Use the serverUrl from the login response as the base URL for one of
the following URIs:
/api/v2/masterTemplate/<id>
/api/v2/masterTemplate/name/<name>
• Mapping Configuration tasks. You can request a list of Mapping Configuration tasks that use an
integration template. Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>/tasks
masterTemplate POST

Creates or updates an integration template.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>
Use a masterTemplate object to define attributes.

masterTemplate DELETE

Deletes an integration template.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>
mttask GET

Returns the details of a Mapping Configuration task.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/mttask/<id>
/api/v2/mttask/name/<name>
mttask POST

Creates or updates a Mapping Configuration task.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/mttask/<id>
Use an mttask object to define attributes.

mttask DELETE

Deletes a Mapping Configuration task.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/mttask/<id>
org GET

Returns the details of your Informatica Cloud organization or a related sub-organization.

Resource Quick Reference 27

 Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/org/<id>
/api/v2/org/name/<name>
org POST
Updates the details of an Informatica Cloud organization or a related sub-organization.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/org/<id>
Use an org object to define attributes.

org DELETE

Deletes a related sub-organization.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/org/<id>
permission GET

Returns permission details for a specific entity.

Use the serverUrl from the login response as the base URL for the following URI:
api/v2/permission/<id>
permission POST

Updates permissions for a specified object. The following values for the updatetype request parameter
determine how to apply the permissions:

• set. The permissions of the user groups provided in the request are updated and permissions for the
remaining user groups are set to default.
• setdefault. The permissions of all user groups are set to default. The request body is optional.
• update. The permissions of the user groups provided in the request are updated while the
permissions of user groups that are not mentioned in request remain unaffected.

Use the serverUrl from the login response as the base URL for the following URI:
api/v2/permission/<id>
register POST

Creates an Informatica Cloud organization. You can use the following methods to create an
organization:

• Creates an Informatica Cloud organization based on user and company information. Use the
following URL:
https://app.informaticaondemand.com/ma/api/v2/user/register
Omit the icSessionId from the request header.
• Creates an Informatica Cloud sub-organization based on an Informatica Cloud user account. Use the
serverUrl from the login response as the base URL for the following URI:
/api/v2/user/register
Define the icSessionId in the request header.
• Creates an Informatica Cloud organization based on Salesforce account details. Use the following
URL:
https://app.informaticaondemand.com/ma/api/v2/user/registerSf
Use a registration object to define attributes.

28 Chapter 1: Informatica Cloud REST API

runtimeEnvironment GET

Returns the details of the runtime environments used by the organization.

Use the serverUrl from the login response as the base URL for the following URI:
api/v2/runtimeEnvironment
schedule GET

Returns the details of a schedule or of all schedules in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/schedule/<id>
/api/v2/schedule/name/<name>
schedule POST

Creates or updates a schedule.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/schedule/<id>
Use a schedule object to define attributes.

schedule DELETE

Deletes a schedule.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/schedule/<id>
serverTime GET

Returns the local time for the Informatica Cloud server.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/server/serverTime
task GET

Returns a list of tasks of the specified type.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/task?type=<type>
user GET

Returns the details of an Informatica Cloud user account or of all user accounts in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/user/<id>
/api/v2/user/name/<name>
user POST

Creates or updates an Informatica Cloud user account.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/<id>
Use a user object to define attributes.

user DELETE

Deletes an Informatica user account.

Resource Quick Reference 29

 Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/<id>
usergroup GET
Returns the details of a user group or of all user groups in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/usergroup/<id>
/api/v2/usergroup/name/<name>
workflow GET

Returns the details of a task flow or of all task flows in the organization.

Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/workflow/<id>
/api/v2/workflow/name/<name>
/api/v2/workflow/?simpleMode=true
workflow POST

Creates or updates a task flow.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/workflow/<id>
Use a workflow object to define attributes.

workflow DELETE

Deletes a task flow.

Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/workflow/<id>

30 Chapter 1: Informatica Cloud REST API

Chapter 2

Informatica Cloud REST API

Resources
This chapter includes the following topics:

• activityLog, 32
• activityMonitor, 40
• agent, 43
• auditlog, 48
• bundleObject, 51
• bundleObjectLicense, 53
• connection, 55
• connector, 74
• customFunc, 75
• dataPreview, 81
• expressionValidation, 84
• field, 85
• fileRecord, 88
• fwConfig, 91
• job, 95
• licenseInfo, 98
• login, 100
• logout, 104
• logoutall, 104
• loginSaml, 105
• mapping, 108
• masterTemplate, 112
• mttask, 122
• org, 140
• permission, 146
• register, 151
• runtimeEnvironment, 159
• salesforceVersion, 161

31
 • schedule, 161
• serverTime, 170
• task, 170
• user, 171
• usergroup, 177
• workflow, 179

activityLog
Use this resource to request information from the activity log. You can also request error logs and session
logs from the server.

GET Request
You can request all of the activity log information or filter the activity log response. To request information
from the activity log, use the following URI:
/api/v2/activity/activityLog
To request information for a specific activity log ID, use the following URI:
/api/v2/activity/activityLog/<id>
To request information for a specific run ID, use the following URI:
/api/v2/activity/activityLog?runId=<runId>
To request information for a specific task, you can use the task ID, use the following URI:
/api/v2/activity/activityLog?taskId=<taskId>
To specify the number of rows to skip, use the following URI:
/api/v2/activity/activityLog?offset=<offset>
To specify a row limit, use the following URI:
/api/v2/activity/activityLog?rowLimit=<rowLimit>
You can use any combination of these options. For example, you can use the following URI in a request:
api/v2/activity/activityLog?
offset=<offset>&rowLimit=<rowLimit>&taskId=<taskId>&runId=<runId>
You can use the following optional activityLog GET URI attributes:

id

Activity log entry ID.

Include this attribute if you want to receive information for a specific ID.

runId

Job ID associated with the log entry ID.

taskId

Task ID associated with the log entry ID. If taskId is not specified, all activityLog entries for all tasks are
returned.

32 Chapter 2: Informatica Cloud REST API Resources

offset

The number of rows to skip. For example, you might want to skip the first three rows.

rowLimit

The maximum number of rows to return. The maximum number you can specify is 1000.

If you omit this attribute, the activityLog returns all available rows, up to a maximum of 200 rows.

GET Response
Returns an activityLogEntry object for each row in the activity log or returns an activityLogEntry object for the
specified ID. Returns the error object if errors occur.

When you request information for each row in the activity log, the activityLogEntry object includes the
following attributes:

id

Activity log entry ID.

type

The type of task. Returns one of the following codes:

• AVS. Contact Validation task.

• DMASK. Data Masking task.
• DQA. Data Assessment task.
• DRS. Data Replication task.
• DSS. Data Synchronization task.
• MTT. Mapping Configuration task.
• PCS. PowerCenter task.
• WORKFLOW. Linear taskflow.
• DNB_TASK. D&B360 task.
• DNB_WORKFLOW. D&B360 workflow.

objectId

Task ID.
objectName

Name of the task.

runId

ID for the task run.

agentId

Agent that runs the task.

runtimeEnvironmentId

Runtime environment where the task runs.

startTime

Start time for the task or task flow. Uses Eastern Time Zone (ET).

endTime

End time for the task or task flow. Uses Eastern Time Zone (ET).

activityLog 33
 startTimeUtc

Start time for the task or task flow. Uses Coordinated Universal Time (UTC).

endTimeUtc

End time for the task or task flow. Uses Coordinated Universal Time (UTC).

state

Whether the task completed successfully. Returns one of the following codes:

• 1. The task completed successfully.

• 2. The task completed with errors.
• 3. The task failed to complete.

failedSourceRows

Number of rows that were not read from the source.

successSourceRows

Number of rows that are successfully read from the source.

failedTargetRows

Number of rows that were not written to the target.

successTargetRows

Number of rows that were successfully written to the target.

errorMsg

Error message associated with the job.

startedBy

User who started the task.

runContextType

Method through which the task was initiated. Includes the following values:

• UI. Task was initiated through the Informatica Cloud user interface.
• SCHEDULER. Task was initiated through the task scheduler.
• REST-API. Task was initiated through the REST API.
• OUTBOUND MESSAGE. Task was initiated through an outbound message.

scheduleName

Schedule name, if task was initiated by a schedule.

entries

Indicates the start of information for a child object. A child object might be a task within a task flow, or
an object in a data replication task or D&B360 workflow.

When you request activity log information for a specific ID, the activityLogEntry object includes the following
attributes:

id

Activity log entry ID.

34 Chapter 2: Informatica Cloud REST API Resources

type

The type of task. Returns one of the following codes:

• AVS. Contact Validation task.

• DMASK. Data Masking task.
• DQA. Data Assessment task.
• DRS. Data Replication task.
• DSS. Data Synchronization task.
• MTT. Mapping Configuration task.
• PCS. PowerCenter task.
• WORKFLOW. Linear taskflow.
• DNB_TASK. D&B360 task.
• DNB_WORKFLOW. D&B360 workflow.

objectId

Task ID.

objectName
Name of the task.

runId

ID for the task run.

agentId

Agent that runs the task.

runtimeEnvironmentId

Runtime environment where the task runs.

startTime

Start time for the task or task flow. Uses Eastern Time Zone (ET).

endTime

End time for the task or task flow. Uses Eastern Time Zone (ET).
startTimeUtc

Start time for the task or task flow. Uses Coordinated Universal Time (UTC).

endTimeUtc

End time for the task or task flow. Uses Coordinated Universal Time (UTC).

state

Whether the task completed successfully. Returns one of the following codes:

• 1. The task completed successfully.

• 2. The task completed with errors.
• 3. The task failed to complete.

failedSourceRows

Number of rows that were not read from the source.

activityLog 35
 successSourceRows

Number of rows that are successfully read from the source.

failedTargetRows

Number of rows that were not written to the target.

successTargetRows

Number of rows that were successfully written to the target.

errorMsg

Error message associated with the job.

startedBy

User who started the task.

runContextType

Method through which the task was initiated. Includes the following values:

• UI. Task was initiated through the Informatica Cloud user interface.
• SCHEDULER. Task was initiated through the task scheduler.
• REST-API. Task was initiated through the REST API.
• OUTBOUND MESSAGE. Task was initiated through an outbound message.

scheduleName

Schedule name, if task was initiated by a schedule.

orgId

Organization ID.

totalSuccessRows

Total number of rows that were successfully read from the source and written to the target.

totalFailedRows

Total number of rows that were not read from the source and written to the target.

logFilename

The name of the generated log file.

errorFilename

The name of the generated error file.

errorFileDir

The location of the error file on the Secure Agent machine.

connType

Connection type.

stopOnError

Determines the runtime environment action to take when an nonfatal error occurs. Includes the following
values:

• True. The task flow stops when an error occurs.

• False. The task flow continues to process when an error occurs.

36 Chapter 2: Informatica Cloud REST API Resources

items

Includes the following attributes in the activityLogEntryItem object:

type

The type of task. Returns one of the following codes:

• AVS. Contact Validation task.

• DMASK. Data Masking task.
• DQA. Data Assessment task.
• DRS. Data Replication task.
• DSS. Data Synchronization task.
• MTT. Mapping Configuration task.
• PCS. PowerCenter task.
• WORKFLOW. Linear taskflow.
• DNB_TASK. D&B360 task.
• DNB_WORKFLOW. D&B360 workflow.

objectId

Task ID.
objectName

Name of the task.

runId

ID for the task run.

agentId

Agent that ran the task.

runtimeEnvironmentId

Runtime environment where the task ran.

startTime

Start time for the task or task flow. Uses Eastern Time Zone (ET).
endTime

End time for the task or task flow. Uses Eastern Time Zone (ET).

state

Whether the task completed successfully. Returns one of the following codes:

• 1. The task completed successfully.

• 2. The task completed with errors.
• 3. The task failed to complete.

errorMsg

Error message associated with the job.

connType

Connection type.

activityLog 37
 children

Returns an activityLogEntryItem object for each table in the task flow.

transformationEntries

Includes the following attributes for each transformation in the transformationLogEntry object:

• txName. Transformation name.

• txType. Transformation type.
• successRows. Number of successful rows for the transformation.
• failedRows. Number of failed rows for the transformation.

sequenceValues

Returns information generated from a task that includes the sequence generator transformation.
Includes the following attributes in the sequenceValueLogEntry object:

• txName. Transformation name.

• nextValue. The last value generated by the task.

inOutParameterValues

The in-out parameter values used in the task. Includes the following attributes in the
inOutParameterValueLogEntry object:

• name. Parameter name.

• value. Parameter value.

startedBy

User who started the task.

runContextType

Method through which the task was initiated. Includes the following values:

• UI. Task was initiated through the Informatica Cloud user interface.
• SCHEDULER. Task was initiated through the task scheduler.
• REST-API. Task was initiated through the REST API.
• OUTBOUND MESSAGE. Task was initiated through an outbound message.

scheduleName

Schedule name, if task was initiated by a schedule.

GET Example
To request 20 rows of information returned from the activity log in JSON format, you might use the following
request:
GET <serverUrl>/api/v2/activity/activityLog?rowLimit=20 HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
A successful request returns a list: an activityLogEntry object for each entry returned from the activity log.

The following text is a sample return in JSON:

[
{
"@type": "activityLogEntry",
"id": "000001C100000000000D",
"type": "DSS",
"objectName": "dss-f2f",

38 Chapter 2: Informatica Cloud REST API Resources

 "runId": 0,
"startTime": "2012-07-30T13:30:00.000Z",
"endTime": "2012-07-30T13:30:30.000Z",
"state": 3,
"failedSourceRows": 0,
"successSourceRows": 0,
"failedTargetRows": 0,
"successTargetRows": 0,
"errorMsg": "Exception class org.apache.axis.AxisFault is caught with message=;
nested exception is: \n\tjava.net.ConnectException: Connection refused: connect.",
"entries":
},
{
"@type": "activityLogEntry",
"id": "000001C100000000000C",
"type": "DRS",
"objectName": "drstask1",
"runId": 1,
"runtimeEnvironmentId": "00000C25000000000002",
"startTime": "2012-07-30T13:30:30.000Z",
"endTime": "2012-07-30T13:32:30.000Z",
"state": 1,
"failedSourceRows": 0,
"successSourceRows": 39,
"failedTargetRows": 0,
"successTargetRows": 39,
"errorMsg": null,
"entries": [
{
"@type": "activityLogEntry",
"id": "12",
"type": "DRS",
"objectName": "Contact",
"runId": 0,
"startTime": "2012-07-30T13:32:31.000Z",
"endTime": "2012-07-30T13:35:31.000Z",
"state": 1,
"failedSourceRows": 0,
"successSourceRows": 39,
"failedTargetRows": 0,
"successTargetRows": 39,
"errorMsg": "No errors encountered.",
"entries": []
},
]
}
]

Error Log Requests

You can request an error log from the server.

To request an error log from the server for a specific activity log ID, use the following URI:
/api/v2/activity/errorLog/id
To retrieve an error log from the server, you might use the following request:
GET <server URL>/api/v2/activity/errorLog/000002C10000000002BG HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
The server returns the error log as a string, as shown in the following example:
"Col1","Col2","Error"

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table

[test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table

activityLog 39
 [test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table

[test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table

[test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table

[test] has no keys specified."

Session Log Requests

You can download session logs for all task types using the sessionLog API. For tasks that have subtasks
such as Data Replication and task flows, you can download a ZIP file that contains all of the session logs in
the hierarchy. For Data Replication tasks, which have two levels of tasks, you can specify an itemId to return
a session log for a subtask if you do not want all of the session logs. For task flows, which have three levels
of tasks, you can specify an itemId or childItemId to return a session log for a particular subtask.

Use the following URI to download session logs:

/saas/api/v2/activity/activityLog/<Top_Level_Log_Entry_Id>/sessionLog?itemId=<child-log-
entry-item-id>&childItemId=<child-log-entry-item-id>
The following example requests include a request for a specific session log and requests for session logs for
subtasks:

• To request a session log, which may return a ZIP file if the task is a Data Replication task or task flow, you
might use the following request:
/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog
• To request a session log for a particular subtask for a Data Replication task or task flow, you might use
the following request:
/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog?itemId=233
• To request a session log for a sub-subtask in a task flow, you might use the following request:
/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog?
itemId=233&childItemId=234

activityMonitor
Use this resource to request information from the activity monitor.

GET Request
To request information from the activity monitor, use the following URI:
/api/v2/activity/activityMonitor?details=<true|false>
You can use the following activityMonitor GET URI attribute:

details

Optional.

Activity monitor detail to be returned from Informatica Cloud. Use one of the following options:

• true. Returns activity monitor information for tasks, task flows, and child objects. Child objects can
include tasks within task flows, and objects within data replication tasks and D&B360 workflows.
• false. Returns activity monitor information for tasks and task flows.

40 Chapter 2: Informatica Cloud REST API Resources

 Default is false. If you omit this optional attribute, activitymonitor does not return additional details.

GET Response
Returns an activityMonitorEntry object for each row in the activity monitor. Returns the error object if errors
occur.

The activityMonitorEntry object includes the following GET response attributes:

id

Activity monitor entry ID.

type

The type of task. Returns one of the following codes:

• AVS. Contact Validation task.

• DMASK. Data Masking task.
• DQA. Data Assessment task.
• DRS. Data Replication task.
• DSS. Data Synchronization task.
• MTT. Mapping Configuration task.
• PCS. PowerCenter task.
• WORKFLOW. Linear taskflow.
• DNB_TASK. D&B360 task.
• DNB_WORKFLOW. D&B360 workflow.

taskId

Task ID.

taskName

Task name.

objectName

Source object used in the task, or the data replication or D&B360 object being processed.
runId

ID for the task run.

startTime

Start time for the task or task flow.

endTime

End time for the task or task flow.

executionState

State of the task. Returns one of the following codes:

• INITIALIZED
• RUNNING
• STOPPING
• COMPLETED

activityMonitor 41
 • FAILED

failedSourceRows

Number of rows that were not read from the source.

successSourceRows

Number of rows that were successfully read from the source.

failedTargetRows

Number of rows that were not written to the target.

successTargetRows

Number of rows that were successfully written to the target.

errorMsg

Error message associated with the job.

entries

Indicates the start of information for a child object. A child object might be a task within a task flow, or
an object in a data replication task or D&B360 workflow.

agentId
Agent used for the activity.

runtimeEnvironmentId

Runtime environment used for the activity.

startedBy

User who started the task.

runContextType

Method through which the task was initiated. Includes the following values:

• UI. Task was initiated through the Informatica Cloud user interface.
• SCHEDULER. Task was initiated through the task scheduler.
• REST-API. Task was initiated through the REST API.
• OUTBOUND MESSAGE. Task was initiated through an outbound message.

scheduleName

Schedule name, if task was initiated by a schedule.

callbackURL

Status of the job.

GET Example
To return activity monitor information including details about child objects in XML, you might use the
following request:
GET <serverUrl>/api/v2/activity/activityMonitor?details=true HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
A successful request returns a list: an activityMonitorEntry object for each item returned from the activity
monitor.

42 Chapter 2: Informatica Cloud REST API Resources

 The following text is a sample return in XML:
<root>
<activityMonitorEntry>
<id>000001C100000000000D</id>
<type>DSS</type>
<objectName>dss-f2f</objectName>
<runId>0</runId>
<startTime>2012-07-30T13:30:00.000Z</startTime>
<endTime></endTime>
<executionState>RUNNING</executionState>
<failedSourceRows>0</failedSourceRows>
<successSourcerows>938</successSourceRows>
<failedTargetRows>0</failedTargetRows>
<successTargetRows>596</successTargetRows>
<errorMsg> </errorMsg>
<entries> </entries>
<agentId>00000C08000000000003</agentId>
<runtimeEnvironmentId>00000C25000000000002</runtimeEnvironmentId>
</activityMonitorEntry>
<activityMonitorEntry>
<id>000001C500000000000L</id>
<type>PCS</type>
<objectName>pcs-lookup</objectName>
<runId>2</runId>
<startTime>2012-07-30T13:30:03.001Z</startTime>
<endTime>2012-07-30T13:30:03.010Z</endTime>
<executionState>COMPLETE</executionState>
<failedSourceRows>0</failedSourceRows>
<successSourcerows>688</successSourceRows>
<failedTargetRows>0</failedTargetRows>
<successTargetRows>688</successTargetRows>
<errorMsg> </errorMsg>
<entries> </entries>
<agentId>00000C08000000000003</agentId>
<runtimeEnvironmentId>00000C25000000000002</runtimeEnvironmentId>
</activityMonitorEntry>
</root>

agent
Use this resource to request the details of an Informatica Cloud Secure Agent or the details of all Secure
Agents in the organization. You can also request the details of services that run on a Secure Agent or details
of services that run on all Secure Agents in the organization. You can also use this resource to delete a
Secure Agent.

GET Request
To request the details of all Secure Agents in the organization, use the following URI:
/api/v2/agent
To request the details of a particular Secure Agent, you can include the Secure Agent ID or the Secure Agent
name in the URI. Use one of the following URIs:
/api/v2/agent/<id>
/api/v2/agent/name/<name>
If you use the Secure Agent name in the URI and the Secure Agent name includes a space, replace the space
with %20. For example:
/api/v2/agent/name/special%20agent

agent 43
 To request the details of the services that run on all of the Secure Agents in the organization, use the
following URI:
/api/v2/agent/details
To request the details of the services that run on a particular Secure Agent, include the agent ID in the URI as
follows:
/api/v2/agent/details/<id>

GET Response
Returns the agent object for the requested Secure Agent ID or Secure Agent name.

If you request information for all Secure Agents in the organization, returns an agent object without the
packages and agentConfigs attributes for each Secure Agent in the organization.

If you request information for agent services, returns an AgentEngine object in addition to the agent object.

Returns the error object if errors occur.

The agent object includes the following attributes:

id

Secure Agent ID.

orgId

Organization ID.

name

Secure Agent name.

description

Description of the Secure Agent.

createTime

Time the Secure Agent was created.

updateTime

Last time the Secure Agent was updated.

createdBy
User who created the Secure Agent.

updatedBy

User who updated the Secure Agent.

active

Whether the Secure Agent is active. Returns one of the following values:

• true. Active.
• false. Inactive.

readyToRun

Whether the Secure Agent is ready to run a task. Returns one of the following values:

• true. Secure Agent is ready to run a task.

• false. Secure Agent is not ready to run a task.

44 Chapter 2: Informatica Cloud REST API Resources

platform

Platform of the Secure Agent machine. Returns one of the following values:

• win64
• linux64

agentHost

Host name of the Secure Agent machine.

password

Password of the Secure Agent machine.

proxyHost

Host name of the outgoing proxy server that the Secure Agent uses.

proxyPort

Port number of the outgoing proxy server.

proxyUser

User name to connect to the outgoing proxy server.

proxyPassword

Password to connect to the outgoing proxy server.

agentVersion

Secure Agent version.

spiUrl

Informatica Cloud Application Integration URL for the organization the user belongs to.

upgradeStatus

Upgrade status.

lastUpgraded

Last time the Secure Agent was upgraded.

lastUpgradeCheck

Last time the Secure Agent was checked for upgrade.

lastStatusChange

Last time the Secure Agent status was updated.

packages

Informatica Cloud Connector packages.

agentConfigs

Attribute that defines Secure Agent properties. Includes the following attributes in an agentConfig object
for each Secure Agent property.

name

Configuration property name.

agent 45
 type

Configuration type. Returns one of the following values:

• Secure Agent Core

• Secure Agent Manager
• DTM
• Apache Tomcat JRE
• Secure Agent Core JRE

subtype
Configuration subtype. Returns one of the following values:

• INFO
• DEBUG

value

Value of the property.

customized

Whether the property is in the custom configuration details. Returns one of the following values:

• true.
• false.

overridden

Whether the property has been overridden. Returns one of the following values:

• true.
• false.

defaultValue

Default value.

platform

Platform. Returns one of the following values:

• win64
• linux64

configUpdateTime

Last time a user updated Secure Agent properties.

If you request details for the services that run on Secure Agents, the agent object also includes the
AgentEngine object. The AgentEngine object includes the following attributes:

agentEngineStatus

Status of the agent service, which includes the following attributes in the AgentEngineStatus object:
appname

The service name that is used internally.

appDisplayName

The service name that displays in the user interface.

46 Chapter 2: Informatica Cloud REST API Resources

 appversion

The service version. The version number changes each time you modify the service.

status

The status of the service.

createTime

The time the service was created.

updateTime

The last time the service was updated.

agentEngineConfigs

Attribute that defines agent service properties. Includes the following attributes in an engineConfig
object for each agent service property:
type

Configuration type.

name

Configuration property name.

value

Value of the property.

platform

Platform. Returns one of the following values:

• win64
• linux64

customized

Whether the property is in the custom configuration details. Returns one of the following values:

• true.
• false.

DELETE Request
You can delete a Secure Agent if it is not associated with any connections. Before you delete a Secure Agent,
update associated connections to use another Secure Agent.

To delete a Secure Agent, use the Secure Agent ID in the following URI:
/api/v2/agent/<id>

DELETE Response
Returns the 200 response code 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.

agent 47
auditlog
Use this resource to request entries from the audit log.

GET Request
To request the most recent 200 entries in the audit log, use the following URI.
/api/v2/auditlog
To request a specific batch of audit log entries, define the batch size and request a batch number with the
following URI.
/api/v2/auditlog?batchId=<batchId>&batchSize=<batchSize>
Use the following auditlog GET URI attributes:

batchSize

Required

Number of entries to include in a batch.

batchId

Required

The batch that you want to view.

Use 0 for the first batch, which contains the most recent audit log entries.

For example, to view entries 26-50, use a batch size of 25, and request batch 1.

GET Response
Returns an auditLogEntry object for each audit log entry returned. Returns the error object if errors occur.

The auditLogEntry object includes the following attributes:

id

Audit log entry ID.

version

Version.

orgId

Org ID.

username

User who performed the action.

entryTime
Time the action occurred.

objectId

ID of the object used.

objectName

Name of the object used.

48 Chapter 2: Informatica Cloud REST API Resources

category

Category of audit log entry. Returns one of the following codes:

• AUTH. Authorization.
• AGREEMENT. Subscription agreement.
• SYSTEM_INFO.
• ADMIN_REPORT.
• ORG. Organization.
• USER.
• AGENT. Secure Agent.
• CONNECTION.
• SCHEDULE.
• DRS. Data replication.
• DQA. Data assessment.
• DMASK. Data masking.
• DSS. Data synchronization.
• DATA_FILE. File.
• WORKFLOW. Task flow.
• PCS. PowerCenter.
• MTT. Mapping configuration.
• CUSTOM_FUNC. Mapplet.
• MIGRATE. Migration.
• CUSTOM_SOURCE. Saved query.
• DNBWORKFLOW. D&B360 workflow.
• ITEM_VIEW. Custom views.
• SUBSCRIPTION_BILLING.
• USER_GROUP.
• SUB_ORG. Sub-organization.
• OBJECT_ACL. Object permissions.
• AVS. Contact validation.
• PACKAGE.
• TEMPLATE. Integration template.
• DTEMPLATE. Mappings.
• CONNECTOR. Informatica Cloud Connector.
• EDITION. Informatica Cloud edition.
• SCHEDULE_BLACKOUT. Schedule blackout period.
• EXT_CONNECTION. Connections stored on a local Secure Agent.
• BUNDLE.
• ORG_EDITION. Information about changes to organization edition association. For example, when the
organization is reassigned a new edition.

auditlog 49
 • RUNTIME_ENVIRONMENT.

event

Type of action performed. Returns one of the following codes:

• LOGIN
• CREATE
• UPDATE
• DELETE
• DISABLE
• RUN
• VERSION1
• VERSION2
• VERSION3
• VERSION4
• VERSION5
• VERSION6
• VERSION7
• DOWNLOAD
• EXPORT
• IMPORT
• MAKE_DEFAULT
• LINK
• ENCRYPT
• MOVE_CONNS_TO_AGENT
• MOVE_CONNS_TO_IOD
• STOP

eventParam
Objects related to the action.

message

Additional information.

GET Example
To view rows 21-40, you might use the following URI.
/api/v2/auditlog?batchId=1&batchSize=20

50 Chapter 2: Informatica Cloud REST API Resources

bundleObject
Use this resource to request the details for a specific bundle or the details for all bundles published by the
organization or installed by the organization. You can also push a published private bundle to sub-
organizations.

GET Request
To request the details of a particular bundle, you can include the bundle ID or the bundle name in the URI. Use
one of the following URIs:
/api/v2/bundleObject/<id>
/api/v2/bundleObject/name/<name>
If you use the bundle name in the URI and the bundle name includes a space, replace the space with %20. For
example:
/api/v2/bundleObject/name/first%20bundle
To request the details for all bundles published by the organization, use one of the following URIs:
/api/v2/bundleObject/?published=true

/api/v2/bundleObject/?published=true&installed=false

To request the details for all bundles installed by the organization, use one of the following URIs:
/api/v2/bundleObject/?installed=true

/api/v2/bundleObject/?published=false&installed=true

GET Response
When you request the details for a bundle, returns the bundleObject for the bundle.

When you request a list of published bundles, returns a bundleObject for each bundle that the organization
published.

When you request a list of installed bundles, returns a bundleObject for each bundle that the organization
installed.

Returns the error object if errors occurred.

The bundleObject includes the following attributes:

id

Bundle ID.

orgId

Organization ID.

name

Bundle name.

description

Description.

createTime

Time the bundle was created.

bundleObject 51
 updateTime

Time the bundle was updated.

createdBy

User who created the bundle.

updatedBy

User who last updated the bundle.

lastVersion

The current published version of the bundle.

revokeTime

This attribute is not used at this time.

paid

Whether the bundle was purchased. Returns true for paid, false for free.

copyable

Determines whether users can download the contents of the bundle locally. Includes the following
values:

• True. Users can download the bundle.

• False. Users cannot download the bundle.

accessType

Access type for the bundle. Returns the following codes in the BundleObjectAccessType object:

• PUBLIC. Available to all Informatica Cloud organizations.

• SUBORGS. Available to sub-organizations of the publishing organization.
• ACCESS_LIST. Available to the organization IDs in the sharedWith attribute.

objects

Objects in the bundle. Includes the following attributes in the bundleRefObject object:

• objectTypeCode. The type of bundle. Includes the following values:

- 0V. Integration template.

- 17. Mapping.

- 0L. Mapplet.
• objectId. Object identified in the bundle.
• objectName. Name of the object in the bundle.
• objectUpdateTime. The date and time that the object in the bundle was last updated.
publishOrgId

ID of the organization that published the bundle.

publishOrgName

Name of the organization that published the bundle.

externalId

External ID for the bundle.

52 Chapter 2: Informatica Cloud REST API Resources

 POST Request
As part of a parent organization, you can share a private bundle with sub-organizations.

You can push a published private bundle to install the bundle on all sub-organizations. Push a published
private bundle when you want the objects in the bundle to be immediately available to all sub-organizations.

To push a bundle to a sub-organization, use the ID of the bundle object in the following URI:
/api/v2/bundleObject/push/<bundleId>

POST Response
Returns the success response if the request is successful. Returns the error object if errors occur.

bundleObjectLicense
Use this resource to request license information about bundles installed on or available to the organization.
You can also install a bundle and uninstall a bundle.

GET Request
To request license information for a bundle associated with to the organization, use the bundle ID in the
following URI:
/api/v2/bundleObjectLicense/<bundleObjectId>
To request license information for all bundles associated with the organization, omit the optional bundle ID.

GET Response
If successful, returns the BundleObjectLicenseType for the requested bundle.

If you request license information for all bundles, returns the bundleObjectLicense object for all bundles
associated with the organization.

Returns the error object if errors occur.

The bundleObjectLicense object includes the following attributes:

bundleObjectId

Bundle ID.

orgId

IDs of the organization.

updateOption
This attribute is not used at this time.

licenseType

Bundle type. Returns one of the following values:

• Free.
• Trial.
• Subscription.

endDate

Date the license expires. Returns NULL for free public bundles.

bundleObjectLicense 53
 numberOfDaysToApply

This attribute is not used at this time.

numberOfMonthsToApply

This attribute is not used at this time.

beginDate

Publish date for the bundle.

bundleVersion

Version number for the bundle.

createTime

Creation date for the bundle.

installed

Indicates if the organization installed the bundle. Returns TRUE for installed bundles and FALSE for
available bundles.

active

Indicates that the bundle is available and active. Returns TRUE.

accessCode

Required to install a licensed bundle. Used for sharing private bundles. Read only.

POST Request
To install a bundle on the organization, use the following URI:
/api/v2/bundleObjectLicense
With this URI, use the following attributes in a bundleObjectLicense object:

bundleObjectId

The ID of the bundle.

check

Optional.

Validates the bundle before installation. Use TRUE to validate the bundle.

POST Response
Returns the success response if the request is successful. Returns the error object if errors occur.

DELETE Request
To uninstall a bundle from the organization, use the following URI:
/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>
Use the following bundleObjectLicense Delete URI attributes:
bundleObjectId

The ID of the bundle.

updateOption

Optional.

54 Chapter 2: Informatica Cloud REST API Resources

 Defines what happens if objects in the bundle are used. Use one of the following options:

• DELETE_EXISTING_OBJECTS. Deletes the objects that use the bundle object.

• UPDATE_EXISTING_OBJECTS. Updates the object that uses the bundle object.
• EXCEPTION_IF_IS_USED. Returns a message when a bundle object is used and cancels the
uninstallation.

DELETE Response
Returns the success response if the request is successful. Returns the error object if errors occur.

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

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>

connection 55
 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:

agentId

Secure Agent ID.

runtimeEnvironmentId

Runtime environment ID.

uiType

Connection type. Use one of the following options:

• CSVFile. CSV flat file.

• FTP.

56 Chapter 2: Informatica Cloud REST API Resources

 • 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. 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:

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

runtimeEnvironmentId 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 Microsoft SQL Server instance name.

host Host name for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections.

domain 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 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, Microsoft SQL Server, and Web Service
connections.

adjustedJdbcHostName Host name. Or host and instance name for Microsoft SQL Server connections.

accountNumber Account ID for NetSuite connections.

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.

58 Chapter 2: Informatica Cloud REST API Resources

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

connection 59
 Attribute Description

connParams Parameters used in the connection.

Includes connection attributes in the connParam object for SAP, NetSuite, Oracle CRM On
Demand, and Informatica Cloud Connector connections.

connListItem The connListItem object includes the following attributes:

id

Source or target ID.

name

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 “connector” on page 74.

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” on page 197 and “Connector Data
Types” on page 196.

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>

60 Chapter 2: Informatica Cloud REST API Resources

 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/user/connection/0002D420000000J HTTP/1.0
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.

connection 61
 Attribute Description

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.

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.

62 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

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.

connection 63
 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.

64 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

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

connection 65
 Attribute 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 Informatica Cloud 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.

66 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

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.

connection 67
 Attribute Description

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.

68 Chapter 2: Informatica Cloud REST API Resources

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 Informatica Cloud uses to access the database in the local area network.

connection 69
 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/[email protected].

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/[email protected].

password Password for the Salesforce account.

70 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

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.

connection 71
 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.

72 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

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 Cloud 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 Cloud 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 Cloud 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
Cloud. Optional.

certificateFilePassword Password for the client certificate. You specify the certificate file password if the web
service provider needs to authenticate Informatica Cloud. 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 Cloud. 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 Cloud. 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 Cloud.
If necessary, use PEM. Optional.

connection 73
 Attribute Description

authenticationType Authentication type to use when the web service provider does not return an authentication
type to Informatica Cloud. 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 Cloud uses to access the database in the local
area network.

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 HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
A successful response returns the following attributes in the connector object:

Attribute Description

name Name of the connector.

type Type of connector. Includes the following values:

- Salesforce
- Oracle
- SqlServer
- MySQL
- CSVFile
- ODBC
- MS_ACCESS
- FTP
- SAP
- WebServicesConsumer
- MSD

publisher Name of the entity that published the connector.

74 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

connectorVersion Connector version.

shortName Connector short name.

isPublic 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 HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
A successful response returns the following attributes in the connectorMetadata object:

Attribute Description

type Type of connector, such as Salesforce or Oracle.

isStandardConnType Whether the connector is standard or custom. A "True" value indicates the connector is
standard.

attributes Connector attributes for the specified connector type. Includes the following attributes for
each connector attribute:
- name. Name of the attribute, such as database or codePage.
- label.
- id.
- value. Value of the attribute.
- type. Data type. For values, see “Connector Data Types” on page 196 .
- isMandatory. Whether the attribute is mandatory.
- visible.
- list. A list of types for the selected connector type. For example, SQL Server includes the
types SqlServer2000, SqlServer2005, SqlServer2008, and so on.

customFunc
Use this resource to request the details of a mapplet or to request a list of all mapplets in the organization.
You can also use this resource to upload a PowerCenter mapplet, and to delete a mapplet.

GET Request
To request a list of all mapplets in the organization, use the following URI:
/api/v2/customFunc

customFunc 75
 To request the details of a single mapplet, you can use the mapplet ID or mapplet name in the request. Use
one of the following URIs:
/api/v2/customFunc/<id>
/api/v2/customFunc/name/<name>
If you use the mapplet name and the mapplet name includes a space, replace the space with %20. For
example:
/api/v2/customFunc/name/my%20mapplet

GET Response
If the request for a list of mapplets is successful, returns the customFunc object for every mapplet in the
organization without the input, output, and connection details.

If the request for the details of a single mapplet is successful, returns the customFunc object.

Returns the error object if errors occur.

The customFunc object includes the following attributes:

id

Mapplet ID.

orgId

Organization ID.

name

Mapplet name.

description

Mapplet description.

createTime

Time the mapplet was created.

updateTime

Time the mapplet was last updated.

createdBy

User who created the mapplet.

updatedBy

User who last updated the mapplet.

mappletName

Name of the Mapplet transformation used in the mapplet.

active

Whether the mapplet is active:

• true. The mapplet is active.

• false. The mapplet is passive.

mappletXmlFile

The mapplet XML file.

76 Chapter 2: Informatica Cloud REST API Resources

inputs

Input fields for the mapplet. Includes the following information for each field in the field object:

• id
• name
• type
• label
• parentObject
• precision
• pcType
• scale
• columnIndex
• isKey
• isExternalId
• isNullable
• isUnique
• isCreateable
• isCalculated
• isUpdateable
• isFilterable
• linkedFields
• relatedInfos. Includes the following information in the fieldRelatedInfo object:
- id

- referenceObject

- relationshipName
• javaType
• showLabel
• naturalOrder
• customProperties

outputs

Output fields for the mapplet. Includes the following information in for each field in the field object:

• id
• name
• type
• label
• parentObject
• precision
• pcType
• scale
• columnIndex

customFunc 77
 • isKey
• isExternalId
• isNullable
• isUnique
• isCreateable
• isCalculated
• isUpdateable
• isFilterable
• linkedFields
• relatedInfos. Includes the following information in the fieldRelatedInfo object:
- id

- referenceObject

- relationshipName
• javaType
• showLabel
• naturalOrder
• customProperties

connections

Connection information for the mapplet. Includes the following attributes in the pcsConnection object
for each connection:

• id
• name
• type
• subtype
• description
• connectionId

POST Request
To update an existing mapplet, use the mapplet ID in the following URI. To upload a new PowerCenter
mapplet, omit the optional ID parameter:
/api/v2/customFunc/<id>
Note: Encode the request body as multipart/form-data.

With this URI, you can use the following attributes in the request body:

file

Required.

The Mapplet XML file exported from Informatica PowerCenter. File content should be in binary format,
UTF-8 encoding.

name

Required.

The Mapplet name.

78 Chapter 2: Informatica Cloud REST API Resources

description

Optional

The Mapplet description.

In addition to the POST attributes, pass the following information in the request body:

• Boundary value. Used to define different parts of the request body.

• File name. Name of the mapplet XML file.
• icSessionId. Informatica Cloud session ID returned by the login resource. You can pass this information in
the request body for clients that do not allow custom headers. If you can pass icSessionId as part of the
request header, you can omit this information in the request body.

Use the following template for the customFunc POST request:

URL: <serverUrl>/api/v2/customFunc/
HTTP method: POST

Content-Type:multipart/form-data;boundary=<boundary value>
--<boundary value>
Content-Disposition:form-data; name="file";filename="<filename.XML>";Content-Type:text/
<xml|json>

<content of the mapplet XML file encoded as UTF-8>

--<boundary value>
Content-Disposition: form-data; name="name"

<mapplet name>
--<boundary value>
Content-Disposition: form-data; name="desc"

<description of the mapplet>

--<boundary value>
Content-Disposition: form-data; name="icSessionId"

<icSessionID returned from login resource>

--<boundary value>--

POST Response
If successful, returns the customFunc response object for the mapplet that was created or updated.

Returns the error object if errors occur.

DELETE Request
To delete a mapplet, use the mapplet ID in the following URI:
/api/v2/customFunc/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example
To update a mapplet with an ID of 3 with an icSessionId of IV4wOrJmd6YUtmKa8t, you might use the
following request. The updated mapplet is named Lookup Mapplet and uses the lookup_mapplet.xml file.
XML data should be encoded in UTF-8.
URL: https://example.informatica.com/saas/api/v2/customFunc/3
HTTP method: POST

Content-Type:multipart/form-data;boundary=243553118520053
--243553118520053

customFunc 79
 Content-Disposition:form-data; name="file";filename="<lookup_mapplet.xml>";Content-
Type:text/xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE POWERMART SYSTEM "powrmart.dtd">
<POWERMART CREATION_DATE="05/14/2012 12:17:26" REPOSITORY_VERSION="181.90">
<REPOSITORY NAME="pc91hf1" VERSION="181" CODEPAGE="UTF-8" DATABASETYPE="Oracle">
<FOLDER NAME="test" GROUP="" OWNER="Administrator" SHARED="SHARED" DESCRIPTION=""
PERMISSIONS="rwx---r--" UUID="96f9d03b-c2c5-4034-8e3a-838026bbf6e8">
<SOURCE BUSINESSNAME ="" DATABASETYPE ="Oracle" DBDNAME ="ddicst" DESCRIPTION ="" NAME
="CUSTOMERMASTER" OBJECTVERSION ="1" OWNERNAME ="C01" VERSIONNUMBER ="1">
<SOURCEFIELD BUSINESSNAME ="" DATATYPE ="nvarchar2" DESCRIPTION ="" FIELDNUMBER ="1"
FIELDPROPERTY ="0" FIELDTYPE ="ELEMITEM" HIDDEN ="NO" KEYTYPE ="PRIMARY KEY" LENGTH ="0"
LEVEL ="0" NAME ="CUSTOMERID" NULLABLE ="NOTNULL" OCCURS ="0" OFFSET ="0" PHYSICALLENGTH
="30" PHYSICALOFFSET ="0" PICTURETEXT ="" PRECISION ="30" SCALE ="0" USAGE_FLAGS =""/>
.
.
.
<ATTRIBUTE NAME ="Parameter Filename" VALUE =""/>
<ATTRIBUTE NAME ="Write Backward Compatible Workflow Log File" VALUE ="NO"/>
<ATTRIBUTE NAME ="Workflow Log File Name" VALUE ="wf_plugin_lookup.log"/>
<ATTRIBUTE NAME ="Workflow Log File Directory" VALUE ="$PMWorkflowLogDir&#x5c;"/>
<ATTRIBUTE NAME ="Save Workflow log by" VALUE ="By runs"/>
<ATTRIBUTE NAME ="Save workflow log for these runs" VALUE ="0"/>
<ATTRIBUTE NAME ="Service Name" VALUE =""/>
<ATTRIBUTE NAME ="Service Timeout" VALUE ="0"/>
<ATTRIBUTE NAME ="Is Service Visible" VALUE ="NO"/>
<ATTRIBUTE NAME ="Is Service Protected" VALUE ="NO"/>
<ATTRIBUTE NAME ="Fail task after wait time" VALUE ="0"/>
<ATTRIBUTE NAME ="Enable HA recovery" VALUE ="NO"/>
<ATTRIBUTE NAME ="Automatically recover terminated tasks" VALUE ="NO"/>
<ATTRIBUTE NAME ="Service Level Name" VALUE ="Default"/>
<ATTRIBUTE NAME ="Allow concurrent run with unique run instance name" VALUE
="NO"/>
<ATTRIBUTE NAME ="Allow concurrent run with same run instance name" VALUE ="NO"/>
<ATTRIBUTE NAME ="Maximum number of concurrent runs" VALUE ="0"/>
<ATTRIBUTE NAME ="Assigned Web Services Hubs" VALUE =""/>
<ATTRIBUTE NAME ="Maximum number of concurrent runs per Hub" VALUE ="1000"/>
<ATTRIBUTE NAME ="Expected Service Time" VALUE ="1"/>
</WORKFLOW>
</FOLDER>
</REPOSITORY>
</POWERMART>

--243553118520053
Content-Disposition: form-data; name="name"

Lookup Mapplet
--243553118520053
Content-Disposition: form-data; name="icSessionId"

IV4wOrJmd6YUtmKa8t
--243553118520053--
A successful request returns the customFunc response object for the mapplet that you updated,

80 Chapter 2: Informatica Cloud REST API Resources

dataPreview
Use this resource to preview data during mapping design. The response returns up to ten rows of source or
target data for the specified object.

GET Request
To request preview data, specify the connection ID or connection name and the object name in one of the
following URIs:

• To request source data, use one of the following URIs:

/api/v2/connection/source/<id>/datapreview/<objectName>
/api/v2/connection/source/name/<name>/datapreview/<objectName>
• To request target data, use one of the following URIs:
/api/v2/connection/target/<id>/datapreview/<objectName>
/api/v2/connection/target/name/<name>/datapreview/<objectName>
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/datapreview/SF_ACCOUNT.csv

GET Response
Returns the dataPreview object for the requested connection ID or connection name and object name.

The dataPreview object includes the following attributes:

connId

Connection ID.

objectName

Name of the source or target object.

header

Column headers.

fieldName

Field name

fieldBusinessName

Business field name.

data

Includes the following attribute in the dataPreviewEntry object:

values

Field values from the source or target object.

GET Example
The following example shows a request to preview data from the SF_ACCOUNT.csv object.
GET <serverUrl>/api/v2/connection/target/0000010B000000000003/datapreview/SF_ACCOUNT.csv
HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
The following text is a sample response:
{

dataPreview 81
 "@type": "dataPreview",
"connId": "0000010B000000000003",
"objectName": "SF_ACCOUNT.csv",
"header": [
"ID",
"ISDELETED",
"MASTERRECORDID",
"NAME",
"TYPE",
"PARENTID",
"BILLINGSTREET",
"BILLINGCITY",
"BILLINGSTATE",
"BILLINGPOSTALCODE",
"BILLINGCOUNTRY",
"BILLINGLATITUDE",
"BILLINGLONGITUDE",
"SHIPPINGSTREET",
"SHIPPINGCITY",
"SHIPPINGSTATE",
"SHIPPINGPOSTALCODE",
"SHIPPINGCOUNTRY",
"SHIPPINGLATITUDE",
"SHIPPINGLONGITUDE",
"PHONE",
"FAX",
"ACCOUNTNUMBER",
"WEBSITE"
],

"fieldName": [
"ID",
"ISDELETED",
"MASTERRECORDID",
"NAME",
"TYPE",
"PARENTID",
"BILLINGSTREET",
"BILLINGCITY",
"BILLINGSTATE",
"BILLINGPOSTALCODE",
"BILLINGCOUNTRY",
"BILLINGLATITUDE",
"BILLINGLONGITUDE",
"SHIPPINGSTREET",
"SHIPPINGCITY",
"SHIPPINGSTATE",
"SHIPPINGPOSTALCODE",
"SHIPPINGCOUNTRY",
"SHIPPINGLATITUDE",
"SHIPPINGLONGITUDE",
"PHONE",
"FAX",
"ACCOUNTNUMBER",
"WEBSITE"
],

"fieldBusinessName": [
"ID",
"ISDELETED",
"MASTERRECORDID",
"NAME",
"TYPE",
"PARENTID",
"BILLINGSTREET",
"BILLINGCITY",
"BILLINGSTATE",
"BILLINGPOSTALCODE",
"BILLINGCOUNTRY",
"BILLINGLATITUDE",
"BILLINGLONGITUDE",

82 Chapter 2: Informatica Cloud REST API Resources

 "SHIPPINGSTREET",
"SHIPPINGCITY",
"SHIPPINGSTATE",
"SHIPPINGPOSTALCODE",
"SHIPPINGCOUNTRY",
"SHIPPINGLATITUDE",
"SHIPPINGLONGITUDE",
"PHONE",
"FAX",
"ACCOUNTNUMBER",
"WEBSITE"
],

"rows": [
{
"@type": "dataPreviewEntry",
"values": [
"001i000000KIAQGAA5",
"0",
"",
"ABCPoint",
"Customer - Channel",
"",
"345 ABC Park",
"Mountain View",
"CA",
"94063",
"",
"",
"",
"345 ABC Park",
"Mountain View",
"CA",
"94063",
"",
"",
"",
"(650) 555-3450",
"(650) 555-9895",
"CC978213",
"www.ABCpoint.com"
]
},

{
"@type": "dataPreviewEntry",
"values": [
"001i000000KIAQHAA5",
"0",
"",
"123 United, UK",
"Customer - Direct",
"",
"123 Estate,\nGateshead, Tyne and Wear NE26 3HS\nUnited Kingdom",
"",
"UK",
"94063",
"",
"",
"",
"123 Estate,\nGateshead, Tyne and Wear NE26 3HS\nUnited Kingdom",
"",
"",
"94063",
"",
"",
"",
"+44 123 4567899",
"+44 123 4567899",
"CD355119-A",
"http://www.123United.com"

dataPreview 83
 ]

expressionValidation
Use this resource to validate expressions.

POST Request
To validate an expression, use the following URI:
/saas/api/v2/expression/validate
Use the following attributes in the request body:
expr

The expression to validate.

connectionId

Connection ID.

objectName

Name of the source or target object.

isSourceType

Whether the expression is for a source object. Values are True or False.

If the expression is valid, the response returns a message that says the expression is valid. If the expression
is not valid, the response returns an error.

POST Example
To validate an expression, you might use the following request:
POST <serverURL>/api/v2/expression/validate HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type":"expressionValidation",
"expr":"REPVERSION",
"connectionId":"0000010B000000000004",
"objectName":"OPB_REPOSIT",
"isSourceType":true
}

84 Chapter 2: Informatica Cloud REST API Resources

field
A field is a subset of a data structure that represents a single data item. For example, a database table
column is a field. Use this resource to request field details for a source or target object and to update the flat
file attributes for a source or target object.

GET Request
To request the field details of a source object, use the source connection ID or source connection name and
the source object name. Use one of the following URIs:
/api/v2/connection/source/<id>/field/<object name>
/api/v2/connection/source/name/<name>/field/<object 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/source/name/my%20connection/field/customer
To request the field details of a target object, use the target connection ID or target connection name and the
target object name. Use one of the following URIs:
/api/v2/connection/target/<id>/field/<object name>
/api/v2/connection/target/name/<name>/field/<object 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/field/customer
You can also use the following URI, which accommodates searching for an object that includes a forward
slash (/):
api/v2/connection/<source or target>/<id>/fields?objectName=<objectName>
Note: The object name is case-sensitive.

GET Response
Returns the field object for each field in the requested object.

Returns the error object if errors occur.

The field object includes different information based on the connection type. The following are the attributes
of a field object:

id

Field ID.

name

Field name.

type

Field type.

uniqueName

Deprecated.

label

Field label.

field 85
 parentObject

Parent object, if applicable.

precision

Length of the field in bytes.

pcType

PowerCenter data type.

scale

Number of digits after the decimal point for numeric values.

columnIndex

Column index.

isKey

Whether the field is a used as a key.

isExternalId

Whether the field is used as an external ID.

isSfIdLookup

Whether the field is used as a Salesforce ID lookup field.

isNullable

Whether the field can contain null values. Values are True or False.

isUnique

Whether the field requires unique values. Values are True or False.

isCreateable

Whether the field accepts new values. Values are True or False.

isCalculated

Whether the field is calculated. Values are True or False.

isUpdateable

Whether the field allows updates. Values are True or False.

isFilterable

Whether the field can be filtered. Values are True or False.

linkedFields

For a Data Masking task, the source field mapped to the input field of the mapplet.

relatedInfos

Information about related fields. The following attributes are included in a fieldRelatedInfo object for
each related field:

id

Field ID.

referenceObject

Object that includes the field.

86 Chapter 2: Informatica Cloud REST API Resources

 relationshipName

Relationship to object.

references

Reference information. The following attributes are included in a fieldRelatedInfo object for each related
field:

id

Field ID.

referenceObject

Object that includes the field.

relationshipName

Relationship to object.

javaType

Java data type.

showLabel

Whether to show the field label. Values are True or False.

naturalOrder

Position number of the field in the source.

customProperties

Custom properties for the field.

GET Example
To use XML to get the field details for the Customer object available through the source connection (ID:
0002D420000000J), you might use the following request:
GET <serverUrl>/api/v2/connection/source/0002D420000000J/field/Customer HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
A successful request returns the fields object for each field in the Customer source object.

POST Request
To update the flat file attributes for a source or target object, use one of the following URI:
/api/v2/connection/source/<id>/field/<objectName>
/api/v2/connection/target/<id>/field/<objectName>
The flat file attributes provided in the request override the default attributes specified in the connection
object.

You can use the following attributes in the flatFileAttrs object:

id

Field ID.

delimiter

Character used to separate fields.

textQualifier

Quote character that defines the boundaries of text strings.

field 87
 escapeChar

Character immediately preceding a field delimiter character embedded in an unquoted string, or

immediately preceding the quote character in a quoted string.

headerLineNo

Number of header lines

firstDataRow

The row number where the data begins in the file.

POST Request Example

To send a request for field information, you might use the following request:
POST <serverUrl>/api/v2/connection/source/0000010B000000000021/field/test_precision.csv
HTTP/1.0
1.0
Content-Type: application/xml
Accept: application/xml
icSessionId
{
"@type": "flatFileAttrs",
"delimiter": ",",
"textQualifier": "'",
"escapeChar": "\\"
}

POST Response
If successful, returns the connListItem object. Returns the error object if errors occur.

fileRecord
Use this resource to upload an integration template XML file or image file to your organization. You can also
use this resource to delete an integration template XML file or image file from the organization.

POST Request
To upload an integration template XML file or image file, use the following URI.
/api/v2/fileRecord
You can upload a file up to 5 MB in size.

Note: Encode the request body as multipart/form-data.

Use the following attributes in the request body.

file

Required.

Content of the file that you want to upload. File content should be in binary format, UTF-8 encoding.

type

Required.

Type of file that you want to upload. Use one of the following values:

• MAPPING. Use to upload an integration template XML file. Use for XML files only.

88 Chapter 2: Informatica Cloud REST API Resources

 • IMAGE. Use to update an image file for an integration template. Use for JPEG or PNG files only.

In addition to the POST attributes, pass the following information in the request body:

• Boundary value. Used to define different parts of the request body.

• File name. The file name of the content you want to upload.
• icSessionId. Informatica Cloud session ID returned by the login resource. You can pass this information in
the request body for clients that do not allow custom headers. If you can pass icSessionId as part of the
request header, you can omit this information in the request body.

Use the following template for the fileRecord POST request:

URL: <serverUrl>/api/v2/fileRecord/
HTTP method: POST

Content-Type:multipart/form-data;boundary=<boundary value>
--<boundary value>
Content-Disposition:form-data; name="file";filename="<filename.ext>";Content-Type:text/
<xml|json>

<content of the file you want to upload encoded as UTF-8>

--<boundary value>
Content-Disposition: form-data; name="type"

<MAPPING | IMAGE>
--<boundary value>
Content-Disposition: form-data; name="icSessionId"

<icSessionID returned from login resource>

--<boundary value>--

POST Response
Returns the fileRecord object if the upload is successful. Returns the error object if errors occur.

The fileRecord object includes the following attributes:

id

ID for the uploaded file. You can use this ID to identify the file when you create or update an integration
template with the masterTemplate resource.

orgId

Organization ID.

name

File name.

description

Description of the file.

createTime

Time the file was uploaded to the organization.

updateTime

Last time the file was updated.

createdBy

User who first uploaded the file.

fileRecord 89
 updatedBy

User who last updated the file.

type

File type.

size

File size.

attachTime

Time the file was associated with an integration template.

DELETE Request
You can delete an integration template XML or image file if the integration template is not used by an
integration template.

To delete a file, use the file ID in the following URI:

/api/v2/fileRecord/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example
To upload the IntegrationTemplate.xml file with an icSessionId of IV4wOrJmd6YUtmKa8t, you might use the
following request. XML data should be encoded in UTF-8.
URL: https://example.informatica.com/saas/api/v2/fileRecord/
HTTP method: POST

Content-Type:multipart/form-data;boundary=243553118520053
--243553118520053
Content-Disposition:form-data; name="file";filename="<IntegrationTemplate.xml>";Content-
Type:text/xml

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Graph SYSTEM "graph.dtd">
<Graph Name="" Description="" UItype="" DlgSize="">
<Groups />
<Parameters>
<Parameter Name="$EXTERNALID__C$" Label="" LabelWidth="" IsMandatory="True"
DefaultValue="" Control="" Data="" Description="" />
<Parameter Name="$TGT$" Label="" LabelWidth="" IsMandatory="True" DefaultValue=""
Control="Combo_Ctrl" Data="Targets" Description="" />
<Parameter Name="$GroupBy$" Label="" LabelWidth="" IsMandatory="True"
DefaultValue="" Control="" Data="" Description="" />
<Parameter Name="$o_PERCENT_FLD__C$" Label="" LabelWidth="" IsMandatory="True"
DefaultValue="" Control="" Data="" Description="" />
<Parameter Name="$SRC$" Label="" LabelWidth="" IsMandatory="True" DefaultValue=""
Control="Combo_Ctrl" Data="Sources" Description="" />
</Parameters>
<Node NameID="Source Definition" Name="$SRC$" Reusable="" Type="Source Definition"
InstanceName="$SRC$" Description="" isParameterized="True">
<CustomProperty Name="Source Table" Value="$SRC$" isParameterized="True" />
<CustomProperty Name="Database Name" Value="" isParameterized="False" />
<CustomProperty Name="Owner Name" Value="" isParameterized="False" />
<CustomProperty Name="Business Name" Value="" isParameterized="False" />
<CustomProperty Name="Database Type" Value="" isParameterized="False" />
<CustomProperty Name="Is ShortCut" Value="False" isParameterized="False" />
</Node>
.
.

90 Chapter 2: Informatica Cloud REST API Resources

 .
<Link Name="Sheet.7" FromNameID="Aggregator" ToNameID="Target Definition"
MasterInputSet="False" isParameterized="False">
<Rule Text="Datatype:string" isParameterized="False" />
<Rule Text="EXCLUDE Named:AUTO__C (TO) AUTO__C" isParameterized="False" />
<Rule Text="Datatype:date/time" isParameterized="False" />
<Rule Text="Pattern:_o$" isParameterized="False" />
<Rule Text="Datatype:nstring" isParameterized="False" />
<Rule Text="Datatype:ntext" isParameterized="False" />
<Rule Text="Datatype:text" isParameterized="False" />
</Link>
</Graph>

--243553118520053
Content-Disposition: form-data; name="type"

MAPPING
--243553118520053
Content-Disposition: form-data; name="icSessionId"

IV4wOrJmd6YUtmKa8t
--243553118520053--
If the upload is successful, returns the fileRecord response object.

fwConfig
Use the fwConfig resource to configure column widths for flat file source, lookup, and target objects.

GET Request
To request all of the fixed-width formats, use the following URI:
/api/v2/fwConfig
To request the details of a particular fixed-width format, you can include the fixed-width format ID or fixed-
width format name in the URI. Use one of the following URIs:
/api/v2/fwConfig/<id>
/api/v2/fwConfig/name/<name>
If you use the fixed-width format name in the URI and the fixed-width format name includes a space, replace
the space with %20. For example:
/api/v2/fwConfig/name/my%20fixedwidth%20format

GET Response
The fwConfig object returns the following attributes:
id

Fixed-width format ID.

name

Fixed-width format name.

description

Description of the fixed-width format.

createTime

Time that the fixed-width format was created.

fwConfig 91
 updateTime

Last time that the fixed-width format was updated.

createdBy

User who created the fixed-width format.

updatedBy

User who updated the fixed-width format.

lineSequential

Whether each row ends with a newline character.

• True. Line sequential is enabled.

• False. Line sequential is not enabled.

padBytes

Number of bytes between the last column of one row and the first column of the next.

skipRows

Number of rows to skip. You can skip blank or header rows.

nullChar

The character to represent a null value.

dateFormat

Default date format to use when a date format is not specified in the flat file connection.

nullCharType

Determines if the null character is single-byte or multibyte.

repeatNullChar

Determines how to treat null characters in a single field.

• True. Read repeat null characters as a single null value.

• False. does not read repeat null characters as a single null value.

stripTrailingBlank

Determines how to treat trailing blanks in string values.

• True. Removes trailing blanks from string values.

• False. Does not remove trailing blanks in string values.

Columns

Includes the following attributes for each column:

• name. Name of the column.

• nativeType. Native data type.
• precision. Length of the field in bytes.
• scale. Number of digits after the decimal point for numeric values.

92 Chapter 2: Informatica Cloud REST API Resources

GET Example
The following example shows a request to get details for a fixed-width format using the fixed-width format
ID:
GET <serverUrl>/api/v2/fwConfig/00001R29000000000002 HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
The following text is a sample response:
{
"@type": "fwConfig",
"id": "00001R29000000000002",
"orgId": "00001R",
"name": "item",
"description": "",
"createTime": "2016-10-06T17:08:09.000Z",
"updateTime": "2016-10-06T17:08:09.000Z",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"lineSequential": true,
"padBytes": 0,
"skipRows": 0,
"nullChar": "*",
"nullCharType": "ASCII",
"repeatNullChar": false,
"stripTrailingBlank": false,
"dateFormat": "",
"columns": [
{
"@type": "fwColumn",
"name": "COLUMN_0",
"nativeType": "string",
"precision": 1,
"physicalLength": 0,
"scale": 0
},
{
"@type": "fwColumn",
"name": "COLUMN_1",
"nativeType": "string",
"precision": 9,
"physicalLength": 0,
"scale": 0
},
{
"@type": "fwColumn",
"name": "COLUMN_2",
"nativeType": "string",
"precision": 10,
"physicalLength": 0,
"scale": 0
}
]
}

POST Request
To update a fixed-width format, use the fixed-width format ID in the following URI. To create a fixed-width
format, omit the optional ID.
/api/v2/fwConfig/<id>
You can submit a partial update using partial mode. If you want to update a field in the fwColumn object
using partial mode, you must include the name. To submit a request using partial mode, use a JSON request
and include the following line in the header:
Update-Mode=PARTIAL
You can use the following attributes in a fwConfig POST request:

fwConfig 93
 id

Fixed-width format ID.

name

Fixed-width format name.

description

Description of the fixed-width format.

createTime

Time that the fixed-width format was created.

updateTime

Last time that the fixed-width format was updated.

createdBy

User who created the fixed-width format.

updatedBy

User who updated the fixed-width format.

lineSequential

Determines whether to end each row with a newline character.

• True. Line sequential is enabled.

• False. Line sequential is not enabled.

padBytes

Number of bytes between the last column of one row and the first column of the next.

skipRows

Number of rows to skip. You can skip blank or header rows.

nullChar

The character to represent a null value.

nullCharType

Whether the null character is single-byte or multibyte.

repeatNullChar

Whether repeat null characters in a single field read as a single null value.

• True. Repeat null characters read as a single null value.

• False. Repeat null characters do not read as a single null value.
stripTrailingBlank

Whether trailing blanks are removed from string values.

• True. Trailing blanks are removed from string values.

• False. Trailing blanks remain in string values.

Columns

Include the following attributes for each column in the fwColumn object:

• name. Name of the column. Key field for the fwColumn collection.

94 Chapter 2: Informatica Cloud REST API Resources

 • nativeType. Native data type.
• precision. Length of the field in bytes.
• scale. Number of digits after the decimal point for numeric values.

POST Response
If successful, returns the fwConfig object that you created or updated. Returns the error object if errors
occur.

POST Example
POST <serverURL>/api/v2/fwConfig/00000103000000000004 HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type": "fwConfig",
"name": "FW_FILE_CONFIG_1",
"description": "Test description",
"lineSequential": false,
"padBytes": 1,
"skipRows": 2,
"nullChar": "*",
"nullCharType": "ASCII",
"repeatNullChar": false,
"stripTrailingBlank": false,
"columns": [
{
"@type": "fwColumn",
"name": "ASCII",
"nativeType": "string",
"precision": 10
}
]
}

DELETE Request
To delete a fixed-width format, use the fixed-width format ID in the following URI:
/api/v2/fwConfig/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

job
Use this resource to start or stop an Informatica Cloud task or task flow based on ID or name. You can also
retrieve job completion status. Use the task resource to retrieve the ID and name of a task or task flow.

Start POST Request

To start a task or task flow, use the following URI:
/api/v2/job
With this URI, use the following attributes in a job object:

taskId

Task or task flow ID. Use taskId or taskName in the URI.

job 95
 taskName

Task or task flow name. Use taskId or taskName in the URI.

taskType

Type of task or task flow. Use one of the following options:

• AVS. Contact Validation task.

• DMASK. Data masking task.
• DQA. Data assessment task.
• DRS. Data replication task.
• DSS. Data synchronization task.
• MTT. Mapping configuration task.
• PCS. PowerCenter task.
• Workflow. Task flow.
• DNB_WORKFLOW. D&B360 workflow.

callbackURL

A valid, publicly available URL. The service posts the job status to the callbackURL.

Start POST Response

Returns the job object if the request is successful. Returns an error object if errors occur.

The job object includes the following attributes:

taskId

Task or task flow ID.

taskName

Task or task flow name.

taskType

Type of task or task flow. Returns one of the following codes:

• AVS. Contact Validation task.

• DMASK. Data masking task.
• DQA. Data assessment task.
• DRS. Data replication task.
• DSS. Data synchronization task.
• MTT. Mapping configuration task.
• PCS. PowerCenter task.
• Workflow. Task flow.
• DNB_WORKFLOW. D&B360 workflow.

runId

ID of the job.

callbackURL

Status of the job.

96 Chapter 2: Informatica Cloud REST API Resources

Stop POST Request
To stop a task or task flow, use the following URI:
/api/v2/job/stop
With this URI, use the following attributes in a job object:

taskId

Task or task flow ID. Use taskId or taskName in the URI.

taskName

Task or task flow name. Use taskId or taskName in the URI.

taskType

Type of task or task flow. Use one of the following options:

• AVS. Contact Validation task.

• DMASK. Data masking task.
• DQA. Data assessment task.
• DRS. Data replication task.
• DSS. Data synchronization task.
• MTT. Mapping configuration task.
• PCS. PowerCenter task.
• Workflow. Task flow.
• DNB_WORKFLOW. D&B360 workflow.

Stop POST Response

Returns the success object if the request is successful. Returns the error object if errors occur.

Stop POST Example

To stop a task flow with an ID of 0034J90000000M in JSON, you might use the following request:
POST <serverUrl>/api/v2/job/stop HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"@type": "job",
"taskId": "0034J90000000M",
"taskType": "Workflow"
}

Job Status Example

When you include the callbackURL in the job request, the service sends a request to the callback URL when
the job completes. The service always uses a JSON request for callbacks.

A callback might be called multiple times because of a system failure or incorrect server response. When the
service sends a request to the callback URL, the endpoint on your server must return a 200 HTTP code within
30 seconds. Otherwise, the URL connection breaks and the service counts the break as a failed attempt. The
server will make a total of three attempts.

The service executes the POST request from the callback URL. The following text is a sample return:
{
@type:"callbackUrlResponse"
endTime: "2013-02-27T18:57:52.000Z",

job 97
 objectId: "0034J90000000M",
objectName: "taskName",
runId: 5,
status: "COMPLETED" // or “FAILED”
}

licenseInfo
Use this resource to get license information about organizations and assign licenses to sub-organizations. In
order to assign licenses to a sub-organization, you must log in to the parent organization as an administrator.

GET Request
To request license information for an organization or sub-organization, use the organization ID in the
following URI:
/api/v2/licenseInfo/org/<id>

GET Response
If successful, returns the license information for the specified organization ID in the orgLicenseInfo object.
The orgLicenseInfo object includes the following attributes:

Attribute Description

orgId Organization ID.

orgEdition The Informatica Cloud edition. Includes the following attributes:

- name
- expirationDate
- clearCustomLicenses
- extendCustomLicenses

98 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

licenseInfo License information for the specified organization. Includes the following attributes:
- licenses. Includes the following attributes in the license object:
- licenseName
- licenseType. Indicates whether the licence is trial, subscription, or free subscription.
- licenseCategory. The category of the license item, either service or feature.
- disabled. A value of "true" indicates that the license is disabled.
- childLicenses
- licenseParams
- expirationDate
- maxTotalJobs
- maxMonthlyJobs
- maxDailyJobs
- maxTotalRows
- maxMonthlyRows
- maxDailyRows
- connectorLicenses. Includes the following attributes:
- uuid. Unique identifier for the connector.
- connectorName
- licenseType. Indicates whether the connector license type is trial or subscription.
- expirationDate
- packageLicenses. Licensed connector packages. Includes the following attributes in the
packageLicense object for each package:
- packageName
- disabled. A value of "true" indicates that the package is disabled.
- bundleLicenses. Returns a bundleObjectLicense object for each bundle license. See
“bundleObjectLicense” on page 53 .

serviceUsage For service licenses, includes the following attributes:

- serviceName
- totalJobs
- monthlyJobs
- dailyJobs
- totalRows
- monthlyRows
- dailyRows

GET Example
To request license information for an organization, you might use the following request:
GET <serverURL>/api/v2/licenseInfo/org/00001R HTTP/1.0
Content-Type: application/json
Accept: application/json
The following text is a sample response:

{
"@type": "orgLicenseInfo",
"orgId": "00001R",
"orgEdition": {
"name": "Default ICS Edition",
"expirationDate": "2018-11-23",
"overwriteCustomLicenses": true
}

POST Request
To assign licenses to a sub-organization, use the organization ID in the following URI:
/api/v2/licenseInfo/org/<id>
Submit the orgLicenseInfo object that includes license changes for the sub-organization.

licenseInfo 99
 POST Response
If successful, returns the orgLicenseInfo object for the sub-organization.

POST Example
To assign a license, you might use the following request:
POST <serverURL>/api/v2/licenseInfo/org/00001R HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type": "orgLicenseInfo",

"licenseInfo": {
"@type": "licenseInfo",
"licenses": [
{
"@type": "license",
"licenseName": "PCS",
"licenseCategory": "SERVICE",
"licenseType": "TRIAL",
"expirationDate": "2018-11-23",
"maxTotalJobs": 0,
"maxMonthlyJobs": 250,
"maxDailyJobs": 24,
"maxTotalRows": 0,
"maxMonthlyRows": 300000,
"maxDailyRows": 10000,
"childLicenses": [],
"licenseParams": []
}
]
}
}

login
Use this resource to log in to an Informatica Cloud organization with Informatica Cloud or Salesforce
credentials. Returns a two hour REST API session ID that you can use for subsequent REST API requests.
After the session ID expires, log in again to continue working with the REST API. Use the logout resource to
end the session. For SAML single sign-on, use the loginSaml resource.

For information on retrieving session status details, see “Session IDs” on page 17.

POST Request
You can log in to an organization with your Informatica Cloud user name and password. Or, you can log in
with a Salesforce session ID and Salesforce server URL.

To log in with your Informatica Cloud user name and password, use the following URL:
https://app.informaticaondemand.com/ma/api/v2/user/login
With this URL, use the following attributes in a login object:

username

Required.

Informatica Cloud user name.

100 Chapter 2: Informatica Cloud REST API Resources

password

Required.

Informatica Cloud password.

To log in using a Salesforce session ID and Salesforce server URL, use the following URL:
https://app.informaticaondemand.com/ma/api/v2/user/loginSf
You can use Salesforce information to log in to Informatica Cloud if you have included your Salesforce user
name in your Informatica Cloud user account.

You can use the Salesforce Web Services API to generate a Salesforce session ID and to retrieve the
Salesforce server URL. For more information, see the login resource in the Salesforce Web Services API
Developer's Guide.

With this URL, use the following attributes in a login object:

sfSessionId

Required.

Salesforce session ID. For information about generating the Salesforce session ID, see the login
resource in the Salesforce Web Services API Developer's Guide.

sfServerUrl

Required.

Salesforce server URL. You can retrieve the Salesforce server URL from the Salesforce Web Services API
login resource response.

POST Response
Returns the user object if the request is successful. Returns the error object if errors occur.

The user object includes the following attributes:

id

User ID.

orgId

ID of the organization the user belongs to.

name

Informatica Cloud user name.

description

Description of the user.

createTime

When the user account was created.

updateTime

When the user account was last updated.

createdBy

Informatica Cloud user who created the user account.

updatedBy

Informatica Cloud user who last updated the user account.

login 101
 sfUsername

Salesforce user name.

password

Password. If using sfUsername, this is the Salesforce password.

firstName

First name for the user account.

lastName

Last name for the user account.

title

Title of the user.

phone

Phone number for the user.

securityQuestion

Security question. Returns one of the following codes:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME
• CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"

securityAnswer

Answer to the security question.

roles

Roles assigned to the user. The following attributes are included in a role object for each role:
name

Role name. Returns one of the following codes:

• SERVICE_CONSUMER
• DESIGNER
• ADMIN

description

Description.

usergroups

User group assigned to the user. The following attributes are included in a usergroup object for each
user group:
id

User group ID.

102 Chapter 2: Informatica Cloud REST API Resources

 orgId

Organization ID.

name

User group name.

description

Description.

createTime

Time the user group was created.

updateTime

Last time the user group was updated.

createdBy

User who created the user group.

updatedBy

User who last updated the user group.

aclEntry

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for
each object type. For more information about the aclEntry object, see the “usergroup” on page 177
resource.

emails

Email address to be notified when the user changes the account password.

If you pass multiple email addresses in this field, Informatica Cloud uses the first email address in the
list.

timezone

Time zone of the user. Time zone honors Daylight Saving Time.

For more information, see Appendix A , “Time Zone Codes” on page 193.

serverUrl

Informatica Cloud URL for the organization the user belongs to. Use the serverUrl as a base for most
REST API resource URIs.

spiUrl

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

Unique identifier for the user.

icSessionId

Informatica Cloud REST API session ID. Use in most REST API request headers.

forceChangePassword

Determines if the user must reset the password after the user logs in for the first time. Includes the
following values:

• True. The user must reset the password.

login 103
 • False. The user is not forced to reset the password.

POST Example
To log in to your Informatica Cloud organization using Informatica Cloud credentials, you might use the
following request:
POST https://app.informaticaondemand.com/ma/api/v2/user/login HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"@type": "login",
"username": "[email protected]",
"password": "mypassword"
}
If successful, returns the user object.

logout
Use this resource to log out of an organization and end the REST API session specified in the request.

POST Request
To log out an organization and end the REST API session, include the Informatica Cloud session ID in the
request header with the following URI.
/api/v2/user/logout

POST Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example
To log out of your Informatica Cloud organization using Informatica Cloud credentials, you might use the
following request:
POST <serverURL>/api/v2/user/logout HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

logoutall
Use this resource to log out of an organization and end all REST API sessions for the organization.

POST Request
To log out of an organization and end all REST API sessions for the organization, use the following URL:
https://app.informaticaondemand.com/ma/api/v2/user/logoutall
With this URL, use the following attributes in a logout object:

104 Chapter 2: Informatica Cloud REST API Resources

 username

Informatica Cloud user name.

password

Informatica Cloud password.

POST Response
Returns the success object if the request is successful.

Returns the error object if errors occur.

POST Example
To log out of an organization and all REST API sessions, you might use the following request:
POST https://app.informaticaondemand.com/ma/api/v2/user/logoutall HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type": "logout",
"username": "[email protected]",
"password": "mypassword"
}

loginSaml
Use this resource to log in to an Informatica Cloud organization using SAML single sign-on and to log out of a
SAML single sign-on session. Log in request returns a two hour REST API session ID that you can use for
subsequent REST API requests. After the session ID expires, log in again to continue working with the REST
API. Use the logout resource to end the session.

For information on retrieving session status details, see “Session IDs” on page 17.

POST Request
You can log in to an organization using SAML single sign-on credentials.

Use the following URL:

https://app.informaticaondemand.com/ma/api/v2/user/loginSaml
With this URL, use the following attributes in a loginSaml object:

samlToken

Required.

SAML login token.

orgId

Required.

Informatica Cloud organization ID.

POST Response
Returns the user object if the request is successful. Returns the error object if errors occur.

The user object includes the following attributes:

loginSaml 105
 id

User ID.

orgId

ID of the organization the user belongs to.

name

Informatica Cloud user name.

description

Description of the user.

createTime

When the user account was last updated.

updateTime

When the user account was last updated.

createdBy

Informatica Cloud user who created the user account.

updatedBy

Informatica Cloud user who last updated the user account.

firstName

First name for the user account.

lastName

Last name for the user account.

title

Title of the user.

phone

Phone number for the user.

roles

Roles assigned to the user. The following attributes are included in a role object for each role:
name

Role. name. Returns one of the following codes:

• SERVICE_CONSUMER
• DESIGNER
• ADMIN

description

Description.

usergroups

User group assigned to the user. The following attributes are included in a usergroup object for each
user group:
id

User group ID.

106 Chapter 2: Informatica Cloud REST API Resources

 orgId

Organization ID.

name

User group name.

description

Description.

createTime

When the user group was last updated.

updateTime

When the user group was last updated.

createdBy

Informatica Cloud user who created the user group.

updatedBy

Informatica Cloud user who last updated the user group.

aclEntry

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for
each object type. For more information about the aclEntry object, see the usergroup resource.

emails

Email addresses to be notified when the user changes the account password.

timezone

Time zone of the user. Time zone honors Daylight Saving Time.

For more information, see Appendix A, Time Zone Codes.

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)

loginSaml 107
 • SqlServer2008 (Microsoft SQL Server 2008)
• SqlServer2012 (Microsoft SQL Server 2012)
• TOOLKIT (Informatica Cloud Connector)
• WebServicesConsumer (Web Service)

serverUrl

Informatica Cloud URL for the organization the user belongs to. Use the serverUrl as a base for most
REST API resource URIs.

spiUrl

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

Unique identifier for the user.

icSessionId

Informatica Cloud REST API session ID. Use in most REST API request headers.

POST Example
To log in to your Informatica Cloud organization using SAML single sign-on, you might use the following
request:
POST https://app.informaticaondemand.com/ma/api/v2/user/loginSaml HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"@type": "login",
"samlToken": "<token>",
"orgId": "00342000"
}
If successful, returns the user object.

mapping
Use this resource to request the details for a mapping or the details of all mappings in the organization.

GET Request
You can request the following information using a mapping GET request:

• Details of all mappings in the organization.

• Details for a particular mapping.
• An image of a mapping.

Details of all mappings in the organization

To request the details of all mappings in the organization, use the following URI:
/api/v2/mapping

108 Chapter 2: Informatica Cloud REST API Resources

Details for a particular mapping

To request the details of a particular mapping, include the mapping ID or mapping name in the URI. Use
one of the following URIs:
/api/v2/mapping/<id>
/api/v2/mapping/name/<name>
If you use the mapping name in the URI and the mapping name value includes a space, replace the space
with %20. For example:
/api/v2/mapping/name/my%20mapping
You can also request a specific mapping by name with the following URI:
/api/v2/mapping/search?name=<name>
Image of a mapping

To request an image of a mapping, specify the mapping ID and whether the mapping is deployed or not.
Use the following URI:
/api/v2/mapping/<id>/image?deployed=<true|false>
For example:
/api/v2/mapping/N0A1700000000001J/image?deployed=true

GET Response
If successful, returns the mapping object for the requested mapping.

If you request the details for all mappings, returns the mapping object for every mapping in the organization
without parameter details.

Returns the error object if errors occur.

The mapping object includes the following attributes:

id

Mapping ID.

orgId

Organization ID.

name

Mapping name.

description

Description of the mapping.

createTime

Time the mapping was created.

updateTime

Last time the mapping was updated.

createdBy

User who created the mapping.

updatedBy

User who last updated the mapping.

mapping 109
 bundleObjectId

ID of the bundle that includes the mapping, if applicable.

bundleVersion

Version of the bundle that includes the mapping, if applicable.

templateId

ID of the template created internally to represent the mapping.

deployTime

Time the mapping was deployed.

hasParameters

Indicates if the mapping includes parameters. Returns the following values:

• TRUE. The mapping includes parameters.

• FALSE. The mapping does not include parameters.

valid

Indicates if the mapping is valid. Returns the following values:

• TRUE. The mapping is valid.

• FALSE. The mapping is not valid.

fixedConnection

Indicates if the mapping has fixed connections. Returns the following values:

• TRUE. The mapping includes fixed connections.

• FALSE. The mapping does not include fixed connections.

hasParametersDeployed

Indicates if the mapping has parameters deployed. Returns the following values:

• TRUE. The mapping has parameters deployed.

• FALSE. The mapping does not have parameters deployed.

fixedConnectionDeployed

Indicates if the mapping has fixed connections deployed. Returns the following values:

• TRUE. The mapping has fixed connections deployed.

• FALSE. The mapping does not have fixed connections deployed.

deployedTemplateId

ID of the template created internally to represent the deployed mapping.

tasks

Number of tasks that use the mapping.

parameters

Parameters used in the mapping.

Includes the following attributes in the mtTaskParameter object for each parameter:

id

Parameter ID.

110 Chapter 2: Informatica Cloud REST API Resources

 name

Parameter name.

label

Parameter label.

type

Parameter type.

description

Parameter description.

customFuncId

Mapplet ID for mapplet type parameters.

uiProperties

Display property for the parameter. Includes the following information:

• cnxtype. Connection type for the parameter.

• logcnx. Logical connection.
• order. Display order.
• wizstep. Wizard step to display the parameter.
• default. Default value.
• visible. Whether the parameter is visible.
• editable. Whether the parameter is editable.
• required. Whether the parameter is required.
• paramtype. UI control type for string parameters. Returns one of the following responses:
- Condition. Filter condition input control.

- Expression. Expression editor input control.

- Field. Field selection input control.

- Fieldmap. Field mapping input control. Includes the following attributes:

- lefttitle. Left title for the field mapping display.

- righttitle. Right title for the field mapping display.

- leftfs. Set of fields to display in the left table of the field mapping display.

- rightfs. Set of fields to display in the right table of the field mapping display.

- leftfilter. Regular expression to limit the fields that display in the left table of the field
mapping display.
- rightfilter. Regular expression to limit the fields that display in the right table of the field
mapping display.
- staticlist. List of fields to display on the right side of the field mapping display.

inOutParameters

In-out parameters used in the mapping.

Includes the following attributes in the mtTaskInOutParameter object for each in-out parameter:

• id
• name

mapping 111
 • description
• initialValue
• datatype
• precision
• scale
• retentionPolicy
• aggregationType
• currentValue

mappingPreviewFileRecordId

ID of the image file that is used when previewing a mapping.

deployedMappingPreviewFileRecordId

ID of the image file that is used when previewing a deployed mapping.

references

Reference information. Returns the reference object, which includes the following attributes:

• refObjectId
• refType

GET Example
To request mapping details for all mappings in the organization, you might use the following request:
GET <serverUrl>/api/v2/mapping HTTP/1.0
Accept: application/xml
icSessionId: <icSessionId>

masterTemplate
Use this resource to request the details for an integration template or the details of all integration templates
in the organization. You can create or update an integration template, and request a list of mapping
configuration tasks that use the template. You can also delete an integration template.

GET Request
To request the details of all integration templates in the organization, use the following URI:
/api/v2/masterTemplate
To request the details of a particular integration template, include the integration template ID or integration
template name in the URI. Use one of the following URIs:
/api/v2/masterTemplate/<id>
/api/v2/masterTemplate/name/<name>
If you use the integration template name in the URI and the integration template name includes a space,
replace the space with %20. For example:
/api/v2/masterTemplate/name/my%20integration%20template

112 Chapter 2: Informatica Cloud REST API Resources

To request a list of mapping configuration tasks that use an integration template, use the integration
template ID in the following URI:
/api/v2/masterTemplate/<id>/tasks

GET Response
If successful, returns the masterTemplate object for the requested integration template. If you request the
details for all integration templates, returns the masterTemplate object without parameter details for every
integration template in the organization.

Returns the error object if errors occur.

The masterTemplate object includes the following attributes:

id

Integration template ID.

orgId

Organization ID.

name

Integration template name.

description

Description of the integration template.

createTime

Time the integration template was created.

updateTime

Last time the integration template was updated.

createdBy

User who created the integration template.

updatedBy

User who last updated the integration template.

diFileRecordId

ID of the integration template XML file.

templateImageId

ID of the integration template image file.

parameters

Parameters used in the integration template. The following attributes are included in the mtParameter
object for each parameter:

id

Parameter ID.

name

Parameter name.

label

Parameter label.

masterTemplate 113
 type

Parameter type.

description

Parameter description.

customFuncId

Mapplet ID for mapplet type parameters.

uiProperties

Display property for the parameter. Includes the following information:

• cnxtype. Connection type for the parameter.

• logcnx. Logical connection.
• order. Display order.
• wizstep. Wizard step to display the parameter.
• default. Default value.
• visible. Whether the parameter is visible.
• editable. Whether the parameter is editable.
• required. Whether the parameter is required.
• paramtype. UI control type for string parameters. Returns one of the following responses:
- Condition. Filter condition input control.

- Expression. Expression editor input control.

- Field. Field selection input control.

- Fieldmap. Field mapping input control. Includes the following attributes:

- lefttitle. Left title for the field mapping display.

- righttitle. Right title for the field mapping display.

- leftfs. Set of fields to display in the left table of the field mapping display.

- rightfs. Set of fields to display in the right table of the field mapping display.

- leftfilter. Regular expression to limit the fields that display in the left table of the field
mapping display.
- rightfilter. Regular expression to limit the fields that display in the right table of the field
mapping display.
- staticlist. List of fields to display on the right side of the field mapping display.

sessionAttrs

General and performance session properties for the task. Can include the following attributes:
Write Backward Compatible Session Log File

Writes the session log to a file.

Session Log File Name

Name for the session log.

Session Log File Directory

Directory where the session log is saved.

114 Chapter 2: Informatica Cloud REST API Resources

 $Source Connection Value

Source connection name.

$Target Connection Value

Target connection name.

Treat Source Rows as

When the Mapping Configuration task reads source data, it marks each row with an indicator to
specify the operation to perform when the row reaches the target:

• Insert. All rows are marked for insert into the target.
• Update. All rows are marked for update in the target.
• Delete. All rows are marked for delete from the target.
• Data Driven. The task uses the Update Strategyobject in the data flow to mark the operation
for each source row.

Commit Type

Commit type to use:

• Source. Performs commits based on the number of source rows.

• Target. Performs commits based on the number of target rows.
• User Defined. Performs commits based on the commit logic defined in the integration template.

If you do not configure a commit type, the task performs a target commit.

Commit Interval

Interval in rows between commits.

If you do not configure a commit interval, the task commits every 10,000 rows.

Commit on End of File

Commits data at the end of the file:

• true.
• false.

Rollback Transactions on Errors

If the task encounters a non-fatal error, you can choose to roll back the transaction at the next
commit point.

When the task encounters a transformation error, it rolls back the transaction if the error occurs
after the effective transaction generator for the target.

Java Classpath
Java classpath to use.

DTM Buffer Size

Amount of memory allocated to the task from the DTM process.

Incremental Aggregation

Performs incremental aggregation.

• true.
• false.

masterTemplate 115
 Reinitialize Aggregate Cache

Overwrites existing aggregate files for an incremental aggregation task.

• true.
• false.

Enable High Precision

rocesses the Decimal datatype to a precision of 28.

• true.
• false.

Session Retry on Deadlock

The Mapping Configuration task retries a write on the target when a deadlock occurs.

• true.
• false.

wizardMetadata

Metadata for the Mapping Configuration task wizard steps. Includes an mtWizardStep object for each
step.
name

Name of the step.

title

The title of the step, displayed in the Mapping Configuration task wizard user interface.

POST Request
To update an integration template, use the integration template ID in the following URI. To create a new
integration template, omit the optional integration template ID.
/api/v2/masterTemplate/<id>
You can submit a partial update using partial mode. If you want to update a field in the mtParameter object
using partial mode, you must include the name or type fields. To submit a request using partial mode, use a
JSON request and include the following line in the header:
Update-Mode=PARTIAL
You can use the following attributes in a masterTemplate object:

name

Required.

Name of the integration template.

description

Optional.

Description of the integration template.

diFileRecordId

Required.

Integration template XML file ID.

Use the ID returned when you upload the file to the organization with the fileRecord resource.

116 Chapter 2: Informatica Cloud REST API Resources

templateImageId

Optional.

Integration template image file ID.

This ID is returned when you upload the file to the organization with the fileRecord resource.

parameters

Object that defines parameters associated with the template.

Use an mtParameter object to define the following attributes for each parameter:

name

Required. Key field for the mtParameter collection.

Parameter name.

label

Optional.

Parameter label.

type

Required. Key field for the mtParameter collection.

Parameter type. Use one of the following values:

• STRING
• SOURCE
• TARGET
• MAPPLET
• LOOKUP

description

Optional.

Parameter description.

customFuncId

Optional.

Mapplet ID for mapplet type parameters.

uiProperties

Optional.

Display properties for the parameter.

Use a UIPropertyType object to define the following display properties:

• cnxtype. Connection type for the parameter. Use a valid connection type. For more information,
see the connection resource.
• logcnx. Logical connection.
• order. Display order.
• wizstep. Wizard step to display parameter.
• default. Default value.

masterTemplate 117
 • visible. Whether the parameter is visible. Use True or False.
• editable. Whether the parameter is editable. Use True or False.
• required. Whether the parameter is required. Use True or False.
• paramtype. UI control type for string parameters. Use one of the following values:
- Condition. Filter condition control.

- Expression. Expression editor control.

- Field. Field selection control.

- Fieldmap. Field mapping input control. Includes the following attributes:

- lefttitle. Left title for the field mapping display.

- righttitle. Right title for the field mapping display.

- leftfs. Set of fields to display in the left table of the field mapping display.

- rightfs. Set of fields to display in the right table of the field mapping display.

- leftfilter. Regular expression to limit the fields that display in the left table of the field
mapping display.
- rightfilter. Regular expression to limit the fields that display in the right table of the field
mapping display.
- staticlist. List of fields to display on the right side of the field mapping display. Use instead of
rightfs.
List field names and associated datatypes separated by a line break or semicolon.

sessionAttrs

Optional.

Object that defines the general and performace session properties for the task.

Use a SessionAttrsType object to define any of the following properties that you want to use:

Write Backward Compatible Session Log File

Optional.

Writes the session log to a file.

• true.
• false.

Session Log File Name

Optional.

Name for the session log.

Use any valid file name. You can use the following variables as part of the session log name:

• $CurrentTaskName. Replaced with the task name.

• $CurrentTime. Replaced with the current time.

Session Log File Directory

Optional.

Directory where the session log is saved.

By default, the session log is saved to the following directory: .

118 Chapter 2: Informatica Cloud REST API Resources

 <Secure Agent installation directory>/apps/Data_Integration_Server/logs

$Source Connection Value

Optional.

Source connection name.

$Target Connection Value

Optional.

Target connection name.

Treat Source Rows as

Optional.

When the Mapping Configuration task reads source data, it marks each row with an indicator to
specify the operation to perform when the row reaches the target.

Use one of the following values:

• Insert. All rows are marked for insert into the target.
• Update. All rows are marked for update in the target.
• Delete. All rows are marked for delete from the target.
• Data Driven. The task uses the Update Strategyobject in the data flow to mark the operation for
each source row.

Commit Type

Optional.

Commit type to use. Use one of the following values:

• Source. Performs commits based on the number of source rows.

• Target. Performs commits based on the number of target rows.
• User Defined. Performs commits based on the commit logic defined in the integration template.

If you do not configure a commit type, the task performs a target commit.

Commit Interval

Optional.

Interval in rows between commits.

If you do not configure a commit interval, the task commits every 10,000 rows.

Commit on End of File

Optional.

Commits data at the end of the file.

• true.
• false.

Rollback Transactions on Errors

Optional.

If the task encounters a non-fatal error, you can choose to roll back the transaction at the next
commit point.

masterTemplate 119
 When the task encounters a transformation error, it rolls back the transaction if the error occurs
after the effective transaction generator for the target.

• true.
• false.

Java Classpath

Optional.

Java classpath to use.

The Java Classpath that you enter is added to the beginning of the system classpath when the task
runs.

Use this option if you use third-party Java packages, builtin Java packages, or custom Java
packages in a Java transformation.

DTM Buffer Size

Optional.

Amount of memory allocated to the task from the DTM process.

By default, a minimum of 12 MB is allocated to the buffer at run time.

You can specify auto or a numeric value. If you enter 2000, the Mapping Configuration task
interprets the number as 2000 bytes. Append KB, MB, or GB to the value to specify other units.

Increase the DTM buffer size in the following circumstances:

• A task contains large amounts of character data.

Increase the DTM buffer size to 24 MB.
• A session contains n partitions. Increase the DTM buffer size to at least n times the value for the
task with one partition.
• A source contains a large binary object with a precision larger than the allocated DTM buffer
size.
Increase the DTM buffer size so that the task does not fail.

Incremental Aggregation

Optional.

Performs incremental aggregation.

• true.
• false.

Reinitialize Aggregate Cache

Optional.

Overwrites existing aggregate files for an incremental aggregation task.

• true.
• false.

Enable High Precision

Optional.

120 Chapter 2: Informatica Cloud REST API Resources

 Processes the Decimal datatype to a precision of 28.

• true.
• false.
Session Retry on Deadlock

Optional.

The Mapping Configuration task retries a write on the target when a deadlock occurs.

• true.
• false.

wizardMetadata

Metadata for the Mapping Configuration task wizard steps. Includes an mtWizardStep object for each
step.
name

Name of the step.

title

The title of the step, displayed in the Mapping Configuration task wizard user interface.

POST Response
If the request to create or update an integration template is successful, returns the master template object
for the integration template that you created or updated.

Returns the error code if errors occur.

DELETE Request
To delete an integration template, use the integration template ID in the following URI:
/api/v2/masterTemplate/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

GET Example

To request a list of tasks that use an integration template with an ID of 000043T1000003G, you might use the
following request:
GET <serverUrl>/api/v2/masterTemplate/000043T1000003G/tasks HTTP/1.0
Accept: application/xml
icSessionId: <icSessionId>
If successful, returns the mtTask object with id, orgId, name, and masterTemplateId for each task that uses
the integration template.

masterTemplate 121
mttask
Use this resource to request the details of a Mapping Configuration task. You can also create, update, or
delete a Mapping Configuration task.

Note: You cannot use the REST API to create a Mapping Configuration task based on a mapping that includes
a mapplet.

GET Request
To request the details of a Mapping Configuration task, you can use the task ID or task name. Use one of the
following URIs:
/api/v2/mttask/<id>
/api/v2/mttask/name/<name>
If you use the task name in the URI and the task name includes a space, replace the space with %20. For
example:
/api/v2/mttask/name/task%20name

GET Response
Returns the mtTask object for the requested task ID or task name.

Returns the error object if errors occurred.

The following table describes attributes in an mtTask object:

Attribute Description

id Task ID.

orgId Organization ID.

name Task name.

description Description.

createTime Time the task was created.

updateTime Last time the task was updated.

createdBy User who created the task.

updatedBy User who last updated the task.

errorTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails

List of comma-separated email addresses that receive email notification when a

task fails to complete.

122 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

successTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails
List of comma-separated email addresses that receive email notification when a
task completes successfully.

warningTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails

List of comma-separated email addresses that receive email notification when a

task completes with errors.

mttask 123
 Attribute Description

parameters Parameters associated with the task.

Includes the following attributes in the mtTaskParameter object for each
parameter:
id
Parameter ID.

name

Parameter name.

type

Parameter type.

indx

Sort index. Not used.

text

Parameter value.

label

Parameter label.

description

Parameter description.

sourceConnectionId

Source connection ID.

targetConnectionId

Target connection ID.

lookupConnectionId

Lookup connection ID.

transfConnectionId

Connection ID of mapplet. Reserved for future use.

midstreamConnectionId

Connection ID of midstream transformation.

sourceObject

Source object name.

sourceObjectLabel

Source object label.

targetObject

Target object name.

targetObjectLabel

Target object label.

124 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

lookupObject

Lookup object name.

lookupObjectLabel
Lookup object label.

midstreamObject

Midstream object name.

midstreamObjectLabel

Midstream object label.

newFlatFile

Deprecated. Use newObject instead.

Whether the application creates a new flat file target. Returns True when it
creates a target.

flatFileName

Deprecated. Use newObjectName instead.

Name of the flat file target.

newObject

Whether the application creates a new flat file target. Returns True when it
creates a target.

newObjectName

Name of the flat file target.

operationType

The task operation for the target.

truncateTarget

Whether the application truncates a database target before writing to it. Returns
True when it truncates the target.

srcFFAttrs

Object for the source file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.
- firstDataRow.
tgtFFAttrs

Object for the target file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.

mttask 125
 Attribute Description

lkpFFAttrs

Object for the target file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.
- firstDataRow.

customFuncCfg

Attribute that defines configuration for mapplets used in the task. Includes the
following attributes in the customFuncConfig object for each mapplet:
- id. Mapplet ID.
- connections. Object to define connections used in a mapplet. Includes the
following attributes in the pcsConnection object for each connection:
- id.
- name. Connection name.
- type. Connection type.
- subtype. Connection subtype.
- description
- connectionId. Connection ID.

showBusinessNames

Whether the task displays business names. Returns True when it shows
business names.

naturalOrder

The order that the task uses to display fields. Returns True for the order
returned by the connection. Returns False for alphabetic order.

isRESTModernSource

Always set to True to enable extended objects.

customQuery

The custom query specified in Mapping Designer or Mapping Configuration task

query options.

overriddenFields

Changes to field metadata in the Mapping Configuration task. Includes the

following attributes in the mtTaskOverriddenField object:
- name
- type
- precision
- scale

tgtFieldRefs

Optional.

Salesforce field reference IDs.

extendedObject

The source or target with more than one object joined.

126 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

targetUpdateColumns

List of column names used to update records in the target object.

runtimeAttrs
Optional.

Advanced connection properties for connections used in a task.

Use a runtimeAttrs object to define key-value pairs of advanced connection

properties. Use an entry object for each key-value pair.

For the attribute name, use the advanced connection property name as
displayed in the Informatica Cloud application.

For more information about advanced connection properties, see the Informatica
Cloud Help.

sequences Defines values for the Sequence Generator transformation. Includes the following
attributes in the sequenceDefinition object:
- txName. Name of the Sequence Generator transformation.
- initialValue. The initial value of the sequence.
- currentValue. The value used for the last row added to the transformation.

inOutParameters In-out parameter used in the task. Includes the following attributes in the
mtTaskInOutParameter object for each in-out parameter:
- id
- name
- description
- initialValue
- datatype
- precision
- scale
- retentionPolicy
- aggregationType
- currentValue

agentId Agent that runs the task.

lastRunTime Time the task last run.

masterTemplateId Integration template ID. Returned when an integration template is the basis of the
task.

mappingId Mapping ID. Returned when a mapping is the basis for the task.

scheduleId Schedule associated with the task flow, if any.

shortDescription The first 50 characters of the description.

sessionProperties Advanced session properties associated with the task.

Includes advanced session properties in a sessionProperties object

outboundMessageUrlToken Outbound message URL token for the task, if it exists.

outboundMessageUrlQueueTime Outbound message URL queue time for the task, if it exists.

mttask 127
 Attribute Description

runtimeEnvironmentId Runtime environment used for the task.

preProcessingCmd Command to run before the task.

postProcessingCmd Command to run after the task completes.

parameterFileName The name of the parameter file used in the task.

POST Request
To update a Mapping Configuration task, use a Mapping Configuration task ID in the following URI. To create
a Mapping Configuration task, omit the optional task ID.
/api/v2/mttask/<id>
You can submit a partial update using partial mode. If you want to update a field that is within a collection
using partial mode, you must include the key field for the collection. The following table lists the collections
in the mttask resource and the corresponding key fields:

Collection Key Fields

mtTaskInOutParameter name

sequenceDefinition txName

mtTaskOverriddenField name

mtTaskParameter name
type

To submit a request using partial mode, use a JSON request and include the following line in the header:
Update-Mode=PARTIAL

128 Chapter 2: Informatica Cloud REST API Resources

The following table describes the attributes you can use with the URI in an mtTask object:

Attribute Description

errorTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails
List of comma-separated email addresses that receive email notification when a
task fails to complete.

successTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails

List of comma-separated email addresses that receive email notification when a

task completes successfully.

warningTaskEmail Optional. Includes the following attributes in the taskEmail object:

id

ID.

emails

List of comma-separated email addresses that receive email notification when a

task completes with errors.

mttask 129
 Attribute Description

parameters Attribute that defines parameters associated with the task.

Use an mtTaskParameter object to define the following attributes for each parameter:
id

System generated parameter ID. You cannot update this value.

name

Parameter name. Key field for the mtTaskParameter collection.

type

Parameter type. Key field for the mtTaskParameter collection. Use one of the
following values:
- STRING
- SOURCE
- TARGET
- MAPPLET
- LOOKUP

indx

Sort index. No longer used.

text

Parameter value.

label

Parameter label.

description

Parameter description.

sourceConnectionId

Source connection ID.

targetConnectionId

Target connection ID.

lookupConnectionId

Lookup connection ID.

newFlatFile

Whether Informatica Cloud creates a new flat file target. Use one of the following
values:
- True. Creates a new target file.
- False. Does not create a target file.

flatFileName

Name of the flat file target.

newObject

Whether the application creates a new flat file target. Returns True when it creates
a target.

130 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

newObjectName

Name of the flat file target.

operationType
The task operation for the target. Use one of the following values:
- Insert
- Upsert
- Update
- Delete
- Data driven
truncateTarget

Whether Informatica Cloud truncates a database target before writing to it. Use one
of the following values:
- True. Truncates the target.
- False. Does not truncate the target.

srcFFAttrs

Object for the source file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.
- firstDataRow.

tgtFFAttrs

Object for the target file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.

lkpFFAttrs

Object for the target file attributes. Includes the following attributes:
- id.
- delimiter.
- textQualifier.
- escapeChar.
- headerLineNo.
- firstDataRow.
customFuncCfg

Attribute to define configuration for mapplets used in the task. Use a

customFuncConfig object to define the following attributes for each mapplet:
- id.
- connections. Attribute to define connections used in a mapplet. Use a
pcsConnection object to define the following attributes for each connection:
- id.
- name. Connection name.
- type. Connection type.
- subtype. Connection subtype.
- description
- connection Id. Connection ID.

mttask 131
 Attribute Description

For more information about connections, see the connection resource.

overriddenFields

Changes to field metadata. Includes the following attributes in the

mtTaskOverriddenField object:
- name. Key field for the mtTaskOverriddenField collection.
- type
- precision
- scale

tgtFieldRefs

Optional.

Salesforce field reference IDs.

runtimeAttrs

Optional.

Advanced connection properties for connections used in a task.

Use a runtimeAttrs object to define key-value pairs of advanced connection

properties. Use an entry object for each key-value pair.

For the attribute name, use the advanced connection property name as displayed in
the Informatica Cloud application.

For more information about advanced connection properties, see the Informatica
Cloud Help.

parameterFileName

Name of the parameter file used in the task.

masterTemplateId ID of the integration template used in the task.

Required when the task uses an integration template.

mappingId ID of the mapping used in the task.

Required when the task uses a mapping.

scheduleId Schedule associated with the task flow, if any.

sessionProperties Advanced session properties. Use a sessionProperties object to define key-value

pairs of advanced session properties. Use an entry object for each key-value pair.
For the attribute name, use the advanced session property name as displayed in the
Informatica Cloud application.

outboundMessageUrlToken Outbound message URL token for the task, if it exists.

outputMessageUrlQueueTime Outbound message URL queue time for the task, if it exists.

runtimeEnvironmentId ID of the runtime environment used for the task.

agentId Agent that runs the task.

132 Chapter 2: Informatica Cloud REST API Resources

 Attribute Description

sequences Defines values for the Sequence Generator transformation. The following attributes
are included in the sequenceDefinition object:
- txName. Name of the Sequence Generator transformation. Key field in the
sequenceDefinition collection.
- initialValue. The initial value of the sequence.
- currentValue.

inOutParameters In-out parameter used in the task. Includes the following attributes in the
mtTaskInOutParameter object for each in-out parameter:
- id
- name. Key field in the mtTaskInOutParameter collection.
- description
- initialValue
- datatype
- precision
- scale
- retentionPolicy
- aggregationType
- currentValue

POST Response
If successful, returns the mtTask object that you created or updated. Returns the error object if errors occur.

DELETE Request
To delete a Mapping Configuration task, use the task ID in the following URI:
/api/v2/mttask/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example
To create a new Mapping Configuration task with XML, you might use the following request:
POST <serverUrl>/api/v2/mttask HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<mtTask>
<errorTaskEmail>
<taskEmail>
<emails>[email protected], [email protected]</emails>
</taskEmail>
</errorTaskEmail>
<successTaskEmail>
<taskEmail>
<emails>[email protected]</emails>
</taskEmail>
</successTaskEmail>
<warningTaskEmail>
<taskEmail>
<emails>[email protected], [email protected]</emails>
</taskEmail>
</warningTaskEmail>
<parameters>
<mtTaskParameter>

mttask 133
 <name>sort convert plugin</name>
<type>MAPPLET</type>
</mtTaskParameter>
</parameters>
<parameters>
<mtTaskParameter>
<name>DB lookup</name>
<type>LOOKUP</type>
</mtTaskParameter>
</parameters>
<sessionProperties>
<entry>
<key>Java Classpath</key>
<value>C:/test/classpathnew</value>
</entry>
<entry>
<key>Pushdown Optimization</key>
<value>To Source</value>
</entry>
<entry>
<key>Write Backward Compatible Session Log File</key>
<value>no</value>
</entry>
</sessionProperties>
<runtimeEnvironmentId>00000398D00000004</runtimeEnvironmentId>
<sequences>
<sequenceDefinition>
<txName>SeqGen1</txName>
<initialValue>1</initialValue>
<currentValue>62</currentValue>
</sequenceDefinition>
</sequences>
<preProcessingCmd>echo CurrentDate is 'date'</preProcessingCmd>
<postProcessingCmd>echo PR-PostProcess</postProcessingCmd>
<masterTemplateId>00034234M00000R</masterTemplateId>
</mtTask>
A successful request returns the mtTask object.

Mask Rule Parameter Attributes for Masking Techniques

Define the parameter attribute values of a mask rule parameter when you run the Mapping Configuration
task. The attributes that you define depend on the masking technique that you apply.

For example, to mask a billing city field with the Substitution City masking technique, define the following
attributes:
[
{
"referenceField": "BillingCity",
"pcType": "string",
"precision": 40,
"paramMap": {
"isSeeded": "TRUE",
"seedValue": "190",
"dicName": "informatica_mask_us_towns.dic",
"outputPort": "TOWNNAMES",
},
"maskingType": "Substitution City"
}
]

134 Chapter 2: Informatica Cloud REST API Resources

The following table lists the attributes that you define for each masking technique:

Masking Technique Attributes

Credit Card - isSeeded

- seedValue
- keepCardIssuer
- targetIssuer

Custom Substitution - DicConn

- DicName
- outputPort
- isSeeded
- seedValue

Email address - isSeeded

- seedValue

IP address - isSeeded
- seedValue

Key Date - isSeeded

- seedValue

Key Numeric - override

- isSeeded
- seedValue

Key String - isSeeded

- seedValue
- useMaskFormat
- maskFormat
- useSrcFilter
- srcFilterOption
- srcFilterStr
- useTargetFilter
- targetFilterOption
- targetFilterStr

Phone - isSeeded
- seedValue

Random Date - useRange

- minWidth
- maxWidth
- useBlurring
- blurringUnit
- blurLow
- blurHigh

Random Numeric - useRange

- minWidth
- maxWidth
- useBlurring
- blurringOption
- blurLow
- blurHigh

mttask 135
 Masking Technique Attributes

Random String - useRange

- minWidth
- maxWidth
- useMaskFormat
- useSrcFilter
- srcFilterStr
- useTargetFilter
- targetFilterOption
- targetFilterStr

SIN - isSeeded
- seedValue
- startDigit
- startDigitValue

SSN - isSeeded
- seedValue

Substitution City - isSeeded

- seedValue
- DicName
- outputPort

Substitution Country - isSeeded

- seedValue
- DicName
- outputPort

Substitution Female Name - isSeeded

- seedValue
- DicName
- outputPort

Substitution Last Name - isSeeded

- seedValue
- DicName
- outputPort

Substitution Male Name - isSeeded

- seedValue
- DicName
- outputPort

Substitution Name - isSeeded

- seedValue
- DicName
- outputPort

Substitution Position - isSeeded

- seedValue
- DicName
- outputPort

Substitution State - isSeeded

- seedValue
- DicName
- outputPort

136 Chapter 2: Informatica Cloud REST API Resources

 Masking Technique Attributes

Substitution Street - isSeeded

- seedValue
- DicName
- outputPort

Substitution U.S. ZIP code - isSeeded

- seedValue
- DicName
- outputPort

URL - isSeeded
- seedValue

Mask Rule Parameter Attribute Values

Define the required parameter attribute values when you run the Mapping Configuration task.

The following table describes the attributes and values that you define for the mask rule parameter:

Attribute Description

blurHigh Required. The higher bound for blurring. You can specify the value in digits.
Default is 0.

blurLow Required. The lower bound for blurring. You can specify the value in digits.
Default is 0.

blurringOption Required. The unit of blurring for a numeric port. You can specify the
following values:
- Percent. Blurs the data based on a percent value.
- Fixed. Blurs the data based on a fixed value.

blurringUnit Required. The unit of blurring for a date port. You can specify the following
values:
- Year. Blurs the year value.
- Month. Blurs the month value.
- Day. Blurs the day value.
- Hour. Blurs the hour value.
- Minute. Blurs the minute value.
- Second. Blurs the second value.
Default is Year.

delimiter Delimiter to separate the first name and last name in a masked email
address. You can specify the value as:
- .
- -
- _

DicConn The connection that contains the dictionary files. Create a flat file connection
that points to the directory with the dictionary files. Specify the flat file
connection name.

dicName The name of the flat file dictionary file. The dictionary file must be present in
the rdtmDir directory of the Secure Agent.

mttask 137
 Attribute Description

domainConstantValue Domain name to use in masked email addresses.

Default is company.com.

expText An attribute to configure an expression.

firstNameColumn The first name column to use in masked email addresses. Specify the name
of the port.

firstNameLength The length of the first name in a masked email address. You can specify the
value in digits.
Default is 5.

isSeeded An attribute to configure repeatable output. You can specify the following
values:
- TRUE. Masks the data with repeatable output. When true, specify a seed
value.
- FALSE. Masks the data with random output.
Default is TRUE.

keepCardIssuer Masks a credit card field with a credit card number from the same issuer.
You can specify the following values:
- TRUE. Retains the same card issuer in the masked data.
- FALSE. Uses a specified card issuer in the masked data.
When false, define the targetIssuer attribute.
Default is TRUE.

lastNameColumn The last name column to use in masked email addresses. Specify the name
of the port.

lastNameLength The maximum length of the last name in masked email addresses. You can
enter the value in digits.
Default is 5.

maskFormat Defines the type of character to substitute for each character in the input
data. You can limit each character to an alphabetic, numeric, or alphanumeric
character type.
Use the following characters to define a mask format:
- A. Alphabetic
- D. Digits 0-9
- N. Alphanumeric
- X. Any character
- R. Rest of the characters.
Specify the value as ADNX+R. R must appear as the last character. For
example, to ensure the masked output begins with an alphabet, enter the
value as A+R.
Default is R.

maxWidth Required. The minimum value for the range. Enter the value in digits.
Default is 0.

maxWidth Required. The maximum value for the range. Enter the datetime value.
Default is 01/19/2038 03:13:59.

138 Chapter 2: Informatica Cloud REST API Resources

Attribute Description

minWidth Required. The minimum value for the range. Enter the datetime value.
Default is 01/01/1970 00:00:00.

minWdth Required. The minimum value for the range. Enter the value in digits.
Default is 0.

outputPort The output port column from the dictionary.

seedValue The seed value. Specify a value between 1 and 999.

Default is 190.

srcFilterOption Required. The type of filter to apply to source filter characters. You can
specify the following values:
- Mask Only. Masks only the specified characters in the source.
- Mask all except. Masks all characters in the source except the characters
specified.

srcFilterStr Required. Defines the characters in the source string that you want to mask.

startDigit Required. Defines the first digit of the masked SIN. You can specify the
following values:
- TRUE. Uses the digit that you specify as the first digit of the masked SIN.
- FALSE. Uses a random digit as the first digit of the masked SIN.
Default is FALSE. When true, define the startDigitValue attribute.

startDigitValue Required. Defines the first digit of the masked SIN. Specify a value between 0
and 9.
Default is 0.

targetFilterOption Required. The type of filter to apply on target filter characters. You can
specify the following values:
- Use Only. Uses only the target characters that you specify.
- Use All Except. Uses all characters in the target except what you specify.

targetFilterStr Required. Substitutes the characters in a target string with the characters
that you define in target filter characters. For example, enter the following
characters to configure the masked output to contain all uppercase
alphabetic characters: ABCDEFGHIJKLMNOPQRSTUVWXYZ.

targetIssuer Required. Masked values contain credit card numbers from the issuer that
you select. You can specify the following values:
- ANY
- JCB
- VISA
- AMEX
- DISCOVER
- MASTERCARD

useBlurring Required. Masks dates based on a variance that you apply to a unit of the
date. The masked date is within the variance. You can specify the following
values:
- TRUE. Applies a variance that you specify on a unit of the date.
- FALSE. Does not apply a variance.
Default is FALSE.

mttask 139
 Attribute Description

useMaskFormat Specifies a mask format. You can specify the following values:
- TRUE. Masks the data based on a format that you specify.
- FALSE. Masks the data in a random format.
Default is TRUE. If true, define the maskFormat attribute.

useRange Required. Specifies a return value between the minimum and maximum
values of the range based on field precision. You can specify the following
values:
- TRUE. Masks the data within a range that you specify.
- FALSE. Does not use a specified range to mask the data.
To define the range, configure the minimum and maximum ranges or
configure a blurring range based on a variance from the original source
value.
Default is FALSE.

useSrcFilter Specifies the characters in the source string that you want to mask. You can
specify the following values:
- TRUE. Masks the characters in the source string that you specify.
- FALSE. Masks random characters in the source string.
Default is FALSE.

useTargetFilter Specifies the characters to use in the masked string. You can specify the
following values:
- TRUE. Uses characters that you specify in the masked string.
- FALSE. Uses random characters in the masked string.
Default is FALSE.

org
Use this resource to request the details of your Informatica Cloud organization or a related sub-organization.
You can use this resource to update an organization or related sub-organization. You can also delete a sub-
organization.

GET Request
To request the details of your organization, use the following URI:
/api/v2/org
To request the details of a sub-organization related to your organization, you can include the sub-
organization ID or sub-organization name in the URI. Use one of the following URIs:
/api/v2/org/<sub-organization ID>
/api/v2/org/name/<sub-organization name>
If you use the task name in the URI and the task name includes a space, replace the space with %20. For
example:
/api/v2/org/name/my%20suborg

GET Response
When you request the details of an organization, Informatica Cloud returns the org object in list format.

140 Chapter 2: Informatica Cloud REST API Resources

If the organization is a parent organization in an organization hierarchy, the org object includes the IDs and
names of all sub-organizations.

Returns the error object if errors occurred.

The org object includes the following attributes.

id

Organization ID.

orgId

Organization ID.

name

Organization name.

description

Description of the organization.

createTime

Time the organization was created.

updateTime

Last time the organization was updated.

createdBy

User who created the organization.

updatedBy

Last user who updated the organization.

parentOrgId

Organization ID for the parent organization.

Returns 0 if the organization is a stand-alone or parent organization.

address1

Address for the organization.

address2

Additional address information for the organization.

address3

Additional address information for the organization.

city

City where the organization is based.

state

State where the organization is based. Returns a state code.

For more information, see Appendix A , “State Codes” on page 185.

zipcode

Postal code of the area where the organization is based.

org 141
 country

Country where the organization is based. Returns a country code.

For more information, see Appendix A , “Country Codes” on page 187.

employees

Range of employees in the organization.

offerCode

Offer code assigned to Informatica Cloud partners.

successEmails

Email addresses to receive notification of tasks that complete successfully.

warningEmails

Email addresses to receive notification of tasks that complete with errors.

errorEmails

Email addresses to receive notification of tasks that fail to complete.

offerCode

Offer code assigned to Informatica Cloud partners.

campaignCode

Campaign code.

atlasProjectId

Atlas project ID.

zuoraAccountId

Zuora account ID.

spiUrl

Informatica Cloud Application Integration URL for the organization.

devOrg

Indicates the organization is a development organization.

Returns 1 for a development organization. Returns 0 for a production organization.

timezone

Time zone of the organization.

maxLogRows

Maximum number of rows to keep in the activity log.

minPasswordLength

Minimum number of characters for a user account password.

minPasswordCharMix

Mix of characters each password must contain.

Passwords can contain a mix of the following character sets: lowercase letters, capital letters, numbers,
and special characters.

142 Chapter 2: Informatica Cloud REST API Resources

 Returns one of the following values:

• 1. Contains at least one of the character sets.

• 2. Contains at least two of the character sets.
• 3. Contains at least three of the character sets.
• 4. Contains all four character sets.

passwordReuseInDays

Number of days until a previous password can be used again.

0 = Always.

passwordExpirationInDays

Number of days until the password expires.

0 = Never.

subOrgLimit

Number of sub-organizations allowed. If the limit has been customized, the REST API returns the custom
limit. Otherwise, the REST API returns the limit associated with the edition.

restApiSessionLimit
Number of concurrent REST API sessions allowed. If the limit has been customized, the REST API
returns the custom limit. Otherwise, the REST API returns the limit associated with the edition.

parentOrgId

Organization ID of the parent organization.

0 indicates the organization is a stand-alone or parent organization.

jobExecUserProfile

Informatica Cloud user account configured to run contact validation tasks.

twoFactorAuthentication

A security option that allows the configuration of trusted IP address ranges as an addition to account
password authentication:

• False. Informatica Cloud requires account passwords for access to the organization.
• True. Informatica Cloud requires account passwords for access to the organization, and the user
must login from within configured IP address ranges.

ipAddressRanges

For Two-Factor Authentication. One or more trusted IP address rangesthat use IP format version 4 (IPv4)
or version 6 (IPv6).

subOrg

Object that contains the following information for each sub-organization:

id

ID of the sub-organization.

name

Name of the sub-organization.

org 143
 POST Request
You can update an Informatica Cloud organization if the user that started the REST API session has the
Admin role and belongs to either the organization that you want to update or the parent organization.

When you update an Informatica Cloud organization, you cannot update the organization ID, offer code, or
organization administrator user account created with the organization.

You can use this resource to update a sub-organization if your organization has the Org Hierarchy license and
if the user that started the REST API session has the Admin role in the parent organization.

To update the details of a sub-organization related to your parent organization, use the organization ID in the
following URI. To update the details of your organization, omit the optional ID.
/api/v2/org/<id>
With this URI, you can use the following attributes in the org object:

name

Organization name.

address1

Address of organization.

address2

Optional.

Additional address information for the organization.

address3

Optional.

Additional address information for the organization.

city

City where the organization is based.

state

State where the organization is based. Use the appropriate state code.

Required when Country is set to US.

For more information, see Appendix A , “State Codes” on page 185.

zipcode

Postal code of the area where the organization is based.

Required when Country is set to US

country

Country where the organization is based. Use the appropriate country code.

For more information, see Appendix A , “Country Codes” on page 187.

description

Optional.

Description of the organization. Maximum length is 255 characters.

144 Chapter 2: Informatica Cloud REST API Resources

successEmails

Optional.

Default email addresses for notification of successful job completion.

warningEmails

Optional.

Default email addresses for warnings about job completion.

errorEmails

Optional.

Default email addresses for notification about job failure.

employees

Range of employees in the organization. Use one of the following ranges:

• "0_10"
• "11_25"
• "26_50"
• "51_100"
• "101_500"
• "501_1000"
• "1001_5000"
• "5001_"

offerCode

Optional.

Offer code assigned to Informatica Cloud partners.

POST Response
If successful, returns the org request object for the organization that you created or updated.

Returns the error object if errors occur.

DELETE Request
You can delete an Informatica Cloud sub-organization if the user that started the Informatica Cloud REST API
session has the Admin role and belongs the parent organization.

To delete an Informatica Cloud organization, use the organization ID with the following URI:
/api/v2/org/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example
To update a sub-organization with an ID of 02340000, you might use the following request:
GET <serverUrl>/api/v2/org/02340000 HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

org 145
 <org>
<name>Dev Org</name>
<address1>333 Main Street</address1>
<city>City</city>
<state>MD</state>
<zipcode>90001</zipcode>
<country>US</country>
</org>
A successful request returns the org request object for the sub-organization that you updated.

permission
Use the permission resource to view and update user group permissions for specific entities.

You can set permission levels for specific user groups and associate the permissions to objects such as
mappings, mapplets, mapping configuration tasks, task flows, and integration templates. The permissions
you specify through the REST API overwrite the permissions set in the user interface.

To request user group permissions for a specified object, use the object ID in the following URI:
/api/v2/permission/<objectId>

GET Response
Returns an objectAcl object with the following attributes:

objectType

Permissions object. Returns one of the following codes:

• Agent. Secure Agent.

• Connection.
• Schedule. Task schedule.
• CustomFunc. Mapplet
• CustomSource. Saved query.
• WORKFLOW. Task flow.
• DSS. Data synchronization task.
• DRS. Data replication task.
• DQA. Data assessment task.
• PCS. PowerCenter task.
• DNB_TASK. D&B360 task.
• AVS. Contact validation task.
• MTT. Mapping configuration task.
• TEMPLATE. Integration template.
• DMASK. Data masking task.
• BUNDLE. Bundle.
• DTEMPLATE. Mapping.
• SERVICE_PROCESS. Service and process.

146 Chapter 2: Informatica Cloud REST API Resources

 • RETIREMENT. Application retirement.
• AgentGroup. Runtime environment.
• BSERVICE. Business service definition.
• FWCONFIG. Fixed width file format.
• StructureDiscovery. Intelligent Structure Discovery.

objectId

ID of the object.
useDefaultPermissions

No longer used. Use the updatetype request parameter instead. Whether to use the default permissions
for the specified user group.
Whether to use the default permissions for the specified user group.

aclEntries

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for each
object type. For more information about the aclEntry object, see the usergroup resource.

GET Example
The following example shows a request to get user group permissions information for a specific mapping:
GET <serverUrl>/api/v2/permission/00001R17000000000002 HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
The following text is a sample response:
{
"@type": "objectAclApi",
"objectType": "DTEMPLATE",
"objectId": "00001R17000000000002",
"aclEntries": [
{
"@type": "aclEntry",
"objectType": "DTEMPLATE",
"createPermission": true,
"readPermission": true,
"updatePermission": true,
"deletePermission": true,
"executePermission": true,
"adminPermission": true,
"userGroupId": "00001R05000000000002",
"userGroupName": "abc"
},
{
"@type": "aclEntry",
"objectType": "DTEMPLATE",
"createPermission": true,
"readPermission": true,
"updatePermission": true,
"deletePermission": true,
"executePermission": true,
"adminPermission": true,
"userGroupId": "00001R05000000000003",
"userGroupName": "def"
}
]
}

permission 147
 POST Request
Include the updatetype request parameter for the objectAcl object in the URI. The updatetype request
parameter determines how the update applies to user groups specified in the request and user groups that
are not specified. Use one of the following values for the updatetype request parameter:

• set. The permissions of the user groups provided in the request are updated. The permissions for the
remaining user groups are revoked.
To use the set update type, use the following URI:
/api/v2/permission/<objectId>?updatetype=set
• setdefault. The permissions of all user groups are set to default. For the setdefault value, the request
body is optional.
To use the setdefault update type, use the following URI:
/api/v2/permission/<objectId>?updatetype=setdefault
• update. The permissions of the user groups provided in the request are updated. The permissions of user
groups that are not mentioned in request remain unaffected.
To use the update update type, use the following URI:
/api/v2/permission/<objectId>?updatetype=update
You can use the following attributes in an objectAcl object:

objectType

Permissions object. Use one of the following codes:

• Agent. Secure Agent.

• Connection.
• Schedule. Task schedule.
• CustomFunc. Mapplet
• CustomSource. Saved query.
• WORKFLOW. Task flow.
• DSS. Data synchronization task.
• DRS. Data replication task.
• DQA. Data assessment task.
• PCS. PowerCenter task.
• DNB_TASK. D&B360 task.
• AVS. Contact validation task.
• MTT. Mapping configuration task.
• TEMPLATE. Integration template.
• DMASK. Data masking task.
• BUNDLE. Bundle.
• DTEMPLATE. Mapping.
• SERVICE_PROCESS. Service and process.
• RETIREMENT. Application retirement.
• AgentGroup. Runtime environment.
• BSERVICE. Business service definition.
• FWCONFIG. Fixed width file format.

148 Chapter 2: Informatica Cloud REST API Resources

 • StructureDiscovery. Intelligent Structure Discovery.

objectId

ID of the object. Read only.

useDefaultPermissions

No longer used. Use the updatetype request parameter instead.

Whether to use the default permissions for the specified user group.

aclEntries

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for each
object type. For more information about the aclEntry object, see the usergroup resource.

POST Response
Returns an objectAcl object with the following attributes:

objectType

Permissions object. Use one of the following codes:

• Agent. Secure Agent.

• Connection.
• Schedule. Task schedule.
• CustomFunc. Mapplet
• CustomSource. Saved query.
• WORKFLOW. Task flow.
• DSS. Data synchronization task.
• DRS. Data replication task.
• DQA. Data assessment task.
• PCS. PowerCenter task.
• DNB_TASK. D&B360 task.
• AVS. Contact validation task.
• MTT. Mapping configuration task.
• TEMPLATE. Integration template.
• DMASK. Data masking task.
• BUNDLE. Bundle.
• DTEMPLATE. Mapping.
• SERVICE_PROCESS. Service and process.
• RETIREMENT. Application retirement.
• AgentGroup. Runtime environment.
• BSERVICE. Business service definition.
• FWCONFIG. Fixed width file format.
• StructureDiscovery. Intelligent Structure Discovery.

objectId

ID of the object.

permission 149
 aclEntries

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for each
object type. For more information about the aclEntry object, see the usergroup resource.

POST Examples
The following example uses the set update type for the request. The request sets permissions for a
connection object, which is specified by the objectId. The request includes two user groups, specified by the
userGroupId. The user groups for which permissions are provided in the request body are saved. Permissions
for the remaining user groups are revoked for the object ID provided in the request URI.
POST <serverURL>/api/v2/permission/0000010B00000000000W?updatetype=set HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type":"objectAclApi",
"objectType":"Connection",
"objectId":"0000010B00000000000W",
"useDefaultPermissions":true,
"aclEntries":[
{
"@type":"aclEntry",
"objectType":"Connection",
"createPermission":true,
"readPermission":true,
"updatePermission":false,
"deletePermission":false,
"executePermission":false,
"adminPermission":false,
"id":"0000010400000000001A",
"orgId":"000001",
"userGroupId":"00000105000000000002",
"userGroupName":"temp",
"objectId":"-1"
}, {
"@type":"aclEntry",
"objectType":"Connection",
"createPermission":true,
"readPermission":true,
"updatePermission":true,
"deletePermission":true,
"executePermission":false,
"adminPermission":true,
"id":"0000010400000000001B",
"orgId":"000001",
"userGroupId":"00000105000000000003",
"userGroupName":"temp2",
"objectId":"-1"
}
]
}
The following example uses the setdefault update type for the request. Permissions for all of the user groups
are set to default for the specified connection object.
POST <serverURL>/api/v2/permission/0000010B00000000000W?updatetype=setdefault HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type":"objectAclApi"
}
The following example uses the update update type for the request. The user groups for which the
permissions are provided in the request body are saved for the specified object. The remaining user group
permissions are not affected.
POST <serverURL>/api/v2/permission/0000010B00000000000W?updatetype=update HTTP/1.0
Content-Type: application/json
Accept: application/json

150 Chapter 2: Informatica Cloud REST API Resources

 {
"@type":"objectAclApi",
"objectType":"Connection",
"objectId":"0000010B00000000000W",
"useDefaultPermissions":true,
"aclEntries":[
{
"@type":"aclEntry",
"objectType":"Connection",
"createPermission":true,
"readPermission":true,
"updatePermission":false,
"deletePermission":false,
"executePermission":false,
"adminPermission":false,
"id":"0000010400000000001A",
"orgId":"000001",
"userGroupId":"00000105000000000002",
"userGroupName":"temp",
"objectId":"-1"
},{
"@type":"aclEntry",
"objectType":"Connection",
"createPermission":true,
"readPermission":true,
"updatePermission":true,
"deletePermission":true,
"executePermission":false,
"adminPermission":true,
"id":"0000010400000000001B",
"orgId":"000001",
"userGroupId":"00000105000000000003",
"userGroupName":"temp2",
"objectId":"-1"
}
]
}

register
Use this resource to create an Informatica Cloud organization or sub-organization. For Informatica Cloud
partners only.

When you create an Informatica Cloud organization, you also create an organization administrator user
account. Use one of the following credentials to create the organization administrator user account:

• Email address and other account details.

The information that you pass becomes the organization administrator user account. If you do not pass
the emails attribute and the user name is a valid email address, the user name is used to populate the
emails attribute. You can create a sub-organization if the user that started the Informatica Cloud REST API
session has the Admin role and belongs to an organization with the Org Hierarchy license.
• Salesforce login.
The Salesforce login becomes the organization administrator user account. Use the Salesforce login to
create a Salesforce session ID and pass the session ID in the register syntax. When you use a Salesforce
login, you cannot create a sub-organization.

You need an Informatica Cloud partner offer code to create an Informatica Cloud organization.

register 151
 register POST Request
To create an Informatica Cloud organization with an email address and user account details, use the
following URL.
https://app.informaticaondemand.com/ma/api/v2/user/register
To create an Informatica Cloud sub-organization, use the following URI.
/api/v2/user/register
You can create an Informatica Cloud sub-organization if your organization has the Org Hierarchy license and
if the user that started the REST API session has the Admin role in the parent organization.

Use the icSessionId from the login response in the request header. Use the serverUrl from the login response
as the base URL.

With both the register URL and URI, you can use the following attributes in a registration object:

org

Attribute that defines an Informatica Cloud organization.

Include the following attributes in an org object:

offerCode

Optional.

Offer code assigned to Informatica Cloud partners.

name

Name for the new Informatica Cloud organization.

address1

Address where the organization is located.

address2

Optional.

Additional address information for the organization.

address3

Optional.
Additional address information for the organization.

city

City where the organization is located.

state

State where the organization is located. Use the appropriate state code.

Required for the United States.

For more information, see Appendix A, “State Codes” on page 185.

zipcode

Zip code where the organization is located.

country

Country where the organization is located. Use the appropriate country code.

152 Chapter 2: Informatica Cloud REST API Resources

 For more information, see Appendix A, “Country Codes” on page 187.

timezone

Time zone of the user. Time zone honors Daylight Saving Time.

For more information, see Appendix A , “Time Zone Codes” on page 193.

employees

Number of employees in the organization. Use one of the following ranges:

• "0_10"
• "11_25"
• "26_50"
• "51_100"
• "101_500"
• "501_1000"
• "1001_5000"
• "5001_"

user

Attribute that defines the organization administrator user account.

Include the following attributes in a user object:

name

Email address for the organization administrator account.

password

Password for the organization administrator account.

firstName

First name of the organization administrator.

lastName

Last name of the organization administrator.

title

Title of the organization administrator.

phone

Phone number for the organization administrator.

emails

Email address that receives notification from Informatica Cloud.

timezone

Optional.

Time zone of the organization administrator. Time zone honors Daylight Saving Time.

Use the appropriate time zone code.

For more information, see Appendix A, “Time Zone Codes” on page 193.

If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default.

register 153
 securityQuestion

Optional.

Security question. Use one of the following codes to select the security question:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME
• CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"

securityAnswer

Optional.

Answer to the security question.

forceChangePassword

Optional.

Determines if the user must reset the password after the user logs in for the first time. Includes the
following values:

• True. The user must reset the password.

• False. The user is not forced to reset the password.

optOutOfEmails

Optional.

Whether the user opts in or out of receiving marketing communication from Informatica. TRUE
indicates that the user does not want to receive marketing communication.

registrationCode

Registration code.

sendEmail

Optional.

When registration completes, sends an email to the user email address with temporary login
information. Use TRUE to send an email.

registerSf POST Request

To create an Informatica Cloud organization with a Salesforce login for the user account, use the following
URL:
https://app.informaticaondemand.com/ma/api/v2/user/registerSf
With this URL, use the following attributes in the registrationSf object:

sfSessionId

Salesforce session ID.

The Salesforce login used to create the session ID becomes the Informatica Cloud user account for the
organization.

154 Chapter 2: Informatica Cloud REST API Resources

 For information about generating the Salesforce session ID, see the login resource in the Salesforce Web
Services API Developer's Guide.

sfServerUrl

Salesforce URL.

offerCode

Optional.

Offer code assigned to Informatica Cloud partners.

registrationCode

Registration code.

icsPassword

Optional.

Password for the Informatica Cloud account.

securityQuestion

Optional.

Security question. Use one of the following codes to select the security question:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME
• CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"

securityAnswer

Optional.

Answer to the security question.

sendEmail

Optional.

When registration completes, sends an email to the user email address with temporary login
information. Use TRUE to send an email.

timezone

Optional.

Time zone of the organization administrator. Time zone honors Daylight Saving Time.

Use the appropriate time zone code.

For more information, see Appendix A, “Time Zone Codes” on page 193.

If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default.

POST Response
Returns the user object if the request is successful. Returns the error object if errors occur.

register 155
 The user object includes the following attributes.
id

User ID.

orgId

ID of the organization the user belongs to.

name

Informatica Cloud user name.

description

Description of the user.

createTime

When the user account was created.

updateTime

When the user account was last updated.

createdBy

Informatica Cloud user who created the user account.

updatedBy

Informatica Cloud user who last updated the user account.

sfUsername

Salesforce user name.

password

Password. If using sfUsername, this is the Salesforce password.

firstName

First name for the user account.

lastName

Last name for the user account.

title

Title of the user.

phone

Phone number for the user.

securityQuestion

Security question. Returns one of the following codes:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME
• CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"

156 Chapter 2: Informatica Cloud REST API Resources

securityAnswer

Answer to the security question.

roles

Roles assigned to the user. The following attributes are included in a role object for each role:
name

Role name. Returns one of the following codes:

• SERVICE_CONSUMER
• DESIGNER
• ADMIN

description

Description.

usergroups

User group assigned to the user. The following attributes are included in a usergroup object for each
user group:
id

User group ID.

orgId

Organization ID.

name

User group name.

description

Description.

createTime

Time the user group was created.

updateTime

Last time the user group was updated.

createdBy

User who created the user group.

updatedBy

User who last updated the user group.

aclEntry

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for
each object type. For more information about the aclEntry object, see the “usergroup” on page 177
resource.

emails

Email address to be notified when the user changes the account password.

If you pass multiple email addresses in this field, Informatica Cloud uses the first email address in the
list.

register 157
 timezone

Time zone of the user. Time zone honors Daylight Saving Time.

For more information, see Appendix A , “Time Zone Codes” on page 193.

serverUrl

Informatica Cloud URL for the organization the user belongs to. Use the serverUrl as a base for most
REST API resource URIs.

spiUrl

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

Unique identifier for the user.

icSessionId

Informatica Cloud REST API session ID. Use in most REST API request headers.

forceChangePassword

Determines if the user must reset the password after the user logs in for the first time. Includes the
following values:

• True. The user must reset the password.

• False. The user is not forced to reset the password.

POST Examples
To register an organization in JSON, you might use the following request:
POST https://app.informaticaondemand.com/ma/api/v2/user/register HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type" : "registration",
"user" : {
"@type" : "user",
"name" : "[email protected]",
"emails" : "[email protected]",
"firstName" : "firstName",
"lastName" : "lastName",
"title" : "jobTitle",
"phone" : "(0)1234 567 890",
"timezone" : null,
"forceChangePassword" : "true"
"optOutOfEmails" : "true"
},
"org" : {
"@type" : "org",
"offerCode" : "PPC30daytrial",
"campaignCode" : "PPC",
"name" : "myOrg",
"address1" : "1 Main St",
"city" : "Mycity",
"state" : "CA",
"zipcode" : "90210",
"country" : "US",
"employees" : "5001_"
},
"registrationCode" : "ics-standard",
"sendEmail" : true
}
A successful request returns the user object that was created, which includes the organization ID for the
organization that was created.

158 Chapter 2: Informatica Cloud REST API Resources

 To register a new organization using Salesforce credentials in JSON, you might use the following request:
POST https://app.informaticaondemand.com/ma/api/v2/user/registerSf HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"@type": "registrationSf",
"sfSessionId": "salesforceID00003",
"sfServerUrl": "http://www.salesforceURL.com",
"offerCode": "OFFERCODE"
}
A successful request returns the user object that was created, which includes the organization ID for the
organization that was created.

runtimeEnvironment
Use the runtimeEnvironment resource to get information about runtime environments for an organization.

To request runtime environment information, use the following URI:

/api/v2/runtimeEnvironment
To request the details of a particular runtime environment, you can include the runtime environment ID or
name in the URI. Use one of the following URIs:
/api/v2/runtimeEnvironment/<id>
/api/v2/runtimeEnvironment/name/<name>
If you use the runtime environment name in the URI and the runtime environment name includes a space,
replace the space with %20. For example:
/api/v2/runtimeEnvironment/name/my%20runtime%20environment

GET Response
Returns runtime environment information for the requested runtime environment. The runtimeEnvironment
object includes the following attributes:

id
Runtime environment ID.

orgId

Organization ID.

name

Runtime environment name.

description

Runtime environment description.

createTime

Date and time that the runtime environment was created.

updateTime

Date and time that the runtime environment was last updated.

runtimeEnvironment 159
 createdBy

User who created the runtime environment.

updatedBy

User who last updated the runtime environment.

agents

Agents assigned to the runtime environment. For more information, see the agent resource.

isShared

Indicates whether the Secure Agent group is shared. Returns one of the following values:

• true. The Secure Agent group is shared.

• false. The Secure Agent group is not shared.

Get Example
To request the details of a particular runtime environment, you might use the following request:
GET <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004 HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>
The following text is a sample return in XML:
{
"@type": "runtimeEnvironment",
"id": "00000425000000000004",
"orgId": "000004",
"name": "SUT_Agent",
"createTime": "2016-12-09T12:34:01.000Z",
"updateTime": "2016-12-09T17:54:00.000Z",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"agents": [
{
"@type": "agent",
"id": "00000408000000000002",
"orgId": "000004",
"name": "USW1MJ02YNKJ",
"createTime": "2016-12-09T13:21:57.000Z",
"updateTime": "2017-01-25T16:37:37.000Z",
"createdBy": "admin",
"updatedBy": "admin",
"active": true,
"readyToRun": false,
"platform": "win64",
"agentHost": "USW1MJ02YNKJ",
"serverUrl": "https://aws-qa5.infaqa.com/saas",
"proxyPort": 0,
"agentVersion": "33.0",
"upgradeStatus": "NotUpgrading",
"spiUrl": "https://ts1w2a.rt.informaticacloud.com",
"lastUpgraded": "2016-12-27T17:37:51.000Z",
"packages": [],
"agentConfigs": [],
"configUpdateTime": "2017-01-18T13:57:15.000Z"
}
],
"isShared": true
}

160 Chapter 2: Informatica Cloud REST API Resources

salesforceVersion
Deprecated. This resource is no longer used.

GET Request
Use the following URI to request the version of Salesforce used by default by Informatica Cloud:
/api/v2/server/salesforceVersion

GET Response
Returns the salesforceVersion object if the request is successful. Returns the error object if errors occur.

The salesforceVersion object includes the following attribute:

versionNo

Salesforce version number.

GET Example
To check the Salesforce version, you might use the following request:
GET <serverUrl>/api/v2/server/salesforceVersion HTTP/1.0
Accept: application/json
icSessionId: <icSessionId>

schedule
Use this resource to request the details of a schedule or the details of all schedules in the organization. You
can create or update a schedule. You can also delete a schedule.

GET Request
To view the details of all schedules in the organization, use the following URI:
/api/v2/schedule
To request the details of a particular schedule, you can include the schedule ID or schedule name in the URI.
Use one of the following URIs:
/api/v2/schedule/<id>
/api/v2/schedule/name/<name>
If you use the schedule name in the URI and the schedule name includes a space, replace the space with %20.
For example:
/api/v2/schedule/name/my%20schedule

GET Response
If successful, returns the schedule object for the requested schedule. Or, if you request the details for all
schedules, returns the schedule object for each schedule in the organization.

Returns the error object if errors occur.

The schedule object includes the following attributes:

id

Schedule ID.

salesforceVersion 161
 orgId

Organization ID.

name

Schedule name.

description

Description of the schedule.

createTime

Time the schedule was created.

updateTime

The last time the schedule was updated.

createdBy

User who created the schedule.

updatedBy

User who last updated the schedule.

startTime

Start time of the schedule.

endTime

End time of the schedule.

interval

Repeat interval for the schedule. Returns one of the following codes:

• None. The schedule does not repeat.

• Minutely. Tasks run on an interval based on a specified number of minutes.
• Hourly. Tasks run on an hourly interval based on the specified number of hours, days, and time range.
• Daily. Tasks run daily at the configured start time.
• Weekly. Tasks run at the configured start time on the configured days.
• Monthly. Tasks run at the configured start time on the configured day of the month.

frequency

Frequency that the schedule runs. Returns a numeric value that represents one of the following:

• For Minutely intervals: tasks run every n minutes.

• For Hourly intervals: tasks run every n hours.

Minutely and Hourly intervals only.

rangeStartTime

The start of the time range within a day that tasks run. Minutely and Hourly intervals only.

rangeEndTime

The end of the time range within a day that tasks run. Minutely and Hourly intervals only.

162 Chapter 2: Informatica Cloud REST API Resources

sun

Tasks run on Sunday. Returns one of the following codes:

• true. The tasks run on Sunday.

• false. The tasks do not run on Sunday.

Minutely, Hourly, and Weekly intervals only.

mon

Tasks run on Monday. Returns one of the following codes:

• true. The tasks run on Monday.

• false. The tasks do not run on Monday.

Minutely, Hourly, and Weekly intervals only.

tue

Tasks run on Tuesday. Returns one of the following codes:

• true. The tasks run on Tuesday.

• false. The tasks do not run on Tuesday.

Minutely, Hourly, and Weekly intervals only.

wed

Tasks run on Wednesday. Returns one of the following codes:

• true. The tasks run on Wednesday.

• false. The tasks do not run on Wednesday.

Minutely, Hourly, and Weekly intervals only.

thu

Tasks run on Thursday. Returns one of the following codes:

• true. The tasks run on Thursday.

• false. The tasks do not run on Thursday.

Minutely, Hourly, and Weekly intervals only.

fri

Tasks run on Friday. Returns one of the following codes:

• true. The tasks run on Friday.

• false. The tasks do not run on Friday.

Minutely, Hourly, and Weekly intervals only.

sat

Tasks run on Saturday. Returns one of the following codes:

• true. The tasks run on Saturday.

• false. The tasks do not run on Saturday.

Minutely, Hourly, and Weekly intervals only.

schedule 163
 weekDay

Tasks run on weekdays only. Returns one of the following codes:

• true. The tasks run on weekdays.

• false. The tasks run every day.

Daily interval only.

dayOfMonth

Date of the month that tasks run. Returns a date between 1-28.

Monthly interval only.

weekOfMonth

Week of the month that tasks run. Returns one of the following codes:

• First. The tasks run in the first week of the month.

• Second. The tasks run in the second week of the month.
• Third. The tasks run in the third week of the month.
• Fourth. The tasks run in the fourth week of the month.
• Last. The tasks run in the last week of the month.

Monthly interval only.

dayOfWeek

Day of the week that tasks run. Returns one of the following codes:

• Day. Tasks run on the first day or last day of the month, based on the selected weekOfMonth option.
• Sunday. The tasks run on Sunday.
• Monday. The tasks run on Monday.
• Tuesday. The tasks run on Tuesday.
• Wednesday. The tasks run on Wednesday.
• Thursday. The tasks run on Thursday.
• Friday. The tasks run on Friday.
• Saturday. The tasks run on Saturday.

Monthly interval only.

timeZone

Time zone of the user who last updated the schedule. Time zone honors Daylight Saving Time.

POST Request
To update a schedule, use the schedule ID with the following URI. To create a schedule, omit the optional
schedule ID.
/api/v2/schedule/<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
You can use the following attributes in a schedule object:

164 Chapter 2: Informatica Cloud REST API Resources

id

Required.

Schedule ID.

orgId

Required.

Organization ID.

name

Required.

Schedule name.

description

Optional.

Description of the schedule.

startTime

Required.

Date and time when the schedule starts running. Use the following format:

YYYY-MM-DDTHH24:MI:SSZ

endTime

Optional.

Date and time when the schedule stops running. If you do not use this parameter, the schedule runs
indefinitely.

Use the following format:

YYYY-MM-DDTHH24:MI:SSZ

interval

Required.

Interval or repeat frequency at which the schedule runs. Use one of the following options:

• None. Tasks run at the schedule start time. The schedule does not repeat.
• Minutely. Tasks run on an interval based on the specified number of minutes, days, and time range.
You can use the following parameters:
- frequency. Frequency in minutes that tasks run.

- sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.

- startTimeRange and endTimeRange. The time range within a day tasks should run. Do not use if you
want tasks to run all day.
- endTime. When the schedule should stop running. Do not use if you want the schedule to run
indefinitely.
• Hourly. Tasks run on an hourly interval based on the start time of the schedule. You can use the
following parameters:
- frequency. Frequency in hours that tasks run.

- sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.

schedule 165
 - startTimeRange and endTimeRange. The time range within a day tasks should run. Do not use if you
want tasks to run all day.
- endTime. When the schedule should stop running. Do not use if you want the schedule to run
indefinitely.
• Daily. Tasks run daily at the start time configured for the schedule. You can use the following
parameters:
- weekDay. Runs the tasks every weekday. Do not use if you want the tasks to run every day.

- endTime. When the schedule should stop running. Do not use if you want the schedule to run
indefinitely.
• Weekly. Tasks run on a weekly interval based on the start time of the schedule. You can use the
following parameters:
- sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.

- endTime. When the schedule should stop running. Do not use if you want the schedule to run
indefinitely.
• Monthly. Tasks run on a monthly interval based on the start time of the schedule. You can use the
following parameters:
- dayOfMonth. Day of the month when you want tasks to run, between 1-28.

- dayOfWeek. Day of the week when you want tasks to run.

- weekOfMonth. Week of the month when you want tasks to run.

- endTime. When the schedule should stop running. Do not use if you want the schedule to run
indefinitely.
To indicate when tasks should run, use dayOfWeek with weekOfMonth, such as the First Monday. Or
use dayOfMonth, such as 1.
Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameter with the Day
dayOfWeek parameter.

frequency

Optional.

Repeat frequency for tasks. Use one of the following values:

• For the Minutely interval, use one of the following options: 5, 10, 15, 20, 30, 45.
• For the Hourly interval, use one of the following options: 1, 2, 3, 4, 6, 8, 12.

Use with Minutely and Hourly intervals only.

rangeStartTime

Optional.

The start of the time range within a day that you want tasks to run. Enter a date and time using the
following format. Only the time portion is used:

YYYY-MM-DDTHH24:MI:SSZ

Use with Minutely and Hourly intervals only.

rangeEndTime

Optional.

The end of the time range within a day that you want tasks to run. Enter a date and time using the
following format. Only the time portion is used:

166 Chapter 2: Informatica Cloud REST API Resources

 YYYY-MM-DDTHH24:MI:SSZ

Use with Minutely and Hourly intervals only.

sun

Optional.

Runs tasks on Sunday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Sunday.

• False. Does not run tasks on Sunday.

Use with Minutely, Hourly, and Weekly intervals only.

mon

Optional.

Runs tasks on Monday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Monday

• False. Does not run tasks on Monday.

Use with Minutely, Hourly, and Weekly intervals only.

tue

Optional.

Runs tasks on Tuesday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Tuesday.

• False. Does not run tasks on Tuesday.

Use with Minutely, Hourly, and Weekly intervals only.

wed

Optional.

Runs tasks on Wednesday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Wednesday.

• False. Does not run tasks on Wednesday.

Use with Minutely, Hourly, and Weekly intervals only.

thu

Optional.

Runs tasks on Thursday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

schedule 167
 Use one of the following options:

• True. Runs tasks on Thursday.

• False. Does not run tasks on Thursday.

Use with Minutely, Hourly, and Weekly intervals only.

fri

Optional.

Runs tasks on Friday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Friday.

• False. Does not run tasks on Friday.

Use with Minutely, Hourly, and Weekly intervals only.

sat

Optional.

Runs tasks on Saturday at the configured time. You can use the sun - sat parameters to run tasks on
several days of the week.

Use one of the following options:

• True. Runs tasks on Saturday.

• False. Does not run tasks on Saturday.

Use with Minutely, Hourly, and Weekly intervals only.

weekDay

Optional.

Runs tasks on weekdays. Use one of the following options:

• True. Run tasks on Monday through Friday. Does not run tasks on the weekend.
• False. Run tasks every day.

Use with the Daily interval only.

dayOfMonth

Optional.

Date of the month that tasks should run. Use a date between 1-28.

Use with the Monthly interval only.

Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameter with the Day
dayOfWeek parameter.

weekOfMonth

Optional.

Week of the month that tasks should run. Use with dayOfWeek to specify the day and week of the month
that tasks should run. For example, the First Day or the Last Wednesday of the month.

168 Chapter 2: Informatica Cloud REST API Resources

 Use one of the following options:

• First
• Second
• Third
• Fourth
• Last

Use with the Monthly interval only.

dayOfWeek

Optional.

Day of the week that tasks should run. Use with weekOfMonth to specify the day and week of the month
that tasks should run. For example, the First Day or the Last Wednesday of the month.

Use one of the following options:

• Day
• Sunday
• Monday
• Tuesday
• Wednesday
• Thursday
• Friday
• Saturday

Use with the Monthly interval only.

timeZone

Optional.

Time zone to use for the schedule. If no valid time zone is passed, Informatica Cloud uses the user's
time zone.

For more information, see Appendix A, “Time Zone Codes” on page 193.

POST Response
Returns the schedule response object for the schedule that you created or updated.

Returns an error object if errors occur.

DELETE Request
To delete a schedule, use the schedule ID with the following URI:
/api/v2/schedule/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns an error object if errors occur.

schedule 169
 GET Example
To request information about all schedules in the organization, you might use the following request:
GET <serverUrl>/api/v2/schedule HTTP/1.0
Accept: application/json
icSessionId: <icSessionId>
A successful request returns a schedule object for each schedule in the organization.

serverTime
Use this resource to return the local time for the Informatica Cloud server.

GET Request
To request the local time of the Informatica Cloud server, use the following URI.
/api/v2/server/serverTime

GET Response
Returns the serverTime object if the request is sucessful. Returns an error object if errors occur.

The serverTime object includes the following attribute:

time

Local time of the Informatica Cloud server.

GET Example
To check the local time of the Informatica Cloud server, you might use the following request:
GET <serverUrl>/api/v2/server/serverTime HTTP/1.0
Accept: application/xml
icSessionId: <icSessionId>

task
Use this resource to request a list of tasks of a specified type. You can use this resource to retrieve the name
and ID for a task.

GET Request
To request a list of tasks of a specified type, use the task type code in the following URI.
/api/v2/task?type=<type>

170 Chapter 2: Informatica Cloud REST API Resources

 Use the following attribute in the URI:

Field Required Description

type Yes Use one of the following codes:

- DMASK. Data Masking task.
- DRS. Data Replication task.
- DSS. Data Synchronization task.
- MTT. Mapping Configuration task.
- PCS. PowerCenter task.

GET Response
If the request is successful, returns the task object for every task of the requested type. Returns the error
object if errors occur.

The task object includes the following attributes:

Field Type Description

id String Task ID.

orgId String Organization ID.

name String Task name.

description String Description.

createTime String Time the task was created.

updateTime String Last time the task was updated.

createdBy String User who created the task.

updatedBy String User who last updated the task.

GET Example
To view a list of all Data Synchronization tasks, use the following request.
/api/v2/task?type=DSS

user
Use this resource to request the details of an Informatica Cloud user account or the details of all user
accounts in the organization. If you have administrator privileges, you can also use this resource to create or
update a user account and to delete a user account. To ensure organization security, this resource does not
display or update the password for a user account.

GET Request
To request the details of all Informatica Cloud user accounts, use the following URI:
/api/v2/user

user 171
 To request the details of a particular Informatica Cloud user account, you can include the user account ID or
user name in the URI. Use one of the following URIs:
/api/v2/user/<id>
/api/v2/user/name/<name>
If you use the user name in the URI and the user name includes a space, replace the space with %20. For
example:
/api/v2/user/name/Fred%20Smith

GET Response
When you request the details for a user account, Informatica Cloud returns the user object for the requested
user account. When you request the details of all user accounts, Informatica Cloud returns the user object for
each user account in the organization.

The user object includes the following attributes:

id

User ID.

orgId

ID of the organization the user belongs to.

name

Informatica Cloud user name.

description

Description of the user.

createTime

When the user account was created.

updateTime

When the user account was last updated.

createdBy

Informatica Cloud user who created the user account.

updatedBy

Informatica Cloud user who last updated the user account.

sfUsername

Salesforce user name.

password

Password. If using sfUsername, this is the Salesforce password.

firstName

First name for the user account.

lastName

Last name for the user account.

title

Title of the user.

172 Chapter 2: Informatica Cloud REST API Resources

phone

Phone number for the user.

securityQuestion

Security question. Returns one of the following codes:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME
• CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"

securityAnswer

Answer to the security question.

roles

Roles assigned to the user. The following attributes are included in a role object for each role:
name
Role name. Returns one of the following codes:

• SERVICE_CONSUMER
• DESIGNER
• ADMIN

description

Description.

usergroups

User group assigned to the user. The following attributes are included in a usergroup object for each
user group:
id
User group ID.

orgId

Organization ID.

name

User group name.

description

Description.

createTime

Time the user group was created.

updateTime

Last time the user group was updated.

user 173
 createdBy

User who created the user group.

updatedBy

User who last updated the user group.

aclEntry

Permissions assigned to the user group. Includes permissions attributes in an aclEntry object for
each object type. For more information about the aclEntry object, see the “usergroup” on page 177
resource.

emails

Email address to be notified when the user changes the account password.

If you pass multiple email addresses in this field, Informatica Cloud uses the first email address in the
list.

timezone

Time zone of the user. Time zone honors Daylight Saving Time.

For more information, see Appendix A , “Time Zone Codes” on page 193.

serverUrl

Informatica Cloud URL for the organization the user belongs to. Use the serverUrl as a base for most
REST API resource URIs.

spiUrl

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

Unique identifier for the user.

icSessionId

Informatica Cloud REST API session ID. Use in most REST API request headers.

forceChangePassword

Determines if the user must reset the password after the user logs in for the first time. Includes the
following values:

• True. The user must reset the password.

• False. The user is not forced to reset the password.

POST Request
You must be logged in as an administrator in order to create users or update user details. To update the
details of an existing user account, use the user account ID in the following URI. To create a new Informatica
Cloud user account, omit the optional user account ID.
/api/v2/user/<id>
With this URI, you can use the following attributes in a user object:

name

Required unless the user is a SAML single sign-on user.

Informatica Cloud user name.

174 Chapter 2: Informatica Cloud REST API Resources

sfUsername

Optional.

Salesforce user name.

password

Password. If using sfUsername, this is the Salesforce password. Not required for a SAML single sign-on
user.

firstName

Required.

First name for the user account.

lastName

Required.

Last name for the user account.

title

Required.

Title of the user.

phone

Required.

Phone number for the user.

emails

Optional.

Email address to be notified when the user changes the account password. If you pass multiple email
addresses in this field, Informatica Cloud uses the first email address in the list.

description

Optional.

Description of the user.

timezone

Optional.

Time zone of the user. Time zone honors Daylight Saving Time. Use the appropriate time zone code.

If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default.

For more information, see Appendix A , “Time Zone Codes” on page 193

securityQuestion

Optional.

Security question. Use one of the following codes to select the security question:

• SPOUSE_MEETING_CITY
• FIRST_JOB_CITY
• CHILDHOOD_FRIEND
• MOTHER_MAIDEN_NAME
• PET_NAME

user 175
 • CHILDHOOD_NICKNAME
• CUSTOM_QUESTION:"<question>"
securityAnswer

Optional.

Answer to the security question.

roles

Required.

Role for the user. Use one of the following codes:

• SERVICE_CONSUMER
• DESIGNER
• ADMIN

usergroups

Optional.

User group for the user.

forceChangePassword

Determines if the user must reset the password after the user logs in for the first time. Includes the
following values:

• True. The user must reset the password.

• False. The user is not forced to reset the password.

POST Response
Returns the user response object for the requested user account. Or, if you requested information for all user
accounts, returns the user response object for each user account in the organization.

Returns an error object if errors occur.

DELETE Request
To delete a user, use the user account ID in the following URI.
/api/v2/user/<id>

DELETE Response
Returns the 200 response code if the request is successful.

Returns an error object if errors occur.

POST Example
To create a new user, you might use the following request:
POST <serverUrl>/api/v2/user/ HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<user>
<name>[email protected]</name>
<firstName>User</firstName>
<lastName>Name</lastName>
<title>developer</title>
<timeZone>America/Chicago</timeZone>
</user>

176 Chapter 2: Informatica Cloud REST API Resources

usergroup
Use this resource to request the details of a user group or the details of all user groups in the organization.

GET Resource
To request the details of all user groups in the organization, use the following URI:
/api/v2/usergroup
To request the details of a particular user group, include the user group ID or the user group name in the URI.
Use one of the following URIs:
/api/v2/usergroup/<id>
/api/v2/usergroup/name/<name>
If you use the user group name in the URI and the user group name includes a space, replace the space with
%20. For example:
/api/v2/usergroup/name/my%20user%20group

GET Response
Returns the usergroup object for the requested user group. When you request information for all user groups
in the organization, returns a usergroup object for each user group in the organization.

Returns the error object if errors occur.

The usergroup object includes the following attributes:

id

User group ID.

orgId

Organization ID.

name

User group name.

description

Description.

createTime

Time the user group was created.

updateTime

Time the user group was last updated.

createdBy

User who created the user group.

updatedBy

User who last updated the user group.

aclEntry

Permissions assigned to the user group. Each aclEntry (Access Control List) represents the permissions
associated with a given object type. Includes the following attributes in an aclEntry object for each
object type:

usergroup 177
 adminPermission

Allows you to configure permissions for individual objects of the selected type.

createPermission

Allows you to create objects. Also allows you to download and install the Secure Agent.

deletePermission

Allows you to delete objects.

executePermission

Allows you to run tasks and task flows. Allows you to restart tasks from the activity log. Allows you
to monitor jobs and stop jobs in the activity monitor.

Also allows you to add tasks to a task flow if you have update permission on the task flow.

objectType

Permissions object. Returns one of the following codes:

• Agent. Secure Agent.

• Connection.
• Schedule.
• CustomFunc. Mapplet
• CustomSource. Saved query.
• WORKFLOW. Task flow.
• DSS. Data synchronization task.
• DRS. Data replication task.
• DQA. Data assessment task.
• PCS. PowerCenter task.
• DNB_TASK. D&B360 task.
• AVS. Contact validation task.
• MTT. Mapping configuration task.
• TEMPLATE. Integration template.
• DMASK. Data masking task.
• BUNDLE. Bundle.
• DTEMPLATE. Mapping.
• SERVICE_PROCESS. Service and process.
• RETIREMENT. Application retirement.
• AgentGroup. Runtime environment.
• BSERVICE. Business service definition.
• FWCONFIG. Fixed width file format.
• StructureDiscovery. Intelligent Structure Discovery.

readPermission

Allows you to view objects and view the details about each object. Also allows you to use a
connection or schedule in a task.

178 Chapter 2: Informatica Cloud REST API Resources

 updatePermission

Allows you to edit objects.

id

User group ID.

orgId

Organization ID.

userId

User ID.

objectId

ID of the permissions object.

objectDeleted

Whether the object was deleted. Returns one of the following values:

• True
• False

addedByAppId

GET Example
To request the details for all user groups in the organization, use the following URI:
/api/v2/usergroup

workflow
Use this resource to request the details of task flow or the details of all task flows in the organization. You
can also create or update a task flow, and you can delete a task flow.

GET Request
To request the details of a particular task flow, include the task flow ID or task flow name in the URI. Use one
of the following URIs:
/api/v2/workflow/<id>
/api/v2/workflow/name/<name>
If you use the task flow name in the URI and the task flow name includes a space, replace the space with %20.
For example:
/api/v2/workflow/name/my%20workflow
To request the details of all task flows in the organization, use the following URI:
/api/v2/workflow
Optionally, you can receive the response in simple mode which significantly improves performance. When
you enable simple mode, the response does not include the ScheduleId attribute and the email attributes. To
receive the response in simple mode, include simpleMode=true in the request. Use the following URI to
receive details of all task flows using simple mode:
/api/v2/workflow/?simpleMode=true

workflow 179
 GET Response
If successful, returns the workflow object for the requested task flow. Or, if you request the details for all task
flows in the organization, returns a workflow object for each task flow in the organization.

Returns an error object if errors occurred.

The workflow object includes the following attributes:

id

Task flow ID.

orgId

Organization ID.

name

Task flow name.

description

Description.

createTime

Time the task flow was created.

updateTime

Last time the task flow was updated.

createdBy

User who created the task flow.

updatedBy

User who last updated the task flow.

errorTaskEmail

Attribute that includes the following attributes in the taskEmail object:

id

ID.

emails

Email addresses to receive notification if the task flow fails to complete.

successTaskEmail

Attribute that includes the following attributes in the taskEmail object.

id

ID.

emails

Email addresses to receive notification if the task flow completes successfully.

warningTaskEmail

Attribute that includes the following attributes in the taskEmail object:

id

ID.

180 Chapter 2: Informatica Cloud REST API Resources

 emails

Email addresses to receive notification if the task flow completes with errors.

agentId

Agent that runs the tasks.

runtimeEnvironmentId

Runtime environment where the tasks run.

scheduleId

Schedule associated with the task flow, if any.

preProcessingCmd

Command to run before the task.

postProcessngCmd

Command to run after the task.

tasks

Attribute that defines each task associated with the workflow.

Includes the following information for each task in a workflowTask object:

taskId

Task ID.

type

Workflow task type. Returns one of the following codes:

• AVS. Contact validation task.

• DMASK. Data masking task.
• DQA. Data assessment task.
• DRS. Data replication task.
• DSS. Data synchronization task.
• MTT. Mapping configuration task.
• PCS. PowerCenter task.

name

Task name.

stopOnError

Stops the task flow if a task fails to complete.

stopOnWarning

Stops the task flow if a task completes with warnings.

POST Request
To update a task flow, use the following URI:
/api/v2/workflow/<id>
To create a task flow, omit the optional task flow ID.

When you update a task flow, Informatica Cloud replaces the existing task flow with the update.

workflow 181
 You can submit a partial update using partial mode. If you want to update a field in the workflowTask object
using partial mode, you must include the taskId field. To submit a request using partial mode, use a JSON
request and include the following line in the header:
Update-Mode=PARTIAL
With this URI, you can use the following attributes in the workflow object:

errorTaskEmail

Optional.

Attribute that includes the following attributes in the taskEmail object:

emails

List of comma-separated email addresses that receive email notification when a task flow fails to
complete.
successTaskEmail

Optional.

Attribute that includes the following attributes in the taskEmail object:

emails

List of comma-separated email addresses that receive email notification when a task flow
completes successfully.

warningTaskEmail

Optional.

Attribute that includes the following attributes in the taskEmail object:

emails

List of comma-separated email addresses that receive email notification when a task flow
completes with errors.

name

Name of the task flow.

description

Optional.

Description of the task flow.

tasks

Attribute that defines the tasks used in the workflow.

Use a workflowTask object to define the following attributes for each task you want to use:

taskId

Task ID.

type

Task type. Use one of the following codes:

• AVS. Contact validation task.

• DQA. Data assessment task.
• DRS. Data replication task.

182 Chapter 2: Informatica Cloud REST API Resources

 • DSS. Data synchronization task.
• MTT. Mapping configuration task.
• PCS. PowerCenter task.

name

Task name.

stopOnError

Optional.

Stops the task flow if the task fails to complete. Use one of the following options:

• 1. True. Stop on error.

• 2. False. Do not stop on error.
stopOnWarning

Optional.

Stops the task flow if a task completes with warnings. Use one of the following options:

• 1. True. Stop on error.

• 2. False. Do not stop on error.
scheduleId

Optional.

Schedule for the task flow.

POST Response
If successful, returns the workflow response object for the task flow that you created or updated.

Returns the error object if errors occur.

DELETE Request
To delete a task flow, use the task flow ID in the following URI:
/api/v2/workflow/<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 existing task flow with an ID of 0000342J0000K, you might use the following request:
POST <serverUrl>/api/v2/workflow/0000342J0000K HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"@type": "workflow",
"name": "task flow",
"tasks":[{
"@type":"workflowTask",
"taskId":"0000100I00000000001G",
"type":"DSS",
"name":"DSS_DQ5",
"stopOnError":"false"

workflow 183
 },{
"@type":"workflowTask",
"taskId":"0000100Z0000000000B8",
"type":"MTT",
"name":"CIT_SimpleTemplate2",
"stopOnError":"false"
},{
"@type":"workflowTask",
"taskId":"0000100G000000000002",
"type":"DRS",
"name":"SF2File",
"stopOnError":"false"
}]
}
A successful request returns the workflow object that you updated.

184 Chapter 2: Informatica Cloud REST API Resources

Appendix A

REST API Codes and

Supplemental Information
This section includes values used for state, country, and time zone attributes. This section also includes
supplemental information such as connector data types and a mapping of connection REST API attributes to
user interface fields.

REST API Codes

REST API Codes Overview

The Informatica Cloud REST API uses codes to represent data such as country names. Use the codes to pass
information to the REST API and to interpret the data returned by the REST API.

The Informatica Cloud REST API uses codes for the following information:

• Country codes. Represent country names.

• State codes. Represent the names of the United States.
• Time zone codes. Represent time zones.

State Codes
The Informatica Cloud REST API uses the following codes to represent the names of the United States.

• AL. Alabama.
• AK. Alaska.
• AZ. Arizona.
• AR. Arkansas.
• CA. California.
• CO. Colorado.
• CT. Connecticut.
• DE. Delaware.
• FL. Florida.

185
 • GA. Georgia.
• HI. Hawaii.
• ID. Idaho.
• IL. Illinois.
• IN. Indiana.
• IA. Iowa.
• KS. Kansas.
• KY. Kentucky.
• LA. Louisiana.
• ME. Maine.
• MD. Maryland.
• MA. Massachusetts.
• MI. Michigan.
• MN. Minnesota.
• MS. Mississippi.
• MO. Missouri.
• MT. Montana.
• NE. Nebraska.
• NV. Nevada.
• NH. New Hampshire.
• NJ. New Jersey.
• NM. New Mexico.
• NY. New York.
• NC. North Carolina.
• ND. North Dakota.
• OH. Ohio.
• OK. Oklahoma.
• OR. Oregon.
• PA. Pennsylvania.
• RI. Rhode Island.
• SC. South Carolina.
• SD. South Dakota.
• TN. Tennessee.
• TX. Texas.
• UT. Utah.
• VT. Vermont.
• VA. Virginia.
• WA. Washington.
• WV. West Virginia.

186 Appendix A: REST API Codes and Supplemental Information

 • WI. Wisconsin.
• WY. Wyoming.

Country Codes
The Informatica Cloud REST API uses the following codes to represent country names.

• AF. Afghanistan.
• AX. Aland Islands.
• AL. Albania.
• DZ. Algeria.
• AS. American Samoa.
• AD. Andorra.
• AO. Angola.
• AI. Anguilla.
• AQ. Antarctica.
• AG. Antigua and Barbuda.
• AR. Argentina.
• AM. Armenia.
• AW. Aruba.
• AU. Australia.
• AT. Austria.
• AZ. Azerbaijan.
• BS. Bahamas.
• BH. Bahrain.
• BD. Bangladesh.
• BB. Barbados.
• BY. Belarus.
• BZ. Belize.
• BE. Belgium.
• BJ. Benin.
• BM. Bermuda.
• BT. Bhutan.
• BO. Bolivia.
• BA. Bosnia and Herzegovina.
• BW. Botswana.
• BV. Bouvet Island.
• BR. Brazil.
• IO. British Indian Ocean Territory.
• BN. Brunei Darussalam.
• BG. Bulgaria.

REST API Codes 187

 • BF. Burkina Faso.
• BI. Burundi.
• KH. Cambodia.
• CM. Cameroon.
• CA. Canada.
• CV. Cape Verde.
• KY. Cayman Islands.
• CF. Central African Republic.
• TD. Chad.
• CL. Chile.
• CN. China.
• CX. Christmas Island.
• CC. Cocos (Keeling) Islands.
• CO. Colombia.
• KM. Comoros.
• CG. Congo.
• CD. Congo, the Democratic Republic of the.
• CK. Cook Islands.
• CR. Costa Rica.
• CI. Cote d'Ivoire.
• HR. Croatia.
• CU. Cuba.
• CY. Cyprus.
• CZ. Czech Republic.
• DK. Denmark.
• DM. Dominica.
• DO. Dominican Republic.
• DJ. Djibouti.
• EC. Ecuador.
• EG. Egypt.
• SV. El Salvador.
• GQ. Equatorial Guinea.
• ER. Eritrea.
• EE. Estonia.
• ET. Ethiopia.
• FK. Falkland Islands (Malvinas).
• FO. Faroe Islands.
• FJ. Fiji.
• FI. Finland.

188 Appendix A: REST API Codes and Supplemental Information

• FR. France.
• GF. French Guiana.
• PF. French Polynesia.
• TF. French Southern Territories.
• GA. Gabon.
• GM. Gambia.
• GE. Georgia.
• DE. Germany.
• GH. Ghana.
• GI. Gibraltar.
• GR. Greece.
• GL. Greenland.
• GD. Grenada.
• GP. Guadeloupe.
• GU. Guam.
• GT. Guatemala.
• GG. Guernsey.
• GN. Guinea.
• GW. Guinea-Bissau.
• GY. Guyana.
• HT. Haiti.
• HM. Heard Island and McDonald Islands.
• HN. Honduras.
• HK. Hong Kong.
• HU. Hungary.
• IS. Iceland.
• IN. India.
• ID. Indonesia.
• IR. Iran, Islamic Republic of.
• IQ. Iraq.
• IE. Ireland.
• IL. Israel.
• IM. Isle of Man.
• IT. Italy.
• JM. Jamaica.
• JP. Japan.
• JE. Jersey.
• JO. Jordan.
• KZ. Kazakhstan.

REST API Codes 189

 • KE. Kenya.
• KI. Kiribati.
• KP. Korea, Democratic People's Republic of.
• KR. Korea, Republic of.
• KW. Kuwait.
• KG. Kyrgyzstan.
• LA. Lao People's Democratic Republic.
• LV. Latvia.
• LB. Lebanon.
• LS. Lesotho.
• LR. Liberia.
• LY. Libyan Arab Jamahiriya.
• LI. Liechtenstein.
• LT. Lithuania.
• LU. Luxembourg.
• MO. Macao.
• MK. Macedonia, the former Yugoslav Republic of.
• MG. Madagascar.
• MW. Malawi.
• MY. Malaysia.
• MV. Maldives.
• ML. Mali.
• MT. Malta.
• MH. Marshall Islands.
• MR. Mauritania.
• MU. Mauritius.
• MQ. Martinique.
• YT. Mayotte.
• MX. Mexico.
• FM. Micronesia, Federated States of.
• MD. Moldova, Republic of.
• MC. Monaco.
• MN. Mongolia.
• ME. Montenegro.
• MS. Montserrat.
• MA. Morocco.
• MZ. Mozambique.
• MM. Myanmar.
• NA. Namibia.

190 Appendix A: REST API Codes and Supplemental Information

• NR. Nauru.
• NP. Nepal.
• NL. Netherlands.
• NC. New Caledonia.
• NZ. New Zealand.
• NI. Nicaragua.
• NE. Niger.
• NG. Nigeria.
• NU. Niue.
• NF. Norfolk Island.
• MP. Northern Mariana Islands.
• OM. Oman.
• PK. Pakistan.
• PW. Palau.
• PS. Palestinian Territory, Occupied.
• PA. Panama.
• PG. Papua New Guinea.
• PY. Paraguay.
• PE. Peru.
• PH. Philippines.
• PN. Pitcairn.
• PL. Poland.
• PT. Portugal.
• PR. Puerto Rico.
• QA. Qatar.
• RE. Reunion.
• RO. Romania.
• RU. Russian Federation.
• RW. Rwanda.
• BL. Saint Barthelemy.
• SH. Saint Helena.
• KN. Saint Kitts and Nevis.
• LC. Saint Lucia.
• MF. Saint Martin (French part).
• PM. Saint Pierre and Miquelon.
• VC. Saint Vincent and the Grenadines.
• WS. Samoa.
• SM. San Marino.
• ST. Sao Tome and Principe.

REST API Codes 191

 • SA. Saudi Arabia.
• SN. Senegal.
• RS. Serbia.
• SC. Seychelles.
• SL. Sierra Leone.
• SG. Singapore.
• SK. Slovakia.
• SI. Slovenia.
• SB. Solomon Islands.
• SO. Somalia.
• ZA. South Africa.
• GS. South Georgia and the South Sandwich Islands.
• ES. Spain.
• LK. Sri Lanka.
• SD. Sudan.
• SR. Suriname.
• SJ. Svalbard and Jan Mayen.
• SZ. Swaziland.
• SY. Syrian Arab Republic.
• SE. Sweden.
• CH. Switzerland.
• TW. Taiwan.
• TJ. Tajikistan.
• TZ. Tanzania, United Republic of.
• TH. Thailand.
• TL. Timor-Leste.
• TG. Togo.
• TK. Tokelau.
• TO. Tonga.
• TT. Trinidad and Tobago.
• TN. Tunisia.
• TR. Turkey.
• TC. Turks and Caicos Islands.
• TM. Turkmenistan.
• TV. Tuvalu.
• UG. Uganda.
• UA. Ukraine.
• AE. United Arab Emirates.
• GB. United Kingdom.

192 Appendix A: REST API Codes and Supplemental Information

 • US. United States.
• UM. United States Minor Outlying Islands.
• UY. Uruguay.
• UZ. Uzbekistan.
• VU. Vanuatu.
• VA. Holy See (Vatican City State).
• VE. Venezuela.
• VN. Viet Nam.
• VG. Virgin Islands, British.
• VI. Virgin Islands, U.S.
• WF. Wallis and Futuna.
• EH. Western Sahara.
• YE. Yemen.
• ZM. Zambia.
• ZW. Zimbabwe.

Time Zone Codes

The Informatica Cloud REST API uses the following time zone codes:

• Pacific/Apia
• Pacific/Tahiti
• HST
• Pacific/Gambier
• AST
• America/Vancouver
• America/Tijuana
• America/Los_Angeles
• America/Phoenix
• America/Dawson_Creek
• America/Denver
• America/El_Salvador
• America/Costa_Rica
• America/Mexico_City
• America/Chicago
• America/Jamaica
• America/Panama
• America/Montreal
• America/Havana
• America/New_York
• America/Barbados

REST API Codes 193

 • America/Bogota
• America/Caracas
• America/Dominica
• America/Guadeloupe
• America/La_Paz
• America/Puerto_Rico
• Brazil/Acre
• Brazil/DeNoronha
• Brazil/East
• Brazil/West
• America/Halifax
• CNT
• America/Buenos_Aires
• Atlantic/South_Georgia
• Atlantic/Cape_Verde
• Africa/Casablanca
• GMT
• Europe/London
• Europe/Vienna
• Europe/Brussels
• Europe/Zurich
• Europe/Prague
• Europe/Berlin
• Europe/Copenhagen
• Europe/Madrid
• Europe/Budapest
• Europe/Rome
• Europe/Luxembourg
• Europe/Amsterdam
• Europe/Warsaw
• Europe/Stockholm
• Europe/Belgrade
• Europe/Paris
• Africa/Johannesburg
• Africa/Cairo
• Europe/Athens
• Asia/Jerusalem
• Europe/Bucharest
• Europe/Istanbul

194 Appendix A: REST API Codes and Supplemental Information

• Asia/Bahrain
• Africa/Nairobi
• Asia/Kuwait
• Asia/Qatar
• Asia/Riyadh
• Asia/Baghdad
• Europe/Moscow
• Asia/Dubai
• Indian/Mauritius
• Asia/Muscat
• Asia/Karachi
• IST
• Asia/Katmandu
• BST
• Asia/Rangoon
• VST
• Australia/Perth
• Asia/Hong_Kong
• Asia/Kuala_Lumpur
• Asia/Singapore
• CTT
• Asia/Seoul
• JST
• ACT
• AET
• Australia/Lord_Howe
• Asia/Magadan
• Pacific/Auckland
• Pacific/Norfolk
• Pacific/Fiji
• Pacific/Chatham
• Pacific/Enderbury
• Pacific/Kiritimati

REST API Codes 195

Connector Data Types
When you submit a request for connector metadata, data type is included in the response. Data types for
connector attributes are returned in REST API responses using a numeric value.

The following example shows a response with the type value of 2:

{
"name": "database",
"label": "",
"id": "",
"value": "",
"type": 2,
"isMandatory": true,
"visible": false,
"list": []
},
The type value of 2 means the database attribute can only contain alphabetic characters.

The following table lists the numeric values that might be included in the response and the corresponding
data type:

Value Data Type Description

1 NUMERIC_TYPE Attribute value can only contain numbers.

2 ALPHABET_TYPE Attribute value can only contain alphabetic characters.

3 NUMERIC_TYPE/ Attribute value can only contain numbers or alphabetic characters.

ALPHABET_TYPE

4 SYMBOLS_TYPE Attribute value can only contain symbols.

5 NUMERIC_TYPE/ Attribute value can only contain numbers and symbols.

SYMBOLS_TYPE

6 ALPHABET_TYPE/ Attribute value can only contain alphabetic characters and symbols.
SYMBOLS_TYPE

7 NUMERIC_TYPE/ Attribute value can only contain alphabetic characters, numbers, and symbols.
ALPHABET_TYPE/
SYMBOLS_TYPE

8 LIST_TYPE Attribute value can only contain values from a predefined list.

9 NUMERIC_TYPE/ Attribute value can only contain values from a predefined list and the value
LIST_TYPE contains only numbers.

10 ALPHABET_TYPE/ Attribute value can only contain values from a predefined list and the value
LIST_TYPE contains only numbers.

11 NUMERIC_TYPE/ Attribute value can only contain values from a predefined list and the value
ALPHABET_TYPE/ contains only alphabetic characters and numbers.
LIST_TYPE

12 SYMBOLS_TYPE/ Attribute value can only contain values from a predefined list and the value
LIST_TYPE contains only symbols.

196 Appendix A: REST API Codes and Supplemental Information

 Value Data Type Description

13 NUMERIC_TYPE/ Attribute value can only contain values from a predefined list and the value
SYMBOLS_TYPE/ contains only numbers and symbols.
LIST_TYPE

14 ALPHABET_TYPE/ Attribute value can only contain values from a predefined list and the value
SYMBOLS_TYPE/ contains only alphabetic characters and symbols.
LIST_TYPE

15 NUMERIC_TYPE/ Attribute value can only contain values from a predefined list and the value
ALPHABET_TYPE/ contains only alphabetic characters, numbers, and symbols.
SYMBOLS_TYPE/
LIST_TYPE

16 BOOLEAN Attribute value is a boolean.

32 PASSWORD Attribute value is a password.

For more information about requesting connector metadata, see “connector” on page 74.

Connection User Interface Fields to REST API

Attributes Mapping
Some connection field names in the user interface do not intuitively map to corresponding REST API attribute
names in the connection resource. Additionally, some attribute names used for REST API GET and POST
methods for the connection resource do not match the attribute names used in the REST API response that
populates the values shown in the user interface.

The following tables map user interface fields with attributes used for REST API GET and POST calls and the
REST API response to the user interface, where the correlation between these fields might be confusing.

Connection UI Field Name REST API GET and POST Response to UI

Attribute Name Attribute Name

All connections Runtime Environment runtimeEnvironmentId agentGroupId

CSV Flat File Directory database dirName

FTP and SFTP Directory database dirName

Microsoft Access Data Source Name database database

Microsoft SQL Server SQL Server Version type subType

Oracle Service Name database database

SAP IDoc Reader Destination Entry database database

Connection User Interface Fields to REST API Attributes Mapping 197

 Connection UI Field Name REST API GET and POST Response to UI
Attribute Name Attribute Name

SAP IDoc Writer and SAP RFC/ Connection String database database
BAPI

Web Service Consumer Endpoint URL serviceUrl serviceUrl

198 Appendix A: REST API Codes and Supplemental Information

Index

A error object
REST API 18
activityLog expressionValidation
REST API resource 32 REST API resource 84
activityMonitor
REST API resource 40
agent
REST API resource 43
F
API field
See REST API 8 REST API resource 85
auditlog fileRecord
REST API resource 48 REST API resource 88
fwConfig
REST API resource 91

B
body configuration
REST API 12
G
bundleObject guidelines
REST API resource 51 REST API 21
bundleObjectLicense
REST API resource 53
H
C header configuration
REST API 11
Cloud Application Integration community
URL 6
Cloud Developer community
URL 6
I
connection Informatica Cloud Community
REST API resource 55 URL 6
connection attributes and user interface fields 197 Informatica Cloud web site
connections URL 6
available connectors for an organization 74 Informatica Global Customer Support
connector 74 contact information 7
connector type data types 196
connectors
available for an organization 55
customFunc
J
REST API resource 75 job
REST API resource 95

D L
dataPreview
REST API resource 81 licenseInfo
date/time format REST API resource 98
REST API 16 login
REST API resource 100
loginSaml

E REST API resource 105

logout
error logs 32 REST API resource 104
error messages logoutall
REST API 19 REST API resource 104

199
M REST API (continued)
masterTemplate resource for working with integration templates
maintenance outages 7 112
mapping mttask resource to work with mapping configuration tasks 122
REST API resource 108 org resource 140
masterTemplate overview 8
REST API resource 112 register resource 151
mttask resource quick reference 21
REST API resource 122 responses 18
retrieving and using object IDs 17
return lists 13

O serverTime resource 170

session status 17
object configuration state codes 185, 187
REST API, in XML and JSON 12 task resource to view task details 170
object IDs time zone codes 193
retrieving for the REST API 17 user resource 171
org usergroup resource to view user group details 177
REST API resource 140 workflow resource to work with task flows 179
XML example 14
XML schema definition (XSD) 11

P return list configuration

REST API in XML and JSON 13
partial updates 15

S
Q schedule
quick reference REST API resource 161
REST API resources 21 serverTime
REST API resource 170
session IDs 17

R session logs 32
state codes
register REST API 185, 187
REST API resource 151 status
responses Informatica cloud services 7
REST API 18 sub-organization licenses 98
REST API system status 7
activityLog resource 32
activityMonitor resource 40
agent resource 43
auditlog resource to view audit entries 48
T
body configuration 12 task
bundleObject resource to view bundle details 51 REST API resource 170
bundleObjectLicense resource 53 time zone codes
codes 185 REST API 193
connection resource 55 trust site
customFunc resource to work with mapplets 75 description 7
dataPreview resource 81 @type
date/time values 16 use with JSON (REST API) 12
documentation conventions 21
error messages 19
error object 18
expressionValidation 84
U
field resource 85 update modes 15
fileRecord resource 88 upgrades 7
fwConfig 91 user
guidelines 21 REST API resource 171
header configuration 11 usergroup
job resource 95 REST API resource 177
JSON example 13
licenseInfo resource 98
login resource 100
loginSaml 105
W
logout resource to end a REST API session 104 workflow
logoutall resource to end all REST API sessions 104 REST API resource 179
mapping resource for working with mappings 108

200 Index
X
XML schema definition (XSD)
REST API 11

Index 201