Informatica® Intelligent Cloud Services

Spring 2018 April

REST API Reference

Informatica Intelligent Cloud Services REST API Reference
Spring 2018 April
July 2018
© Copyright Informatica LLC 2016, 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, Informatica Intelligent Cloud Services, 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-07-24

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

Chapter 1: Informatica Intelligent Cloud Services REST API Overview. . . . . . . . . 8

REST API Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
XML Schema Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Header and Body Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Request Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Request Body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Return Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
JSON Format Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
XML Format Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Update Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Date/Time Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Object IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Session IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
REST API Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Success Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Error Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Rest API Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Resource Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 2: REST API Version 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

activityLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
activityMonitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
auditlog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
bundleObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
bundleObjectLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
CSV Flat File Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Table of Contents 3
 FTP and SFTP Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Microsoft Access Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Microsoft Dynamics CRM Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Microsoft SQL Server Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
MySQL Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
NetSuite Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
ODBC Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Oracle Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Oracle CRM On Demand Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Salesforce Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
SAP IDoc Reader Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SAP IDoc Writer Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Web Service Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
connector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
customFunc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
dataPreview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
expressionValidation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
fileRecord. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
fwConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
loginSaml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
logoutall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
masterTemplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
mttask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Mask Rule Parameter Attributes for Masking Techniques. . . . . . . . . . . . . . . . . . . . . . . . 124
Mask Rule Parameter Attribute Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
org. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
permission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
runtimeEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
serverTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
usergroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Chapter 3: REST API Version 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Export and Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

4 Table of Contents
 export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
license. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
lookup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

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

REST API Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
REST API Codes Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
State Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Country Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Time Zone Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Connector Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Connection User Interface Fields to REST API Attributes Mapping. . . . . . . . . . . . . . . . . . . . . . 201

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Table of Contents 5
Preface
Informatica Intelligent Cloud Services REST API Reference explains how developers can use the Informatica
Intelligent Cloud Services REST API to interact with their Informatica Intelligent Cloud Services organization.

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 Intelligent Cloud Services Web Site

You can access the Informatica Intelligent Cloud Services web site at http://www.informatica.com/cloud.
This site contains information about Data Integration editions and applications as well as information about
other Informatica Cloud integration services.

Informatica Intelligent Cloud Services Communities

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

Access the Informatica Intelligent Cloud Services Community at:

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

To find resources on using 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:

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

6
Informatica Intelligent Cloud Services Marketplace
Visit the Informatica Marketplace to try and buy Data Integration Connectors, templates, and mapplets:

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

Data Integration Connector Documentation

You can access documentation for Data Integration 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 Intelligent Cloud Services 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 Intelligent Cloud Services. 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 Intelligent Cloud

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

This guide includes information about REST resources that you can use for Data Integration and for the
Administrator and Monitor core services.

To use the Informatica Intelligent Cloud Services REST API, you need a valid Informatica Intelligent Cloud
Services 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 objects. Informatica Intelligent Cloud Services returns the requested information, performs the
requested task, or returns an error and related messages.

REST API Versions

Informatica Intelligent Cloud Services supports REST API version 2 resources and REST API version 3
resources.

Note the following differences between REST API version 2 and version 3 calls:

Format

You can use the following formats depending upon which API version you are using:

• REST API version 2 supports XML and JSON calls.

• REST API version 3 supports JSON calls.

Login URL

Use one of the following login URLs depending upon which API version you want to use:

• For version 2, use https://dm-us.informaticacloud.com/ma/api/v2/user/login.

• For version 3, use https://dm-us.informaticacloud.com/saas/public/core/v3/login.

8
 Base URL

The login response includes the base URL that you must include in subsequent calls. The name of the
base URL attribute and the URL that you use after login depends upon the API version that you use, as
shown in the following examples:

• For version 2, use <serverUrl>/api/v2/<API name>.

• For version 3, use <baseApiUrl>/public/core/v3/<API name>.

Session ID

The name of the attribute for session ID depends upon the API version that you use. Use the following
attributes:

• Use icSessionId in the header for version 2 calls.

• Use INFA-SESSION-ID in the header for version 3 calls.

Session IDs cannot be used interchangeably across V2 and V3 APIs. For example, if you log in using the
version 2 login resource, you cannot use the session ID that was returned in a login response to the
version 3 login request.

XML Schema Definition

You can access the XML schema definition (XSD) for the Informatica Intelligent Cloud Services REST API at
the following URL:
https://na1.dm-us.informaticacloud.com/saas/xsd/ics_api_v2.xsd
To use the XSD URL, log into Informatica Intelligent Cloud Services, then enter the XSD URL.

Header and Body Configuration

Configure the request header and request body as required, taking into consideration the format of the call
and the resource version that you use.

Request Header
The request header is slightly different for version 2 and version 3 resources.

When you construct a REST API request header, use the following format for version 2:
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/<json | xml>
Accept: application/<json | xml>
icSessionId: <SessionId>
When you construct a REST API request header, use the following format for version 3:
<METHOD> <baseApiUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

XML Schema Definition 9

 The following list describes the attributes of the above formats:

Attribute Required Description

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

serverUrl Required for most Base URL for all version 2 resources except login and register.
v2 resources Use a placeholder for serverUrl, and replace the placeholder with the
Informatica Intelligent Cloud Services URL returned by the login resource.
For the login and register resources, use the URL listed in the resource.

baseApiUrl Required for most Base URL for all version 3 resources except login.
v3 resources Use a placeholder for baseApiUrl, and replace the placeholder with the
Informatica Intelligent Cloud Services URL returned by the login resource.
For the login resource, use the URL listed in the resource.

URI Required for most Resource URI.

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

HTTP version Yes HTTP version that you are using.

Content-Type Required for Format of the request. Use one of the following options:
POST requests - application/json. Reads request as JSON.
- application/xml. Reads request as XML. Only applicable to version 2
resources.
Default is json.

Accept No Request format that you want to receive. Use one of the following options:
- application/json. Sends response as JSON.
- application/xml. Sends response as XML. Only applicable to version 2
resources.
Default is json.

icSessionId Required for most Informatica Intelligent Cloud Services session ID. Required for all version 2
v2 resources resources except login and register.
Use a placeholder for sessionId, and replace the placeholder with the session
ID returned by the login resource.

INFA- Required for most Informatica Intelligent Cloud Services session ID. Required for all version 3
SESSION-ID v3 resources resources except login.
Use a placeholder for sessionId, 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.

10 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 JSON Format
When you use the JSON format for version 2 REST API calls, define a request object with the @type attribute,
as shown in the following examples:
{
"@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>",
}
Note: Do not use the @type attribute for version 3 REST API calls.

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>

Header and Body Configuration 11

 In JSON, no additional attributes are used. The REST API encloses the list in square brackets ( [ ] ), as
follows:
[
{
"<attribute1>": "<value1>",
"<attribute2>": "<value2>",
}{
"<attribute1>": "<value1>",
"<attribute2>": "<value2>",
}
]

JSON Format Example

To log in using JSON, you might use the following request header and body:
POST https://dm-us.informaticacloud.com/saas/public/core/v3/login HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"username": "[email protected]",
"password": "mypassword"
}
The login might return the following information:
{
"products": [
{
"name": "Integration Cloud",
"baseApiUrl": "https://pod.clouddev.informaticacloud.com/saas"
}
],
"userInfo": {
"sessionId": "9KA11tLGqxVcGeul8SQBK3",
"id": "9L1GFroXSDHe2IIg7QhBaT",
"name": "user",
"parentOrgId": "52ZSTB0IDK6dXxaEQLUaQu",
"orgId": "0cuQSDTq5sikvN7x8r1xm1",
"orgName": "MyOrg_INFA",
"groups": {},
"status": "Active"
}
}
You can then use the sessionId and the baseapiUrl to construct a request to obtain your organization's
license information, for example:
GET https://pod.clouddev.informaticacloud.com/saas/public/core/v3/license/org/{orgId}
HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: IV4wOrJmd6YUtmKa8t

XML Format Example

To log in using XML, you might use the following header and body:
POST https://dm-us.informaticacloud.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>

12 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

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

Update Modes 13
 • 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.

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 Intelligent Cloud Services 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 Intelligent Cloud Services.
<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.

14 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 T

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.

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 linear taskflow ID. To find the object ID that
you need, you can use the related GET request.

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

Object IDs are not readily available through the Data Integration user interface.

Session IDs
When you log in to a Informatica Intelligent Cloud Services organization using the REST API, the login
resource returns the REST API session ID. You include this session ID in most subsequent REST API requests
during the session. The session ID is valid for 30 minutes.

Session IDs cannot be used interchangeable across version 2 and version 3 APIs. In other words, you can use
the session ID returned by the version 2 login resource for version 2 API calls only.

To make a call that uses a REST API version 2 resource, use the icSessionId attribute to include the session
ID in the header. To make a call that uses a REST API version 3 resource, use the INFA-SESSION-ID attribute
to include the session ID in the header.

The following example shows how icSessionId is used in the header for a REST API version 2 call::
GET https://app.informaticacloud.com/saas/api/v2/licenseInfo/org/<id>
HTTP/1.0
Content-Type: application/xml

Object IDs 15
 Accept: application/xml
icSessionId: IV4wOrJmd6YUtmKa8t
The following example shows how INFA-SESSION-ID is used in the header for a REST API version 3 call:
GET https://app.informaticacloud.com/saas/public/core/v3/license/org/{orgId}
HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3
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:

• userName. Your Informatica Intelligent Cloud Services user name.

• icToken. The session ID.

For example, you might use the following request:

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

{
"@type": "validatedToken",
"userName": "[email protected]",
"icToken": "9KA11tLGqxVcGeul8SQBK3"
}
The response returns whether the session ID is valid or not and the number of minutes left before the session
ID expires. For example, you might receive the following response:
{
"@type": "validatedToken",
"timeUntilExpire": 29,
"isValidToken": true
}

16 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

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"/>

REST API Responses 17

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

Rest API Guidelines

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

• Use the login resource to start a 30 minute 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 Intelligent Cloud Services session included in the
request header.
• 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 Intelligent Cloud Services uses JSON by
default.
• For all resources except login and register, use a placeholder for the session ID in request headers.
Replace the placeholder with the session ID data returned when you log in to a session.
The login and register resources do not require icSessionId or INFA-SESSION-ID in the request header.
• For all resources except login, use a placeholder for the base URL. For version 2 resources, replace the
placeholder with the serverUrl data. For version 3 resources, replace the placeholder with baseApiUrl data.
• 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 that use version 2 resources, use the @type attribute to define an object. For
requests in JSON that use version 3 resources, do not use the @type attribute. 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 Intelligent Cloud Services 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.

18 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

Resource Quick Reference
The following list contains the syntax and a brief description of the Informatica Intelligent Cloud Services
REST API resources:

activityLog GET

Version 2 API.

Returns information from the activity log.

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

Resource Quick Reference 19

 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

Version 2 API.

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

Version 2 API.

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

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

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>

20 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 • 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

Version 2 API.

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

Version 2 API.

Deletes a connection.

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

Uploads a PowerCenter mapplet.

Resource Quick Reference 21

 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

Version 2 API.

Deletes a mapplet.

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

Version 2 API.

Use 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>
export POST

Version 3 API.

Starts an export job and returns an export job ID.

Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/export
export GET

Version 3 API.

Returns export status or the export package.

You can request the following information:

• To receive status of an export job, use the baseApiUrl from the login response as the base URL for
one of the following URIs:
/public/core/v3/export/<id>
/public/core/v3/export/<id>?expand=objects
• To receive a .zip stream of the export package, use the baseApiUrl from the login response as the
base URL for the following URI:
/public/core/v3/export/<id>/package
expressionValidation POST

Version 2 API.

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

Version 2 API.

Returns the field details for a source or target object.

22 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 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
Version 2 API.

Updates the flat file attributes 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>
The flat file attributes provided in the request override the default attributes specified in the connection
object.

fileRecord POST

Version 2 API.

Upload a Visio 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

Version 2 API.

Delete a Visio 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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

Delete a fixed-width format.

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

Resource Quick Reference 23

 import POST

Version 3 API.

Uploads an import package or starts an import job.

You can perform the following actions:

• To upload an import package, use the baseApiUrl from the login response as the base URL for the
following URI:
/public/core/v3/import/package
For Content-Type, use multipart/form-data.
• To specify details for an import job and start the job, use the baseApiUrl from the login response as
the base URL for the following URI:
/public/core/v3/import/<id>
import GET

Version 3 API.

Returns status of an import job.

Use the baseApiUrl from the login response as the base URL and include the import job ID in one of the
following URIs:
/public/core/v3/import/<id>
/public/core/v3/import/<id>?expand=objects
job POST

Version 2 API.

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

• To start a task or linear taskflow, use the serverUrl from the login response as the base URL for the
following URI:
/api/v2/job
• To stop a task or linear taskflow, 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.

license GET

Version 3 API.

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

Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/license/org/<id>
license PUT

Version 3 API.

Updates license information for a sub-organization.

Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/license/org/<id>
Use the orgLicenseAssignment object to update license information.

24 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

login POST

Version 3 API.

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

Use version 3 login when you plan to use version 3 resources.

Use the following URL:

https://dm-us.informaticacloud.com/saas/public/core/v3/login
Omit INFA-SESSION-ID from the request header.

Use a login object and include the following fields: username, password.
logout POST

Version 3 API.

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

Use the same URL used for the login POST except for the API name. Use the following URI:
https://dm-us.informaticacloud.com/saas/public/core/v3/logout
login POST

Version 2 API.

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

Use version 2 login when you plan to use version 2 resources.

Use the following URL:

https://dm-us.informaticacloud.com/ma/api/v2/user/login
Omit icSessionId from the request header.

Use a login object and include the following fields: username, password.

loginSAML POST

Version 2 API.

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://dm-us.informaticacloud.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

Version 2 API.
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

Version 2 API.

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

Use the following URL:

https://dm-us.informaticacloud.com/ma/api/v2/user/logoutall

Resource Quick Reference 25

 lookup POST

Version 3 API.

Looks up an object's ID, name, path, or type attributes.

Use the serverUrl from the login response as the base URL for the following URI:
/public/core/v3/lookup
Use a logout object to define attributes. Include the following required attributes: username, password.

Omit icSessionId from the request header.

mapping GET
Version 2 API.

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

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

Version 2 API.

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

• Visio templates. You can request the details of a Visio template or of all Visio 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 tasks. You can request a list of mapping tasks that use a Visio template. Use the serverUrl
from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>/tasks
masterTemplate POST

Version 2 API.

Creates or updates a Visio 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

Version 2 API.

Deletes a Visio template.

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

Version 2 API.

Returns the details of a mapping task.

26 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 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
Version 2 API.

Creates or updates a mapping 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

Version 2 API.
Deletes a mapping task.

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

Version 2 API.

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

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

Version 2 API.

Updates the details of an Informatica Intelligent Cloud Services 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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

Resource Quick Reference 27

 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

Version 2.

Creates an Informatica Intelligent Cloud Services sub-organization based on an Informatica Intelligent

Cloud Services user account. For Informatica Intelligent Cloud Services partners only.

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

runtimeEnvironment GET

Version 2 API.

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

Version 2 API.

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

Version 2 API.

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

Version 2 API.

Deletes a schedule.

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

Version 2 API.

28 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

 Returns the local time for the Informatica Intelligent Cloud Services server.

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

Version 2 API.

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

Version 2 API.

Returns the details of an Informatica Intelligent Cloud Services 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

Version 2 API.

Creates or updates an Informatica Intelligent Cloud Services 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

Version 2 API.

Deletes an Informatica Intelligent Cloud Services user account.

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

Version 2 API.

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

Version 2 API.

Returns the details of a linear taskflow or of all linear taskflows 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

Version 2 API.

Resource Quick Reference 29

 Creates or updates a linear taskflow.

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

Version 2 API.

Deletes a linear taskflow.

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

30 Chapter 1: Informatica Intelligent Cloud Services REST API Overview

Chapter 2

REST API Version 2

Use the following resources in addition to the version 3 resources.

When you use version 2 resources, note the following rules:

• Log in using the version 2 login resource.

• Use JSON or XML format.
• Use the following base URL.:
<serverUrl>/api/v2/<API name>
• Use the following request header format:
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
icSessionId: <SessionId>

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>

31
 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 attributes in the activityLog GET URI:

Field Description

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.

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:

Field Type Description

id String Activity log entry ID.

type String The type of task. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

objectId String Task ID.

objectName String Name of the task.

runId Long ID for the task run.

agentId String Agent that runs the task.

