Powercenter IC Develop guide

Informatica Cloud (Spring 2012)

Developer Guide

Informatica Cloud Developer Guide

Spring 2012

Copyright (c) 2007-2012 Informatica. All rights reserved.

This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use anddisclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. 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 Corporation. This Software may be protected by U.S. and/or internationalPatents and other Patents Pending.

Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided inDFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013©(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable.

The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us inwriting.

Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange,PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica OnDemand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and InformaticaMaster Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other companyand 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, including without limitation: Copyright DataDirect Technologies. All rightsreserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rightsreserved.Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © MetaIntegration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems Incorporated. Allrights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All rights reserved.Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights reserved. Copyright ©Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights reserved. Copyright © InformationBuilders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rightsreserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ej-technologies GmbH. All rights reserved. Copyright © JaspersoftCorporation. All rights reserved. Copyright © is International Business Machines Corporation. All rights reserved. Copyright © yWorks GmbH. All rights reserved. Copyright ©1998-2003 Daniel Veillard. All rights reserved. Copyright © 2001-2004 Unicode, Inc.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and other software which is licensed under the Apache License,Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing,software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See theLicense for the specific language governing permissions and limitations under the License.

This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software copyright ©1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under the GNU Lesser General Public License Agreement, which may be found at http://www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but notlimited to the implied warranties of merchantability and fitness for a particular purpose.

The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine,and Vanderbilt University, Copyright (©) 1993-2006, all rights reserved.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution ofthis software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html.

This product includes Curl software which is Copyright 1996-2007, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding thissoftware are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or withoutfee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

The product includes software copyright 2001-2005 (©) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms availableat http://www.dom4j.org/license.html.

The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to termsavailable at http://dojotoolkit.org/license.

This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding thissoftware are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html.

This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at http://www.gnu.org/software/kawa/Software-License.html.

This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & WirelessDeutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.

This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are subjectto terms available at http://www.boost.org/LICENSE_1_0.txt.

This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at http://www.pcre.org/license.txt.

This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to termsavailable at http://www.eclipse.org/org/documents/epl-v10.php.

This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http://www.stlport.org/doc/license.html, http://www.asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html, http://httpunit.sourceforge.net/doc/license.html, http://jung.sourceforge.net/license.txt, http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/license.html, http://www.libssh2.org,http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/license-agreements/fuse-message-broker-v-5-3- license-agreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html; http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt. http://jotm.objectweb.org/bsd_license.html; . http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://developer.apple.com/library/mac/#samplecode/HelpHook/Listings/HelpHook_java.html; http://www.jcraft.com/jsch/LICENSE.txt; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http://forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http://www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, http://www.slf4j.org/license.html;http://www.iodbc.org/dataspace/iodbc/wiki/iODBC/License; http://www.keplerproject.org/md5/license.html, http://www.opensource.apple.com/source/awk/awk-2/awk.h, http://www.arglist.com/regex/COPYRIGHT, http://atl-svn.assembla.com/svn/wp_sideprj/FSPWebDav/CVTUTF.C, and http://www.cs.toronto.edu/pub/regexp.README .

This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and DistributionLicense (http://www.opensource.org/licenses/cddl1.php) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code LicenseAgreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php) the MIT License (http://www.opensource.org/licenses/mit-license.php) and the Artistic License (http://www.opensource.org/licenses/artistic-license-1.0).

This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this softwareare subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab. For furtherinformation please visit http://www.extreme.indiana.edu/.

This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775;6,640,226; 6,789,096; 6,820,077; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,243,110, 7,254,590; 7,281,001; 7,421,458; 7,496,588; 7,523,121; 7,584,422,7,720,842; 7,721,270; and 7,774,791, international Patents and other Patents Pending.

DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the impliedwarranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. Theinformation provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation issubject to change at any time without notice.

NOTICES

This Informatica product (the “Software”) includes certain drivers (the “DataDirect Drivers”) from DataDirect Technologies, an operating company of Progress SoftwareCorporation (“DataDirect”) which are subject to the following terms and conditions:

1.THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.

2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT,INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OFTHE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACHOF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.

Part Number: ICS-DVG-12000-0001

Table of Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiInformatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Cloud Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Cloud Community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Cloud Trust Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Chapter 1: Informatica Cloud Toolkit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Informatica Cloud Toolkit Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Sample Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Development Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Best Practices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Informatica Cloud Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Informatica Cloud Toolkit Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

IPlugin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

IRegistrationInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

IMetadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

ITypeSystem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

IConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

IDataOperation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

IRead. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

IWrite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2: Informatica Cloud REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Informatica Cloud REST API Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

REST API Response Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

XML Schema Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

API Test Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

REST API Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Response Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Resource Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

activitylog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

activitymonitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table of Contents i

dnbbatch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

dnbworkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

org. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

runjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

salesforceversion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

servertime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

ii Table of Contents

PrefaceWelcome to Informatica Cloud, Informatica’s hosted data services. Informatica Cloud uses functionality fromPowerCenter and Informatica Data Quality to provide easy-to-use, web-based data services.

The Informatica Cloud User Guide explains how organization administrators and business users can useInformatica Cloud Services to perform tasks.

Informatica Resources

Informatica DocumentationThe Informatica Documentation team takes every effort to create accurate, usable documentation. If you havequestions, comments, or ideas about this documentation, contact the Informatica Documentation team throughemail at [email protected]. We will use your feedback to improve our documentation. Let usknow if we can contact you regarding your comments.

The Documentation team updates documentation as needed. To get the latest documentation for your product,navigate to Product Documentation from http://mysupport.informatica.com.

Informatica Web SiteYou can access the Informatica corporate web site at http://www.informatica.com. The site contains informationabout Informatica, its background, upcoming events, and sales offices. You will also find product and partnerinformation. The services area of the site includes important information about technical support, training andeducation, and implementation services.

Informatica Cloud Web SiteYou can access the Informatica Cloud web site at http://www.informaticacloud.com. This site contains informationabout Informatica Cloud editions and services. It also provides information about partners, customers, andupcoming events.

Informatica Cloud CommunityYou can access the Informatica Cloud Community at https://community.informatica.com/community/products/informatica_cloud.

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

iii

mailto:[email protected]

http://mysupport.informatica.com

http://www.informatica.com

http://www.informaticacloud.com

https://community.informatica.com/community/products/informatica_cloud

Informatica Cloud Trust SiteYou can access the Informatica Cloud trust site at http://trust.informaticacloud.com. This site provides real timeinformation about Informatica Cloud system availability, current and historical data about system performance, anddetails about Informatica Cloud security policies.

Informatica Global Customer SupportTo contact Informatica Global Customer Support:

¨ Click the Support link in the Informatica Cloud application.

¨ Use the WebSupport Service. WebSupport requires a user name and password. You can request a user nameand password at http://my.informatica.com.

¨ Call 1-877-INFA-HELP (1-877-463-2435).

iv Preface

http://trust.informaticacloud.com

http://my.informatica.com

C H A P T E R 1

Informatica Cloud ToolkitThis chapter includes the following topics:

¨ Informatica Cloud Toolkit Overview, 1

¨ Development Process, 2

¨ Informatica Cloud Architecture, 2

¨ Informatica Cloud Toolkit Architecture, 4

¨ IPlugin, 4

¨ IRegistrationInfo, 5

¨ IMetadata, 6

¨ ITypeSystem, 6

¨ IConnection, 7

¨ IDataOperation, 7

Informatica Cloud Toolkit OverviewThe Informatica Cloud Toolkit provides a set of application programming interface (API) components that allowsyou to extend the capability of Informatica Cloud.

With the Informatica Cloud Toolkit, you can develop Informatica Cloud Connectors to read from or write toendpoints that are not yet natively supported in Informatica Cloud. A connector can include the followingfunctionality:

¨ Read data from an endpoint. You can develop a connector to read data as a source or lookup.

¨ Write data to an endpoint. You can develop a connector to write data to a target.

When you import an Informatica Cloud Connector to an organization, the endpoint accessed by the connectordisplays as a connection type in the Informatica Cloud application. An Informatica Cloud user can then createconnections for the connection type and use the connections in data synchronization tasks. For the user, theInformatica Cloud Connector displays and performs like a native Informatica Cloud connection type.

Before you use the Informatica Cloud Toolkit to create an Informatica Cloud Connector, you must have knowledgeof Java, the endpoint that you want to use, and object-oriented programming.

Sample ProjectThe Informatica Cloud Toolkit provides a sample project that builds a sample connector. You can use the sampleproject as a guide to using the Informatica Cloud Toolkit and as a template for your Informatica Cloud Connector.

1

The sample connector connects to a sample application that can serve as a host application for testing. Thesample application includes records and sample data.

To use the sample project and application, import the sample project to Eclipse and deploy the sample applicationto the Google App Engine.

Development ProcessTo create an Informatica Cloud Connector, use the following process:

1. Use the Informatica Cloud Toolkit to create the Informatica Cloud Connector.

2. Perform unit testing.

Correct any known errors before continuing to the next step.

3. Contact Informatica to upload the connector for testing.

Informatica deploys the connector to a development organization in the development instance and creates auser account for you. Once deployed, the connector is pushed to every Secure Agent in the organization.

4. Test the connector.

After the connector is deployed in the test organization, you can test the connector by creating connectionsand using them in data synchronization tasks.

The connector is pushed to Secure Agents as two files. You can replace these files on a local Secure Agentto test updates and changes.

5. Contact Informatica for certification and deployment.

Contact Informatica when development is complete. After the Informatica Cloud Team tests and certifies theconnector, the connector can be deployed to Informatica Cloud.

Best Practices

¨ Implement a Java unit testing framework to validate method implementation. This can help debug and fix mostissues in isolated mode. It is easier to fix issues before deploying the connector to the test organization.

¨ Assign a unique UUID for each connector. Use the same UUID in each version and update of the connector.Informatica Cloud uses the UUID to identify the connector, and internal registration entries are created andmaintained based on the UUID.

Informatica Cloud ArchitectureBefore you create an Informatica Cloud Connector with the Informatica Cloud Toolkit, you should understand thebasic Informatica Cloud architecture.

2 Chapter 1: Informatica Cloud Toolkit

1. Informatica Cloud Secure Agent. A component of Informatica Cloud installed on a local machine that runs alltasks and provides firewall access between external data sources and your organization.The Secure Agent is installed on a local machine with a web browser and internet access. Secure Agentmachines require access to the Informatica Cloud repository as well as the sources and targets that you wantto use.

When the Secure Agent runs a task, it connects to the Informatica Cloud repository to access task details,connects directly and securely to sources and targets, transfers data between sources and targets, andperforms any additional task requirements.

An organization can use unlimited Secure Agents to run jobs.

When selected for use in an organization, Informatica Cloud Connectors are deployed to all Secure Agents inthe organization.

2. Informatica Cloud repository. Securely stores organization and task metadata, and any additional metadatacreated by users in the organization, at the Informatica Cloud hosting facility.

3. External and internal endpoints. The source and target systems that you want to access. You can connectnatively to the endpoints that Informatica Cloud supports. Or, you can use Informatica Cloud Connectors toconnect to endpoints that are not yet supported.

Informatica Cloud Architecture 3

Informatica Cloud Toolkit ArchitectureThe Informatica Cloud Toolkit provides the framework to develop connectors for Informatica Cloud. TheInformatica Cloud Toolkit uses the following high-level interfaces:

¨ IPlugin. Top level interface.

- IRegistrationInfo. Defines connector metadata.

- IMetadata. Retrieves metadata from the endpoint.

- ITypeSystem. Retrieves datatypes from the endpoint and their mappings to Java datatypes.

- IConnection. Defines connection actions and properties.

- IDataOperation. Defines data operation information used by the IRead and IWrite interfaces.

- IRead. Defines how to read data from the endpoint.

- IWrite. Defines how to write data to the endpoint.

IPluginThe top-level interface, IPlugin, provides a starting point for connector development. IPlugin calls objects createdby high-level interfaces, such as IConnection and IMetadata, and defines connector-level details, such as errorlogging.

The following table describes the methods that you can use with the IPlugin interface:

Method Description

getConnection Returns an object that implements the IConnection interface.IConnection defines how to connect to the endpoint.

getMetadata Returns an object that implements the IMetadata interface.IMetadata retrieves endpoint metadata.

getReader Returns an object that implements the IRead interface.Uses the IConnection interface to identify the connection touse for the read.

getRegistrationInfo Returns an connector metadata as defined by theIRegistrationInterface.

getWriter Returns an object that implements the IWrite interface.Uses the IConnection interface to identify the connection touse for the write.

getVersion Class Returns the connector version as defined by thePluginVersion class.The connector version uses the following format:<major release>.<minor release>.<build number>.For example: 1.3.11.


Method Description

setContext Method Defines the context of the connector. The context can be reador write.

setLogger Method Configures error logging. You can configure the logging levelsand the messages that you want to use.You can create error, warning, or informational messages.Messages can include a prefix and code, as well as messagetext.Messages are written to the session log for the job.

IRegistrationInfoThe registration interface, IRegistrationInfo, allows you to specify static connector metadata. Connector metadatais critical information used internally by the Informatica Cloud Toolkit.

The following table describes the methods that you can use with the IRegistrationInfo interface:

Method Description

getConnectionAttributes Returns a list of all connection attributes as defined by theConnectionAttribute class.

getFieldAttributes Returns static field attribute information about the endpoint asdefined by the FieldAttribute class.Assumes field attributes are valid for all fields, not specific toa single field.

getName Returns the name of the connector endpoint.The name can include chararacters and spaces.

getPluginDescription Returns the description for the connector.

getPluginShortName Returns the connector short name.The short name should not include characters or spaces.

getPluginUUID Returns the unique identifier (UUID) of the connector.

getReadOperationAttributes Returns the design-time and runtime attributes of the readoperation as defined by the RecordAttribute class.

getRecordAttributes Returns static record attributes as defined by theRecordAttribute class.Assumes record attributes are valid for all records accessedby the connector, not specific to a single record.

getTransformationAttributes Note: This method is not supported with this release.

getTransformationOperations Note: This method is not supported with this release.

IRegistrationInfo 5

Method Description

getTypeSystem Returns the endpoint system datatypes and the mapping toJava datatypes as defined by the ITypeSystem class.

getWriteOperationAttributes Returns the design-time and runtime attributes of the writeoperation as defined by the RecordAttribute class.

IMetadataThe metadata access interface, IMetadata, retrieves information about the endpoint that you want to use. WithIMetadata, you can implement metadata access from the endpoint using a native API, such as a WSAPI or anyJava API.

The following table describes the methods that you can use with the IMetadata interface:

Method Description

filterRecords Returns data based on search criteria passed as a regexpattern.

getAllRecords Returns the names of all records in the endpoint.

getContainedRecords Note: This method is not supported with this release.

getDataPreview Returns a snapshot of data for the record.The data preview is limited by the pageSize argument.

getFields Returns all fields in a record.

getFieldsForTransformation Note: This method is not supported with this release.

getRecordAttributeValue Returns the design-time attributes of a record.

getRelatedRecords Note: This method is not supported with this release.

ITypeSystemThe datatype interface, ITypeSystem, returns datatypes from the endpoint and their mappings to Java datatypes.

The following table describes the methods that you can use with the ITypeSystem interface:

Method Description

getNativeDataTypes Returns the datatypes used in the endpoint.


Method Description

Datatypes should be modeled using the DataType class.

getDatatypeMapping Returns a mapping of endpoint datatypes to Java datatypes.When modeling fields using the Field class, the Java datatypein the Field object must be one of the Java datatypes listed forthe native datatype in this mapping.

IConnectionThe connection interface, IConnection, defines connection actions and properties.

The following table describes the methods that you can use with the IConnection interface:

Method Description

connect Connects to the endpoint system.

disconnect Disconnects from the endpoint system.

setConnectionAttributes Defines connection properties, such as user name, password,and application URL.

validate Note: This method is not supported with this release.

IDataOperationThe data operation interface, IDataOperation, defines data operation information used by the IRead and IWriteinterfaces.

The following table describes the methods that you can use with the IDataOperation interface:

Method Description

initializeAndValidate Intializes and validates runtime implementation.

setMetadataVersion Defines the metadata version used at the time of the creationof the task.

setOperationAttributes Defines the runtime attributes for data operation, such asfilters.

setPrimaryRecord Defines the primary record to be used in the read or writeoperation.

setRecordAttribute Defines the record attributes.

IConnection 7

Method Description

Note: This method is not supported with this release.

setSecondaryRecord Defines the secondary or related records to be used in theread or write operation.Note: This method is not supported with this release.

IReadThe read interface, IRead, is an extension of the IDataOperation interface. IRead allows you to read data nativelyfrom the endpoint.

When you configure the read method, list fields in the same order returned by the setFieldList method. TheInformatica Cloud application determines the field order based on the source field order and the field mappingsconfigured in the task.

The following table describes the methods that you can use with the IRead interface:

Method Description

read Reads data from the endpoint natively and sends it to theIOutputDataBuffer interface row by row.List fields in the same order returned by the setFieldListmethod.Convert data to the appropriate Java datatype for the field.

setAdvancedFilters Defines the advanced filters to be used in the read.

setFieldList Defines the fields to be used in the read.List fields in the same order returned by the Informatica Cloudapplication.

setFilters Deflines the list of filters to be used in the read.

IWriteThe write interface, IWrite, is an extension of the IDataOperation interface. IWrite allows you to write data nativelyto the endpoint.

When you configure the insert, update, upsert, and delete methods, list fields in the same order returned by thesetFieldList method. The Informatica Cloud application determines the field order based on the target field order.

The following table describes the methods that you can use with the IWrite interface:

Method Description

delete Obtains data from the IInputDataBuffer interface and deletesit from the target.


Method Description

List fields in the same order returned by the setFieldListmethod.

insert Obtains data from the IInputDataBuffer interface and inserts itto the target.List fields in the same order returned by the setFieldListmethod.

setFieldList Defines the fields to be used in the write.

update Obtains data from the IInputDataBuffer interface and updatesit in the target.List fields in the same order returned by the setFieldListmethod.

upsert Obtains data from the IInputDataBuffer interface. Inserts newdata to the target and updates existing data in the target.List fields in the same order returned by the setFieldListmethod.

IDataOperation 9

C H A P T E R 2

Informatica Cloud REST APIThis chapter includes the following topics:

¨ Informatica Cloud REST API Overview, 10

¨ Documentation Conventions, 12

¨ REST API Guidelines, 12

¨ Response Codes, 14

¨ Resource Quick Reference, 15

¨ activitylog, 18

¨ activitymonitor, 20

¨ agent, 22

¨ connection, 23

¨ dnbbatch, 39

¨ dnbworkflow, 41

¨ login, 45

¨ org, 46

¨ register, 49

¨ runjob, 53

¨ salesforceversion, 55

¨ schedule, 55

¨ servertime, 62

¨ user, 63

Informatica Cloud REST API OverviewThe Informatica Cloud REST API allows you to access information from your Informatica Cloud organization. Youcan also perform tasks such as create, update, and delete connections and schedules, start and monitor tasks andtask flows, and verify the Salesforce API version.

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

To perform a task using the Informatica Cloud REST API, use the appropriate resource and method, along withthe applicable parameters. Informatica Cloud returns the requested information, performs the requested task, orreturns a response code and related messages.

10

The Informatica Cloud REST API provides the following resources:

¨ activitylog. Returns job details from the Informatica Cloud activity log.

¨ activitymonitor. Returns job details from the Informatica Cloud activity monitor.

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

¨ connection. Returns the details of a connection or the details of all connections in the organization. Creates orupdates a connection. Also deletes a connection.

¨ dnbbatch. Returns or updates the definition of a D&B360 batch.This resource is being depreciated. For similar and expanded functionality, use the dnbworkflow resource.(Available for Informatica Cloud D&B360 partners only.)

¨ dnbworkflow. Returns the details of a D&B360 workflow or the details of all D&B360 workflows in theorganization. Creates or updates a D&B360 workflow. Also deletes a D&B360 workflow. (Available forInformatica Cloud D&B360 partners only.)

¨ login. Creates an Informatica Cloud REST API session.

¨ org. Returns or updates the details of an Informatica Cloud organization. Also deletes an Informatica Cloudsub-organization.

¨ register. Creates an Informatica Cloud organization. (Available for Informatica Cloud partners only.)

¨ runjob. Starts a task or task flow.

¨ salesforceversion. Returns the Salesforce version used by Informatica Cloud.

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

¨ servertime. Returns the local time of the Informatica Cloud server.

¨ user. Returns the details of a user account or the details of all user accounts in the organization. Creates orupdates a user account. Also deletes a user account.

REST API Response FormatsThe Informatica Cloud REST API supports responses in JSON and XML. By default, responses are in XML.

The following code is a sample response in XML:

<?xml version="1.0" encoding="utf-8" ?> <LoginResponse> <errorCode>NO_ERROR</errorCode> <errorMsg /> <sessionId>bZTxMxokc877HFBSlA1+bu1Gs/HcQB3pgKJ/pRWFwCJEXIGBp0IYhaenAzFAm6xH</sessionId> </LoginResponse>

The following code is the same response in JSON:

{"errorCode":"NO_ERROR", "errorMsg":"","sessionId":"9U0aBR7uP3s1DfWjwvgwS5ly1ujsawDHezvBG4O36zphh3alMp0v0VtyhDd1r2ll"}

XML Schema DefinitionYou can access the Informatica Cloud API xml schema definition (XSD) at the following URL:

https://app.informaticaondemand.com/saas/api/ics_api_1.xsd

To use the XSD URL, log into Informatica Cloud, then enter the XSD URL.

Informatica Cloud REST API Overview 11

API Test PageInformatica Cloud provides a test page where you can test the resources, methods, and parameters you want touse. You can access the test page at the following URL:

https://app.informaticaondemand.com/saas/app/admin/apiTest.do

To use the test page URL, log into Informatica Cloud, then enter the test page URL.

Documentation ConventionsInformatica Cloud REST API documentation uses the following conventions:

¨ Methods are in capital letters, such as GET.

¨ Syntax descriptions use the following conventions:

- The resource name is separated from related parameters by a question mark ( ? ).

- Parameters are separated by ampersands ( & ).

- Parameter values are enclosed in angle brackets ( < > ).

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

- Optional parameters are in italics.

In the following example, the resource is runjob, the parameters are icSessionId, jobName, jobType, andresponseType. The responseType parameter is optional, and possible values for the parameter are xml or json:

runjob?icSessionId=<IC session ID>=&jobName=<task or taskflow name>&jobType=<task type>&responseType=<xml|json>

REST API GuidelinesUse the following guidelines when working with Informatica Cloud REST API:

¨ When constructing a request, configure the resource and parameters in the format you want to use forsubmission.

¨ If you do not specify a response type, Informatica Cloud returns responses in XML. To return results in JSON,set the responseType parameter to json.

¨ All resources and parameters are case sensitive.

¨ Use the following URL as the base for all resource calls:https://app.informaticaondemand.com/saas/api/1/

GET ExampleThe following code displays how you might use the activitymonitor resource to view information from the activitymonitor:

public void listActivityLog(String icSessionId, boolean details) { try { //Open connection for request URL url = new URL("https://app.informaticaondemand.com/saas/api/1/activitymonitor"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setDoOutput(true);

12 Chapter 2: Informatica Cloud REST API

OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream());

//write parameters String responseType = "XML"; StringBuilder sb = new StringBuilder(); sb.append("responseType=").append(responseType); sb.append("&icSessionId=").append(icSessionId); sb.append("&details=").append(details); writer.write(sb.toString()); writer.flush();

// Get the response StringBuffer answer = new StringBuffer(); BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream())); String line; while ((line = reader.readLine()) != null) { answer.append(line); } writer.close(); reader.close();

//Output the response System.out.println(answer.toString());

} catch (MalformedURLException ex) { ex.printStackTrace(); } catch (IOException ex) { ex.printStackTrace(); } }

POST ExampleThe following code displays how you might use the login resource to log in and generate an Informatica Cloudsession ID:

public void login(String username, String password) { try { //Open connection for request URL url = new URL("https://app.informaticaondemand.com/saas/api/1/login"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("POST"); conn.setDoOutput(true); OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream());

//write parameters String responseType = "XML"; StringBuilder sb = new StringBuilder(); sb.append("responseType=").append(responseType); sb.append("&username=").append(username); sb.append("&password=").append(password); writer.write(sb.toString()); writer.flush();

// Get the response StringBuffer answer = new StringBuffer(); BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream())); String line; while ((line = reader.readLine()) != null) { answer.append(line); } writer.close(); reader.close();

//Output the response System.out.println(answer.toString());

} catch (MalformedURLException ex) { ex.printStackTrace(); } catch (IOException ex) { ex.printStackTrace(); } }

REST API Guidelines 13

Response CodesInformatica Cloud REST API provides the following response codes:

Return Code Description

NO_ERROR The request completed without errors.

ACTIVITY_LOG_ERROR An error occurred while accessing the activity log.

ACTIVITY_MONITOR_ERROR An error occurred while accessing the activity monitor.

AGENT_ERROR An error occurred while accessing the Secure Agent.

CONNECTION_ERROR An error occurred while processing a connection.

DNB_BATCH_ERROR An error occurred while processing a D&B360 batch.

DNB_BATCH_SFLOGIN_ERROR You used an invalid Salesforce login with the dnbbatch resource.

DNB_WORKFLOW_ERROR An error occurred while processing a D&B360 workflow.

INVALID_SESSION_ID You used an invalid Informatica Cloud or Salesforce session ID.

INSUFFICIENT_PRIVILEGE You do not have the appropriate privilege to perform the request.

INSUFFICIENT_PERMISSION You do not have the appropriate permissions to perform the request.

LOGIN_AUTHENTICATION_FAILED Informatica Cloud was unable to authenticate the login. Verify that you are usingthe correct user name and password.

LOGIN_INVALID_USERNAME You entered an invalid user name.

LOGIN_INVALID_SALESFORCE_SESSION You entered an invalid Salesforce session ID.

REGISTER_DUPLICATE_USERNAME The user name you want to create is already in use.

REGISTER_ERROR An error occurred while creating an Informatica Cloud organization.

REGISTER_INVALID_OFFER_CODE You entered an invalid partner offer code.

RUN_JOB_ERROR An error occurred while starting a task or task flow.

SCHEDULE_ERROR An error occurred while processing a schedule.

USER_ERROR An error occurred while using the user resource.

UNSUPPORTED_METHOD You used a method that is not supported in this version of the Informatica CloudREST API.


Resource Quick ReferenceThe following table contains the syntax and a brief description of the Informatica Cloud REST API resources:

Resource Method Syntax Description

activitylog GET activitylog?icSessionId=<IC session ID>&rowLimit=<number of rows>&responseType=<xml|json>

Returns information from theactivity log.For more information, see “activitylog” on page 18.

activitymonitor GET activitymonitor?icSessionId=<IC session ID>&details=<true|false>&responseType=<xml|json>

Returns information from theactivity monitor.For more information, see “activitymonitor” on page 20.

agent GET agent?icSessionId=<IC session ID>&id=<Secure Agent ID>&name=<Secure Agent name>&responseType=<xml|json>

Returns the details of a SecureAgent or of all Secure Agents inthe organization.For more information, see “agent” on page 22.

connection GET connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&responseType=<xml|json>

Returns the details of aconnection or of all connectionsin the organization.For more information, see “connection” on page 23.

POST For syntax based on connection type, see “connection” on page 23.

Creates or updates a connection.

DELETE connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&responseType=<xml|json>

Deletes a connection.For more information, see “connection” on page 23.

dnbbatch

Note: Thisresource is beingdepreciated. Forsimilar andexpandedfunctionality, usethe dnbworkflowresource.

GET dnbbatch?icSessionId=<IC session ID>&responseType=<xml|json> Returns the details of a D&B360

batch.For more information, see “dnbbatch” on page 39.

POST dnbbatch?icSessionId=<IC session ID>&sfUsername=<Salesforce user name>&sfPassword=<Salesforce password>&sfSecurityToken=<Salesforce security token>&rowLimit=<row limit>&enableNewBatch=<new batch enabled>&newBatchStartTime=<new batch start time>&newBatchRepeatFrequency=<new batch repeat frequency>&newBatchRepeatInterval=<new batch repeat interval>&enableRefreshBatch=<refresh batch enabled>&refreshBatchStartTime=<refresh batch start time>&refreshBatchRepeatFrequency=<refresh batch repeat frequency>&refreshBatchRepeatInterval=<refresh batch repeat interval>&responseType=<xml|json>

Updates the details of a D&B360batch.For more information, see “dnbbatch” on page 39.

dnbworkflow GET dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow identifier>

Returns the details of a D&B360workflow or of all D&B360workflows in the organization.

Resource Quick Reference 15


&name=<workflow name>&responseType=<xml|json>

For more information, see “dnbworkflow” on page 41.

POST dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow unique identifier>&name=<workflow name>&description=<description>&connectionId=<connection ID>&connectionId2=<connection ID2>&scheduleId=<schedule ID>&rowLimit=<row limit>&partnerProfile=<partner profile>&companyCustomObject=<company custom object>&adminCustomObject=<admin custom object>&leadCustomObject=<lead custom object>&odbcUser=<ODBC user>&responseType=<xml|json>

Creates or updates a D&B360workflow.For more information, see “dnbworkflow” on page 41.

DELETE dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow unique identifier>&name=<workflow name>&responseType=<xml|json>

Deletes a D&B360 workflow.For more information, see “dnbworkflow” on page 41.

login POST login?username=<IC username>&password=<IC password>&responseType=<xml|json>

orlogin?sfSessionId=<Salesforce session ID>&sfServerUrl=<Salesforce server URL>&responseType=<xml|json>

Returns an Informatica Cloudsession ID that you can use toperform additional API calls.For more information, see “login” on page 45.

org GET org?icSessionId=<IC session ID>&id=<organization ID>&responseType=<xml|json>

Returns the details of anInformatica Cloud organization.For more information, see “org” on page 46.

POST org?icSessionId=<IC session ID>&id=<organization ID>&orgName=<organization name>&address=<org address>&address2=<additional address info>&address3=<additional address info>&city=<city>&state=<state>&zipcode=<zip code>&country=<country>&description=<org description>&email=<email address>&responseType=<xml|json>

Updates Informatica Cloudorganization details. For moreinformation, see “org” on page46.

DELETE org?icSessionId=<IC session ID>&id=<organization ID>&responseType=<xml|json>

Deletes an Informatica Cloud sub-organization. For moreinformation, see “org” on page46.

register POST register?offerCode=<offer code>&sfSessionId=<Salesforce session ID>&sfServerUrl<Salesforce URL>&responseType=<xml|json>

orregister?parentSessionID=<IC session ID to create sub-org>&offerCode=<offer code>&orgName<organization name>&firstName=<first name>&lastName=<last name>&title=<title>&email=<email address>

Creates an Informatica Cloudorganization.For more information, see “register” on page 49.



&phone=<phone number>&timeZone=<timezone>&address=<address>&city=<city>&state=<state>&zipcode=<zip code>&country=<country>&employees=<employees>&responseType=<xml|json>

runjob POST runjob?icSessionId=<IC session ID>&jobName=<task or taskflow name>&jobType=<task type>&responseType=<xml|json>

orrunjob?username=<IC user name>&password=<IC password>&jobName=<task or taskflow name>&jobType=<task type>&responseType=<xml|json>

Start a task or task flow.For more information, see “runjob” on page 53.

salesforceversion GET salesforceversion?responseType=<xml|json> Returns the Salesforce versionused by Informatica Cloud.For more information, see “salesforceversion” on page 55.

schedule GET schedule?icSessionId=<IC session ID>&id=<schedule ID>&name=<schedule name>&responseType=<xml|json>

Returns the details of a scheduleor of all schedules in theorganization.For more information, see “schedule” on page 55.

POST schedule?icSessionId=<IC session ID>&id=<schedule ID>&name=<schedule name>&description=<description>&startTime=<schedule start time>&endTime=<schedule end time>&interval=<interval>&frequency=<frequency>$rangeStartTime=<daily start time>&rangeEndTime=<daily end time>&sun=<Sunday>&mon=<Monday>&tue=<Tuesday>&wed=<Wednesday>&thu=<Thursday>&fri=<Friday>&sat=<Saturday>&weekDay=<run on weekdays>&dayOfMonth=<date of the month>&weekOfMonth=<week of the month>&dayOfWeek=<day of the week>&responseType=<xml|json>

Creates or updates a schedule.For more information, see “schedule” on page 55.

DELETE schedule?icSessionId=<IC session ID>&id=<schedule ID>&name=<schedule name>&responseType=<xml|json>

Deletes a schedule.For more information, see “schedule” on page 55.

servertime GET servertime?responseType=<xml|json> Returns the local time for theInformatica Cloud server.For more information, see “servertime” on page 62.

user GET user?icSessionId=<IC session ID>&username=<IC user name>&responseType=<xml|json>

Returns the details of anInformatica Cloud user account

Resource Quick Reference 17


or of all user accounts in theorganization.For more information, see “user” on page 63.

POST user?icSessionId=<IC session ID>&username=<IC user name>&sfUsername=<Salesforce user name>&password=<Salesforce password>&firstName=<first name>&lastName=<last name>&title=<title>&phone=<phone>&email=<email>&description=<description>&timeZone=<time zone>&responseType=<xml|json>

Creates or updates anInformatica Cloud user account.For more information, see “user” on page 63.

DELETE user?icSessionId=<IC session ID>&username=<user name>&responseType=<xml|json>

Deletes an Informatica useraccount.For more information, see “user” on page 63.

activitylogUse this resource to return information from the activity log.

GET Request Syntaxactivitylog?icSessionId=<IC session ID>&rowLimit=<number of rows>&responseType=<xml|json>

Parameter Required/Optional

Description

icSessionId Required The Informatica Cloud REST API session ID.

rowLimit Optional The maximum number of rows to return.

responseType Optional Format for the response from Informatica Cloud. Use one of the following options:- json. Returns information in JSON.- xml. Returns information in XML.By default, Informatica Cloud responds in XML.


GET Response ReturnReturns the following information from the activity log:

Element Name Description

Type Task type. Returns one of the following codes:- AVS. Contact Validation task.- DQA. Data assessment task.- DRS. Data replication task.- DSS. Data synchronization task.- PCS. PowerCenter task.- Workflow. Task flow.- DNB_Task. D&B360 task.- DNB_Workflow. D&B360 workflow.

objectName Task name.

runId ID for the task run.

startTime Start time for the task or task flow.

endTime End time for the task or task flow.

success Whether the task completed successfully. Returns one of the following codes:- true. The task completed successfully or with errors.- false. The task failed to complete.

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

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

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

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

errorMsg Error message associated with the job.

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

The following is a sample return in XML:

<?xml version="1.0" encoding="utf-8"?> <ActivityLogResponse> <errorCode>NO_ERROR</errorCode> <errorMsg></errorMsg> <entries> <ActivityLogEntry> <type>WORKFLOW</type> <objectName>task flow</objectName> <runId>1</runId> <startTime>2011-05-06T19:38:38.000Z</startTime> <endTime>2011-05-06T19:39:35.000Z</endTime> <success>1</success> <failedSourceRows>0</failedSourceRows> <successSourceRows>60</successSourceRows> <failedTargetRows>0</failedTargetRows> <successTargetRows>60</successTargetRows> <entries> <ActivityLogEntry> <type>DRS</type> <objectName>DRS</objectName> <runId>9</runId> <startTime>2011-05-06T19:38:38.000Z</startTime>

activitylog 19

<endTime>2011-05-06T19:39:16.000Z</endTime> <success>1</success> <failedSourceRows>0</failedSourceRows> <successSourceRows>26</successSourceRows> <failedTargetRows>0</failedTargetRows> <successTargetRows>26</successTargetRows> <entries> <ActivityLogEntry> <type>DRS</type> <objectName>Lead</objectName> <runId>0</runId> <startTime>2011-05-06T19:38:42.000Z</startTime> <endTime>2011-05-06T19:38:51.000Z</endTime> <success>1</success> <failedSourceRows>0</failedSourceRows> <successSourceRows>22</successSourceRows> <failedTargetRows>0</failedTargetRows> <successTargetRows>22</successTargetRows> <errorMsg>No errors encountered.</errorMsg> </ActivityLogEntry>

ExampleTo return 20 rows from the activity log, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/activitylog

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfrowLimit=20

Note that because the response type was not defined, Informatica Cloud returns the response in XML.

activitymonitorUse this resource to return information from the activity monitor.

GET Request Syntaxactivitymonitor?icSessionId=<IC session ID>&details=<true|false>&responseType=<xml|json>


Description


details Optional Activity monitor detail to be returned from Informatica Cloud. Use one of the following options:- true. Returns activity monitor information for tasks and task flows. Also returns details for

child objects, such as tasks within task flows, and the objects within data replication tasksand D&B360 workflows.

- false. Returns activity monitor information for tasks and task flows.By default, activitymonitor returns information for tasks and task flows, without additional detailsabout child objects.



GET Response ReturnThe following information about tasks and task flows from the activity monitor:


Type Task type. Returns one of the following codes:- AVS. Contact Validation task.- DQA. Data assessment task.- DRS. Data replication task.- DSS. Data synchronization task.- PCS. PowerCenter task.- Workflow. Task flow.- DNB_Task. D&B360 task.- DNB_Workflow. D&B360 workflow.

taskName Task name.

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

runId ID for the task run.

startTime Start time for the task or task flow.

endTime End time for the task or task flow.

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

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

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

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

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

errorMsg Error message associated with the job.

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

ExampleTo request information about tasks and task flows from the activity monitor, you might use the following URL andparameters:

https://app.informaticaondemand.com/saas/api/1/activitymonitor

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfdetails=false

activitymonitor 21

agentUse this resource to return the details of an Informatica Cloud Secure Agent or the details of all Secure Agents inthe organization.

GET Request SyntaxTo view the details of a Secure Agent, use the following syntax. To view the details of all Secure Agents in theorganization, omit the id and name parameters.

agent?icSessionId=<IC session ID>&id=<Secure Agent ID>&name=<Secure Agent name>&responseType=<xml|json>


Description


id Optional Secure Agent ID. To view the details of a Secure Agent, use id or name.

name Optional Secure Agent name. To view the details of a Secure Agent, use id or name.


GET Response ReturnWhen you request details of a single Secure Agent, Informatica Cloud returns the following information for theSecure Agent. When you request the details of all Secure Agents, Informatica Cloud returns the followinginformation for all Secure Agents in the organization.


id Secure Agent ID.

name Secure Agent name.

description Description of the Secure Agent.

active Whether or not the Secure Agent is Active:- true. Active.- false. Inactive.

platform Platform of the Secure Agent machine.

hostname Host name of the Secure Agent machine.

ExampleTo return details for the MyAgent Secure Agent, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/agent

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfname=MyAgent



connectionUse this resource to view the details of a connection or the details of all connections in the organization. You canalso create or update a connection, and you can delete a connection.

GET Request SyntaxTo view the details of a connection, use the following syntax. To view the details of all connections in theorganization, omit the id and name parameters.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&responseType=<xml|json>


Description


id Optional Connection ID. To view the details of a connection, use id or name.

name Optional Connection name. To view the details of a connection, use id or name.


GET Response ReturnWhen you request the details of a single connection, Informatica Cloud returns the following information for theconnection. When you request the details of all connections in the organization, Informatica Cloud returns thefollowing information for each connection.

Informatica Cloud returns the parameters relevant to the connection type.

GET Return Parameter Description

id Connection ID.

name Connection name.

description Description of the connection.

createTime Time the connection was created.

updateTime Last time the connection was updated.

createdBy User who created the connection.

updatedBy User who last updated the connection.

connection 23


type Connection type. Returns one of the following responses:- CSVFile. CSV flat file.- FTP.- NetSuite.- MSD. Microsoft Dynamics CRM.- SqlServer. Microsoft SQL Server.- SqlServer2005. Microsoft SQL Server 2005.- SqlServer2008. Microsoft SQL Server 2008.- MS_ACCESS.- 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.- WebServicesConsumer. Web Service.

username User name for the connection.

password Password for the connection.

securityToken Security token for a Salesforce connection.

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

port Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections.

database Returns the following information:- For Microsoft SQL Server and MySQL connections, returns the database name.- For Flat File connections, returns the directory.- For FTP/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.

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

instanceName Microsoft SQL Server instance name.

codepage Code page for Flat File, FTP/SFTP, Microsoft SQL Server, MySQL, MS Access, ODBC, Oracle,and SAP.

dateFormat Date format for Flat File and FTP/SFTP connections.

remoteDirectory Remote directory for FTP/SFTP connections.

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

stsUrl Security token service URL for Microsoft Dynamics CRM connections that use Active Directoryauthentication.

authenticationType Authentication type for Microsoft Dynamics CRM and Web Service connections.



accountNumber The account ID for NetSuite connections.

organizationName Organization name for Microsoft Dynamics CRM connections.

languageCode Language code for SAP IDoc Writer connections.

clientCode Client code for SAP IDoc Writer connections.

domain Domain name for Microsoft Dynamics CRM connections that use IFD or Active Directoryauthentication, and Web Service connections.

timeout Timeout for Web Service connections.

trustCertificatesFile Trust certificates file name for Web Service connections.

certificateFile Certificates file name for Web Service connections.

certificateFilePassword Certificates file password for Web Service connections.

certificateFileType Certificates file type for Web Service connections.

privateKeyFile Private key file name for Web Service connections.

privateKeyPassword Private key password for Web Service connections.

privateKeyFileType Private key file type for Web Service connections.

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

POST Request SyntaxThis section describes the syntax to create or update connections. See the connection type for details.

You can use an agent GET request to retrieve the Secure Agent ID required for some connection types. Toretrieve connection IDs, you can use a connection GET request.

When you pass both the connection ID and the connection name, the connection ID takes precedence. Forexample, if you pass a connection ID of 234 and a connection name of "MSD1", Informatica Cloud looks for aconnection with the 234 ID. If it finds it, it updates the connection name to MSD1 as well as any other parameterupdates that you pass. If it does not find the connection ID, it creates a new connection based on the parametersthat you pass.

connection 25

To create or update a CSV Flat File connection, use the following syntax.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=CSVFile&database=<directory>&dateFormat=<date format>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

CSV Flat File Parameter Required/Optional

Description


id Optional Connection ID.

name Required Connection name.

description Optional Description of the connection.

type Required Connection type. Use CSVFile.

database Required Directory where flat files are stored.

dateFormat Required Date format for date fields in the flat file. Use a valid format, such as MM/dd/yyyyHH:mm:ss.

codepage Required The code page of the system that hosts the flat file. Use one of the followingoptions:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.

agentId Required Secure Agent ID.


To create or update an FTP/SFTP connection, use the following syntax.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=<FTP|SFTP>&username=<user name>&password=<password>&host=<host name>&port=<port>&database=<local directory>&remoteDirectory=<remote dir>&dateFormat=<date format>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

FTP/SFTP Parameter Required/Optional

Description





type Required Connection type. Use FTP or SFTP.

username Required User name.


FTP/SFTP Parameter Required/Optional

Description

password Required Password.

host Required Name of the machine hosting the database server or FTP/SFTP host. For a FTP/SFTPconnection, enter the host name or IP address.

port Required Network port number used to connect to FTP/SFTP connection. Default port is 21 forFTP and 22 for SFTP.

database Required Directory on a local machine that stores the local file.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 Required 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 directories.For more information, see the FTP/SFTP server documentation.

dateFormat Required Date format for date fields in the flat file. Use a valid format, such as MM/dd/yyyyHH:mm:ss.

codepage Required The code page of the system that hosts the flat file. Use one of the following options:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update a Microsoft Dynamics CRM connection, use the following syntax.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=MSD&authenticationType=<auth type>&username<user name>&password=<password>&organizationName=<MSD org name>&domain=<domain>&serviceUrl=<service URL>&stsUrl=<sts URL>&agentId=<Secure Agent ID>&responseType=<xml|json>

Microsoft DynamicsCRM Parameter

Required/Optional

Description





type Required Connection type. Use MSD.

connection 27

Microsoft DynamicsCRM Parameter

Required/Optional

Description

authenticationType Required Authentication type for the connection. Select a valid authenticationtype. Use one of the following authentication types:- LIVE. Microsoft Live. Use for data synchronization tasks or

PowerCenter tasks.- IFD. Internet Facing Development (IFD). Use for data synchronization

tasks or PowerCenter tasks.- AD. Active Directory. Use for PowerCenter tasks only.

username Required Microsoft Dynamics CRM user name.

password Required Microsoft Dynamics CRM password.

organizationName Required Microsoft Dynamics CRM organization name.

domain OptionalRequired for IFD andActive Directoryauthentication

Microsoft Dynamics CRM domain name.IFD and Active Directory authentication only.

serviceUrl Required URL of the Microsoft Dynamics CRM service.For Microsoft Live authentication, use the following format:https:// <orgname>.crm.dynamics.comFor IFD authentication, use the following format:https://<server.company.com>:<port>For Active Directory, use the following format:http://<server.company.com>:<port>

stsUrl OptionalRequired for IFDauthentication

Microsoft Dynamics CRM security token service URL. For example,https:// sts1.company.com.IFD authentication only.

agentId OptionalRequired for ActiveDirectoryauthentication

Secure Agent ID.Active Directory authentication only.

responseType Optional Format for the response from Informatica Cloud. Use one of thefollowing options:- json. Returns information in JSON.- xml. Returns information in XML.By default, Informatica Cloud responds in XML.


To create or update a MS Access connection, use the following syntax.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=MS_ACCESS&database=<DSN>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

MS Access Parameter Required/Optional

Description





type Required Connection type. Use MS_ACCESS.

database Required Data source name.

codepage Required The code page compatible with the MS Access database. Use one of the followingoptions:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update a MySQL connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=MySQL&username=<username>&password=<password>&host=<host>&port=<port>&database=<database>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

MySQL Parameter Required/Optional

Description





type Required Connection type. Use MySQL.

username Required User name for the database login.

password Required Password for the database login.

host Required Name of the machine hosting the database server.

connection 29

MySQL Parameter Required/Optional

Description

port Required Network port number used to connect to the database server. Default is 3306.

database Required Database name for the MySQL database target. Database name is case sensitive if thedatabase is case sensitive.Maximum length is 64 characters. Valid characters are alphanumeric and underscore.

codepage Required The code page of the database server. Use one of the following options:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update a NetSuite connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=NetSuite&username=<username>&password=<password>&accountNumber=<account ID>&serviceURL=<WSDL URL>&responseType=<xml|json>

NetSuite Parameter Required/Optional

Description





type Required Connection type. Use NetSuite.

username Required NetSuite user name.

password Required NetSuite password.

accountNumber Required NetSuite account ID. To locate your account ID, log in to NetSuite and navigate toSetup > Integration > Web Services Preferences.

serviceUrl Required WSDL URL. Default WSDL URL is:https://webservices.netsuite.com/wsdl/v2010_2_0/netsuite.wsdl



To create or update an ODBC connection, use the following format:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=ODBC&username=<user name>&password=<password>&database<DSN>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

ODBC Parameter Required/Optional

Description





type Required Connection type. Use ODBC.



database Required Data source name.

schema OptionalRequired to connect toIBM DB2

Schema used for the target connection.Use uppercase letters when you specify the schema name for an Oracledatabase.Required to connect to an IBM DB2 database.

codepage Required The code page of the database server or flat file defined in the connection.Use one of the following options:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.


responseType Optional Format for the response from Informatica Cloud. Use one of the followingoptions:- json. Returns information in JSON.- xml. Returns information in XML.By default, Informatica Cloud responds in XML.

To create or update an Oracle connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=Oracle&username=<user name>&password=<password>&host=<host>&port=<port>&database=<service name>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

Oracle Parameter Required/Optional

Description



connection 31

Oracle Parameter Required/Optional

Description



type Required Connection type. Use Oracle.




port Required Network port number used to connect to the database server. Default is 1521.

database Required Service name that uniquely identifies the Oracle database. If the connection fails, contactthe database administrator.

schema Optional Schema used for the target connection.

codepage Required The code page of the database server. Select one of the following code pages:- MS Windows Latin 1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.

agentId Required Secure Agent that Informatica Cloud uses to access the database in the local areanetwork.


To create or update an Oracle CRM On Demand connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=OCOD&username=<user name>&password=<password>&serviceUrl=<service URL>&responseType=<xml|json>

Oracle CRM OnDemand Parameter

Required/Optional

Description





type Required Connection type. Use OCOD.

username Required Oracle CRM On Demand user name. Use the following format:<domain>/<user name>


Oracle CRM OnDemand Parameter

Required/Optional

Description

For example: domain/[email protected].

password Required Oracle CRM On Demand password.

serviceUrl Required URL of the Oracle CRM On Demand service. For example: https://securecompany.crmondemand.com.


To create or update a Salesforce connection, use the following syntax.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=Salesforce&username=<user name>&password=<password>&securityToken=<security token>&serviceUrl=<serviceURL>&responseType=<xml|json>

Salesforce Parameter Required/Optional

Description





type Required Connection type. Use Salesforce.

username Required User name for the Salesforce account.

password Required Password for the Salesforce account.

securityToken Optional Security token associated with the user name and password.

serviceUrl Required URL of the Salesforce service. Maximum length is 100 characters.Default service URL is:https://www.salesforce.com/services/Soap/u/22.0


To create or update an SAP IDoc Writer connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=SAP_ALE_IDoc_Writer&username=<user

connection 33

name>&password=<password>&database=<destination entry>&languageCode=<language code>&clientCode=<client code>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

SAP IDoc WriterParameter

Required/Optional

Description





type Required Connection type. Use SAP_ALE_IDoc_Writer.

username Required SAP user name with authorization on S_DATASET, S_TABU_DIS, S_PROGRAM,and B_BTCH_JOB objects.

password Required Password for the SAP user name.

database Required Type A DEST entry in saprfc.ini.

languageCode Required Language code that corresponds to the SAP language. A two-letter code, such asen for English.

clientCode Required SAP client number. A three-letter code.

codepage Required The code page compatible with the SAP target. Select one of the following codepages:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update an SAP IDoc Reader connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=SAP_ALE_IDoc_Reader&database=<destination entry>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

SAP ALE IDocReader Parameter

Required/Optional

Description






SAP ALE IDocReader Parameter

Required/Optional

Description

type Required Connection type. Use SAP_ALE_IDoc_Reader.

database Required Type R DEST entry in saprfc.ini.The Program ID for this destination entry must be the same as the Program ID for thelogical system you defined in SAP to receive IDocs or consume business content data.For business content integration, set to INFACONTNT.

codepage Required The code page compatible with the SAP source. Select one of the following codepages:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update a Microsoft SQL Server connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=<SqlServer|SqlServer2005|SqlServer2008>&username=<user name>&password=<password>&host=<host>&port=<port>&instanceName=<instance name>&database=<database>&schema=<schema>&codepage=<code page>&agentId=<Secure Agent ID>&responseType=<xml|json>

Microsoft SQLServer Parameter

Required/Optional

Description





type Required Connection type. Use one of the following codes:- SqlServer. Use for SqlServer2000.- SqlServer2005.- SqlServer2008.




port Required Network port number used to connect to the database server. Default portnumber is 1433.

connection 35

Microsoft SQLServer Parameter

Required/Optional

Description

instanceName Optional Instance name of the Microsoft SQL Server database.

database Required Database name for the Microsoft SQL Server target. Database name is casesensitive if the database is case sensitive. Maximum length is 100characters.Database names can include alphanumeric and underscore characters.

schema OptionalRequired forMicrosoft SQLServer 2005 and2008

Schema used for the target connection.Required for Microsoft SQL Server 2005 and Microsoft SQL Server 2008databases.

codepage Required The code page of the Microsoft SQL Server database. Select one of thefollowing code pages:- MS Windows Latin1. Select for ISO 8859-1 Western European data.- UTF-8. Select for Unicode data.



To create or update a Web Services connection, use the following syntax:

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&description=<description>&type=WebServicesConsumer&username=<user name>&password=<password>&domain=<domain>&serviceUrl=<endpoint URL>&timeout=<timeout>&trustCertificatesFile=<trust certificates file>&certificateFile=<certificate file>&certificateFilePassword=<certificate file password>&certificateFileType=<PEM|DER>&privateKeyFile=<private key file>&privateKeyPassword=<privateKeyPassword>&privateKeyFileType=PEM&authenticationType=<auth type>&agentId=<Secure Agent ID>&responseType=<xml|json>

Web Service Parameter Required/Optional

Description





type Required Connection type. Use WebServicesConsumer.

username Optional User name for the web service login. If the web service does not require a username, leave this field empty.



Description

password Optional Password for the web service login. If the web service does not require a username, leave this field empty.

domain Optional Domain for authentication.

serviceUrl Optional Endpoint URL for the web service that you want to access. The WSDL file specifiesthis URL in the location element.

timeout Optional Number of seconds Informatica Cloud waits for a connection to the web serviceprovider before it closes the connection and fails the session. Also, the number ofseconds the Informatica Cloud waits for a SOAP response after sending a SOAPrequest before it fails the session.Default is 60 seconds.

trustCertificatesFile Optional File containing the bundle of trusted certificates that Informatica Cloud uses whenauthenticating the SSL certificate of the web services provider. Default is ca-bundle.crt.

certificateFile Optional Client certificate that a web service provider uses when authenticating a client. Youspecify the client certificate file if the web service provider needs to authenticateInformatica Cloud.

certificateFilePassword Optional Password for the client certificate. You specify the certificate file password if theweb service provider needs to authenticate Informatica Cloud.

certificateFileType Optional File type of the client certificate. You specify the certificate file type if the webservice provider needs to authenticate the Integration Service. Use one of thefollowing codes:- PEM- DER

privateKeyFile Optional Private key file for the client certificate. You specify the private key file if the webservice provider needs to authenticate Informatica Cloud.

privateKeyPassword Optional Password for the private key of the client certificate. You specify the key passwordif the web service provider needs to authenticate Informatica Cloud.

privateKeyFileType Optional File type of the private key of the client certificate. You specify the key file type ifthe web service provider needs to authenticate Informatica Cloud.If necessary, use PEM.

authenticationType Optional Authentication type to use when the web service provider does not return anauthentication type to Informatica Cloud. Use one of the following options:- Auto. The Integration Service attempts to determine the authentication type of

the web service provider.- Basic. Based on a non-encrypted user name and password.- Digest. Based on an encrypted user name and password.- NTLM. Based on encrypted user name, password, and domain.Default is Auto.

connection 37


Description

agentId Required ID for the Secure Agent that Informatica Cloud uses to access the database in thelocal area network.


POST Response ReturnA code indicating the success or failure of the request:

¨ true. The request was successful.

¨ false. The request failed.

DELETE Request SyntaxTo delete a connection, use the following syntax. You can use a connection GET request to retrieve theconnection ID or name.

connection?icSessionId=<IC session ID>&id=<connection ID>&name=<connection name>&responseType=<xml|json>


Description


id Optional Connection ID. To delete a connection, use id or name.

name Optional Connection name. To delete a connection, use id or name.


DELETE Response ReturnA code indicating the success or failure of the request:



ExampleTo create an MSD connection that uses Microsoft Live authentication, you might use the following URL andparameters:

https://app.informaticaondemand.com/saas/api/1/connection

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfname=MSD Livetype=MSDauthenticationType=LIVEusername=user


password=passwordorganizationName=orgnameserviceURL=https://mycompany.crm.dynamics.comresponseType=JSON

dnbbatchNote: This resource is being depreciated. For similar and expanded functionality, use the dnbworkflow resource.

Use this resource to view or update the details of a D&B360 batch. For Informatica Cloud D&B360 partners only.

GET Request SyntaxTo view the details of a D&B360 batch, use the following syntax.

dnbbatch?icSessionId=<IC session ID>&responseType=<xml|json>


Description

icSessionId Required Informatica Cloud REST API session ID.


GET Response ReturnWhen you request details about the D&B360 batch, Informatica Cloud returns the following information:

Parameter Description

sfUsername Salesforce user name.

sfPassword Salesforce password.

sfSecurityToken Salesforce security token.

sfServiceUrl Salesforce URL.

rowLimit Batch row limit.

enableNewBatch Whether a new batch is enabled.

newBatchStartTime New batch start time.

newBatchRepeatFrequency New batch repeat frequency.

newBatchRepeatInterval New batch repeat interval.

enableRefreshBatch Whether a refresh batch is enabled.

dnbbatch 39


refreshBatchStartTime Refresh batch start time.

refreshBatchRepeatFrequency Refresh batch repeat frequency.

refreshBatchRepeatInterval Refresh batch repeat interval.

POST Request SyntaxTo update the details of a D&B360 batch, use the following syntax:

dnbbatch?icSessionId=<IC session ID>&sfUsername=<Salesforce user name>&sfPassword=<Salesforce password>&sfSecurityToken=<Salesforce security token>&rowLimit=<row limit>&enableNewBatch=<new batch enabled>&newBatchStartTime=<new batch start time>&newBatchRepeatFrequency=<new batch repeat frequency>&newBatchRepeatInterval=<new batch repeat interval>&enableRefreshBatch=<refresh batch enabled>&refreshBatchStartTime=<refresh batch start time>&refreshBatchRepeatFrequency=<refresh batch repeat frequency>&refreshBatchRepeatInterval=<refresh batch repeat interval>&responseType=<xml|json>


Description


sfUsername Required Salesforce user name.

sfPassword Required Salesforce password.

sfSecurityToken Optional Salesforce security token.

rowLimit Optional Batch row limit.

enableNewBatch Optional Whether a new batch is enabled.

newBatchStartTime Optional New batch start time. Required if a new batch is enabled.

newBatchRepeatFrequency Optional New batch repeat frequency. Required if a new batch is enabled.

newBatchRepeatInterval Optional New batch repeat interval. Required if a new batch is enabled.

enableRefreshBatch Optional Whether a refresh batch is enabled.

refreshBatchStartTime Optional Refresh batch start time. Required if a refresh batch is enabled.

refreshBatchRepeatFrequency Optional Refresh batch repeat frequency. Required if a refresh batch is enabled.

refreshBatchRepeatInterval Optional Refresh batch repeat interval. Required if a refresh batch is enabled.


POST Response ReturnA code that indicates the success or failure of the update.


ExampleTo view information about a D&B360 batch, you might use the following URL and parameter:

https://app.informaticaondemand.com/saas/api/1/dnbbatch

Parameter:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECf

dnbworkflowUse this resource to view the details of a D&B360 workflow or the details of all D&B360 workflows in theorganization. You can also create or update a D&B360 workflow, and you can delete a D&B360 workflow. ForInformatica Cloud D&B360 partners only.

GET Request SyntaxTo view the details of a D&B360 workflow, use the following syntax. To view details of all D&B360 workflows, omitthe id, uname, and name parameters.

dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow identifier>&name=<workflow name>&responseType=<xml|json>


Description


id Optional Workflow ID. To view the details of a D&B360 workflow, use id, uname, or name.

uname Optional Workflow unique identifier. To view the details of a D&B360 workflow, use id, uname, or name.

name Optional Workflow name. To view the details of a D&B360 workflow, use id, uname, or name.


GET Response ReturnWhen you request details of a single D&B360 workflow, Informatica Cloud returns the following information. Whenyou request the details of all D&B360 workflows in the organization, Informatica Cloud returns the followinginformation for each workflow.


id Workflow ID.

name Workflow name.

uname Workflow unique identifier.

dnbworkflow 41


description Description of the workflow.

createTime When the workflow was created.

updateTime When the workflow was last updated.

createdBy D&B360 user who created the workflow.

updatedBy D&B360 user who updated the workflow.

rowLimit Row limit for the workflow.

partnerProfile Partner profile code.

companyCustomObject Company custom object number.

adminCustomObject Admin custom object number.

leadCustomObject Lead custom object number.

odbcUser ODBC user ID.

connections Connections used in the workflow.

schedule Name of the schedule associated with the workflow.

dnbTasks An ordered list of D&B360 tasks for each workflow.

POST Request SyntaxThis section describes the syntax to create or update a D&B360 workflow.

You can use a dnbworkflow GET request to retrieve the workflow ID or other details. To retrieve connection IDs,you can use a connection GET request.

When you pass the workflow ID, name, or uname, Informatica Cloud uses the following precedence:

¨ id

¨ name

¨ uname

For example, if you pass a workflow ID of 14 and a workflow name of "SAP CRM1", Informatica Cloud looks for aworkflow with the ID of 14. If it finds it, it updates the workflow name to SAP CRM1 as well as any other parameterupdates that you pass. If it does not find the workflow ID, it creates a new workflow based on the parameters thatyou pass.

Similarly, if you pass a name of "SFDC" and a uname of "NewBatchSalesforceAccountExtract", Informatica Cloudlooks for a workflow named SFDC. If it finds it, it updates the workflow uname toNewBatchSalesforceAccountExtract. If it does not find not find the workflow name, it creates a new workflowbased on the parameters that you pass.

To create or update a D&B360 workflow, use the following syntax.

dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow unique identifier>&name=<workflow name>&description=<description>&connectionId=<connection ID>&connectionId2=<connection ID2>&scheduleId=<schedule ID>&rowLimit=<row


limit>&partnerProfile=<partner profile>&companyCustomObject=<company custom object>&adminCustomObject=<admin custom object>&leadCustomObject=<lead custom object>&odbcUser=<ODBC user>&responseType=<xml|json>


Description


id Optional Workflow ID. To update a workflow, use id, uname, or name.

uname Optional Unique identifier for the workflow. To create a workflow, use uname or name. Toupdate a workflow, use id, uname, or name.

name Optional Name of the workflow. To create a workflow, use uname or name. To update aworkflow, use id, uname, or name.

description Optional Description of the workflow.

connectionId Required Connection ID.

connectionId2 Optional Additional connection ID. Used for SAP IDoc Writer connections.

scheduleId Optional Schedule ID.

rowLimit Optional Workflow row limit.

partnerProfile Optional The partner profile used by D&B360 for the SAP CRM package, such as INFA.Contact your SAP CRM administrator for a Partner Profile code.SAP CRM D&B360 workflows only.

companyCustomObject Optional Oracle CRM On Demand Company custom object number.Enter a number between 1 - 10.To get the number, login into your Oracle CRM On Demand instance and navigate toAdmin > Application Customization > Customize Record Types. Omit the leading 0when entering the number.Oracle CRM On Demand D&B360 workflows only.

adminCustomObject Optional Oracle CRM On Demand Admin custom object number.Enter a number between 1 - 10.To get the number, login into your Oracle CRM On Demand instance and navigate toAdmin > Application Customization > Customize Record Types. Omit the leading 0when entering the number.Oracle CRM On Demand D&B360 workflows only.

leadCustomObject Optional Oracle CRM On Demand Lead custom object number.Enter a number between 1 - 10.To get the number, login into your Oracle CRM On Demand instance and navigate toAdmin > Application Customization > Customize Record Types. Omit the leading 0when entering the number.Oracle CRM On Demand D&B360 workflows only.

odbcUser Optional ODBC user ID for batch jobs that interact with Siebel CRM through an ODBC driver.The ODBC user ID is a dedicated Siebel database account that the Secure Agentuses to access Siebel database tables.

dnbworkflow 43


Description

Enter your user ROW_ID value. To get this value, run the following query on theSiebel CRM database:Select ROW_ID from S_USER where LOGIN = <Secure Agent login name>.The default value is 0-1.Siebel D&B360 workflows only.


POST Response ReturnA code that indicates the success or failure of the action.

DELETE Request SyntaxTo delete a D&B360 workflow, use the following syntax.

dnbworkflow?icSessionId=<IC session ID>&id=<workflow ID>&uname=<workflow unique identifier>&name=<workflow name>&responseType=<xml|json>


Description


id Optional Workflow ID.

uname Optional Workflow unique identifier.

name Optional Workflow name.


ExampleTo view the details of all available D&B360 workflows, you might use the following URL and parameter:

https://app.informaticaondemand.com/saas/api/1/dnbworkflow

Parameter:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECf



loginUse this resource to log in to Informatica Cloud and create an Informatica Cloud REST API session. Returns asession ID that you can use to perform additional API calls without additional login requirements. Resources usedto monitor jobs require a session ID.

POST Request SyntaxYou can log in using your Informatica Cloud user name and password. Or you can log in using a Salesforcesession ID and Salesforce server URL.

To log in using your Informatica Cloud user name and password, use the following syntax.

login?username=<IC username>&password=<IC password>&responseType=<xml|json>


Description

username Required Informatica Cloud user name.

password Required Informatica Cloud password.


You can log in using a Salesforce session ID and Salesforce server URL if you have included your Salesforce username in your Informatica Cloud user account.

Use the Salesforce Web Services API to generate a Salesforce session ID and to retrieve the Salesforce serverURL. For more information, see the login resource in the Salesforce Web Services API Developer's Guide.

To log in using a Salesforce session ID and Salesforce server URL, use the following syntax.

login?sfSessionId=<Salesforce session ID>&sfServerUrl=<Salesforce server URL>&responseType=<xml|json>


Description

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

sfServerUrl Required Salesforce server URL.You can retrieve the Salesforce server URL from the Salesforce Web Services API loginresource response.


login 45

POST Response ReturnAn Informatica Cloud REST API session ID that you can use for additional API calls, such as the following:

ijJepc5K+IIntsaNVBkGiMCDl3QBr8ruap4grRToHnyhzim2PkuP7qRX2iY1gHMY


<?xml version="1.0" encoding="utf-8"?> <LoginResponse> <errorCode>NO_ERROR</errorCode> <errorMsg></errorMsg> <sessionId>ijJepc5K+IIntsaNVBkGiMCDl3QBr8ruap4grRToHnyhzim2PkuP7qRX2iY1gHMY</sessionId> </LoginResponse>

ExampleTo create a session ID using his Informatica Cloud user name and requesting the response in JSON, John Doemight use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/login

Parameters:[email protected]=jdoepasswordresponseType=json

To create a session ID using a Salesforce session ID and Salesforce server URL, you might use the following URLand parameters:

https://app.informaticaondemand.com/saas/api/1/login

Parameters:sfSessionID=34352sfServerURL=https://na3-api.salesforce.com/services/Soap/u/22.0

orgUse this resource to view or update the details of an Informatica Cloud organization. You can also use thisresource to delete an Informatica Cloud sub-organization.

GET Request SyntaxTo view the details of an Informatica Cloud organization, use the following syntax.

org?icSessionId=<IC session ID>&id=<organization ID>&responseType=<xml|json>


Description


id Optional Organization ID.



GET Response ReturnWhen you request the details of an organization, Informatica Cloud returns the following information. If theorganization is a parent organization in an organization hierarchy, Informatica Cloud returns the IDs and names ofall sub-organizations.


id Organization ID.

parentOrgId Organization ID for the parent organization.Returns 0 if the organization is a stand-alone organization.

orgName Organization name.

address Address of organization.

address2 Additional address information for the organization.

address3 Additional address information for the organization.

city City where the organization is based.

state State where the organization is based.

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

country Country where the organization is based.

offerCode Offer code assigned to Informatica Cloud partners.

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

SubOrg: id ID of the sub-organization. For parent organizations in an organization hierarchy.

SubOrg: name Name of the sub-organization. For parent organizations in an organization hierarchy.

responseType Format for the response from Informatica Cloud. Use one of the following options:- json. Returns information in JSON.- xml. Returns information in XML.By default, Informatica Cloud responds in XML.

POST RequestYou can update an Informatica Cloud organization if the user that started the Informatica Cloud REST API sessionhas the Admin role and belongs to either the organization that you want to update or the parent organization.

When you update an Informatica Cloud organization, you cannot update the organization ID, offer code, ororganization administrator user account created with the organization.

You can use an org GET request to retrieve the organization ID for your organization or any sub-organizations.

To update the details of an Informatica Cloud organization, use the following syntax.

org?icSessionId=<IC session ID>&id=<organization ID>&orgName=<organization name>&address=<org address>&address2=<additional address info>&address3=<additional address info>&city=<city>&state=<state>&zipcode=<zip code>&country=<country>&description=<org

org 47

description>&email=<email address>&responseType=<xml|json>

Parameter Required/Optional Description


id Required Organization ID.

orgName Required Organization name.

address Optional Address of organization.

address2 Optional Additional address information for the organization.

address3 Optional Additional address information for the organization.

city Optional City where the organization is based.

state Optional State where the organization is based.

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

country Optional Country where the organization is based.

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

email Optional Default email address for success, warning, or failure notification related to jobcompletion.

responseType Format for the response from Informatica Cloud. Use one of the following options:- json. Returns information in JSON.- xml. Returns information in XML.By default, Informatica Cloud responds in XML.

POST Response ReturnWhen you update an Informatica Cloud organization, Informatica Cloud returns a code that indicates the successor failure of the request.

DELETE RequestYou can delete an Informatica Cloud sub-organization if the user that started the Informatica Cloud REST APIsession has the Admin role and belongs the parent organization.


To delete an Informatica Cloud organization, use the following syntax.

org?icSessionId=<IC session ID>&id=<organization ID>&responseType=<xml|json>


Description


id Required Organization ID.


DELETE Response ReturnWhen you delete a user account, Informatica Cloud returns a code that indicates the success or failure of therequest.

ExampleTo delete a sub-organization, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/org

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfid=Org12345

registerUse this resource to create an Informatica Cloud organization. You can use this resource to create a sub-organization if your organization has the Org Hierarchy license. For Informatica Cloud partners only.

POST Request SyntaxWhen you create an Informatica Cloud organization, you also create an organization administrator user account.To create the organization administrator user account, use one of the following:

¨ Salesforce login. The Salesforce login becomes the organization administrator user account. Use theSalesforce login to create a Salesforce session ID and pass the session ID in the register syntax. When youuse a Salesforce login, you cannot create a sub-organization.

¨ Email address and other account details. The information that you pass becomes the organizationadministrator user account. You can create a sub-organization if the user that started the Informatica CloudREST API session has the Admin role and belongs to an organization with the Org Hierarchy license.

You need an Informatica Cloud partner offer code to create an Informatica Cloud organization.

register 49

To create an Informatica Cloud organization with a Salesforce login for the user account, use the following syntax.

register?offerCode=<offer code>&sfSessionId=<Salesforce session ID>&sfServerUrl<Salesforce URL>&responseType=<xml|json>


Description

offerCode Required Offer code assigned to Informatica Cloud partners.

sfSessionId Required Salesforce session ID.The Salesforce login used to create the session ID becomes the Informatica Cloud useraccount for the organization.For information about generating the Salesforce session ID, see the login resource in theSalesforce Web Services API Developer's Guide.

sfServerUrl Required Salesforce URL.


To create an Informatica Cloud organization with an email address and user account details, use the followingsyntax. To create an Informatica Cloud sub-organization, pass the parentSessionId parameter.

register?parentSessionID=<IC Session ID to create sub-org>&offerCode=<offer code>&orgName<organization name>&firstName=<first name>&lastName=<last name>&title=<title>&email=<email address>&phone=<phone number>&timeZone=<time zone>&address=<address>&city=<city>&state=<state>&zipcode=<zip code>&country=<country>&employees=<employees>&responseType=<xml|json>


Description

parentSessionId Optional The Informatica Cloud REST API session ID. Use to create a sub-organization under yourorganization.The user who started the Informatica REST API session must have the Admin role.For organizations with the Org Hierarchy license only.

offerCode Required Offer code assigned to Informatica Cloud partners.

orgName Required Name for the new Informatica Cloud organization.

firstName Required First name of the organization administrator.

lastName Required Last name of the organization administrator.

title Optional Title of the organization administrator.

email Required Email address for the organization administrator.

phone Optional Phone number for the organization administrator.



Description

timeZone Optional Time zone of the organization administrator. Time zone honors Daylight Saving Time. Youcan use one of the following parameters:- Pacific/Apia- Pacific/Tahiti- HST- Pacific/Gambier- AST- America/Vancouver- America/Tijuana- America/Los_Angeles- America/Phoenix- America/Dawson_Creek- America/Denver- America/El_Salvador- America/Costa_Rica- America/Mexico_City- America/Chicago- America/Jamaica- America/Panama- America/Montreal- America/Havana- America/New_York- America/Barbados- America/Dominica- America/Guadeloupe- America/Puerto_Rico- America/Halifax- CNT- America/Buenos_Aires- Atlantic/South_Georgia- Atlantic/Cape_Verde- Africa/Casablanca- GMT- Europe/London- Europe/Vienna- Europe/Brussels- Europe/Zurich- Europe/Prague- Europe/Berlin- Europe/Copenhagen- Europe/Madrid- Europe/Budapest- Europe/Rome- Europe/Luxembourg- Europe/Amsterdam- Europe/Warsaw- Europe/Stockholm- Europe/Belgrade- Europe/Paris- Africa/Johannesburg- Africa/Cairo- Europe/Athens- Asia/Jerusalem- Europe/Bucharest- Europe/Istanbul- Asia/Bahrain- Africa/Nairobi

register 51


Description

- 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/Norfolk- Pacific/Fiji- Pacific/Chatham- Pacific/Enderbury- Pacific/KiritimatIf no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default.

address Optional Address where the organization is located.

city Optional City where the organization is located.

state Optional State where the organization is located.

zipcode Optional Zip code where the organization is located.

country Optional Country where the organization is located.

employees Optional Number of employees in the organization.


POST Response ReturnAn Informatica Cloud organization ID, such as the following:

Org12345


ExampleTo create an organization using an offer code and Salesforce session ID, you might use the following URL andparameters:

https://app.informaticaondemand.com/saas/api/1/register

Parameters:offerCode=35434sfSessionID=34352sfServerURL=https://www.salesforce.com/services/Soap/u/24.0

runjobUse this resource to start an Informatica Cloud task or task flow.

POST Syntaxrunjob?icSessionId=<IC session ID>&jobId=<task or taskflow ID>&jobName=<task or taskflow name>&jobType=<task type>&responseType=<xml|json>


Description


jobId Optional Task or taskflow ID. To start a task or task flow, use jobId or jobName.

jobName Optional Task or taskflow name. To start a task or task flow, use jobId or jobName.

jobType Required Type of task or taskflow. Use one of the following options:- AVS. Contact Validation task.- DQA. Data assessment task.- DRS. Data replication task.- DSS. Data synchronization task.- PCS. PowerCenter task.- Workflow. Task flow.- DNB_Task. D&B360 task.- DNB_Workflow. D&B360 workflow.


runjob 53

OR:

runjob?username=<IC user name>&password=<IC password>&jobId=<task or taskflow ID>&jobName=<task or taskflow name>&jobType=<task type>&responseType=<xml|json>


Description


password Required Informatica Cloud password.

jobId Optional Task or taskflow ID. To start a task or task flow, use jobId or jobName.

jobName Optional Task or taskflow name. To start a task or task flow, use jobId or jobName.

jobType Required Type of task or taskflow. Use one of the following options:- AVS. Contact Validation task.- DQA. Data assessment task.- DRS. Data replication task.- DSS. Data synchronization task.- PCS. PowerCenter task.- Workflow. Task flow.- DNB_Task. D&B360 task.- DNB_Workflow. D&B360 workflow.


POST Response ReturnA code indicating the success or failure of the request:



The following is a sample response in XML:

<?xml version="1.0" encoding="utf-8"?> <RunJobResponse> <errorCode>NO_ERROR</errorCode> <errorMsg></errorMsg> <success>true</success> </RunJobResponse>

ExampleTo start a data replication task called Replicate_All, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/runjob

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfjobName=Replicate_AlljobType=DRS


salesforceversionUse this resource to return the Salesforce version used by Informatica Cloud.

GET Request Syntaxsalesforceversion?responseType=<xml|json>


Description


GET Response ReturnThe Salesforce version used by Informatica Cloud.


<?xml version="1.0" encoding="utf-8"?> <SalesforceVersionResponse> <errorCode>NO_ERROR</errorCode> <errorMsg></errorMsg> <versionNo>19</versionNo> </SalesforceVersionResponse>

ExampleTo verify the Salesforce version used by Informatica Cloud, you can use the following URL:

https://app.informaticaondemand.com/saas/api/1/salesforceversion

scheduleUse this resource to view the details of a schedule or the details of all schedules in the organization. You can alsocreate or update a schedule, and you can delete a schedule.

GET Request SyntaxTo view the details of a schedule, use the following syntax. To view the details of all schedules, omit the id andname parameters.

schedule?icSessionId=<IC session ID>&id=<schedule ID>&name=<schedule name>&responseType=<xml|json>


Description


id Optional Schedule ID. To view the details of a schedule, use id or name.

salesforceversion 55


Description

name Optional Schedule name. To view the details of a schedule, use id or name.


GET Response ReturnWhen you request details of a single schedule, Informatica Cloud returns the following information. When yourequest the details of all schedules, Informatica Cloud returns the following information for each schedule.


id Schedule ID.

name Schedule name.

description Description of the schedule.

createTime Time the schedule was created.

updateTime The last time the schedule was updated.

createdBy User who created the schedule.

updatedBy User who last updated the schedule.

startTime Start time of the schedule.

endTime End time of the schedule.

interval Repeat interval for the schedule. Returns one of the following codes:- none. The schedule does not repeat.- minutely. Tasks run on an interval based on a specified number of minutes.- hourly. Tasks run on an hourly interval based on the specified number of hours, days, and time range.- daily. Tasks run daily at the configured start time.- weekly. Tasks run at the configured start time on the configured days.- monthly. Tasks run at the configured start time on the configured day of the month.

frequency Frequency that the schedule runs. Returns a numeric value that represents one of the following:- For Minutely intervals: tasks run every n minutes.- For Hourly intervals: tasks run every n hours.Minutely and Hourly intervals only.

rangeStartTime The start of the time range within a day that tasks run.Minutely and Hourly intervals only.

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



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

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

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

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

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

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

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

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

weekDay Tasks run on weekdays only. Returns one of the following codes:- true. The tasks run on weekdays.- false. The tasks run every day.Daily interval only.

weekOfMonth Week of the month that tasks run. Returns one of the following codes:- first. The tasks run in the first week of the month.- second. The tasks run in the second week of the month.- third. The tasks run in the third week of the month.- fourth. The tasks run in the fourth week of the month.- last. The tasks run in the last week of the month.Monthly interval only.

schedule 57


dayOfWeek Day of the week that tasks run. Returns one of the following codes:- day. Tasks run on the first day or last day of the month, based on the selected weekOfMonth option.- sun. The tasks run on Sunday.- mon. The tasks run on Monday.- tue. The tasks run on Tuesday.- wed. The tasks run on Wednesday.- thu. The tasks run on Thursday.- fri. The tasks run on Friday.- sat. The tasks run on Saturday.Monthly interval only.

timeZone Time zone of the user who last updated the schedule. Time zone honors Daylight Saving Time.

POST Request SyntaxThis section describes the syntax to create or update schedules.

When you pass both the schedule ID and the schedule name, the schedule ID takes precedence. For example, ifyou pass a schedule ID of 11 and a schedule name of Daily, Informatica Cloud looks for a schedule with an ID of11. If it finds it, it updates the schedule name to Daily and updates any other parameters that you pass. If it doesnot find the schedule ID, it creates a new schedule based on the parameters that you pass.

You can use a schedule GET request to retrieve the schedule name or ID.

To create or update a schedule, use the following syntax.

schedule?icSessionId=<IC session ID>&id=<schedule ID>&name=<schedule name>&description=<description>&startTime=<schedule start time>&endTime=<schedule end time>&interval=<interval>&frequency=<frequency>$rangeStartTime=<daily start time>&rangeEndTime=<daily end time>&sun=<Sunday>&mon=<Monday>&tue=<Tuesday>&wed=<Wednesday>&thu=<Thursday>&fri=<Friday>&sat=<Saturday>&weekDay=<run on weekdays>&dayOfMonth=<date of the month>&weekOfMonth=<week of the month>&dayOfWeek=<day of the week>&responseType=<xml|json>


Description


id Optional Schedule ID.

name Required Schedule name.

description Optional Description of the schedule.

startTime Required Date and time when the schedule starts running. Use the following format:YYYY-MM-DDTHH24:MI:SSZ

endTime Optional Date and time when the schedule stops running. If you do not use this parameter, theschedule runs indefinitely.Use the following format:YYYY-MM-DDTHH24:MI:SSZ



Description

interval Required Interval or repeat frequency at which the schedule runs. Use one of the following options:- None. Tasks run at the schedule start time. The schedule does not repeat.- Minutely. Tasks run on an interval based on the specified number of minutes, days, and

time range. You can use the following parameters:- frequency. Frequency in minutes that tasks run.- sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.- startTimeRange and endTimeRange. The time range within a day tasks should run.

Do not use if you want tasks to run all day.- endTime. When the schedule should stop running. Do not use if you want the

schedule to run indefinitely.- Hourly. Tasks run on an hourly interval based on the start time of the schedule. You can

use the following parameters:- frequency. Frequency in hours that tasks run.- sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.- 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 FirstMonday. Or use dayOfMonth, such as 1.Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameterwith the Day dayOfWeek parameter.

frequency Required forMinutely andHourlyIntervals

Repeat frequency for tasks. Use one of the following values:- For the Minutely interval, use one of the following options: 5, 10, 15, 20, 30, 45.- For the Hourly interval, use one of the following options: 1, 2, 3, 4, 6, 8, 12.Use with Minutely and Hourly intervals only.

rangeStartTime Optional The start of the time range within a day that you want tasks to run. Enter a date and timeusing the following format. Only the time portion is used:YYYY-MM-DDTHH24:MI:SSZUse with Minutely and Hourly intervals only.

rangeEndTime Optional The end of the time range within a day that you want tasks to run. Enter a date and timeusing the following format. Only the time portion is used:YYYY-MM-DDTHH24:MI:SSZ

schedule 59


Description

Use with Minutely and Hourly intervals only.

sun Optional Runs tasks on Sunday at the configured time. You can use the sun - sat parameters to runtasks on several days of the week.Use one of the following options:- True. Runs tasks on Sunday.- False. Does not run tasks on Sunday.Use with Minutely, Hourly, and Weekly intervals only.

mon Optional Runs tasks on Monday at the configured time. You can use the sun - sat parameters to runtasks on several days of the week.Use one of the following options:- True. Runs tasks on Monday- False. Does not run tasks on Monday.Use with Minutely, Hourly, and Weekly intervals only.

tue Optional Runs tasks on Tuesday at the configured time. You can use the sun - sat parameters torun tasks on several days of the week.Use one of the following options:- True. Runs tasks on Tuesday.- False. Does not run tasks on Tuesday.Use with Minutely, Hourly, and Weekly intervals only.

wed Optional Runs tasks on Wednesday at the configured time. You can use the sun - sat parameters torun tasks on several days of the week.Use one of the following options:- True. Runs tasks on Wednesday.- False. Does not run tasks on Wednesday.Use with Minutely, Hourly, and Weekly intervals only.

thu Optional Runs tasks on Thursday at the configured time. You can use the sun - sat parameters torun tasks on several days of the week.Use one of the following options:- True. Runs tasks on Thursday.- False. Does not run tasks on Thursday.Use with Minutely, Hourly, and Weekly intervals only.

fri Optional Runs tasks on Friday at the configured time. You can use the sun - sat parameters to runtasks on several days of the week.Use one of the following options:- True. Runs tasks on Friday.- False. Does not run tasks on Friday.Use with Minutely, Hourly, and Weekly intervals only.

sat Optional Runs tasks on Saturday at the configured time. You can use the sun - sat parameters torun tasks on several days of the week.Use one of the following options:- True. Runs tasks on Saturday.- False. Does not run tasks on Saturday.Use with Minutely, Hourly, and Weekly intervals only.



Description

weekDay Optional Runs tasks on weekdays. Use one of the following options:- True. Run tasks on Monday through Friday. Does not run tasks on the weekend.- False. Run tasks every day.Use with the Daily interval only.

dayOfMonth Optional Date of the month that tasks should run. Use a date between 1-28.Use with the Monthly interval only.Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameter withthe Day dayOfWeek parameter.

weekOfMonth Optional Week of the month that tasks should run. Use with dayOfWeek to specify the day andweek of the month that tasks should run. For example, the First Day or the LastWednesday of the month.Use one of the following options:- First- Second- Third- Fourth- LastUse with the Monthly interval only.

dayOfWeek Optional Day of the week that tasks should run. Use with weekOfMonth to specify the day and weekof the month that tasks should run. For example, the First Day or the Last Wednesday ofthe month.Use one of the following options:- Day- Sunday- Monday- Tuesday- Wednesday- Thursday- Friday- SaturdayUse with the Monthly interval only.


POST Response ReturnA code that indicates the success or failure of the request.

DELETE Request SyntaxYou can delete a schedule by using the schedule ID or schedule name. You can use a schedule GET request toretrieve the schedule name or ID.

schedule 61

To delete a schedule using the schedule ID, use the following syntax.

schedule?icSessionId=<IC session ID>&id=<schedule id>&responseType=<xml|json>


Description


id Required Schedule ID.


To delete a schedule using the schedule name, use the following syntax.

schedule?icSessionId=<IC session ID>&name=<schedule name>&responseType=<xml|json>


Description


name Required Schedule name.


DELETE Response ReturnA code that indicates the success or failure of the request.

ExampleTo view the details of a schedule named Daily, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/schedule

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfname=Daily

servertimeUse this resource to return the local time for the Informatica Cloud server.


GET Request Syntaxservertime?responseType=<xml|json>


Description


GET Return ResponseThe local time for the Informatica Cloud server.

ExampleTo verify the local time for the Informatica Cloud server, you can use the following URL:

https://app.informaticaondemand.com/saas/api/1/servertime

userUse this resource to view the details of an Informatica Cloud user account or the details of all user accounts in theorganization. You can also use this resource to create or update a user account and to delete a user account. Toensure organization security, this resource does not display or update the password for a user account.

GET Request SyntaxTo view the details of an Informatica Cloud user account, use the following syntax. To view the details of all useraccounts, omit the username parameter.

user?icSessionId=<IC session ID>&username=<IC user name>&responseType=<xml|json>


Description


username Optional Informatica Cloud user name.


user 63

GET Response ReturnWhen you request details about a user account, Informatica Cloud returns the following information. When yourequest the details of all user accounts, Informatica Cloud returns the following information for each user account.


username Informatica Cloud user name.

sfUsername Salesforce user name.

password Salesforce password.

firstName First name for the user account.

lastName Last name for the user account.

title Title of the user.

phone Phone number for the user.

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

orgId ID of the organization the user belongs to.

description Description of the user.

createTime When the user account was created.

updateTime When the user account was last updated.

createdBy Informatica Cloud user who created the user account.

updatedBy Informatica Cloud user who last updated the user account.

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

POST Request SyntaxTo create an Informatica Cloud user account or update the details of an existing account, use the following syntax.You can use a user GET request to retrieve a list of user names.

user?icSessionId=<IC session ID>&username=<IC user name>&sfUsername=<Salesforce user name>&password=<Salesforce password>&firstName=<first name>&lastName=<last name>&title=<title>&phone=<phone>&email=<email>&description=<description>&timeZone=<time zone>&responseType=<xml|json>


Description



sfUsername Optional Salesforce user name.



Description

password Optional Salesforce password.

firstName Optional First name for the user account.

lastName Optional Last name for the user account.

title Optional Title of the user.

phone Optional Phone number for the user.

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

description Optional Description of the user.

user 65


Description

timeZone Optional Time zone of the user. Time zone honors Daylight Saving Time. You can use one of thefollowing parameters:- Pacific/Apia- Pacific/Tahiti- HST- Pacific/Gambier- AST- America/Vancouver- America/Tijuana- America/Los_Angeles- America/Phoenix- America/Dawson_Creek- America/Denver- America/El_Salvador- America/Costa_Rica- America/Mexico_City- America/Chicago- America/Jamaica- America/Panama- America/Montreal- America/Havana- America/New_York- America/Barbados- America/Dominica- America/Guadeloupe- America/Puerto_Rico- America/Halifax- CNT- America/Buenos_Aires- Atlantic/South_Georgia- Atlantic/Cape_Verde- Africa/Casablanca- GMT- Europe/London- Europe/Vienna- Europe/Brussels- Europe/Zurich- Europe/Prague- Europe/Berlin- Europe/Copenhagen- Europe/Madrid- Europe/Budapest- Europe/Rome- Europe/Luxembourg- Europe/Amsterdam- Europe/Warsaw- Europe/Stockholm- Europe/Belgrade- Europe/Paris- Africa/Johannesburg- Africa/Cairo- Europe/Athens- Asia/Jerusalem- Europe/Bucharest- Europe/Istanbul- Asia/Bahrain- Africa/Nairobi



Description

- 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/Norfolk- Pacific/Fiji- Pacific/Chatham- Pacific/Enderbury- Pacific/KiritimatIf no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default.


POST Response ReturnA code that indicates the success or failure of the update.

DELETE Request SyntaxYou can delete a user account by using the user name. You can use a user GET request to retrieve a list of usernames.

user 67

To delete a user, use the following syntax.

user?icSessionId=<IC session ID>&username=<user name>&responseType=<xml|json>


Description


username Required User name.


Delete Response ReturnA code that indicates the success or failure of the request.

ExampleTo view information about the John Doe user account, you might use the following URL and parameters:

https://app.informaticaondemand.com/saas/api/1/user

Parameters:icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECfusername=jdoe@xyz.com


I N D E X

Aactivitylog

REST API resource 18activitymonitor

REST API resource 20agent

REST API resource 22API

Informatica Cloud REST API 10

Bbest practices

Informatica Cloud Toolkit 2

Cconnection

REST API resource 23

Ddnbbatch

REST API resource 39dnbworkflow


IIConnection

Informatica Cloud Toolkit connection interface 7IDataOperation

Informatica Cloud Toolkit data operation interface 7IMetadata

Informatica Cloud Toolkit metadata interface 6Informatica Cloud

REST API 10Informatica Cloud Community

URL iiiInformatica Cloud Connector

best practices 2Informatica Cloud Connectors

development process 2Informatica Cloud Toolkit

IConnection interface 7IDataOperation interface 7IMetadata interface 6interface architecture 4IPlugin interface 4IRead interface 8IRegistrationInfo 5

ITypeSystem interface 6IWrite interface 8overview 1sample project 1

Informatica Cloud web siteURL iii

Informatica Global Customer Supportcontact information iv

IPluginInformatica Cloud Toolkit top-level interface 4

IReadInformatica Cloud Toolkit read interface 8

IRegistrationInfoInformatica Cloud Toolkit registration interface 5

ITypeSystemInformatica Cloud Toolkit datatype interface 6

IWriteInformatica Cloud Toolkit write interface 8

Llogin


Oorg


Pprocess

for developing Informatica Cloud Connectors 2

Qquick reference

REST API 15

Rregister

REST API resource 49response codes

REST API 14response formats

REST API 11REST API

documentation conventions 12guidelines 12overview 10

69

quick reference 15response formats 11return codes 14test page 12XML schema definition (XSD) 11

runjobREST API resource 53

Ssalesforceversion

REST API resource 55sample project

Informatica Cloud Toolkit 1schedule

REST API resource 55servertime


Ttest page

REST API 12

trust sitedescription iv

Uuser


XXML schema definition

REST API 11XSD See XML schema definition

70 Index

Date post:	06-May-2017
Category:	Documents
Upload:	rafi617
View:	242 times
Download:	4 times

Powercenter IC Develop guide

Documents