runtimeEnvironmentId String Runtime environment where the task runs.

startTime Date/time Start time for the task or linear taskflow. Uses Eastern Time Zone (ET).

endTime Date/time End time for the task or linear taskflow. Uses Eastern Time Zone (ET).

32 Chapter 2: REST API Version 2

 Field Type Description

startTimeUtc Date/time Start time for the task or linear taskflow. Uses Coordinated Universal Time
(UTC).

endTimeUtc Date/time End time for the task or linear taskflow. Uses Coordinated Universal Time
(UTC).

state String 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 Long Number of rows that were not read from the source.

successSourceRows Long Number of rows that are successfully read from the source.

failedTargetRows Long Number of rows that were not written to the target.

successTargetRows Long Number of rows that were successfully written to the target.

errorMsg String Error message associated with the job.

startedBy String User who started the task.

runContextType String Method through which the task was initiated. Includes the following values:
-UI. Task was initiated through the 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 String Schedule name, if task was initiated by a schedule.

entries Indicates the start of information for a child object.

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

Field Type Description

id String Activity log entry ID.

type String The type of task. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

objectId String Task ID.

objectName String Name of the task.

runId String ID for the task run.

activityLog 33
 Field Type Description

agentId String Agent that runs the task.

runtimeEnvironmentId String Runtime environment where the task runs.

startTime Date/time Start time for the task or linear taskflow. Uses Eastern Time Zone (ET).

endTime Date/time End time for the task or linear taskflow. Uses Eastern Time Zone (ET).

startTimeUtc Date/time Start time for the task or linear taskflow. Uses Coordinated Universal Time
(UTC).

endTimeUtc Date/time End time for the task or linear taskflow. Uses Coordinated Universal Time
(UTC).

state String 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 Long Number of rows that were not read from the source.

successSourceRows Long Number of rows that are successfully read from the source.

failedTargetRows Long Number of rows that were not written to the target.

successTargetRows Long Number of rows that were successfully written to the target.

errorMsg String Error message associated with the job.

startedBy String User who started the task.

runContextType String Method through which the task was initiated. Includes the following values:
-UI. Task was initiated through the 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 String Schedule name, if task was initiated by a schedule.

orgId String Organization ID.

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

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

logFilename String The name of the generated log file.

errorFilename String The name of the generated error file.

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

connType String Connection type.

34 Chapter 2: REST API Version 2

Field Type Description

stopOnError Boolean Determines the runtime environment action to take when an nonfatal error
occurs. Includes the following values:
- True. The linear taskflow stops when an error occurs.
- False. The linear taskflow continues to process when an error occurs.

items Includes an activityLogEntryItem object for each task.

type String Included in the activityLogEntryItem object.

The type of task. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

objectId String Included in the activityLogEntryItem object.

Task ID.

objectName String Included in the activityLogEntryItem object.

Name of the task.

runId String Included in the activityLogEntryItem object.

ID for the task run.

agentId String Included in the activityLogEntryItem object.

Agent that ran the task.

runtimeEnvironmentId String Included in the activityLogEntryItem object.

Runtime environment where the task ran.

startTime Date/time Included in the activityLogEntryItem object.

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

endTime Date/time Included in the activityLogEntryItem object.End time for the task or linear
taskflow. Uses Eastern Time Zone (ET).

state String Included in the activityLogEntryItem object.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 String Included in the activityLogEntryItem object.

Error message associated with the job.

connType String Included in the activityLogEntryItem object.

Connection type.

children String Included in the activityLogEntryItem object.

Returns an activityLogEntryItem object for each table in the linear taskflow.

startedBy String User who started the task.

activityLog 35
 Field Type Description

runContextType String Method through which the task was initiated. Includes the following values:
-UI. Task was initiated through the 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 String Schedule name, if task was initiated by a schedule.

transformationEntries Includes information in a transformationLogEntry object for each

transformation.

txName String Included in the transformationLogEntry object.

Transformation name.

txType String Included in the transformationLogEntry object.

Transformation type.

successRows Long Included in the transformationLogEntry object.

Number of successful rows for the transformation.

failedRows Long Included in the transformationLogEntry object.

Number of failed rows for the transformation.

sequenceValues Returns information generated from a task that includes the sequence
generator transformation. Includes a sequenceValueLogEntry object for each
transformation.

txName String Included in the sequenceValueLogEntry object.

Transformation name.

nextValue String Included in the sequenceValueLogEntry object.

The last value generated by the task.

inOutParameterValues The in-out parameter values used in the task. Includes an

inOutParameterValueLogEntry for each parameter.

name String Included in the inOutParameterValueLogEntry object.

Parameter name.

value String Included in the inOutParameterValueLogEntry object.

Parameter value.

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.

36 Chapter 2: REST API Version 2

The following text is a sample return in JSON:
[
{
"@type": "activityLogEntry",
"id": "000001C100000000000D",
"type": "DSS",
"objectName": "dss-f2f",
"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>

activityLog 37
 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

[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 replication tasks and linear taskflows, you can download a ZIP file that contains all of the session
logs in the hierarchy. For 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 linear taskflows, 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 replication task or linear taskflow, you
might use the following request:
/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog
• To request a session log for a particular subtask for a replication task or linear taskflow, 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 linear taskflow, 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 attribute in the activityMonitor GET URI:

details

Optional.

38 Chapter 2: REST API Version 2

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

• true. Returns activity monitor information for tasks, linear taskflows, and child objects. Child objects
can include tasks within linear taskflows, and objects within replication tasks.
• false. Returns activity monitor information for tasks and linear taskflows.

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:

Field Type Description

id String Activity monitor entry ID.

type String The type of task. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

taskId String Task ID.

taskName String Task name.

objectName String Source object used in the task, or the replication object being processed.

runId Long ID for the task run.

startTime Date/time Start time for the task or linear taskflow.

endTime Date/time End time for the task or linear taskflow.

executionState String State of the task. Returns one of the following codes:
- INITIALIZED
- RUNNING
- STOPPING
- COMPLETED
- FAILED

failedSourceRows Long Number of rows that were not read from the source.

successSourceRows Long Number of rows that were successfully read from the source.

failedTargetRows Long Number of rows that were not written to the target.

successTargetRows Long Number of rows that were successfully written to the target.

errorMsg String Error message associated with the job.

activityMonitor 39
 Field Type Description

entries Indicates the start of information for a child object. A child object might be a
task within a linear taskflow, or an object in a replication task.

agentId String Agent used for the activity.

runtimeEnvironmentId String Runtime environment used for the activity.

startedBy String User who started the task.

runContextType String Method through which the task was initiated. Includes the following values:
-UI. Task was initiated through the Data Integration 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 String Schedule name, if task was initiated by a schedule.

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

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>

40 Chapter 2: REST API Version 2

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

agent 41
 The agent object includes the following attributes:

Field Type Description

id String Secure Agent ID.

orgId String Organization ID.

name String Secure Agent name.

description String Description of the Secure Agent.

createTime Date/time Time the Secure Agent was created.

updateTime Date/time Last time the Secure Agent was updated.

createdBy String User who created the Secure Agent.

updatedBy String User who updated the Secure Agent.

active Boolean Whether the Secure Agent is active. Returns true or false.

readyToRun Boolean Whether the Secure Agent is ready to run a task. Returns true or false.

platform String Platform of the Secure Agent machine. Returns one of the following values:
- win64
- linux64

agentHost String Host name of the Secure Agent machine.

password String Password of the Secure Agent machine.

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

proxyPort Int Port number of the outgoing proxy server.

proxyUser String User name to connect to the outgoing proxy server.

proxyPassword String Password to connect to the outgoing proxy server.

agentVersion String Secure Agent version.

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

upgradeStatus String Upgrade status.

lastUpgraded Date/time Last time the Secure Agent was upgraded.

lastUpgradeCheck Date/time Last time the Secure Agent was checked for upgrade.

lastStatusChange Date/time Last time the Secure Agent status was updated.

packages String Informatica Cloud Connector packages.

configUpdateTime Date/time Last time a user updated Secure Agent properties.

42 Chapter 2: REST API Version 2

 Field Type Description

agentConfigs Attribute that defines Secure Agent properties. Includes information in an

agentConfig object for each Secure Agent property.

name String Included in the agentConfig object.

Configuration property name.

type String Included in the agentConfig object.

Configuration type. Returns one of the following values:
- Secure Agent Core
- Secure Agent Manager
- DTM
- Apache Tomcat JRE
- Secure Agent Core JRE

subtype String Included in the agentConfig object.

Configuration subtype. Returns one of the following values:
- INFO
- DEBUG

value String Included in the agentConfig object.

Value of the property.

customized Boolean Included in the agentConfig object.

Whether the property is in the custom configuration details. Returns true or false.

overridden Boolean Included in the agentConfig object.

Whether the property has been overridden. Returns true or false.

defaultValue String Included in the agentConfig object.

Default value.

platform String Included in the agentConfig object.

Platform. Returns one of the following values:
- win64
- linux64

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:

Field Type Description

agentEngineStatus Status of the agent service, which includes information in the AgentEngineStatus
object.

appname String Included in the AgentEngineStatus object.

The service name that is used internally.

appDisplayName String Included in the AgentEngineStatus object.

The service name that displays in the user interface.

agent 43
 Field Type Description

appversion String Included in the AgentEngineStatus object.

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

status String Included in the AgentEngineStatus object.

The status of the service.

createTime Date/time Included in the AgentEngineStatus object.

The time the service was created.

updateTime Date/time Included in the AgentEngineStatus object.

The last time the service was updated.

agentEngineConfigs Defines agent service properties. Includes information in an engineConfig object

for each agent service property.

type String Included in the engineConfig object.

Configuration type.

name String Included in the engineConfig object.

Configuration property name.

value String Included in the engineConfig object.

Value of the property.

platform String Included in the engineConfig object.

Platform. Returns one of the following values:
- win64
- linux64

customized Boolean Included in the engineConfig object.

Whether the property is in the custom configuration details. Returns true or 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.

44 Chapter 2: REST API Version 2

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>
Include the following information in the GET URI:

Field Required Description

batchSize Yes Number of entries to include in a batch.

batchId Yes 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:

Field Type Description

id String Audit log entry ID.

version Int Version.

orgId String Organization ID.

username String User who performed the action.

entryTime Time the action occurred.

objectId String ID of the object used.

objectName String Name of the object used.

auditlog 45
 Field Type Description

category String 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. Replication.
- DQA. Data assessment.
- DMASK.Masking.
- DSS. Synchronization.
- DATA_FILE. File.
- WORKFLOW. Linear taskflow.
- PCS. PowerCenter.
- MTT. Mapping task.
- CUSTOM_FUNC. Mapplet.
- MIGRATE. Migration.
- CUSTOM_SOURCE. Saved query.
- SUBSCRIPTION_BILLING
- USER_GROUP
- SUB_ORG. Sub-organization.
- OBJECT_ACL. Object permissions.
- PACKAGE
- TEMPLATE. Visio 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.
- RUNTIME_ENVIRONMENT.

46 Chapter 2: REST API Version 2

 Field Type Description

event String 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 String Objects related to the action.

message String Additional information.

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

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

bundleObject 47
 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:

Field Type Description

id String Bundle ID.

orgId String Organization ID.

name String Bundle name.

description String Description.

createTime Date/time Time the bundle was created.

updateTime String Time the bundle was updated.

createdBy String User who created the bundle.

updatedBy String User who last updated the bundle.

lastVersion String The current published version of the bundle.

revokeTime Date/time This attribute is not used at this time.

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

copyable Boolean Determines whether users can download the contents of the bundle locally. Returns
true or false.

accessType String Access type for the bundle. Returns the following codes in the
BundleObjectAccessType object:
- PUBLIC. Available to all Informatica Intelligent Cloud Services organizations.
- SUBORGS. Available to sub-organizations of the publishing organization.
- ACCESS_LIST. Available to the organization IDs in the sharedWith attribute.

48 Chapter 2: REST API Version 2

 Field Type Description

objects Objects in the bundle. Includes information for each object in the bundleRefObject
object.

objectTypeCode String Included in the bundleRefObject object.

The type of bundle. Includes the following values:
- 0V. Visio template.
- 17. Mapping.
- 0L. Mapplet.

objectId String Included in the bundleRefObject object.

Object identified in the bundle.

objectName String Included in the bundleRefObject object.

Name of the object in the bundle.

objectUpdateTime String Included in the bundleRefObject object.

The date and time that the object in the bundle was last updated.

publishOrgId String ID of the organization that published the bundle.

publishOrgName String Name of the organization that published the bundle.

externalId String External ID for the bundle.

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.

bundleObjectLicense 49
 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:

Field Type Description

bundleObjectId String Bundle ID.

orgId String Organization ID.

updateOption String This attribute is not used at this time.

licenseType String Bundle type. Returns one of the following values:

- Free
- Trial
- Subscription

endDate Date/time Date the license expires. Returns NULL for free public bundles.

numberOfDaysToApply Int Not used at this time.

numberOfMonthsToApply Int Not used at this time.

beginDate Date/time Publish date for the bundle.

bundleVersion String Version number for the bundle.

createTime Date/time Creation date for the bundle.

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

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

accessCode String 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 attribute in a bundleObjectLicense object:

Field Type Required Description

bundleObjectId String Yes The ID of the bundle.

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

50 Chapter 2: REST API Version 2

 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:

Field Type Required Description

bundleObjectId String Yes The ID of the bundle.

updateOption String 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>

connection 51
 If you use the connection name in the URI and the connection name includes a space, replace the space
with %20. For example:
/api/v2/connection/name/my%20connection
List of objects that you can use as a source or target

You can request the objects that you can use as a source or target. A maximum of 200 objects can be
returned for one request. To request source or target objects, you can include either the connection ID or
connection name in the URI. Use one of the following URIs:
/api/v2/connection/source/<id>
/api/v2/connection/target/<id>
/api/v2/connection/source/name/<name>
/api/v2/connection/target/name/<name>
If you use the connection name in the URI and the connection name includes a space, replace the space
with %20. For example:
/api/v2/connection/target/name/my%20connection
If you expect to receive a large number of objects, you might want to filter the results. To filter the
results, include the connection ID and the searchPattern parameter. To use the searchPattern parameter,
use the following URI:
/api/v2/connection/<source or target>/<id>?searchPattern=<pattern>
For example, the following request returns source objects that include "abc" in the object name:
/api/v2/connection/source/002D420000000J?searchPattern=abc
List of connections of a specified type associated with a Secure Agent or runtime environment

To request a list of connections by Secure Agent ID and connection type, use the following URI:
/api/v2/connection/search?agentId=<agentId>&uiType=<uiType>
To request a list of connections by runtime environment ID and connection type, use the following URI:
/api/v2/connection/search?runtimeEnvironmentId=<runtimeEnvironmentId>&uiType=<uiType>
If you pass both agentId and runtimeEnvironmentId, the service uses runtimeEnvironmentId and ignores
agentId. If you pass only agentId, the service translates agentId into its corresponding
runtimeEnvironmentId before it saves the resource to the repository.

Metadata details for a specified connection

To request metadata details for a specified connection, use the following URI:
/api/v2/connection/source/<connection ID>/metadata
/api/v2/connection/target/<connection ID>/metadata
The metadata is returned in the runtimeAttribute object which contains the following attributes:

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

52 Chapter 2: REST API Version 2

Use the following connection request URI attributes:

Field Type Required Description

agentId String Secure Agent ID

runtimeEnvironmentId String Runtime environment ID.

uiType String Yes Connection type. Use one of the following options:
- CSVFile. CSV flat file.
- FTP.
- MS_ACCESS.
- MSD. Microsoft Dynamics CRM.
- MySQL.
- ODBC.
- Oracle.
- OCOD. Oracle CRM On Demand.
- Salesforce.
- SFTP. Secure FTP.
- SAP_ALE_IDoc_Reader. SAP IDoc Reader.
- SAP_ALE_IDoc_Writer. SAP IDoc Writer.
- SqlServer. Microsoft SQL Server 2000.
- SqlServer2005. Microsoft SQL Server 2005.
- SqlServer2008. Microsoft SQL Server 2008.
- 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:

Field Type Description

id String Connection ID.

orgId String Organization ID.

name String Connection name.

description String Description of the connection.

createTime Date/time Time the connection was created.

connection 53
 Field Type Description

updateTime Date/time Last time the connection was updated.

createdBy String User who created the connection.

updatedBy String User who last updated the connection.

agentId String Secure Agent ID for Flat File, FTP/SFTP, Microsoft SQL Server, MS Access,
MySQL, ODBC, Oracle, and Web Service connections.

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

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

domain String 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 String 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 String Client code for SAP IDoc Writer connections.

authenticationType String Authentication type for Microsoft Dynamics CRM, Microsoft SQL Server, and
Web Service connections.

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

accountNumber String Account ID for NetSuite connections.

languageCode String Language code for SAP IDoc Writer connections.

remoteDirectory String Remote directory for FTP/SFTP connections.

schema String Schema name for Microsoft SQL Server, ODBC, Oracle, and Web Service
connections.

serviceUrl String Service URL for Microsoft Dynamics CRM, Oracle CRM On Demand, and
Salesforce connections.

54 Chapter 2: REST API Version 2

Field Type Description

shortDescription String The first 50 letters of the description.

type String 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 Int Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle
connections.

password String Password for the connection.

username String User name for the connection.

securityToken String Security token for a Salesforce connection.

stsUrl String Security token service URL for Microsoft Dynamics CRM connections that use
Active Directory authentication.

organizationName String Organization name for Microsoft Dynamics CRM connections.

timeout Int Timeout for Web Service connections.

trustCertificatesFile String Trust certificates file name for Web Service connections.

certificateFile String Certificates file name for Web Service connections.

certificateFilePassword String Certificates file password for Web Service connections.

certificateFileType String Certificates file type for Web Service connections.

privateKeyFile String Private key file name for Web Service connections.

privateKeyPassword String Private key password for Web Service connections.

connection 55
 Field Type Description

privateKeyFileType String Private key file type for Web Service connections.

connParams String 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 List of connections included in the connListItem object.

id String Included in the connListItem object.

Source or target ID.

name String Included in the connListItem object.

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

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

POST Response
If successful, returns the connection object for the connection that was created or updated.

Returns the error object if errors occur.

56 Chapter 2: REST API Version 2

 DELETE Request
To delete a connection, use the connection ID in the following URI.
/api/v2/connection/<id>

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

Returns the error object if errors occur.

POST Example
To update an SAP Table connection, you might use the following request, enclosing SAP attributes in the
connParam object:
POST <serverUrl>/api/v2/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.

connection 57
 Attribute Description

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.

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.

58 Chapter 2: REST API Version 2

Attribute Description

username User name.

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

60 Chapter 2: REST API Version 2

 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 synchronization tasks or PowerCenter tasks.
- IFD. Internet Facing Development (IFD). Use for 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 61
 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 Data Integration 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.

62 Chapter 2: REST API Version 2

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

64 Chapter 2: REST API Version 2

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

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

66 Chapter 2: REST API Version 2

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

68 Chapter 2: REST API Version 2

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

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

connection 69
 Attribute Description

authenticationType Authentication type to use when the web service provider does not return an authentication
type to Informatica Intelligent Cloud Services. 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 Intelligent Cloud Services 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:

Field Type Description

name String Name of the connector.

type String Type of connector. Includes the following values:

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

publisher String Name of the entity that published the connector.

70 Chapter 2: REST API Version 2

 Field Type Description

connectorVersion Int Connector version.

shortName String Connector short name.

isPublic Boolean Whether the connector is a public or private connector. If you are interested in a
connector that is private, contact Informatica Global Customer Support.

GET Request and Response for Connector Metadata

To get metadata for a specific connector type, submit a GET request using the following URI:
/api/v2/connector/metadata?connectorName=<connectorName>
For example, you might use the following request:
GET <serverUrl>/api/v2/connectorName=SQLServer HTTP/1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
A successful response returns the following attributes in the connectorMetadata object:

Field Type Description

type String Type of connector, such as Salesforce or Oracle.

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

attributes Connector attributes for the specified connector type. Includes information in the
attribute object for each connector object.

name String Included in the attribute object.

Name of the attribute, such as database or codePage.

label String Included in the attribute object.

Label.

id String Included in the attribute object.

ID.

value String Included in the attribute object.

Value of the attribute.

type Int Included in the attribute object.

Data type. For values, see “Connector Data Types” on page 200 .

isMandatory Boolean Included in the attribute object.

Whether the attribute is mandatory.

connector 71
 Field Type Description

visible Boolean Included in the attribute object.

Whether the attribute is visible.

list String Included in the attribute object.

A list of types for the selected connector type. For example, SQL Server includes
the types SqlServer2000, SqlServer2005, SqlServer2008, and so on.

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

Field Type Description

id String Mapplet ID.

orgId String Organization ID.

name String Mapplet name.

description String Mapplet description.

createTime Date/time Time the mapplet was created.

72 Chapter 2: REST API Version 2

Field Type Description

updateTime Date/time Time the mapplet was last updated.

createdBy String User who created the mapplet.

updatedBy String User who last updated the mapplet.

mappletName String Name of the Mapplet transformation used in the mapplet.

active Boolean Whether the mapplet is active. Returns true or false.

mappletXmlFile String The mapplet XML file.

inputs String 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

customFunc 73
 Field Type Description

outputs String Output 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

connections Connection information for the mapplet. Includes a pcsConnection object for each
connection.

id Long Included in the pcsConnection object.

name String Included in the pcsConnection object.

Connection name.

type String Included in the pcsConnection object.

Connection type.

subtype String Included in the pcsConnection object.

Connection subtype.

description String Included in the pcsConnection object.

Description of the connection.

connectionId String Included in the pcsConnection object.

Connection ID.

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.

74 Chapter 2: REST API Version 2

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

Field Type Required Description

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

name String Yes The Mapplet name.

description String 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 Intelligent Cloud Services 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.

customFunc 75
 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
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,

76 Chapter 2: REST API Version 2

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:

Field Type Description

connId String Connection ID.

objectName String Name of the source or target object.

header String Column headers.

fieldName String Field name.

fieldBusinessName String Business field name.

data Includes the following attribute in the dataPreviewEntry object.

values String Included in the dataPreviewEntry object. 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:
{

"@type": "dataPreview",
"connId": "0000010B000000000003",
"objectName": "SF_ACCOUNT.csv",
"header": [

dataPreview 77
 "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",
"SHIPPINGSTREET",
"SHIPPINGCITY",
"SHIPPINGSTATE",
"SHIPPINGPOSTALCODE",

78 Chapter 2: REST API Version 2

 "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 79
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:

Field Type Required Description

expr String Yes The expression to validate.

connectionId String Yes Connection ID.

objectName String Yes Name of the source or target object.

isSourceType Boolean Yes 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
}

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>

80 Chapter 2: REST API Version 2

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:

Field Type Description

id Long Field ID.

name String Field name.

type String Field type.

label String Field label.

parentObject String Parent object, if applicable.

precision Int Length of the field in bytes.

pcType String PowerCenter data type.

scale Int Number of digits after the decimal point for numeric values.

columnIndex Int Column index.

isKey Boolean Whether the field is a used as a key.

isExternalId Boolean Whether the field is used as an external ID.

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

isNullible Boolean Whether the field can contain null values.

isUnique Boolean Whether the field requires unique values.

field 81
 Field Type Description

isCreateable Boolean Whether the field accepts new values.

isCalculated Boolean Whether the field is calculated.

isUpdateable Boolean Whether the field allows updates.

isFilterable Boolean Whether the field can be filtered.

linkedFields String For a masking task, the source field mapped to the input field of the mapplet.

relatedInfos Information about related fields included in a fieldRelatedInfo object for each related
field.

fieldId Long Included in the fieldRelatedInfo object.

Field ID.

referenceObject String Included in the fieldRelatedInfo object. Object that includes the field.

relationshipName String Included in the fieldRelatedInfo object. Relationship to object.

references Reference information included in a fieldRelatedInfo object for each related field.

fieldId Long Included in the fieldRelatedInfo object.

Field ID.

referenceObject String Included in the fieldRelatedInfo object.

Object that includes the field.

relationshipName String Included in the fieldRelatedInfo object.

Relationship to object.

javaType String Java data type.

showLabel Boolean Whether to show the field label.

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

82 Chapter 2: REST API Version 2

 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:

Field Type Required Description

id Long Yes Field ID.

delimiter String Yes Character used to separate fields.

textQualifier String Yes Quote character that defines the boundaries of text strings.

escapeChar String Yes Character immediately preceding a field delimiter character embedded in an
unquoted string, or immediately preceding the quote character in a quoted
string

headerLineNo Int Yes Number of header lines.

firstDataRow Int Yes 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 a Visio template XML file or image file to your organization. You can also use this
resource to delete a Visio template XML file or image file from the organization.

POST Request
To upload a Visio template XML file or image file, use the following URI.
/api/v2/fileRecord

fileRecord 83
 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:

Field Type Required Description

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

type String Yes Type of file that you want to upload. Use one of the following values:
- MAPPING. Use to upload a Visio template XML file. Use for XML files only.
- IMAGE. Use to update an image file for a Visio 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 Intelligent Cloud Services 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:

Field Type Description

id String ID for the uploaded file.

You can use this ID to identify the file when you create or update a Visio template with the
masterTemplate resource.

orgId String Organization ID.

84 Chapter 2: REST API Version 2

 Field Type Description

name String File name.

description String Description of the file.

createTime Date/time Time that the file was uploaded to the organization.

updateTime Date/time Last time that the file was updated.

createdBy String User who first uploaded the file.

updatedBy String User who last updated the file.

type String File type.

size Int File size.

attachTime String Time the file was associated with a Visio template.

DELETE Request
You can delete a Visio template XML or image file if the Visio template is not used by a Visio 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 VisioTemplate.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="<VisioTemplate.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"

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

86 Chapter 2: REST API Version 2

GET Response
The fwConfig object returns the following attributes:

Field Type Description

id String Fixed-width format ID.

name String Fixed-width format name.

description String Description of the fixed-width format.

createTime Date/time Time that the fixed-width format was created.

updateTime Date/time Last time that the fixed-width format was updated.

createdBy String User who created the fixed-width format.

updatedBy String User who last updated the fixed-width format.

lineSequential Boolean Whether each row ends with a newline character.

- True. Line sequential is enabled.
- False. Line sequential is not enabled.

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

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

nullChar String The character to represent a null value.

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

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

repeatNullChar Boolean 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 Boolean 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 String 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.

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>

fwConfig 87
 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

88 Chapter 2: REST API Version 2

You can use the following attributes in a fwConfig POST request:

Field Type Required Description

id String Yes Fixed-width format ID.

name String Yes Fixed-width format name.

description String Description of the fixed-width format.

lineSequential Boolean Yes Whether each row ends with a newline character.
- True. Line sequential is enabled.
- False. Line sequential is not enabled.

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

skipRows Int Yes Number of rows to skip. You can skip blank or header rows.

nullChar String Yes The character to represent a null value.

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

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

repeatNullChar Boolean Yes 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 Boolean Yes 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 String Yes 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.

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,

fwConfig 89
 "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 a task or linear taskflow 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 linear taskflow.

Start POST Request

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

Field Type Required Description

taskId String Required if Task or linear taskflow ID. Use taskId or taskName in the URI.
taskName not
included.

taskName String Required if taskId Task or linear taskflow name. Use taskId or taskName in the URI.
not included.

type String Yes The type of task. Use one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

callbackURL String Yes 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.

90 Chapter 2: REST API Version 2

The job object includes the following attributes:

Field Type Description

taskId String Task or linear taskflow ID.

taskName String Task or linear taskflow name.

type String The type of task. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

runId Long ID of the job.

callbackURL String Status of the job.

Stop POST Request

To stop a task or linear taskflow, use the following URI:
/api/v2/job/stop
With this URI, use the following attributes in a job object:

Field Type Required Description

taskId String Required if taskName not Task or linear taskflow ID. Use taskId or taskName in the URI.
included.

taskName String Required if taskId not Task or linear taskflow name. Use taskId or taskName in the URI.
included.

type String Yes The type of task. Use one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.
- WORKFLOW. Linear taskflow.

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 linear taskflow 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",

job 91
 "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",
objectId: "0034J90000000M",
objectName: "taskName",
runId: 5,
status: "COMPLETED" // or “FAILED”
}

login
Use this resource to log in to an Informatica Intelligent Cloud Services organization to use version 2 REST API
resources. Returns a 30 minute 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 15.

POST Request
To log in using version 2 of the Informatica Intelligent Cloud Services REST API, use the following URL:
https://dm-us.informaticacloud.com/ma/api/v2/user/login
With this URL, use the following attributes in a login object:

Field Type Required Description

username String Yes Informatica Intelligent Cloud Services user name.

password String Yes Informatica Intelligent Cloud Services password.

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

92 Chapter 2: REST API Version 2

The user object includes the following attributes:

Field Type Description

id String User ID.

orgId String ID of the organization the user belongs to.

6 characters.

name String Informatica Intelligent Cloud Services user name.

description String Description of the user.

createTime String When the user account was created.

updateTime String When the user account was last updated

createdBy String Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Informatica Intelligent Cloud Services user who last updated the user account.

firstName String First name for the user account.

lastName String Last name for the user account.

title String Title of the user.

phone String Phone number for the user.

securityQuestion String 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 String Answer to the security question.

roles Object that contains roles assigned to the user.

name String Included in role object.

Role name. Returns one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN

description String Included in role object.

Role description.

usergroups Object Object that contains user groups assigned to the user. Includes a usergroup
object for each user group.

id String Included in usergroup object.

User group ID.

login 93
 Field Type Description

orgId String Included in usergroup object.

Organization ID. 6 characters.

name String Included in usergroup object.

User group name.

description String Included in usergroup object.

Description of the user.

createTime String Included in usergroup object.

When the user account was created.

updateTime String Included in usergroup object.

When the user account was last updated

createdBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who last updated the user account.

aclEntry Included in usergroup object.

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 “usergroup” on page 158 .

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

timezone String Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see “Time Zone Codes” on page 197 .

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

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

uuId String Unique identifier for the user.

icSessionId String Informatica Intelligent Cloud Services session ID for version 2 REST API session.
Use in most version 2 REST API request headers.

forceChangePassword Boolean 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 Example
To log in to your Informatica Intelligent Cloud Services organization, you might use the following request:
POST https://dm-us.informaticacloud.com/ma/api/v2/user/login HTTP/1.0
Content-Type: application/json
Accept: application/json

94 Chapter 2: REST API Version 2

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

loginSaml
Use this version 2 API resource to log in to Informatica Intelligent Cloud Services using SAML single sign-on.
The 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 15.

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

Use the following URL:

https://dm-us.informaticacloud.com/ma/api/v2/user/loginSaml
With this URL, use the following attributes in a loginSaml object:

Field Type Required Description

samlToken String Yes SAML login token.

orgId String Yes Informatica Intelligent Cloud Services 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:

Field Type Description

id String User ID.

orgId String ID of the organization the user belongs to.

6 characters.

name String Informatica Intelligent Cloud Services user name.

description String Description of the user.

createTime String When the user account was created.

updateTime String When the user account was last updated

loginSaml 95
 Field Type Description

createdBy String Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Informatica Intelligent Cloud Services user who last updated the user account.

firstName String First name for the user account.

lastName String Last name for the user account.

title String Title of the user.

phone String Phone number for the user.

roles Object that contains roles assigned to the user.

name String Included in role object.

Role name. Returns one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN

description String Included in role object.

Role description.

usergroups Object Object that contains user groups assigned to the user. Includes a usergroup object for each
user group.

id String Included in usergroup object.

User group ID.

orgId String Included in usergroup object.

Organization ID. 6 characters.

name String Included in usergroup object.

User group name.

description String Included in usergroup object.

Description of the user.

createTime String Included in usergroup object.

When the user account was created.

updateTime String Included in usergroup object.

When the user account was last updated

createdBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who last updated the user account.

96 Chapter 2: REST API Version 2

 Field Type Description

aclEntry Included in usergroup object.

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 “usergroup” on page
158 .

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

timezone String Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see “Time Zone Codes” on page 197 .

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

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

uuId String Unique identifier for the user.

icSessionId String Informatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most
version 2 REST API request headers.

POST Example
To log in to Informatica Intelligent Cloud Services using SAML single sign-on, you might use the following
request:
POST https://dm-us.informaticacloud.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.

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

POST Request
To log out an organization and end the version 2 REST API session, include the Informatica Intelligent Cloud
Services 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.

logout 97
 POST Example
To log out of your Informatica Intelligent Cloud Services organization, 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 version 2 REST API sessions for the organization.

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

username

Informatica Intelligent Cloud Services user name.

password

Informatica Intelligent Cloud Services 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 version 2 REST API sessions, you might use the following request:
POST https://dm-us.informaticacloud.com/ma/api/v2/user/logoutall HTTP/1.0
Content-Type: application/json
Accept: application/json
{
"@type": "logout",
"username": "[email protected]",
"password": "mypassword"
}

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.

98 Chapter 2: REST API Version 2

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

Field Type Description

id String Mapping ID.

orgId String Organization ID.

name String Mapping name.

description String Description of the mapping.

createTime Date/time Time the mapping was created.

updateTime Date/time Last time the mapping was updated.

createdBy String User who created the mapping.

mapping 99
 Field Type Description

updatedBy String User who last updated the mapping.

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

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

templateId String ID of the template created internally to represent the mapping.

deployTime Date/time Time the mapping was deployed.

hasParameters Boolean Indicates if the mapping includes parameters. Returns true or

false.

valid Boolean Indicates if the mapping is valid. Returns true or false.

fixedConnection Boolean Indicates if the mapping has fixed connections. Returns true or
false.

hasParametersDeployed Boolean Indicates if the mapping has parameters deployed. Returns true
or false.

fixedConnectionDeployed Boolean Indicates if the mapping has fixed connections deployed.

Returns true or false.

deployedTemplateId String ID of the template created internally to represent the deployed

mapping.

tasks Int Number of tasks that use the mapping.

parameters Parameters used in the mapping. Includes an mtTaskParameter

object for each parameter.

id Long Included in the mtTaskParameter object.

Parameter ID.

name String Included in the mtTaskParameter object.

Parameter name.

type String Included in the mtTaskParameter object.

Parameter type.

description String Included in the mtTaskParameter object.

Parameter description.

customFuncId String Mapplet ID for mapplet type parameters.

100 Chapter 2: REST API Version 2

Field Type Description

uiProperties String Included in the mtParameter object.

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 parameter used in the mapping. Includes a

mtTaskInOutParameter object for each in-out parameter.

id Long Included in the mtTaskInOutParameter object.

Parameter ID.

name String Included in the mtTaskInOutParameter object.

Parameter name.

description String Included in the mtTaskInOutParameter object.

Description of the parameter.

initialValue String Included in the mtTaskInOutParameter object.

Initial value for the parameter.

datatype String Included in the mtTaskInOutParameter object.

Data type of the parameter.

mapping 101
 Field Type Description

precision String Included in the mtTaskInOutParameter object.

Precision of the parameter.

scale String Included in the mtTaskInOutParameter object.

Scale of the parameter.

retentionPolicy String Included in the mtTaskInOutParameter object.

Determines when the task retains the current value.

aggregationType String Included in the mtTaskInOutParameter object.

Determines the final current value of the parameter when the
task runs.

currentValue String Included in the mtTaskInOutParameter object.

Current value for the parameter.

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

deployedMappingPreviewFileRecordId String 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 String Included in the reference object.

refType String Included in the reference object.

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 a Visio template or the details of all Visio templates in the
organization. You can create or update a Visio template, and request a list of mapping tasks that use the
template. You can also delete a Visio template.

GET Request
To request the details of all Visio templates in the organization, use the following URI:
/api/v2/masterTemplate

102 Chapter 2: REST API Version 2

To request the details of a particular Visio template, include the Visio template ID or Visio template name in
the URI. Use one of the following URIs:
/api/v2/masterTemplate/<id>
/api/v2/masterTemplate/name/<name>
If you use the Visio template name in the URI and the Visio template name includes a space, replace the
space with %20. For example:
/api/v2/masterTemplate/name/my%20Visio%20template
To request a list of mapping tasks that use a Visio template, use the Visio template ID in the following URI:
/api/v2/masterTemplate/<id>/tasks

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

Returns the error object if errors occur.

The masterTemplate object includes the following attributes:

Field Type Description

id String Visio template ID.

orgId String Organization ID.

name String Visio template name.

description String Description of the Visio template.

createTime dateTime Time the Visio template was created.

updateTime dateTime Last time the Visio template was updated.

createdBy String User who created the Visio template.

updatedBy String User who last updated the Visio template.

diFileRecordId String ID of the Visio template XML file.

templateImageId String ID of the Visio template image file.

parameters Parameters used in the Visio template. Includes an mtParameter object for each
parameter.

id Long Included in the mtParameter object.

Parameter ID.

name String Included in the mtParameter object.

Parameter name.

label String Included in the mtParameter object.

Parameter label.

masterTemplate 103
 Field Type Description

type String Included in the mtParameter object.

Parameter type.

description String Included in the mtParameter object.

Parameter description.

customFuncId String Included in the mtParameter object.

Mapplet ID for mapplet type parameters.

uiProperties String Included in the mtParameter object.

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.

104 Chapter 2: REST API Version 2

 Field Type Description

sessionAttrs String General and performance session properties for the task. Can include values for 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.
- $Source Connection Value. Source connection name.
- $Target Connection Value. Target connection name.
- Treat Source Rows as. When the mapping 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 Visio
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. Returns true or 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. Returns true or false.
- Reinitialize Aggregate Cache. Overwrites existing aggregate files for an
incremental aggregation task. Returns true or false.
- Enable High Precision. Processes the Decimal datatype to a precision of 28.
Returns true or false.
- Session Retry on Deadlock. The mapping task retries a write on the target when a
deadlock occurs. Returns true or false.

wizardMetadata Metadata for the mapping task wizard steps. Includes an mtWizardStep object for
each step.

name String Included in the mtWizardStep object.

Name of the step.

title String Included in the mtWizardStep object.

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

POST Request
To update a Visio template, use the Visio template ID in the following URI. To create a new Visio template,
omit the optional Visio template ID.
/api/v2/masterTemplate/<id>

masterTemplate 105
 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:

Field Type Required Description

name String Yes Name of the Visio template.

description String Description of the Visio template.

diFileRecordId String Yes Visio template XML file ID.

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

templateImageId String Visio 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 each parameter.

name String Yes Include in the mtParameter object.

Key field for the mtParameter collection.
Parameter name.

label String Include in the mtParameter object.

Parameter label.

type String Yes Include in the mtParameter object.

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

description String Include in the mtParameter object.

Parameter description.

customFuncId String Include in the mtParameter object.

Mapplet ID for mapplet type parameters.

106 Chapter 2: REST API Version 2

Field Type Required Description

uiProperties String Include in the mtParameter object.

Display property 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 the parameter.
- default. Default value.
- 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 input control.
- Expression. Expression editor input control.
- Field. Field selection input control.
- Fieldmap. Field mapping input control. Include 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.

masterTemplate 107
 Field Type Required Description

sessionAttrs String Include in the mtParameter object.

General and performance session properties for the task. Can include values
for 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.
- $Source Connection Value. Source connection name.
- $Target Connection Value. Target connection name.
- Treat Source Rows as. When the mapping 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 Visio 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. Returns true
or 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. Returns true
or false.
- Reinitialize Aggregate Cache. Overwrites existing aggregate files for an
incremental aggregation task. Returns true or false.
- Enable High Precision. Processes the Decimal datatype to a precision of
28. Returns true or false.
- Session Retry on Deadlock. The mapping task retries a write on the target
when a deadlock occurs. Returns true or false.

wizardMetadata Metadata for the mapping task wizard steps. Include an mtWizardStep
object for each step.

108 Chapter 2: REST API Version 2

 Field Type Required Description

name String Included in the mtWizardStep object.

Name of the step.

title String Included in the mtWizardStep object.

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

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

Returns the error code if errors occur.

DELETE Request
To delete a Visio template, use the Visio 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 a Visio 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 Visio template.

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

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

GET Request
To request the details of a mapping 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

mttask 109
 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:

Field Type Description

id String Task ID.

orgId String Organization ID.

name String Task name.

description String Description.

createTime Date/time Time the task was created.

updateTime Date/time Last time the task was updated.

createdBy String User who created the task.

updatedBy String User who last updated the task.

errorTaskEmail Object that includes the taskEmail object for error notifications

id String Included in taskEmail object for errorTaskEmail.

ID.

emails String Included in taskEmail object for errorTaskEmail.

Email address that receives email notification when a task fails to
complete.

successTaskEmail Object that includes the taskEmail object for success notifications.

id String Included in taskEmail object for successTaskEmail.

ID.

emails String Included in taskEmail object for successTaskEmail.

Email address that receives email notification when a task completes
successfully.

warningTaskEmail Object that includes the taskEmail object for warning notifications.

id String Included in taskEmail object for warningTaskEmail.

ID.

emails String Included in taskEmail object for warningTaskEmail.

Email address that receives email notification when a task completes with
errors.

parameters Parameters associated with the task. Includes attributes in the

mtTaskParameter object for each parameter.

110 Chapter 2: REST API Version 2

Field Type Description

id Long Included in the mtTaskParameter object.

Parameter ID.

name String Included in the mtTaskParameter object.

Parameter name.

type String Included in the mtTaskParameter object.

Parameter type.

text String Included in the mtTaskParameter object.

Parameter value.

label String Included in the mtTaskParameter object.

Parameter label.

description String Included in the mtTaskParameter object.

Parameter description.

sourceConnectionId String Included in the mtTaskParameter object.

Source connection ID.

targetConnectionId String Included in the mtTaskParameter object.

Target connection ID.

lookupConnectionId String Included in the mtTaskParameter object.

Lookup connection ID.

transfConnectionId String Included in the mtTaskParameter object.

Connection ID of mapplet. Reserved for future use.

midstreamConnectionId String Included in the mtTaskParameter object.

Connection ID of midstream transformation.

sourceObject String Included in the mtTaskParameter object.

Source object name.

sourceObjectLabel String Included in the mtTaskParameter object.

Source object label.

targetObject String Included in the mtTaskParameter object.

Target object name.

targetObjectLabel String Included in the mtTaskParameter object.

Target object label.

lookupObject String Included in the mtTaskParameter object.

Lookup object name.

lookupObjectLabel String Included in the mtTaskParameter object.

Lookup object label.

mttask 111
 Field Type Description

midstreamObject String Included in the mtTaskParameter object.

Midstream object name.

midstreamObjectLabel String Included in the mtTaskParameter object.

Midstream object label.

newObject Boolean Included in the mtTaskParameter object.

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

newObjectName String Included in the mtTaskParameter object.

Name of the flat file target.

operationType String Included in the mtTaskParameter object.

The task operation for the target.

truncateTarget Boolean Included in the mtTaskParameter object.

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

srcFFAttrs Included in the mtTaskParameter object.

Object that contains the source file attributes in the flatFileAttrs object.

tgtFFAttrs Included in the mtTaskParameter object.

Object that contains the target file attributes in the flatFileAttrs object.

lkpFFAttrs Included in the mtTaskParameter object.

Object that contains the lookup file attributes in the flatFileAttrs object.

flatFileAttrs Object that includes attributes for the source, target, and lookup files.

id Long Included in the flatFileAttrs object.

Field ID.

delimiter String Included in the flatFileAttrs object.

Character used to separate fields

textQualifier String Included in the flatFileAttrs object.

Quote character that defines the boundaries of text strings

escapeChar String Included in the flatFileAttrs object.

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

headerLineNo Int Included in the flatFileAttrs object.

Number of header lines

firstDataRow Int Included in the flatFileAttrs object.

The row number where the data begins in the file.

112 Chapter 2: REST API Version 2

Field Type Description

customFuncCfg Included in the mtTaskParameter object.

Object that defines configuration for mapplets used in the task. Includes
attributes in the customFuncConfig object for each mapplet.

id Long Included in the customFuncConfig object.

Mapplet ID.

connections Included in the customFuncConfig object.

Object to define connections used in a mapplet. Includes information in
the pcsConnection object for each connection.

id Long Included in the pcsConnection object.

name String Included in the pcsConnection object.

Connection name.

type String Included in the pcsConnection object.

Connection type.

subtype String Included in the pcsConnection object.

Connection subtype.

description String Included in the pcsConnection object.

Description of the connection.

connectionId String Included in the pcsConnection object.

Connection ID.

showBusinessNames Boolean Included in the mtTaskParameter object.

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

naturalOrder Boolean Included in the mtTaskParameter object.

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

isRESTModernSource Boolean Included in the mtTaskParameter object.

Always set to True to enable extended objects.

customQuery String Included in the mtTaskParameter object.

The custom query specified in Mapping Designer or mapping task query
options.

overriddenFields Included in the mtTaskParameter object.

Changes to field metadata in the mapping task. Includes information in the
mtTaskOverriddenField object for each overridden field.

name String Included in the mtTaskOverriddenField object.

Field name.

type String Included in the mtTaskOverriddenField object.Field type.

mttask 113
 Field Type Description

precision Int Included in the mtTaskOverriddenField object.Length of the field in bytes.

scale Int Included in the mtTaskOverriddenField object.Number of digits after the

decimal point for numeric values.

tgtFieldRefs String Included in the mtTaskParameter object.

Salesforce field reference IDs.

extendedObject Included in the mtTaskParameter object.

The source or target with more than one object joined.

targetUpdateColumns String Included in the mtTaskParameter object.

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

runtimeAttrs String Included in the mtTaskParameter object.

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 Data Integration user interface.
For more information about advanced connection properties, see the Data
Integration Help

dataFormat Included in the mtTaskParameter object.

Data format provided by the connector.
Includes attributes in the dataFormat object for each connector.
The dataFormat object is not applicable to all connectors. To see if
dataFormat is applicable to the connectors you are using, see the relevant
connector guides.

formatId Included in the dataFormat object.

Data format type provided by the connector, such as FLAT, AVRO,
PARQUET, JSON, or XML.

dataFormatAttributes Included in the dataFormat object.

Format attributes for the data format type. For example, for a flat file, the
dataFormatAttributes object includes values such as escapeChar,
delimiter, and qualifier.

sequences Defines values for the Sequence Generator transformation. Includes the
sequenceDefinition object for each sequence transformation.

txName String Included in the sequenceDefinition object.

Name of the Sequence Generator transformation.

initialValue String Included in the sequenceDefinition object.

The initial value of the sequence.

currentValue String Included in the sequenceDefinition object.

The value used for the last row added to the transformation.

114 Chapter 2: REST API Version 2

Field Type Description

inOutParameters In-out parameter used in the task. Includes a mtTaskInOutParameter

object for each in-out parameter.

id Long Included in the mtTaskInOutParameter object.

Parameter ID.

name String Included in the mtTaskInOutParameter object.

Parameter name.

description String Included in the mtTaskInOutParameter object.

Description of the parameter.

initialValue String Included in the mtTaskInOutParameter object.

Initial value for the parameter.

datatype String Included in the mtTaskInOutParameter object.

Data type of the parameter.

precision String Included in the mtTaskInOutParameter object.

Precision of the parameter.

scale String Included in the mtTaskInOutParameter object.

Scale of the parameter.

retentionPolicy String Included in the mtTaskInOutParameter object.

Determines when the task retains the current value.

aggregationType String Included in the mtTaskInOutParameter object.

Determines the final current value of the parameter when the task runs.

currentValue String Included in the mtTaskInOutParameter object.

Current value for the parameter.

agentId String Agent that runs the task.

lastRunTime Date/time Time the task last run.

masterTemplateId String Visio template ID. Returned when a Visio template is the basis of the task.

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

scheduleId String Schedule associated with the task, if any.

shortDescription String The first 50 characters of the description.

sessionProperties String Advanced session properties associated with the task.

Includes advanced session properties in a sessionProperties object.

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

mttask 115
 Field Type Description

outboundMessageUrlQueu Long Outbound message URL queue time for the task, if it exists.
eTime

runtimeEnvironmentId String Runtime environment used for the task.

preProcessingCmd String Command to run before the task.

postProcessingCmd String Command to run after the task completes.

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

maxLogs Long Number of session log files and import log files Data Integration retains.

verbose Boolean Whether Data Integration generates additional data in the logs to use for
troubleshooting purposes. Returns True or False.

POST Request
To update a mapping task, use a mapping task ID in the following URI. To create a mapping 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
The following table describes the attributes you can include in an mtTask object:

Field Type Required Description

errorTaskEmail Object that includes the taskEmail object for error

notifications

id String Include in taskEmail object for errorTaskEmail.

ID.

116 Chapter 2: REST API Version 2

Field Type Required Description

emails String Include in taskEmail object for errorTaskEmail.

Email address that receives email notification when a
task fails to complete.

successTaskEmail Object that includes the taskEmail object for success

notifications.

id String Include in taskEmail object for successTaskEmail.

ID.

emails String Include in taskEmail object for successTaskEmail.

Email address that receives email notification when a
task completes successfully.

warningTaskEmail Object that includes the taskEmail object for warning

notifications.

id String Include in taskEmail object for warningTaskEmail.

ID.

emails String Include in taskEmail object for warningTaskEmail.

Email address that receives email notification when a
task completes with errors.

parameters Parameters associated with the task. Use an

mtTaskParameter object to define the following
attributes for each parameter.

id Long Include in the mtTaskParameter object.

System generated parameter ID. You cannot update this
value

name String Include in the mtTaskParameter object.

Parameter name. Key field for the mtTaskParameter
collection.

type String Include in the mtTaskParameter object.

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

text String Include in the mtTaskParameter object.

Parameter value.

label String Include in the mtTaskParameter object.

Parameter label.

description String Include in the mtTaskParameter object.

Parameter description.

mttask 117
 Field Type Required Description

sourceConnectionId String Include in the mtTaskParameter object.

Source connection ID.

targetConnectionId String Include in the mtTaskParameter object.

Target connection ID.

lookupConnectionId String Include in the mtTaskParameter object.

Lookup connection ID.

newFlatFile Boolean. Include in the mtTaskParameter object.

Whether Data Integration creates a new flat file target.
Use one of the following values:
- True.
- False.

flatFileName String Include in the mtTaskParameter object.

Name of the flat file target.

newObject Boolean Include in the mtTaskParameter object.

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

newObjectName String Include in the mtTaskParameter object.

Name of the flat file target.

operationType String Include in the mtTaskParameter object.

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

truncateTarget Boolean Include in the mtTaskParameter object.

Whether the application truncates a database target
before writing to it. Use one of the following values:
- True.
- False.

srcFFAttrs Include in the mtTaskParameter object.

Object for the source file attributes. Include the
attributes in the flatFileAttrs object.

tgtFFAttrs Include in the mtTaskParameter object.

Object for the target file attributes. Include the
attributes in the flatFileAttrs object.

lkpFFAttrs Include in the mtTaskParameter object.

Object for the lookup file attributes. Include the
attributes in the flatFileAttrs object.

118 Chapter 2: REST API Version 2

Field Type Required Description

flatFileAttrs Object to hold attributes for the source, target, and

lookup files.

id Long Include in the flatFileAttrs object.

Field ID.

delimiter String Include in the flatFileAttrs object.

Character used to separate fields.

textQualifier String Include in the flatFileAttrs object.

Quote character that defines the boundaries of text
strings.

escapeChar String Include in the flatFileAttrs object.

Character immediately preceding a field delimiter
character embedded in an unquoted string, or
immediately preceding the quote character in a quoted
string.

headerLineNo Int Include in the flatFileAttrs object.

Number of header lines.

firstDataRow Int Include in the flatFileAttrs object.

The row number where the data begins in the file.

customFuncCfg Include in the mtTaskParameter object.

Object to define configuration for mapplets used in the
task. Use a customFuncConfig object to define each
mapplet.

id Long Include in the customFuncConfig object.

Mapplet ID.

connections Include in the customFuncConfig object.

Object to define connections used in a mapplet. Use a
pcsConnection object for each connection.
For more information about connections, see
“connection” on page 51.

id Long Include in the pcsConnection object.

name String Include in the pcsConnection object.

Connection name.

type String Include in the pcsConnection object.

Connection type.

subtype String Include in the pcsConnection object.

Connection subtype.

mttask 119
 Field Type Required Description

description String Include in the pcsConnection object.

Description of the connection.

connectionId String Include in the pcsConnection object.

Connection ID.

overriddenFields Include in the mtTaskParameter object.

Changes to field metadata in the mapping task. Use the
mtTaskOverriddenField object for each overridden field.

name String Include in the mtTaskOverriddenField object.

Field name. Key field for the mtTaskOverriddenField
collection.

type String Include in the mtTaskOverriddenField object.

Field type.

precision Int Include in the mtTaskOverriddenField object.

Length of the field in bytes.

scale Int Include in the mtTaskOverriddenField object.

Number of digits after the decimal point for numeric
values.

tgtFieldRefs String Include in the mtTaskParameter object.

Salesforce field reference IDs.

runtimeAttrs String Include in the mtTaskParameter object.

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 Data Integration user
interface.
For more information about advanced connection
properties, see the Data Integration Help

parameterFileName String Include in the mtTaskParameter object.

Name of the parameter file used in the task.

dataFormat Include in the mtTaskParameter object.

Data format provided by the connector.
Include attributes in the dataFormat object for each
connector.
The dataFormat object is not applicable to all
connectors. To see if dataFormat is applicable to the
connectors you are using, see the relevant connector
guides.

120 Chapter 2: REST API Version 2

Field Type Required Description

formatId String Include in the dataFormat object.

Data format type provided by the connector, such as
FLAT, AVRO, PARQUET, JSON, or XML.

dataFormatAttributes String Include in the dataFormat object.

Format attributes for the data format type. For example,
for a flat file data format, the dataFormatAttributes
object includes values such as escapeChar, delimiter,
and qualifier.

inOutParameters In-out parameter used in the task. Include an

mtTaskInOutParameter object for each in-out
parameter.

id Long Include in the mtTaskInOutParameter object.

Parameter ID.

name String Include in the mtTaskInOutParameter object.

Parameter name. Key field in the mtTaskInOutParameter
collection.

description String Include in the mtTaskInOutParameter object.

Description of the parameter.

initialValue String Include in the mtTaskInOutParameter object.

Initial value for the parameter.

datatype String Include in the mtTaskInOutParameter object.

Data type of the parameter.

precision String Include in the mtTaskInOutParameter object.

Precision of the parameter.

scale String Include in the mtTaskInOutParameter object.

Scale of the parameter.

retentionPolicy String Include in the mtTaskInOutParameter object.

Determines when the task retains the current value.

aggregationType String Include in the mtTaskInOutParameter object.

Determines the final current value of the parameter
when the task runs.

currentValue String Include in the mtTaskInOutParameter object.

Current value for the parameter.

masterTemplateId String Required ID of the Visio template used in the task.

when task
uses a
Visio
template.

mttask 121
 Field Type Required Description

mappingId String Required ID of the mapping used in the task.

when a
mapping is
the basis
for task.

scheduleId String Schedule associated with the task, if any.

sessionProperties String 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 Data Integration user
interface.

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

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

preProcessingCmd String Command to run before the task.

postProcessingCmd String Command to run after the task completes.

maxLogs Long Number of session log files and import log files to
retain. By default, Data Integration stores each type of
log file for 10 runs before it overwrites the log files for
new runs.

verbose Boolean Whether to generate additional data in the logs to use

for troubleshooting purposes. Use True or False.

runtimeEnvironmentId String Yes ID of the runtime environment used for the task.

agentId String Agent that runs the task.

sequences Defines values for the Sequence Generator

transformation. Use a sequenceDefinition object for
each sequence transformation.

txName String Include in the sequenceDefinition object.

Name of the Sequence Generator transformation. Key
field in the sequenceDefinition collection.

initialValue String Include in the sequenceDefinition object.

The initial value of the sequence.

currentValue String Include in the sequenceDefinition object.

The value used for the last row added to the
transformation.

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

122 Chapter 2: REST API Version 2

DELETE Request
To delete a mapping 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 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>
<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>

mttask 123
 <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 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"
}
]
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

124 Chapter 2: REST API Version 2

Masking Technique Attributes

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

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

mttask 125
 Masking Technique Attributes

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

Substitution Street - isSeeded

- seedValue
- DicName
- outputPort

Substitution U.S. ZIP code - isSeeded

- seedValue
- DicName
- outputPort

URL - isSeeded
- seedValue

126 Chapter 2: REST API Version 2

Mask Rule Parameter Attribute Values
Define the required parameter attribute values when you run the mapping 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.

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.

mttask 127
 Attribute Description

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.

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.

128 Chapter 2: REST API Version 2

Attribute Description

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.

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.

mttask 129
 Attribute Description

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 Intelligent Cloud Services 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 Intelligent Cloud Services returns the org object
in list format.

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.

130 Chapter 2: REST API Version 2

The org object includes the following attributes:

Field Type Description

id String Organization ID.

orgId String Organization ID.

name String Organization name.

description String Description of the organization.

createTime Date/time Time the organization was created.

updateTime Date/time Last time the organization was updated.

createdBy String ser who created the organization.

updatedBy String Last user who updated the organization.

parentOrgId String Organization ID for the parent organization.

Returns 0 if the organization is a stand-alone or parent organization.

address1 String Address for the organization.

address2 String Additional address information for the organization.

address3 String Additional address information for the organization.

city String City where the organization is based.

state String State where the organization is based. Returns a state code.
For more information, see Appendix A , “State Codes” on page 189 .

zipcode String Postal code of the area where the organization is based.

timezone String Time zone of the organization.

country String Country where the organization is based. Returns a country code.
For more information, see Appendix A , “Country Codes” on page 191 .

employees String Range of employees in the organization.

offerCode String Offer code assigned to Informatica Intelligent Cloud Services partners.

successEmails String Email address to receive notification of tasks that complete successfully.

warningEmails String Email address to receive notification of tasks that complete with errors.

errorEmails String Email address to receive notification of tasks that fail to complete.

campaignCode String Campaign code.

atlasProjectId String Atlas project ID.

org 131
 Field Type Description

zuoraAccountId String Zuora account ID.

spiUrl String Informatica Cloud Application Integration URL for the organization.

devOrg Boolean Indicates the organization is a development organization.

Returns 1 for a development organization. Returns 0 for a production
organization.

maxLogRows Int Maximum number of rows to keep in the activity log.

minPasswordLength Int Minimum number of characters for a user account password.

minPasswordCharMix Int 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.
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 Int Number of days until a previous password can be used again.
0 = Always.

passwordExpirationInDays Int Number of days until the password expires.

0 = Never.

subOrgLimit Int 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 Int 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 String Organization ID of the parent organization.

0 indicates the organization is a stand-alone or parent organization.

jobExecUserProfile String Informatica Intelligent Cloud Services user account configured to run
contact validation tasks.

subOrgs Object that contains information for each sub-organization.

id String Included in subOrgs object.

ID of the sub-organization.

name String Included in subOrgs object.

Name of the sub-organization.

POST Request
You can update an Informatica Intelligent Cloud Services 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.

132 Chapter 2: REST API Version 2

When you update an Informatica Intelligent Cloud Services 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:

Field Type Required Description

name String Yes Organization name.

address String Yes Address of organization.

address2 String Additional address information for the organization.

address3 String Additional address information for the organization.

city String Yes City where the organization is based.

state String Required when State where the organization is based. Use the appropriate state code.
Country is US Required when Country is set to US.
For more information, see Appendix A , “State Codes” on page 189 .

zipcode String Required when Postal code of the area where the organization is based.
Country is US Required when Country is set to US

country String Yes Country where the organization is based. Use the appropriate country
code.
For more information, see Appendix A , “Country Codes” on page 191 .

description String Description of the organization. Maximum length is 255 characters.

successEmails String Default email address for notification of successful job completion.

warningEmails String Default email addresses for warnings about job completion.

errorEmails String Default email address for notification about job failure.

employees String Yes 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 String Offer code assigned to Informatica Intelligent Cloud Services partners.

org 133
 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 Intelligent Cloud Services sub-organization if the user that started the REST
API session has the Admin role and belongs the parent organization.

To delete an Informatica Intelligent Cloud Services 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>
<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 tasks, linear taskflows, and Visio templates. The permissions you specify
through the REST API overwrite the permissions set in the user interface.

GET Request
To request user group permissions for a specified object, use a GET request and include the object ID in the
following URI:
/api/v2/permission/<objectId>

134 Chapter 2: REST API Version 2

GET Response
Returns an objectAcl object with the following attributes:

Field Type Description

objectType Permissions object. Returns one of the following codes:

- Agent. Secure Agent.
- Connection.
- Schedule. Task schedule.
- CustomFunc. Mapplet
- CustomSource. Saved query.
- WORKFLOW. Linear taskflow.
- DSS. Synchronization task.
- DRS. Replication task.
- PCS. PowerCenter task.
- MTT. Mapping task.
- TEMPLATE. Visio template.
- DMASK. 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.

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” on page
158 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",

permission 135
 "createPermission": true,
"readPermission": true,
"updatePermission": true,
"deletePermission": true,
"executePermission": true,
"adminPermission": true,
"userGroupId": "00001R05000000000003",
"userGroupName": "def"
}
]
}

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

136 Chapter 2: REST API Version 2

You can use the following attributes in an objectAcl object:

Field Type Required Description

objectType String Yes Permissions object. Returns one of the following codes:
- Agent. Secure Agent.
- Connection.
- Schedule. Task schedule.
- CustomFunc. Mapplet
- CustomSource. Saved query.
- WORKFLOW. Linear taskflow.
- DSS. Synchronization task.
- DRS. Replication task.
- PCS. PowerCenter task.
- MTT. Mapping task.
- TEMPLATE. Visio template.
- DMASK. 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 String ID of the object.

aclEntries Yes 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 158 resource.

POST Response
A successful response returns the objectAcl object.

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",

permission 137
 "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
{
"@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"

138 Chapter 2: REST API Version 2

 }
]
}

register
Use this resource to create an Informatica Intelligent Cloud Services sub-organization. For Informatica
Intelligent Cloud Services partners only.

You can create an Informatica Intelligent Cloud Services 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.

register POST Request

To create an Informatica Intelligent Cloud Services sub-organization, use the following URI.
/api/v2/user/register
Use the session ID from the login response in the request header. Use the serverUrl from the login response
as the base URL.

You can use the following attributes in a registration object:

Field Type Required Description

org Attribute that defines an Informatica Intelligent Cloud Services

organization.

offerCode String Include in the org object.

Offer code assigned to Informatica Intelligent Cloud Services
partners.

name String Yes Include in the org object.

Name for the new Informatica Intelligent Cloud Services
organization.

address1 String Yes Include in the org object.

Address where the organization is located.

address2 String Include in the org object.

Additional address information for the organization.

address3 String Include in the org object.

Additional address information for the organization.

city String Yes Include in the org object.

City where the organization is located.

register 139
 Field Type Required Description

state String Yes Include in the org object.

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

zipcode String Yes Include in the org object.

Zip code where the organization is located.

country String Yes Include in the org object.

Country where the organization is located. Use the appropriate
country code.
For more information, see Appendix A, “Country Codes” on page 191 .

timezone String Yes Include in the org object.

Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see Appendix A , “Time Zone Codes” on page
197 .

employees String Yes Include in the org object.

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.

name String Yes Include in the user object.

Email address for the organization administrator account.

password String Yes Include in the user object.

Password for the organization administrator account.

firstName String Yes Include in the user object.

First name of the organization administrator.

lastName String Yes Include in the user object.

Last name of the organization administrator.

title String Yes Include in the user object.

Title of the organization administrator.

phone String Yes Include in the user object.

Phone number for the organization administrator.

140 Chapter 2: REST API Version 2

 Field Type Required Description

email String Yes Include in the user object.

Email address that receives notification from Informatica Intelligent
Cloud Services.

timezone String Include in the user object.

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
197 .
If no valid time zone is passed, Informatica Intelligent Cloud
Services uses America/Los_Angeles by default.

securityQuestion String Include in the user object.

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 String Include in the user object.

Answer to the security question.

forceChangePassword Boolean Include in the user object.

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 Boolean Include in the user object.

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 String Registration code.

sendEmail Boolean When registration completes, sends an email to the user email
address with temporary login information. Use TRUE to send an
email.

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

register 141
 The user object includes the following attributes.

Field Type Description

id String User ID.

orgId String ID of the organization the user belongs to.

6 characters.

name String Informatica Intelligent Cloud Services user name.

description String Description of the user.

createTime String When the user account was created.

updateTime String When the user account was last updated

createdBy String Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Informatica Intelligent Cloud Services user who last updated the user account.

firstName String First name for the user account.

lastName String Last name for the user account.

title String Title of the user.

phone String Phone number for the user.

securityQuestion String 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 String Answer to the security question.

roles Object that contains roles assigned to the user.

name String Included in role object.

Role name. Returns one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN

description String Included in role object.

Role description.

usergroups Object Object that contains user groups assigned to the user. Includes a usergroup
object for each user group.

id String Included in usergroup object.

User group ID.

142 Chapter 2: REST API Version 2

 Field Type Description

orgId String Included in usergroup object.

Organization ID. 6 characters.

name String Included in usergroup object.

User group name.

description String Included in usergroup object.

Description of the user.

createTime String Included in usergroup object.

When the user account was created.

updateTime String Included in usergroup object.

When the user account was last updated

createdBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who last updated the user account.

aclEntry Included in usergroup object.

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 “usergroup” on page 158 .

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

timezone String Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see “Time Zone Codes” on page 197 .

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

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

uuId String Unique identifier for the user.

icSessionId String Informatica Intelligent Cloud Services session ID for version 2 REST API session.
Use in most version 2 REST API request headers.

forceChangePassword Boolean 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://dm-us.informaticacloud.com/ma/api/v2/user/register HTTP/1.0
Content-Type: application/json
Accept: application/json

register 143
 {
"@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.

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

144 Chapter 2: REST API Version 2

GET Response
Returns runtime environment information for the requested runtime environment. The runtimeEnvironment
object includes the following attributes:

Field Type Description

id String Runtime environment ID.

orgId String Organization ID.

name String Runtime environment name.

description String Description of the runtime environment.

createTime Date/time Date and time the runtime environment was created.

updateTime Date/time Date and time that the runtime environment was last updated.

createdBy String User who created the runtime environment.

updatedBy String User who last updated the runtime environment.

agents Agents assigned to the runtime environment. For more information, see the agent
resource.

isShared Boolean 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",

runtimeEnvironment 145
 "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
}

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:

Field Type Description

id String Schedule ID.

orgId String Organization ID.

name String Schedule name.

description String Description of the schedule.

createTime dateTime Time the schedule was created.

updateTime dateTime Last time the schedule was updated.

146 Chapter 2: REST API Version 2

Field Type Description

createdBy String User who created the schedule.

updatedBy String User who last updated the schedule.

startTime dateTime Date and time when the schedule starts running.

endTime dateTime Date and time when the schedule stops running.

interval String Interval or repeat frequency at which the schedule runs. Returns one of the following
codes:
- None. The schedule does not repeat.
- Minutely. Tasks run on an interval based on the specified number of minutes, days,
and time range.
- Hourly. Tasks run on an hourly interval based on the start time of the schedule.
- Daily. Tasks run daily at the start time configured for the schedule.
- Weekly. Tasks run on a weekly interval based on the start time of the schedule.
- Monthly. Tasks run on a monthly interval based on the start time of the schedule.

frequency Int 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 dateTime The start of the time range within a day that tasks run. Minutely and Hourly intervals
only.

rangeEndTime dateTime The end of the time range within a day that tasks run. Minutely and Hourly intervals
only.

sun Boolean Tasks run on Sunday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

mon Boolean Tasks run on Monday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

tue Boolean Tasks run on Tuesday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

wed Boolean Tasks run on Wednesday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

thu Boolean Tasks run on Thursday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

schedule 147
 Field Type Description

fri Boolean Tasks run on Friday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

sat Boolean Tasks run on Saturday. Returns one of the following codes:
- true
- false
Minutely, Hourly, and Weekly intervals only.

weekDay Boolean Tasks run on weekdays only. Returns one of the following codes:
- true
- false
Daily interval only.

dayOfMonth Int Date of the month that tasks run. Returns a date between 1-28.
Monthly interval only.

weekOfMonth String 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 String 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
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
Monthly interval only.

timeZone String 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

148 Chapter 2: REST API Version 2

You can use the following attributes in a schedule object:

Field Type Required Description

id String Required Schedule ID.

for
updates
only

orgId String Yes Organization ID.

name String Yes Schedule name.

description String Description of the schedule.

startTime dateTime Yes Date and time when the schedule starts running.

endTime dateTime Date and time when the schedule stops running. If you do not use this
parameter, the schedule runs indefinitely.

schedule 149
 Field Type Required Description

interval String Yes 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.
- 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 Int Yes 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 dateTime The start of the time range within a day that you want tasks to run. Enter
a date and time using standard date/time format. Only the time portion
is used.
Use with Minutely and Hourly intervals only.

150 Chapter 2: REST API Version 2

Field Type Required Description

rangeEndTime dateTime The end of the time range within a day that you want tasks to run. Enter
a date and time using standard date/time format. Only the time portion
is used.
Use with Minutely and Hourly intervals only.

sun Boolean 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 with Minutely, Hourly, and Weekly intervals only.

mon Boolean Runs tasks on Monday at the configured time.

See description for sun.

tue Boolean Runs tasks on Tuesday at the configured time.

See description for sun.

wed Boolean Runs tasks on Wednesday at the configured time.

See description for sun.

thu Boolean Runs tasks on Thursday at the configured time.

See description for sun.

fri Boolean Runs tasks on Friday at the configured time.

See description for sun.

sat Boolean Runs tasks on Saturday at the configured time.

See description for sun.

weekDay Boolean 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 Int 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 String 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.
Use one of the following options:
- First
- Second
- Third
- Fourth
- Last
Use with the Monthly interval only.

schedule 151
 Field Type Required Description

dayOfWeek String 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 String Time zone to use for the schedule. If no valid time zone is passed,
Informatica Intelligent Cloud Services uses the user's time zone.
For more information, see Appendix A, “Time Zone Codes” on page 197

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.

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 Intelligent Cloud Services server.

GET Request
To request the local time of the Informatica Intelligent Cloud Services server, use the following URI.
/api/v2/server/serverTime

152 Chapter 2: REST API Version 2

 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 Intelligent Cloud Services server.

GET Example
To check the local time of the Informatica Intelligent Cloud Services 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>
Use the following attribute in the URI:

Field Required Description

type Yes Use one of the following codes:

- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping 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.

task 153
 Field Type Description

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 synchronization tasks, use the following request.
/api/v2/task?type=DSS

user
Use this resource to request the details of an Informatica Intelligent Cloud Services 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 Intelligent Cloud Services user accounts, use the following URI:
/api/v2/user
To request the details of a particular Informatica Intelligent Cloud Services 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 Intelligent Cloud Services returns the user
object for the requested user account. When you request the details of all user accounts, Informatica
Intelligent Cloud Services returns the user object for each user account in the organization.

154 Chapter 2: REST API Version 2

The user object includes the following attributes:

Field Type Description

id String User ID.

orgId String ID of the organization the user belongs to.

6 characters.

name String Informatica Intelligent Cloud Services user name.

description String Description of the user.

createTime String When the user account was created.

updateTime String When the user account was last updated

createdBy String Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Informatica Intelligent Cloud Services user who last updated the user account.

firstName String First name for the user account.

lastName String Last name for the user account.

title String Title of the user.

phone String Phone number for the user.

securityQuestion String 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 String Answer to the security question.

roles Object that contains roles assigned to the user.

name String Included in role object.

Role name. Returns one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN

description String Included in role object.

Role description.

usergroups Object Object that contains user groups assigned to the user. Includes a usergroup
object for each user group.

id String Included in usergroup object.

User group ID.

user 155
 Field Type Description

orgId String Included in usergroup object.

Organization ID. 6 characters.

name String Included in usergroup object.

User group name.

description String Included in usergroup object.

Description of the user.

createTime String Included in usergroup object.

When the user account was created.

updateTime String Included in usergroup object.

When the user account was last updated

createdBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who created the user account.

updatedBy String Included in usergroup object.

Informatica Intelligent Cloud Services user who last updated the user account.

aclEntry Included in usergroup object.

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 “usergroup” on page 158 .

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

timezone String Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see “Time Zone Codes” on page 197 .

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

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

uuId String Unique identifier for the user.

icSessionId String Informatica Intelligent Cloud Services session ID for version 2 REST API session.
Use in most version 2 REST API request headers.

forceChangePassword Boolean 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.
/api/v2/user/<id>

156 Chapter 2: REST API Version 2

To create a new Informatica Intelligent Cloud Services user account, omit the optional user account ID in the
URI.

To create a SAML single sign-on user account, do not include password.

You can use the following attributes in a user object:

Field Type Required Description

orgId String Yes ID of the organization the user will belong to.
6 characters.

name String Yes Informatica Intelligent Cloud Services user name.

password String Yes, unless Informatica Intelligent Cloud Services password.

the user is a Do not include if the user is a SAML single sign-on user and the
SAML single organization is SAML enabled.
sign-on
user.

firstName String Yes First name for the user account.

lastName String Yes Last name for the user account.

title String Yes Title of the user.

phone String Yes Phone number for the user.

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

description String Description of the user.

timezone String 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 Intelligent Cloud
Services uses America/Los_Angeles by default.
For more information, see “Time Zone Codes” on page 197 .

securityQuestion String 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 String Answer to the security question.

roles Yes Role for the user. Use one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN

user 157
 Field Type Required Description

usergroups User group for the user.

forceChangePassword String 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>
<orgId>00342000</orgId>
<name>[email protected]</name>
<firstName>User</firstName>
<lastName>Name</lastName>
<title>developer</title>
<timeZone>America/Chicago</timeZone>
</user>

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>

158 Chapter 2: REST API Version 2

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:

Field Type Description

id String User group ID.

orgId String Organization ID.

name String User group name.

description String Description.

createTime String Time the user group was created.

updateTime String Time the user group was last updated.

createdBy String User who created the user group.

updatedBy String User who last updated the user group.

aclEntry Permissions assigned to the user group. Each aclEntry (Access Control List) object
represents the permissions associated with a given object type.

adminPermission Boolean Included in aclEntry object.

Permission to configure permissions for individual objects of the selected type.

createPermission Boolean Included in aclEntry object.

Permission to create objects. Also allows you to download and install the Secure
Agent.

deletePermission Boolean Included in aclEntry object.

Permission to delete objects.

executePermission Boolean Included in aclEntry object.

Permission to perform the following tasks:
- Run tasks and linear taskflows.
- Restart tasks.
- Monitor jobs and stop jobs.
- Add tasks to a linear taskflow if you have update permission on the linear
taskflow.

readPermission Boolean Included in aclEntry object.

Permission to view objects and view the details about each object. Also permission
to use a connection or schedule in a task.

usergroup 159
 Field Type Description

updatePermission Boolean Included in aclEntry object.

Permission to edit objects.

objectType Included in aclEntry object.

Permissions object. Returns one of the following codes:
- Agent. Secure Agent.
- Connection.
- Schedule. Task schedule.
- CustomFunc. Mapplet
- CustomSource. Saved query.
- WORKFLOW. Linear taskflow.
- DSS. Synchronization task.
- DRS. Replication task.
- PCS. PowerCenter task.
- MTT. Mapping task.
- TEMPLATE. Visio template.
- DMASK. 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.

id String User group ID.

orgId String Organization ID.

userId String User ID.

objectId String ID of the permissions object.

objectDeleted Boolean Whether the object was deleted. Returns one of the following values:
- True
- False

addedByAppId String

GET Example
To request the details for all user groups in the organization, use the following URI:
/api/v2/usergroup

160 Chapter 2: REST API Version 2

workflow
Use this resource to request the details of a linear taskflow or the details of all linear taskflows in the
organization. You can also create, update, or delete a linear taskflow.

GET Request
To request the details of a particular linear taskflow, include the linear taskflow ID or linear taskflow name in
the URI. Use one of the following URIs:
/api/v2/workflow/<id>
/api/v2/workflow/name/<name>
If you use the linear taskflow name in the URI and the linear taskflow name includes a space, replace the
space with %20. For example:
/api/v2/workflow/name/my%20linear%20taskflow
To request the details of all linear taskflows 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 linear taskflows using simple mode:
/api/v2/workflow/?simpleMode=true

GET Response
If successful, returns the workflow object for the requested linear taskflow. Or, if you request the details for
all linear taskflows in the organization, returns a workflow object for each linear taskflow in the organization.

Returns an error object if errors occurred.

The workflow object includes the following attributes:

Field Type Description

id String Linear taskflow ID.

orgId String Organization ID.

name String Linear taskflow name.

description String Description.

createTime Date/time Time the linear taskflow was created.

updateTime Date/time Last time the linear taskflow was updated.

createdBy String User who created the linear taskflow.

updatedBy String User who last updated the linear taskflow.

errorTaskEmail Object that includes the taskEmail object for error notifications.

workflow 161
 Field Type Description

id String Included in taskEmail object for errorTaskEmail.

ID.

emails String Included in taskEmail object for errorTaskEmail.

Email address that receives email notification when a task fails to complete.

successTaskEmail Object that includes the taskEmail object for success notifications.

id String Included in taskEmail object for successTaskEmail.

ID.

emails String Included in taskEmail object for successTaskEmail.

Email address that receives email notification when a task completes
successfully.

warningTaskEmail Object that includes the taskEmail object for warning notifications.

id String Included in taskEmail object for warningTaskEmail.

ID.

emails String Included in taskEmail object for warningTaskEmail.

Email address that receives email notification when a task completes with
errors.

agentId String Agent that runs the task.

runtimeEnvironmentId String Runtime environment used for the task.

scheduleId String Schedule associated with the linear taskflow, if any.

preProcessingCmd String Command to run before the task.

postProcessingCmd String Command to run after the task completes.

tasks Defines each task associated with the linear taskflow. Includes a workflowTask
object for each task.

taskId String Included in the workflowTask object.

Task ID.

type String Included in the workflowTask object.

Workflow task type. Returns one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.

name String Included in the workflowTask object.

Task name.

162 Chapter 2: REST API Version 2

 Field Type Description

stopOnError Boolean Included in the workflowTask object.

Stops the linear taskflow if a task fails to complete.

stopOnWarning Boolean Included in the workflowTask object.

Stops the linear taskflow if a task completes with warnings.

POST Request
To update a linear taskflow, use the following URI:
/api/v2/workflow/<id>
To create a linear taskflow, omit the optional linear taskflow ID.

When you update a linear taskflow, Data Integration replaces the existing linear taskflow with the update.

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:

Field Type Required Description

errorTaskEmail Object that includes the taskEmail object for error notifications.

id String Include in taskEmail object for errorTaskEmail.

ID.

emails String Include in taskEmail object for errorTaskEmail.

Email address that receives email notification when a task fails to
complete.

successTaskEmail Object that includes the taskEmail object for success notifications.

id String Include in taskEmail object for successTaskEmail.

ID.

emails String Include in taskEmail object for successTaskEmail.

Email address that receives email notification when a task completes
successfully.

warningTaskEmail Object that includes the taskEmail object for warning notifications.

id String Include in taskEmail object for warningTaskEmail.

ID.

emails String Include in taskEmail object for warningTaskEmail.

Email address that receives email notification when a task completes
with errors.

name String Yes Name of the linear taskflow.

workflow 163
 Field Type Required Description

description String Description of the linear taskflow.

tasks Use a workflowTask object to define the following attributes for each
task you want to include in the linear taskflow.

taskId String Yes Include in the workflowTask object.

Task ID.

Yes Include in the workflowTask object.

Workflow task type. Use one of the following codes:
- DMASK. Masking task.
- DRS. Replication task.
- DSS. Synchronization task.
- MTT. Mapping task.
- PCS. PowerCenter task.

name String Yes Include in the workflowTask object.

Name of the task.

stopOnError Boolean Include in the workflowTask object.

Stops the linear taskflow 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 Boolean Include in the workflowTask object.

Stops the linear taskflow 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 String Schedule for the linear taskflow.

POST Response
If successful, returns the workflow response object for the linear taskflow that you created or updated.

Returns the error object if errors occur.

DELETE Request
To delete a linear taskflow, use the linear taskflow 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 linear taskflow 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>

164 Chapter 2: REST API Version 2

 {
"@type": "workflow",
"name": "linear taskflow",
"tasks":[{
"@type":"workflowTask",
"taskId":"0000100I00000000001G",
"type":"DSS",
"name":"DSS_DQ5",
"stopOnError":"false"
},{
"@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.

workflow 165
Chapter 3

REST API Version 3

Use the following resources in addition to the version 2 resources.

When you use version 3 resources, note the following rules:

• Log in using the version 3 login resource.

• Use JSON format.
• Use the following base URL:
<baseApiUrl>/public/core/v3/<API name>
• Use the following request header format:
<METHOD> <baseApiUrl>/<URI> HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

Export and Import

Use the export and import resources to migrate objects from one organization to another.

To use the export and import resources, the source and target organizations must have the Import/Export
license.

To migrate objects, you export them from the source organization and then import them into the target
organization. You might want to use the export and import resources to migrate objects through
development, test, and production environments, or to reuse a previous version of an object.

For Data Integration, you can export and import the following types of assets:

• Mappings
• Tasks
• Linear taskflows
• Business services
• Fixed-width configuration files
• Hierarchical schemas
• Mapplets
• Saved queries
• Visio templates

When you export and import assets, supporting objects such as component assets, connections, and runtime
environments are also included in the package.

166
export
Use this resource with the import resource to migrate objects from one organization to another.

Exporting objects involves a series of requests and responses. The end result is a .zip file that contains the
exported objects. To export objects, you complete the following tasks:

1. Send a lookup GET request to receive the object IDs for the objects to export.
Informatica Intelligent Cloud Services returns the object IDs.
See “lookup” on page 185.
2. Send an export POST request to start the export job, using the object IDs returned in the lookup
response.
Informatica Intelligent Cloud Services returns the job ID for the export job.
See “Start Export Job” on page 167.
3. Send an export GET request to get the status of the export job, using the export job ID for the export
package.
Informatica Intelligent Cloud Services returns the job ID and status. The response can also include a list
of the objects in the export package.
See “Get Export Job Status” on page 169.
4. Send an export GET request to download the export package.
Informatica Intelligent Cloud Services returns the export package in a .zip file.
See “Download Export Package” on page 173.

Start Export Job

Use a POST request to start an export job.

POST Request
To start the export job, use the following URI:
/public/core/v3/export
Include the following fields in the request:

Field Type Required Description

name String Name of the export job. If a name is not specified, the default name
will be used in the following format: job-
<currentTimeInMilliseconds>

objects Collection<Complex Yes Object IDs for objects to export.

type>

id String Yes Include in the objects object.

Global ID for the export object. This can be a project, folder, or
asset ID.

POST Request Example

You might use a request similar to the following example:
POST <baseApiUrl>/public/core/v3/export
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

Export and Import 167

 {
"name" : "testJob1",
"objects" : [
{
"id": "l7bgB85m5oGiXObDxwnvK9"
},
{
"id": "1MW0GDAE1sFgnvWkvom7mK"
},
{
"id": "iIVBNZSpUKFg4N6g2PKUox"
}
]
}

POST Response
If successful, returns the following information for the export job:

Field Type Description

id String ID of the export job.

createTime String Time export package was created.

updateTime String Time export package was last updated.

name String Name of the import job.

startTime String Time the export job was started.

endTime String Time the export job ended.

status Complex type Status of the export.

state String Returned in the status object.

Status of the export job, such as In Progress, Success, or Failed.

message String Returned in the status object.

Export job status message.

objects Collection Collection of objects. Returns null if blank.

POST Response Examples

If successful, you might receive a response similar to the following example:
{
"id": "7evG9CokA1whk8ehF3opKM",
"createTime": "2017-10-26T08:15:48.502Z",
"updateTime": "2017-10-26T08:15:48.502Z",
"name": "testJob1",
"startTime": "2017-10-26T08:15:48.501Z",
"endTime": null,
"status": {
"state": "IN_PROGRESS",
"message": "In Progress"
},
"objects": null
}

168 Chapter 3: REST API Version 3

If you receive an error, you might see a response similar to the following example:
{
"error": {
"code": "MigrationSvc_034",
"message": "Invalid object id/s [[242973wgfscbwasd23]]. Object resolution failed.",
"requestId": "2ataXVlgw3ydI1Yb2MA4sq"
}
}

Get Export Job Status

Use a GET request to get the status of an export job.

GET Request
To obtain status of the export job, use one of the following URIs:

• To receive status of the export job, use the following URI:

/public/core/v3/export/<id>
• To receive status for each object in the export job, use the following URI:
/public/core/v3/export/<id>?expand=objects
The <id> is the export job ID.

Continue polling the request until the state is SUCCESSFUL.

GET Response
Returns the following export status information:

Field Type Description

id String ID of the export job.

createTime String Time the export job was created.

updateTime String Last time the export job was updated.

name String Name of the export job.

startTime String Start time of the export job.

endTime String End time of the export job.

status Complex type Status of the export job.

state String Returned in the status object.

State of the export job, such as In Progress, Success, or Failed.

message String Returned in the status object.

Export job status message.

objects Collection Objects in the export job. Returned only when the URI includes ?expand=objects

id String Returned in the objects object.

Global ID of the export object requested.

Export and Import 169

 Field Type Description

name String Returned in the objects object.

Name of the object to export.

path String Returned in the objects object.

Complete path of the object to export.

description String Returned in the objects object.

Description of the object to export.

status Complex type Returned in the objects object.

Export status of the individual object.

state String Returned in the status object.

Export state of the individual object, such as IN PROGRESS, SUCCESS, or FAILED.

message String Returned in the status object.

Export status message for the individual object.

GET Response Example

If your request for an export job's status is successful, you might receive a response similar to the following
example:
{
"id": "7evG9CokA1whk8ehF3opKM",
"createTime": "2017-10-26T08:15:48.502Z",
"updateTime": "2017-10-26T08:15:48.502Z",
"name": "testJob1",
"startTime": "2017-10-26T08:15:48.501Z",
"endTime": null,
"status": {
"state": "IN_PROGRESS",
"message": "In Progress."
},
"objects": null
}
If your request included import status for individual objects, a successful response might be similar to the
following example:
{
"id": "7evG9CokA1whk8ehF3opKM",
"createTime": "2017-10-26T08:15:49.000Z",
"updateTime": "2017-10-26T08:15:50.000Z",
"name": "testJob1",
"startTime": "2017-10-26T08:15:49.000Z",
"endTime": "2017-10-26T08:15:50.000Z",
"status": {
"state": "SUCCESSFUL",
"message": "Export completed successfully."
},
"objects": [
{
"id": "1MW0GDAE1sFgnvWkvom7mK",
"name": "Linear Taskflow",
"path": "/ICS Taskflow",
"type": "SAAS_LINEAR_TASKFLOW",
"description": null,
"status": {
"state": "SUCCESSFUL",
"message": null

170 Chapter 3: REST API Version 3

 }
},
{
"id": "1SuZ9Gf8LtphrJn9EdHCod",
"name": "SQL Server",
"path": "/DSS",
"type": "Folder",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "1Uf9PTj6kTjbsVYMk55OC6",
"name": "Synchronization Task Multi Source",
"path": "/Default/SQL Server",
"type": "SAAS_DSS",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "2UL9ZO9Z3OJeuxbL2cYbaX",
"name": "Synchronization Task Simple Filter",
"path": "/Default/SQL Server",
"type": "SAAS_DSS",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "31SzqpeEEKacy7OaXXCfaD",
"name": "Synchronization Task Multi Source",
"path": "/DSS/SQL Server",
"type": "SAAS_DSS",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "5FA0DnMzeuDbYZnn3hdto9",
"name": "Default",
"path": "/",
"type": "Project",
"description": "Auto-generated Default Project",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "5V5VpaoJGTNkWCB2f2t4MG",
"name": "Synchronization Task Simple Filter",
"path": "/DSS/SQL Server",
"type": "SAAS_DSS",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "7udJJF48H5Iizzry8gjUAb",
"name": "SQL Server",

Export and Import 171

 "path": "/Default",
"type": "Folder",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "fIQLvhNnsqBjXKNfjyZFaH",
"name": "ICS Taskflow",
"path": "/",
"type": "Project",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "hGrgtrajWMUjNIsnLKQCAi",
"name": "SQL Server Linux",
"path": null,
"type": "SAAS_CONNECTION",
"description": null,
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "iIVBNZSpUKFg4N6g2PKUox",
"name": "abc_map",
"path": "/Default",
"type": "MAPPING",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "l7bgB85m5oGiXObDxwnvK9",
"name": "DSS",
"path": "/",
"type": "Project",
"description": "",
"status": {
"state": "SUCCESSFUL",
"message": null
}
},
{
"id": "lOqsFQE4OSWeyg77AeWwK2",
"name": "Linux",
"path": null,
"type": "SAAS_RUNTIME_ENVIRONMENT",
"description": null,
"status": {
"state": "SUCCESSFUL",
"message": null
}
}
]
}

172 Chapter 3: REST API Version 3

 Download Export Package
Use a GET request to download an export package.

GET Request
To download the export package, use the following URI:
/public/core/v3/export/<id>/package
The <id> is the export job ID.

GET Response
If successful, you receive the .zip stream in the response body and the response type will be application/zip.

If unsuccessful, you might receive a response similar to the following example:

{
"error": {
"code": "MigrationSvc_017",
"message": "Export request with identifier [asdasduguyvasd8347] doesn't exist.",
"requestId": "2ataXVlgw3ydI1Yb2MA4sq"
}
}

import
Use this resource with the export resource to migrate objects from one organization to another.

Importing objects involves a series of requests and responses. To import objects, you complete the following
tasks:

1. Send an import POST request to upload the .zip file.

Informatica Intelligent Cloud Services returns the job ID for the import job.
See “Upload Import Package” on page 173.
2. Send an import POST request to import objects. The request includes the import job ID, a list of objects
to import if the entire package is not desired, and parameters to resolve any conflict resolution that
might occur. For example, if you attempt to import an asset that has the same name as another asset in
the import location.
Informatica Intelligent Cloud Services returns the status of the import such as In Progress or Success, or
returns an error message. The response also includes the source organization ID for the organization
that created the export package.
See “Start Import Job” on page 174.
3. Send an import GET request to get the status of the import job. You can also request status at the object
level.
Informatica Intelligent Cloud Services returns the status of the import job and if requested, status of
each object in the package.
See “Get Import Job Status” on page 177.

Upload Import Package

Use a POST request to upload an import package.

POST Request
To upload the import package, use the following URI:
/public/core/v3/import/package

Export and Import 173

 For Content-Type, use
multipart/form-data
In the request body, include a part with the name of package. For its content, use the export zip file that you
want to import. The following image shows an example of the request body in Postman:

POST Response
If successful, returns the following information for the import job:

Field Type Description

jobId String ID of the import job.

jobStatus Collection Status of the package upload.

state String Returned in the status object.

Status of the import job, such as In Progress, Success, or Failed.

message String Returned in the status object.

Import job status message.

POST Response Example

You might receive a response similar to the following example:
{
"jobId": "2oZb7vFI2QQg4ncd4AyCGn",
"jobStatus": {
"state": "NOT_STARTED",
"message": null
}
}

Start Import Job

Use a POST request to specify and start an import job.

POST Request
To specify the import objects and start the import job, use the following URI:
/public/core/v3/import/<id>
The <id> is the import job ID received in the POST response for the import package upload.

174 Chapter 3: REST API Version 3

Include the following fields in the request:

Field Type Required Description

name String Name of the import job. If a name is not

specified, the default name will be used in the
following format:
job-<currentTimeInMilliseconds>

importSpecification ComplexType Used to specify import specifications. If not

specified, then the import includes all objects in
the import package with default conflict
resolution settings.

defaultConflictResolution String Include in the importSpecification object.

Whether to overwrite existing assets with the
assets in the import file. Includes the following
options:
- OVERWRITE. Overwrite the existing asset
with the asset in the import file.
- REUSE. Do not import the asset.
Note: The import includes connections and
runtime environments associated with the
assets if they do not exist in the target
organization.

includeObjects Collection<String> Include in the importSpecification object.

Objects to include in the import.
If this field is not specified, then the import
includes all objects in the import package.
If the specified object is a project, then the
import includes all assets that belong to the
project and all dependent objects that are not
already present in the target organization.
If the specified object is an asset, the import
creates the asset's containers (project, folder)
if they do not already exist.

objectSpecification Collection<ComplexType> Include in the importSpecification object.

Specifies the object properties. If properties are
not specified for a particular object, then the
import uses the default conflict resolution
settings.

sourceObjectGuid String Yes Include in the objectSpecification object.

The object ID in the export package file.
Mandatory if objectSpecification is present.

Export and Import 175

 Field Type Required Description

conflictResolution String Include in the objectSpecification object.

Whether to overwrite existing assets with the
assets in the import file. Includes the following
options:
- OVERWRITE. Overwrite the existing asset
with the asset in the import file.
- REUSE. Do not import the asset.
Note: The import includes connections and
runtime environments associated with the
assets if they do not exist in the target
organization.

targetObjectId String Include in the objectSpecification object.

Used for Container to Container mapping, as
well as some asset to asset mappings.
Supported for GA: connection, runtime
environment and projects.

POST Request Example

You might use a request similar to the following example:
POST <baseApiUrl>/public/core/v3/import/2oZb7vFI2QQg4ncd4AyCGn HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
"name" : "testImportName",
"importSpecification" : {
"defaultConflictResolution" : "REUSE",
"includeObjects" : ["iIVBNZSpUKFg4N6g2PKUox","ejZY66c19YUccBdbGwKG4P"],
"objectSpecification" : [{
"sourceObjectId" : "iIVBNZSpUKFg4N6g2PKUox",
"conflictResolution" : "OVERWRITE"
},
{
"sourceObjectId" : "5FA0DnMzeuDbYZnn3hdto9",
"targetObjectId" : "5KgUiEkW95NkjLRRefWKiG"
}]
}
}

POST Response
If successful, returns the following information for the import job:

Field Type Description

jobId String ID of the import job.

createTime String Time the import job was created.

updateTime String last time the import job was updated.

name String Name of the import job.

startTime String Start time of the import job.

176 Chapter 3: REST API Version 3

 Field Type Description

endTime String End time of the import job.

status Collection Status of the package upload.

state String Returned in the status object.

Import state of the individual object, such as IN PROGRESS, SUCCESS, or FAILED.

message String Returned in the status object.

Import job status message.

objects Collection Objects included in the import job.

sourceOrgId String Organization ID of the organization that created the export package that was imported.

POST Response Examples

If successful, you might receive a response similar to the following example:
{
"id": "2oZb7vFI2QQg4ncd4AyCGn",
"createTime": "2017-10-26T08:40:09.000Z",
"updateTime": "2017-10-26T08:55:53.238Z",
"name": "testImportName",
"startTime": "2017-10-26T08:55:53.232Z",
"endTime": "2017-10-26T08:53:03.000Z",
"status": {
"state": "IN_PROGRESS",
"message": "In Progress."
},
"objects": null,
"sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX"
}
If you receive an error, you might see a response similar to the following example:
{
"error": {
"code": "MigrationSvc_040",
"message": "User does not have required permissions.",
"requestId": "2ataXVlgw3ydI1Yb2MA4sq"
}
}

Get Import Job Status

Use a GET request to get the status of an import job.

GET Request
To obtain status of the import job, use one of the following URIs:

• To receive status of the import job, use the following URI:

/public/core/v3/import/<id>
• To receive status for each object in the import job, use the following URI:
/public/core/v3/import/<id>?expand=objects
The <id> is the import job ID.

Export and Import 177

 GET Response
Returns the following import status information:

Field Type Description

id String ID of the import job.

createTime String Time the import job was created.

updateTime String Last time the import job was updated.

name String Name of the import job.

startTime String Start time of the import job.

endTime String End time of the import job.

status Complex Type Status of the package upload.

state String Returned in the status object.

Status of the import job, such as IN PROGRESS, SUCCESS, or FAILED.

message String Returned in the status object.

Import job status message.

sourceOrgId String ID of the organization that created the export package that was imported.

objects Collection Objects included in the import.

sourceObject Collection Returned in the objects object.

Object included in the import.

id String Returned in the sourceObject object.

Global ID of the object included in the import.

name String Returned in the sourceObject object.

Name of the objectincluded in the import.

path String Returned in the sourceObject object.

Complete path of the object included in the import.

type String Returned in the sourceObject object.

Type of object included in the import.

description String Returned in the sourceObject object.

Description of object included in the import.

targetObject Collection Returned in the objects object.

Target object.

id String Returned in the targetObject object.

Global ID of the target object.

178 Chapter 3: REST API Version 3

 Field Type Description

name String Returned in the targetObject object.

Name of the target object.

path String Returned in the targetObject object.

Complete path of the target object.

type String Returned in the targetObject object.

Type of target object.

description String Returned in the targetObject object.

Description of target object.

status String Returned in the targetObject object.

Status of the target object.

status Complex Type Returned in the objects object.

Import status of the individual object.

state String Returned in the status object.

Import state of the individual object, such as IN PROGRESS, SUCCESS, or FAILED.

message String Returned in the status object.

Import status message for the individual object.

GET Response Example

If your request for an import job's status is successful, you might receive a response similar to the following
example:
{
"id": "2oZb7vFI2QQg4ncd4AyCGn",
"createTime": "2017-10-26T08:40:09.000Z",
"updateTime": "2017-10-26T08:55:56.000Z",
"name": "ImportName",
"startTime": "2017-10-26T08:55:53.000Z",
"endTime": "2017-10-26T08:55:56.000Z",
"status": {
"state": "SUCCESSFUL",
"message": "Import completed successfully."
},
"objects": null,
"sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX"
}
If your request included import status for individual objects, a successful response might be similar to the
following example:
{
"id": "2oZb7vFI2QQg4ncd4AyCGn",
"createTime": "2017-10-26T08:40:09.000Z",
"updateTime": "2017-10-26T08:55:56.000Z",
"name": "ImportName",
"startTime": "2017-10-26T08:55:53.000Z",
"endTime": "2017-10-26T08:55:56.000Z",
"status": {
"state": "SUCCESSFUL",
"message": "Import completed successfully."
},
"objects": [

Export and Import 179

 {
"sourceObject": {
"id": "ejZY66c19YUccBdbGwKG4P",
"name": "M1",
"path": "/Default",
"type": "MAPPING",
"description": "ab"
},
"targetObject": {
"id": null,
"name": "M1",
"path": "/default1",
"type": "MAPPING",
"description": null,
"status": null
},
"status": {
"state": "SUCCESSFUL",
"message": "Reuse existing."
}
},
{
"sourceObject": {
"id": "iIVBNZSpUKFg4N6g2PKUox",
"name": "abc_map",
"path": "/Default",
"type": "MAPPING",
"description": ""
},
"targetObject": {
"id": null,
"name": "abc_map",
"path": "/default1",
"type": "MAPPING",
"description": null,
"status": null
},
"status": {
"state": "SUCCESSFUL",
"message": "Overwrite existing."
}
}
],
"sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX"
}

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

You can use the license resource to send the following requests:

• GET request to obtain an organization's editions, custom licenses, and custom limits.
• PUT request to update a sub-organization's license information.

GET Request
To request license information for an organization or sub-organization, use the following URI:
/public/core/v3/license/org/<orgId>

180 Chapter 3: REST API Version 3

GET Response
Returns requested license information if successful or an error object if errors occur.

If successful, returns the following license information for the specified organization ID:

Field Type Description

customLicenses List Information about the organization's custom licenses.

licenseDef String Included in the customLicenses object.

The unique identifier for the custom license.

expirationDate String Included in the customLicenses object.

Time at which the license expires.

licenseType Included in the custom license object.

Type of license.
Includes the following values:
- TRIAL
- SUBSCRIPTION
- FREE
- NONE

assignedEditions List Information about the organization's editions in the edition object.

edition String Included in the edition object.

Unique identifier for the limit.

expirationDate String Included in the edition object.

Expiration date for the edition.

customLimits List Information about the organization's custom limits.

limitDefinition String Included in the customLimit object.

Unique identifier for the limit.

value Integer Included in the customLimit object.

Maximum uses of the limit.
Use -1 to indicate there is no maximum for the limit.

GET Example
The following example shows a request for an organization's license information:
GET <baseApiUrl>/public/core/v3/license/org/1ax3wad2FEsz35asd2892s
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
The response includes license information for the organization as shown in the following example:
{
"id": "1ax3wad2FEsz35asd2892s",
"parentOrg": null,
"customLicenses": [
{
"licenseType": "SUBSCRIPTION",
"expirationDate": "2017-11-05T18:01:24Z",

license 181
 "licenseDef": "a5Xjp3VF3sjcyZUDa6UaWh"
}
],
"assignedEditions": [
{
"expirationDate": "2017-11-05T18:01:24Z",
"edition": "4sdvnCrYEjfcKjTvAoigEF"
},
{
"expirationDate": "2018-10-06T18:00:08Z",
"edition": "5SPzPwEFvBEds8LzVwXX4K"
}
],
"customLimits": [
{
"value": -1,
"limitDefinition": "09cX4Tmi1qSfrS997ORMYl"
}
]
}

PUT Request
Use a PUT request to update a sub-organization's license information. In order to update licenses for a sub-
organization, you must log in to the parent organization as an administrator.

This request overwrites the sub-organization's licenses with the licenses in the request. To make changes to
a sub-organization's licenses, first request license information for the sub-organization, make your
modifications in the object, and then use it as the request body.

To update license information for a sub-organization, use the following URI:

/public/core/v3/license/org/<orgId>

PUT Response
Returns a success code if successful or an error object if errors occur.

PUT Example
To change a sub-organization's licenses, you might use the following request:
PUT <baseApiUrl>/public/core/v3/license/org/<orgId> HTTP/1.0
Accept:application/json
INFA-SESSION-ID: <sessionId>

{
"customLicenses": [
{
"licenseType": "SUBSCRIPTION",
"expirationDate": "2017-11-05T18:01:24Z",
"licenseDef": "a5Xjp3VF3sjcyZUDa6UaWh"
}
],
"assignedEditions": [
{
"expirationDate": "2017-11-05T18:01:24Z",
"edition": "4sdvnCrYEjfcKjTvAoigEF"
},
{
"expirationDate": "2018-10-06T18:00:08Z",
"edition": "5SPzPwEFvBEds8LzVwXX4K"
}
],
"customLimits": [
{
"value": -1,
"limitDefinition": "09cX4Tmi1qSfrS997ORMYl"
}
]
}

182 Chapter 3: REST API Version 3

login
Use this resource to log in to Informatica Intelligent Cloud Services to use version 3 REST API resources.
Returns a 30 minute 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 15.

POST Request
To log in using version 3 of the Informatica Intelligent Cloud Services API, use the following URL:
https://dm-us.informaticacloud.com/saas/public/core/v3/login
Use the following fields in a login object:

Field Type Required Description

username String Yes Informatica Intelligent Cloud Services user name.

password String Yes Informatica Intelligent Cloud Services password.

POST Response
Returns the following objects if the request is successful:

Field Type Description

products Collection Subscribed Informatica products.

name String Product name.

baseApiUrl String Returned in the product object.

Base API URL for the product.

userInfo Collection User information.

sessionId String Returned in the userInfo object.

REST API session ID for the current session. Use in most REST API request headers

id String Returned in the userInfo object.

User ID.

name String User name.

parentOrgId String Organization ID for the parent organization.

orgId String Returned in the userInfo object.

ID of the organization the user belongs to.
22 characters.

orgName String Returned in the userInfo object.

Organization name.

login 183
 Field Type Description

groups Collection User group information for the user.

status String Status of the user.

Returns one of the following values:
- Active
- Inactive

Use the base API URL returned in the response and the session ID for subsequent requests during this
session.

POST Example
To log in to your Informatica Intelligent Cloud Services organization, you might use the following request:
POST https://dm-us.informaticacloud.com/saas/public/core/v3/login HTTP/1.0
Content-Type: application/json
Accept: application/json

{
"username": "[email protected]",
"password": "mypassword"
}
If successful, the response includes the products and userInfo objects as shown in the following example:
{
"products": [
{
"name": "Integration Cloud",
"baseApiUrl": "https://pod.clouddev.informaticacloud.com/saas"
}
],
"userInfo": {
"sessionId": "9KA11tLGqxVcGeul8SQBK3",
"id": "9L1GFroXSDHe2IIg7QhBaT",
"name": "user",
"parentOrgId": "52ZSTB0IDK6dXxaEQLUaQu",
"orgId": "0cuQSDTq5sikvN7x8r1xm1",
"orgName": "MyOrg_INFA",
"groups": {},
"status": "Active"
}
}

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

POST Request
To log out of an organization and end the version 3 REST API session, include the Informatica Intelligent
Cloud Services session ID in the request header with the following URI:
https://dm-us.informaticacloud.com/saas/public/core/v3/logout

184 Chapter 3: REST API Version 3

 POST Response
Returns the 200 response code if the request is successful or an error object if errors occur.

POST Example
To log out of your Informatica Intelligent Cloud Services organization, use the following request:
POST https://dm-us.informaticacloud.com/saas/public/core/v3/logout HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

lookup
Use the lookup resource to look up an object's ID, name, path, or type attributes.

POST Request
This resource is usually used to obtain an object's ID to use in an export request. When you use this resource
to obtain an object's ID, the lookup resource uses the object path and type to perform the lookup.

To request lookup information, use the following URI:

/public/core/v3/lookup

lookup 185
 You can use the following fields in the objects object:

Field Type Required Description

id String Required if object path and type Global identifier of the object.
not included.

path String Required with type if object ID Full path of the object including project, folder, and object name.
not included.

type String Required with path if object ID Type of object.

not included. For Data Integration, the object can be one of the following types:
- DTEMPLATE
- MTT
- DSS
- DMASK
- DRS
- Connection
- AGENT
- AgentGroup
- MAPPLET
- BSERVICE
- HSCHEMA
- PCS
- FWCONFIG
- CustomSource
- MI_TASK
- WORKFLOW
- VISIOTEMPLATE
- SCHEDULE
- SCHEDULE_JOB
- SCHEDULE_BLACKOUT
- TASKFLOW
Object types are not case sensitive.

POST Response
Returns the object if successful or an error object if errors occur.

If successful, returns the following lookup information for each object:

Field Type Description

objects Collection Collection of objects for which lookup is requested.

id String Global identifier of the object.

path String Full path of the object including project, folder, and object name.

type String Type of object.

description String Description of the object.

createdBy String User who created the object.

updateTime String Last time the object was modified.

186 Chapter 3: REST API Version 3

POST Example
The following example shows a lookup request for eight objects:
POST <baseApiUrl>/public/core/v3/lookup HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
"objects": [{
"id" : "2iXOKghGpySlgv6ifQImyl"
}, {
"path" : "Default/Synchronization Task1",
"type" : "DSS"
}, {
"id" : "hTrrjm1kawScIm1BGEj6UV"
}, {
"path" : "My Project",
"type" : "Project"
}, {
"path" : "My Project/DSS Tasks Folder",
"type" : "Folder"
}, {
"path": "USW1R90FPZXD",
"type": "Agent"
}, {
"path": "USW1R90FPZXD",
"type": "AgentGroup"
}, {
"path": "FF_Conn_1",
"type": "Connection"
}]
}
The response includes lookup information for each object as shown in the following example:
{
"objects": [
{
"id": "2iXOKghGpySlgv6ifQImyl",
"path": "Default/Mapping1",
"type": "DTEMPLATE",
"description": "My Mapping 1",
"updateTime": "2018-04-13T20:44:37Z"
},
{
"id": "1fOqrwpFvLkimAkFFvIiwl",
"path": "Default/Synchronization Task1",
"type": "DSS",
"description": "Sync Data Task",
"updateTime": "2018-04-13T20:45:44Z"
},
{
"id": "hTrrjm1kawScIm1BGEj6UV",
"path": "My Project/Linear Taskflow1",
"type": "WORKFLOW",
"description": null,
"updateTime": "2018-04-13T20:50:31Z"
},
{
"id": "0EzsUXQ1RnkbKD6VyOukCb",
"path": "My Project",
"type": "Project",
"description": "",
"updateTime": "2018-04-13T20:40:07Z"
},
{
"id": "dRNcMcUVou5lh5kihmEAWl",
"path": "My Project/DSS Tasks Folder",
"type": "Folder",

lookup 187
 "description": "DSS Tasks",
"updateTime": "2018-04-13T20:49:17Z"
},
{
"id": "1a8moeCNtm4fh5vGcUhxOj",
"path": "USW1R90FPZXD",
"type": "AGENT",
"description": null,
"updateTime": "2018-04-12T19:01:16Z"
},
{
"id": "9iJP8TdBOMujA7eH2CTm8l",
"path": "USW1R90FPZXD",
"type": "AgentGroup",
"description": null,
"updateTime": "2018-04-12T19:01:17Z"
},
{
"id": "5VkwOw6Jd8RglXEkxDu0ya",
"path": "FF_Conn_1",
"type": "Connection",
"description": null,
"updateTime": "2018-04-12T21:34:11Z"
}
]
}

188 Chapter 3: REST API Version 3

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 Intelligent Cloud Services 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 Intelligent Cloud Services 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 Intelligent Cloud Services 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.

189
 • FL. Florida.
• 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.

190 Appendix A: REST API Codes and Supplemental Information

 • WV. West Virginia.
• 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.

REST API Codes 191

 • BG. Bulgaria.
• 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.

192 Appendix A: REST API Codes and Supplemental Information

• FI. Finland.
• 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.

REST API Codes 193

 • KZ. Kazakhstan.
• 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.

194 Appendix A: REST API Codes and Supplemental Information

• NA. Namibia.
• 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.

REST API Codes 195

 • ST. Sao Tome and Principe.
• 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.

196 Appendix A: REST API Codes and Supplemental Information

 • GB. United Kingdom.
• 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 Intelligent Cloud Services 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

REST API Codes 197

 • America/Barbados
• 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

198 Appendix A: REST API Codes and Supplemental Information

• Europe/Istanbul
• 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 199

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.

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

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 201

 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

202 Appendix A: REST API Codes and Supplemental Information

Index

A date/time format
REST API 14
activityLog
REST API resource 31
activityMonitor
REST API resource 38
E
agent error logs 31
REST API resource 41 error object
asset migration REST API 17
exporting 167 export
importing 173 REST API v3 resource 167
auditlog expressionValidation
REST API resource 45 REST API resource 80

B F
base URL 9 field
base URLs REST API resource 80
difference for REST API versions 8 fileRecord
body configuration REST API resource 83
REST API 10 format
bundleObject difference for REST API versions 8
REST API resource 47 fwConfig
bundleObjectLicense REST API resource 86
REST API resource 49

G
C guidelines
Cloud Application Integration community REST API 18
URL 6
Cloud Data Integration web site
URL 6
Cloud Developer community
H
URL 6 header configuration
connection REST API 9
REST API resource 51
connection attributes and user interface fields 201
connections
available connectors for an organization 70
I
connector 70 import
connector type data types 200 REST API v3 resource 173
connectors Informatica Cloud web site
available for an organization 51 URL 6
customFunc Informatica Global Customer Support
REST API resource 72 contact information 7

D J
Data Integration community job
URL 6 REST API resource 90
dataPreview
REST API resource 77

203
L REST API (continued)
agent resource 41
license auditlog resource to view audit entries 45
REST API v3 resource 180 body configuration 10
linear taskflows bundleObject resource to view bundle details 47
workflow resource 161 bundleObjectLicense resource 49
login codes 189
REST API resource 92, 183 connection resource 51
loginSaml customFunc resource to work with mapplets 72
REST API resource 95 dataPreview resource 77
logout date/time values 14
REST API resource 97 documentation conventions 18
REST API v3 resource 184 error object 17
logoutall expressionValidation 80
REST API resource 98 field resource 80
lookup fileRecord resource 83
REST API v3 resource 185 fwConfig resource 86
guidelines 18
header configuration 9

M job resource 90
JSON example 12
maintenance outages 7 login resource 92, 183
mapping loginSaml 95
REST API resource 98 logout resource 97
masterTemplate logoutall resource 98
REST API resource 102 mapping resource for working with mappings 98
migrating objects masterTemplate resource for working with Visio templates 102
exporting 167 mttask resource to work with mapping tasks 109
importing 173 org resource 130
mttask permission resource 134
REST API resource 109 register resource 139
resource quick reference 19
responses 17

O retrieving and using object IDs 15

return lists 11
object configuration runtimeEnvironment resource 144
REST API, in XML and JSON 10 schedule resource 146
object IDs serverTime resource 152
retrieving for the REST API 15 state codes 189, 191
object migration task resource to view task details 153
exporting 167 time zone codes 197
importing 173 user resource 154
org usergroup resource 158
REST API resource 130 versions 8
workflow resource for linear taskflows 161
XML example 12

P XML schema definition (XSD) 9

REST API v3
partial updates 13 export resource 167
permission import resource 173
REST API resource 134 license resource 180
logout resource 184
lookup resource 185

Q return list configuration

REST API in XML and JSON 11
quick reference runtimeEnvironment
REST API resources 19 REST API resource 144

R S
register schedule
REST API resource 139 REST API resource 146
responses serverTime
REST API 17 REST API resource 152
REST API serverURL 8
activityLog resource 31 session IDs
activityMonitor resource 38 difference for REST API versions 8

204 Index
session logs 31 upgrades 7
session status 15 user
state codes REST API resource 154
REST API 189, 191 usergroup
status REST API resource 158
Informatica cloud services 7
system status 7

V
T Visio templates 102

task
REST API resource 153
time zone codes
W
REST API 197 workflow
trust site REST API resource 161
description 7
@type
use with JSON REST API 10
X
XML schema definition (XSD)

U REST API 9

update modes 13

Index 205