Informatica Cloud (Winter 2013) Developer Guide

Transcription

1 Informatica Cloud (Winter 2013) Developer Guide

2 Informatica Cloud Developer Guide Winter 2013 Copyright (c) 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 and disclosure 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 international Patents 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 in DFARS (a) and (a) (1995), DFARS (1)(ii) (OCT 1988), FAR (a) (1995), FAR , or FAR (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 in writing. 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 On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and Informatica Master Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright Sun Microsystems. All rights reserved. Copyright RSA Security Inc. All Rights Reserved. Copyright Ordinal Technology Corp. All rights reserved.copyright Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright Meta Integration Technology, Inc. All rights reserved. Copyright Intalio. All rights reserved. Copyright Oracle. All rights reserved. Copyright Adobe Systems Incorporated. All rights 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 Information Builders, Inc. All rights reserved. Copyright OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright International Organization for Standardization All rights reserved. Copyright ej-technologies GmbH. All rights reserved. Copyright Jaspersoft Corporation. All rights reserved. Copyright is International Business Machines Corporation. All rights reserved. Copyright yworks GmbH. All rights reserved. Copyright Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved. Copyright Daniel Veillard. All rights reserved. Copyright Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright MicroQuill Software Publishing, Inc. All rights reserved. Copyright PassMark Software Pty Ltd. All rights reserved. Copyright LogiXML, Inc. All rights reserved. Copyright Lorenzi Davide, All rights reserved. Copyright Red Hat, Inc. All rights reserved. Copyright The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright EMC Corporation. All rights reserved. Copyright Flexera Software. All rights reserved. This product includes software developed by the Apache Software Foundation ( and other software which is licensed under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at 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 the License for the specific language governing permissions and limitations under the License. This product includes software which was developed by Mozilla ( software copyright The JBoss Group, LLC, all rights reserved; software copyright 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 The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited 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 ( ) , 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 of this software is subject to terms available at and This product includes Curl software which is Copyright , Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. The product includes software copyright ( ) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at license.html. The product includes software copyright , The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at 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 & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by Boost ( or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at / This product includes software copyright University of Cambridge. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software licensed under the terms at doc/ license.html, license.html, licenseagreement; license.html;

3 software/tcltk/license.html, iodbc/license; and This product includes software licensed under the Academic Free License ( the Common Development and Distribution License ( the Common Public License ( the Sun Binary Code License Agreement Supplemental License Terms, the BSD License ( the MIT License ( and the Artistic License ( This product includes software copyright Joe WaInes, XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by the Indiana University Extreme! Lab. For further information please visit 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 implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject 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 Software Corporation ("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 NOT LIMITED 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 OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS. Part Number: ICS-DVG

4 Table of Contents Preface.... iv Informatica Resources.... iv Informatica Documentation.... iv Informatica Web Site.... iv Informatica Cloud Web Site.... iv Informatica Cloud Communities.... iv Informatica Cloud Marketplace.... v Informatica Cloud Connector Documentation.... v Informatica Cloud Trust Site.... v Informatica Global Customer Support.... v Chapter 1: Informatica Cloud Toolkit Informatica Cloud Toolkit Overview Sample Project Development Process Best Practices Rules and Guidelines for Development Informatica Cloud Architecture Informatica Cloud Toolkit Architecture Tasks and Toolkit Interfaces IPlugin IRegistrationInfo IMetadata ITypeSystem IConnection IDataOperation IRead IWrite Chapter 2: Informatica Cloud REST API Informatica Cloud REST API Overview REST API Request and Response Formats Response Object and Codes XML Schema Definition Documentation Conventions REST API Guidelines Resource Quick Reference activitylog Table of Contents i

5 activitymonitor agent connection dnbbatch dnbworkflow login org register runjob salesforceversion schedule servertime user Chapter 3: Informatica Cloud REST API - Version Informatica Cloud REST API Version 2 Overview XML Schema Definition Header and Body Configuration Date/Time Values Object IDs REST API Responses Error Object Error Messages REST API Guidelines Documentation Conventions Resource Quick Reference activitylog activitymonitor agent connection customfunc dnbworkflow field filerecord job login mastertemplate mttask org register salesforceversion schedule servertime ii Table of Contents

6 user workflow Index Table of Contents iii

7 Preface Welcome to Informatica Cloud, Informatica s hosted applications. Informatica Cloud uses functionality from PowerCenter and Informatica Data Quality to provide easy-to-use, web-based applications. The Informatica Cloud Developer Guide explains how developers can use the Informatica Cloud Toolkit and REST API. Informatica Resources Informatica Documentation The Informatica Documentation team takes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through at [email protected]. We will use your feedback to improve our documentation. Let us know 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 Informatica Web Site You can access the Informatica corporate web site at The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services. Informatica Cloud Web Site You can access the Informatica Cloud web site at This site contains information about Informatica Cloud editions and applications. It also provides information about partners, customers, and upcoming events. Informatica Cloud Communities Use the Informatica Cloud Community to discuss and resolve technical issues in Informatica Cloud. You can also find technical tips, documentation updates, and answers to frequently asked questions. Access the Informatica Cloud Community at: iv

8 Developers can learn more and share tips at the Cloud Developer community: Informatica Cloud Marketplace You can try and buy Informatica Cloud Connectors and Informatica Cloud integration templates at the Informatica Marketplace: Informatica Cloud Connector Documentation You can access documentation for Informatica Cloud Connectors at the Informatica Cloud Community: Informatica Cloud Trust Site You can access the Informatica Cloud trust site at This site provides real time information about Informatica Cloud system availability, current and historical data about system performance, and details about Informatica Cloud security policies. Informatica Global Customer Support To contact Informatica Global Customer Support: Click the Submit Support Request icon in the Informatica Cloud application. Use the WebSupport Service. WebSupport requires a user name and password. You can request a user name and password at Call INFA-HELP ( ). Preface v

9 vi

10 C H A P T E R 1 Informatica Cloud Toolkit This chapter includes the following topics: Informatica Cloud Toolkit Overview, 1 Development Process, 2 Informatica Cloud Architecture, 3 Informatica Cloud Toolkit Architecture, 5 IPlugin, 5 IRegistrationInfo, 6 IMetadata, 7 ITypeSystem, 8 IConnection, 8 IDataOperation, 9 Informatica Cloud Toolkit Overview The Informatica Cloud Toolkit provides a set of application programming interface (API) components that allows you to extend the capability of Informatica Cloud. With the Informatica Cloud Toolkit, you can develop Informatica Cloud Connectors to read from or write to endpoints that are not yet natively supported in Informatica Cloud. A connector can include the following functionality: 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 connector displays as a connection type in the Informatica Cloud application. An Informatica Cloud user can then create connections for the connection type and use the connections in data synchronization tasks. For the user, the Informatica 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 knowledge of Java, the endpoint that you want to use, and object-oriented programming. Sample Project The Informatica Cloud Toolkit provides a sample project that builds a sample connector. You can use the sample project as a guide to using the Informatica Cloud Toolkit and as a template for your Informatica Cloud Connector. 1

11 The sample connector connects to a sample application that can serve as a host application for testing. The sample application includes records and sample data. To use the sample project and application, import the sample project to Eclipse and deploy the sample application to the Google App Engine. Development Process To 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 a user 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 connections and using them in data synchronization tasks. The connector is pushed to Secure Agents as a package. You can unzip the files on a local Secure Agent to 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 the connector, 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 most issues 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 and maintained based on the UUID. To implement logging to help with troubleshooting, use the setlogger method in the iplugin interface to call the ilogger interface. With logging enabled, runtime details are written to the session log for the job. In addition, Informatica Cloud creates a connection log each time a user selects the connection for use in a task. The connection log file is named <PluginShortName>_<connection_timestamp>.log. It is written to the following directory: <SecureAgent_InstallDirectory>/main/tomcat/log Rules and Guidelines for Development Use the following rules and guidelines when developing Informatica Cloud Connectors: Use at least one custom connection attribute when configuring an Informatica Cloud Connector. 2 Chapter 1: Informatica Cloud Toolkit

12 Connection attributes that are standard across connection types, such as user name or password, are casesensitive. Note the capitalization used for connection attributes in the Informatica Cloud Toolkit. When you define the default values for source or target fields using the setdefaultvalue method in the RecordAttribute class, note the following details: - The default value for a NUMBER datatype should be an integer. - If a default value is not defined for a multivalued attribute, the datatype of the first value is used. Informatica Cloud Architecture Before you create an Informatica Cloud Connector with the Informatica Cloud Toolkit, you should understand the basic Informatica Cloud architecture. Informatica Cloud Architecture 3

13 1. Informatica Cloud Secure Agent. A component of Informatica Cloud installed on a local machine that runs all tasks 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 Agent machines require access to the Informatica Cloud repository as well as the sources and targets that you want to 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, and performs 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 in the organization. 2. Informatica Cloud repository. Securely stores organization and task metadata, and any additional metadata created 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 connect natively to the endpoints that Informatica Cloud supports. Or, you can use Informatica Cloud Connectors to connect to endpoints that are not yet supported. 4 Chapter 1: Informatica Cloud Toolkit

14 Informatica Cloud Toolkit Architecture The Informatica Cloud Toolkit provides the framework to develop connectors for Informatica Cloud. The Informatica 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. Tasks and Toolkit Interfaces Informatica Cloud Toolkit interfaces and methods determine behavior in Informatica Cloud. To help clarify the relationship, the table describes a few examples of the Informatica Cloud Toolkit interfaces and methods that are called when you work with tasks: Cloud Interaction Create or edit connection: Test connection Select source: Browse the source object list Select target: Browse the target object list Data preview: Displays the first 50 fields of the selected source or target Field mapping: Refresh fields Run task: Extracts data from the source Run task: Performs insert/update/delete on the target Toolkit Interface IConnection > connect IMetadata > getallrecords IMetadata > getallrecords IMetadata > getdatapreview IMetadata > getfields IRead IWrite IPlugin The top-level interface, IPlugin, provides a starting point for connector development. IPlugin calls objects created by high-level interfaces, such as IConnection and IMetadata, and defines connector-level details, such as error logging. Informatica Cloud Toolkit Architecture 5

15 The following table describes the methods that you can use with the IPlugin interface: Method getconnection getmetadata getreader getregistrationinfo getwriter getversion Class setcontext Method setlogger Method Returns an object that implements the IConnection interface. IConnection defines how to connect to the endpoint. Returns an object that implements the IMetadata interface. IMetadata retrieves endpoint metadata. Returns an object that implements the IRead interface. Uses the IConnection interface to identify the connection to use for the read. Returns an connector metadata as defined by the IRegistrationInterface. Returns an object that implements the IWrite interface. Uses the IConnection interface to identify the connection to use for the write. Returns the connector version as defined by the PluginVersion class. The connector version uses the following format: <major release>.<minor release>.<build number>. For example: Defines the context of the connector. The context can be read or write. Configures error logging by calling the ilogger interface. You can configure the logging levels and 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 message text. With logging enabled, runtime details are written to the session log for the job. In addition, Informatica Cloud creates a connection log each time a user selects the connection for use in a task. The connection log file is named <PluginShortName>_<connection_timestamp>.log. It is written to the following directory: <SecureAgent_InstallDirectory>/main/tomcat/log IRegistrationInfo The registration interface, IRegistrationInfo, allows you to specify static connector metadata. Connector metadata is critical information used internally by the Informatica Cloud Toolkit. 6 Chapter 1: Informatica Cloud Toolkit

16 The following table describes the methods that you can use with the IRegistrationInfo interface: Method getconnectionattributes getfieldattributes getname getplugin getpluginshortname getpluginuuid getreadoperationattributes getrecordattributes gettransformationattributes gettransformationoperations gettypesystem getwriteoperationattributes Returns a list of all connection attributes as defined by the ConnectionAttribute class. Returns static field attribute information about the endpoint as defined by the FieldAttribute class. Assumes field attributes are valid for all fields, not specific to a single field. Returns the name of the connector endpoint. The name can include chararacters and spaces. Returns the description for the connector. Returns the connector short name. The short name should not include characters or spaces. Returns the unique identifier (UUID) of the connector. Returns the design-time and runtime attributes of the read operation as defined by the RecordAttribute class. Returns static record attributes as defined by the RecordAttribute class. Assumes record attributes are valid for all records accessed by the connector, not specific to a single record. Note: This method is not supported with this release. Note: This method is not supported with this release. Returns the endpoint system datatypes and the mapping to Java datatypes as defined by the ITypeSystem class. Returns the design-time and runtime attributes of the write operation as defined by the RecordAttribute class. IMetadata The metadata access interface, IMetadata, retrieves information about the endpoint that you want to use. With IMetadata, you can implement metadata access from the endpoint using a native API, such as a WSAPI or any Java API. IMetadata 7

17 The following table describes the methods that you can use with the IMetadata interface: Method filterrecords getallrecords getdatapreview getfields getreadopdesigntimeattribvalues getrecordattributevalue getwriteopdesigntimeattribvalues serializefiltercriteria Returns data based on search criteria passed as a regex pattern. Returns the names of all records in the endpoint. Returns a snapshot of data for the record. The data preview is limited by the pagesize argument. Returns all fields in a record. Returns refreshed fields or cached fields based on the refreshfields argument. Returns the design-time attribute values for the read operation based on the attrnames argument. Returns the design-time attributes of a record. Returns the design-time attribute values for the write operation based on the attrnames argument. Returns a string representation of the filter list. ITypeSystem The 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 getnativedatatypes getdatatypemapping Returns the datatypes used in the endpoint. Datatypes should be modeled using the DataType class. Returns a mapping of endpoint datatypes to Java datatypes. When modeling fields using the Field class, the Java datatype in the Field object must be one of the Java datatypes listed for the native datatype in this mapping. IConnection The connection interface, IConnection, defines connection actions and properties. 8 Chapter 1: Informatica Cloud Toolkit

18 The following table describes the methods that you can use with the IConnection interface: Method connect disconnect setconnectionattributes validate Connects to the endpoint system. Disconnects from the endpoint system. Defines connection properties, such as user name, password, and application URL. Note: This method is not supported with this release. IDataOperation The data operation interface, IDataOperation, defines data operation information used by the IRead and IWrite interfaces. The following table describes the methods that you can use with the IDataOperation interface: Method initializeandvalidate setchildrecords setmetadataversion setoperationattributes setprimaryrecord setrecordattribute Intializes and validates runtime implementation. Defines the list of child records for which the data operation is performed. Defines the metadata version used at the time of the creation of the task. Defines the runtime attributes for data operation, such as filters. Defines the primary record to be used in the read or write operation. Defines the record attributes. Note: This method is not supported with this release. IRead The read interface, IRead, is an extension of the IDataOperation interface. IRead allows you to read data natively from the endpoint. When you configure the read method, list fields in the same order returned by the setfieldlist method. The Informatica Cloud application determines the field order based on the source field order and the field mappings configured in the task. IDataOperation 9

19 The following table describes the methods that you can use with the IRead interface: Method read setadvancedfilters setfieldlist setfilters setrelatedrecords Reads data from the endpoint natively and sends it to the IOutputDataBuffer interface row by row. List fields in the same order returned by the setfieldlist method. Convert data to the appropriate Java datatype for the field. Defines the advanced filters to be used in the read. Defines the fields to be used in the read. List fields in the same order returned by the Informatica Cloud application. Deflines the list of filters to be used in the read. Required to ensure the interface functions as expected. Defines the list of related records for which the data operation is performed. IWrite The write interface, IWrite, is an extension of the IDataOperation interface. IWrite allows you to write data natively to the endpoint. When you configure the insert, update, upsert, and delete methods, list fields in the same order returned by the setfieldlist 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 delete insert setfieldlist update upsert Obtains data from the IInputDataBuffer interface and deletes it from the target. List fields in the same order returned by the setfieldlist method. Obtains data from the IInputDataBuffer interface and inserts it to the target. List fields in the same order returned by the setfieldlist method. Defines the fields to be used in the write. Obtains data from the IInputDataBuffer interface and updates it in the target. List fields in the same order returned by the setfieldlist method. Obtains data from the IInputDataBuffer interface. Inserts new data to the target and updates existing data in the target. List fields in the same order returned by the setfieldlist method. 10 Chapter 1: Informatica Cloud Toolkit

20 C H A P T E R 2 Informatica Cloud REST API This chapter includes the following topics: Informatica Cloud REST API Overview, 11 Documentation Conventions, 14 REST API Guidelines, 14 Resource Quick Reference, 15 activitylog, 19 activitymonitor, 21 agent, 23 connection, 24 dnbbatch, 39 dnbworkflow, 41 login, 45 org, 46 register, 49 runjob, 54 salesforceversion, 56 schedule, 56 servertime, 63 user, 64 Informatica Cloud REST API Overview The Informatica Cloud REST API allows you to access information from your Informatica Cloud organization. You can also perform tasks such as create, update, and delete connections and schedules, start and monitor tasks and task 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 REST API guidelines. To perform a task using the Informatica Cloud REST API, use the appropriate resource and method, along with the applicable parameters. Informatica Cloud returns the requested information, performs the requested task, or returns a response code and related messages. 11

21 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 or updates 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 the organization. Creates or updates a D&B360 workflow. Also deletes a D&B360 workflow. (Available for Informatica 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 Cloud sub-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 or updates 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 or updates a user account. Also deletes a user account. REST API Request and Response Formats The Informatica Cloud REST API supports requests and responses in JSON and XML. The default is JSON. Configure the format by setting HTTP header attributes. The following table describes how to configure the request and response formats: Request/Response Format Type HTTP Header Attribute Definition Request JSON Accept=application/jsn XML Response JSON Content-Type=application/jsn XML Response Object and Codes When the REST API encounters an error, it returns the following error object: <xs:complextype name="error"> <xs:sequence> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> <xs:element name="statuscode" type="xs:int"/> 12 Chapter 2: Informatica Cloud REST API

22 </xs:sequence> </xs:complextype> The error object uses the following response codes: Response Code NO_ERROR ACTIVITY_LOG_ERROR ACTIVITY_MONITOR_ERROR AGENT_ERROR CONNECTION_ERROR DNB_BATCH_ERROR DNB_BATCH_SFLOGIN_ERROR DNB_WORKFLOW_ERROR INVALID_SESSION_ID INSUFFICIENT_PRIVILEGE INSUFFICIENT_PERMISSION LOGIN_AUTHENTICATION_FAILED LOGIN_INVALID_USERNAME LOGIN_INVALID_SALESFORCE_SESSION REGISTER_DUPLICATE_USERNAME REGISTER_ERROR REGISTER_INVALID_OFFER_CODE RUN_JOB_ERROR SCHEDULE_ERROR USER_ERROR UNSUPPORTED_METHOD The request completed without errors. An error occurred while accessing the activity log. An error occurred while accessing the activity monitor. An error occurred while accessing the Secure Agent. An error occurred while processing a connection. An error occurred while processing a D&B360 batch. You used an invalid Salesforce login with the dnbbatch resource. An error occurred while processing a D&B360 workflow. You used an invalid Informatica Cloud or Salesforce session ID. You do not have the appropriate privilege to perform the request. You do not have the appropriate permissions to perform the request. Informatica Cloud was unable to authenticate the login. Verify that you are using the correct user name and password. You entered an invalid user name. You entered an invalid Salesforce session ID. The user name you want to create is already in use. An error occurred while creating an Informatica Cloud organization. You entered an invalid partner offer code. An error occurred while starting a task or task flow. An error occurred while processing a schedule. An error occurred while using the user resource. You used a method that is not supported in this version of the Informatica Cloud REST API. XML Schema Definition You can access the Informatica Cloud API xml schema definition (XSD) at the following URL: To use the XSD URL, log into Informatica Cloud, then enter the XSD URL. Informatica Cloud REST API Overview 13

23 Documentation Conventions Informatica 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 ( ). - parameters are in italics. In the following example, the resource is runjob, the parameters are icsessionid, jobname, jobtype, and responsetype. 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 Guidelines Use 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 for submission. 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: GET Example The following code displays how you might use the activitymonitor resource to view information from the activity monitor: public void listactivitymonitor(string icsessionid, boolean details) { try { //Open connection for request URL url = new URL(" HttpURLConnection conn = (HttpURLConnection) url.openconnection(); conn.setrequestmethod("get"); 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("&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())); 14 Chapter 2: Informatica Cloud REST API

24 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 Example The following code displays how you might use the login resource to log in and generate an Informatica Cloud session ID: public void login(string username, String password) { try { //Open connection for request URL url = new URL(" 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(); } } Resource Quick Reference The following table contains the syntax and a brief description of the Informatica Cloud REST API resources: Resource Method Syntax activitylog GET activitylog?icsessionid=<ic session ID> &rowlimit=<number of rows> &responsetype=<xml json> Returns information from the activity log. Resource Quick Reference 15

25 Resource Method Syntax For more information, see activitylog on page 19. activitymonitor GET activitymonitor?icsessionid=<ic session ID> &details=<true false> &responsetype=<xml json> agent GET agent?icsessionid=<ic session ID> &id=<secure Agent ID> &name=<secure Agent name> &responsetype=<xml json> connection GET connection?icsessionid=<ic session ID> &id=<connection ID> &name=<connection name> &responsetype=<xml json> Returns information from the activity monitor. For more information, see activitymonitor on page 21. Returns the details of a Secure Agent or of all Secure Agents in the organization. For more information, see agent on page 23. Returns the details of a connection or of all connections in the organization. For more information, see connection on page 24. POST For syntax based on connection type, see connection on page 24. 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 24. dnbbatch Note: This resource is being depreciated. For similar and expanded functionality, use the dnbworkflow resource. GET POST dnbbatch?icsessionid=<ic session ID> &responsetype=<xml json> 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> Returns the details of a D&B360 batch. For more information, see dnbbatch on page 39. Updates the details of a D&B360 batch. For more information, see dnbbatch on page 39. dnbworkflow GET dnbworkflow?icsessionid=<ic session ID> &id=<workflow ID> &uname=<workflow identifier> &name=<workflow name> &responsetype=<xml json> Returns the details of a D&B360 workflow or of all D&B360 workflows in the organization. For more information, see dnbworkflow on page 41. POST dnbworkflow?icsessionid=<ic session ID> &id=<workflow ID> &uname=<workflow unique identifier> Creates or updates a D&B360 workflow. 16 Chapter 2: Informatica Cloud REST API

26 Resource Method Syntax &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> 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> or login?sfsessionid=<salesforce session ID> &sfserverurl=<salesforce server URL> &responsetype=<xml json> org GET org?icsessionid=<ic session ID> &id=<organization ID> &responsetype=<xml json> Returns an Informatica Cloud session ID that you can use to perform additional API calls. For more information, see login on page 45. Returns the details of an Informatica Cloud organization. For more information, see org on page 46. POST DELETE 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> & =< address> &responsetype=<xml json> org?icsessionid=<ic session ID> &id=<organization ID> &responsetype=<xml json> Updates Informatica Cloud organization details. For more information, see org on page 46. Deletes an Informatica Cloud suborganization. For more information, see org on page 46. register POST register?offercode=<offer code> &sfsessionid=<salesforce session ID> &sfserverurl<salesforce URL> &responsetype=<xml json> or register?parentsessionid=<ic session ID to create sub-org> &offercode=<offer code> &orgname<organization name> &firstname=<first name> &lastname=<last name> &title=<title> & =< address> &phone=<phone number> &timezone=<timezone> &address=<address> &city=<city> &state=<state> &zipcode=<zip code> &country=<country> Creates an Informatica Cloud organization. For more information, see register on page 49. Resource Quick Reference 17

27 Resource Method Syntax &employees=<employees> &responsetype=<xml json> runjob POST runjob?icsessionid=<ic session ID> &jobname=<task or taskflow name> &jobtype=<task type> &responsetype=<xml json> or runjob?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 54. salesforceversion GET salesforceversion?responsetype=<xml json> Returns the Salesforce version used by Informatica Cloud. For more information, see salesforceversion on page 56. schedule GET schedule?icsessionid=<ic session ID> &id=<schedule ID> &name=<schedule name> &responsetype=<xml json> Returns the details of a schedule or of all schedules in the organization. For more information, see schedule on page 56. POST DELETE 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> schedule?icsessionid=<ic session ID> &id=<schedule ID> &name=<schedule name> &responsetype=<xml json> Creates or updates a schedule. For more information, see schedule on page 56. Deletes a schedule. For more information, see schedule on page 56. servertime GET servertime?responsetype=<xml json> Returns the local time for the Informatica Cloud server. For more information, see servertime on page 63. user GET user?icsessionid=<ic session ID> &username=<ic user name> &responsetype=<xml json> Returns the details of an Informatica Cloud user account or of all user accounts in the organization. For more information, see user on page Chapter 2: Informatica Cloud REST API

28 Resource Method Syntax POST DELETE 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> & =< > &description=<description> &timezone=<time zone> &responsetype=<xml json> user?icsessionid=<ic session ID> &username=<user name> &responsetype=<xml json> Creates or updates an Informatica Cloud user account. For more information, see user on page 64. Deletes an Informatica user account. For more information, see user on page 64. activitylog Use this resource to return information from the activity log. GET Request Syntax activitylog?icsessionid=<ic session ID>&rowLimit=<number of rows>&responsetype=<xml json> Parameter icsessionid Required The Informatica Cloud REST API session ID. rowlimit The maximum number of rows to return. 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. activitylog 19

29 GET Response Return Returns the following information from the activity log: Element Name Type objectname runid starttime endtime success failedsourcerows successsourcerows failedtargetrows successtargetrows errormsg entries 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. - MTT. Custom integration task. - Workflow. Task flow. - DNB_TASK. D&B360 task. - DNB_WORKFLOW. D&B360 workflow. Task name. ID for the task run. Start time for the task or task flow. End time for the task or task flow. 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. Number of rows that were not read from the source. Number of rows that were successfully read from the source. Number of rows that were not written to the target. Number of rows that were successfully written to the target. Error message associated with the job. Indicates the start of information for a child object. A child object might be a task within a task flow, or an object in a data replication task or D&B360 workflow. 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> t19:38:38.000z</starttime> <endtime> t19: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> 20 Chapter 2: Informatica Cloud REST API

30 Example <runid>9</runid> <starttime> t19:38:38.000z</starttime> <endtime> t19: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> t19:38:42.000z</starttime> <endtime> t19: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> To return 20 rows from the activity log, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf rowlimit=20 Note that because the response type was not defined, Informatica Cloud returns the response in XML. activitymonitor Use this resource to return information from the activity monitor. GET Request Syntax activitymonitor?icsessionid=<ic session ID>&details=<true false>&responsetype=<xml json> Parameter icsessionid Required The Informatica Cloud REST API session ID. details 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 tasks and 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 details about child objects. 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. activitymonitor 21

31 GET Response Return The following information about tasks and task flows from the activity monitor: Element Name Type taskname objectname runid starttime endtime executionstate failedsourcerows successsourcerows failedtargetrows successtargetrows errormsg entries 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. - MTT. Custom integration task. - Workflow. Task flow. - DNB_TASK. D&B360 task. - DNB_WORKFLOW. D&B360 workflow. Task name. Source object used in the task, or the data replication or D&B360 object being processed. ID for the task run. Start time for the task or task flow. End time for the task or task flow. State of the task. Returns one of the following codes: - INITIALIZED - RUNNING - STOPPING - COMPLETED - FAILED Number of rows that were not read from the source. Number of rows that were successfully read from the source. Number of rows that were not written to the target. Number of rows that were successfully written to the target. Error message associated with the job. Indicates the start of information for a child object. A child object might be a task within a task flow, or an object in a data replication task or D&B360 workflow. Example To request information about tasks and task flows from the activity monitor, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf details=false 22 Chapter 2: Informatica Cloud REST API

32 agent Use this resource to return the details of an Informatica Cloud Secure Agent or the details of all Secure Agents in the organization. GET Request Syntax To view the details of a Secure Agent, use the following syntax. To view the details of all Secure Agents in the organization, omit the id and name parameters. agent?icsessionid=<ic session ID>&id=<Secure Agent ID>&name=<Secure Agent name>&responsetype=<xml json> Parameter icsessionid Required The Informatica Cloud REST API session ID. id Secure Agent ID. To view the details of a Secure Agent, use id or name. name Secure Agent name. To view the details of a Secure Agent, use id or name. 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. GET Response Return When you request details of a single Secure Agent, Informatica Cloud returns the following information for the Secure Agent. When you request the details of all Secure Agents, Informatica Cloud returns the following information for all Secure Agents in the organization. Element Name id name description active platform hostname Secure Agent ID. Secure Agent name. of the Secure Agent. Whether or not the Secure Agent is Active: - true. Active. - false. Inactive. Platform of the Secure Agent machine. Host name of the Secure Agent machine. Example To return details for the MyAgent Secure Agent, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf name=myagent Note that because the response type was not defined, Informatica Cloud returns the response in XML. agent 23

33 connection Use this resource to view the details of a connection or the details of all connections in the organization. You can also create or update a connection, and you can delete a connection. GET Request Syntax To view the details of a connection, use the following syntax. To view the details of all connections in the organization, omit the id and name parameters. connection?icsessionid=<ic session ID>&id=<connection ID>&name=<connection name>&responsetype=<xml json> Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. To view the details of a connection, use id or name. name Connection name. To view the details of a connection, use id or name. 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. GET Response Return When you request the details of a single connection, Informatica Cloud returns the following information for the connection. When you request the details of all connections in the organization, Informatica Cloud returns the following information for each connection. Informatica Cloud returns the parameters relevant to the connection type. GET Return Parameter id name description createtime updatetime createdby updatedby Connection ID. Connection name. of the connection. Time the connection was created. Last time the connection was updated. User who created the connection. User who last updated the connection. 24 Chapter 2: Informatica Cloud REST API

34 GET Return Parameter type username password securitytoken host port database schema instancename codepage dateformat remotedirectory serviceurl stsurl authenticationtype accountnumber Connection type. Returns one of the following responses: - CSVFile. CSV flat file. - FTP. - MSD. Microsoft Dynamics CRM. - SqlServer. Microsoft SQL Server. - SqlServer2005. Microsoft SQL Server SqlServer2008. Microsoft SQL Server 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. User name for the connection. Password for the connection. Security token for a Salesforce connection. Host name for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. 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 name for Microsoft SQL Server, ODBC, Oracle, and Web Service connections. Microsoft SQL Server instance name. Code page for Flat File, FTP/SFTP, Microsoft SQL Server, MySQL, MS Access, ODBC, Oracle, and SAP. Date format for Flat File and FTP/SFTP connections. Remote directory for FTP/SFTP connections. Service URL for Microsoft Dynamics CRM, Oracle CRM On Demand, and Salesforce connections. Security token service URL for Microsoft Dynamics CRM connections that use Active Directory authentication. Authentication type for Microsoft Dynamics CRM and Web Service connections. The account ID for NetSuite connections. connection 25

35 GET Return Parameter organizationname languagecode clientcode domain timeout trustcertificatesfile certificatefile certificatefilepassword certificatefiletype privatekeyfile privatekeypassword privatekeyfiletype agent Organization name for Microsoft Dynamics CRM connections. Language code for SAP IDoc Writer connections. Client code for SAP IDoc Writer connections. Domain name for Microsoft Dynamics CRM connections that use IFD or Active Directory authentication, and Web Service connections. Timeout for Web Service connections. Trust certificates file name for Web Service connections. Certificates file name for Web Service connections. Certificates file password for Web Service connections. Certificates file type for Web Service connections. Private key file name for Web Service connections. Private key password for Web Service connections. Private key file type for Web Service connections. Secure Agent ID for Flat File, FTP/SFTP, Microsoft SQL Server, MS Access, MySQL, ODBC, Oracle, and Web Service connections. POST Request Syntax This section describes the syntax to create or update connections. See the connection type for details. You cannot use the connection resource to create or update Informatica Cloud Connector connections. You can use an agent GET request to retrieve the Secure Agent ID required for some connection types. To retrieve 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. For example, if you pass a connection ID of 234 and a connection name of "MSD1", Informatica Cloud looks for a connection with the 234 ID. If it finds it, it updates the connection name to MSD1 as well as any other parameter updates that you pass. If it does not find the connection ID, it creates a new connection based on the parameters that you pass. 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. 26 Chapter 2: Informatica Cloud REST API

36 CSV Flat File Parameter name Required Connection name. 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/yyyy HH:mm:ss. codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use FTP or SFTP. username Required User name. password Required Password. host Required Name of the machine hosting the database server or FTP/SFTP host. For a FTP/SFTP connection, enter the host name or IP address. port Required Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP and 22 for SFTP. connection 27

37 FTP/SFTP Parameter 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/yyyy HH:mm:ss. codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 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 Dynamics CRM Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use MSD. authenticationtype Required Authentication type for the connection. Select a valid authentication type. Use one of the following authentication types: - LIVE. Microsoft Live. Use for data synchronization tasks or PowerCenter tasks. - IFD. Internet Facing Development (IFD). Use for data synchronization tasks or PowerCenter tasks. - AD. Active Directory. Use for PowerCenter tasks only. username Required Microsoft Dynamics CRM user name. 28 Chapter 2: Informatica Cloud REST API

38 Microsoft Dynamics CRM Parameter password Required Microsoft Dynamics CRM password. organizationname Required Microsoft Dynamics CRM organization name. domain Required for IFD and Active Directory authentication 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: <orgname>.crm.dynamics.com For IFD authentication, use the following format: For Active Directory, use the following format: stsurl agentid Required for IFD authentication Required for Active Directory authentication Microsoft Dynamics CRM security token service URL. For example, sts1.company.com. IFD authentication only. Secure Agent ID. Active Directory authentication only. 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. 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use MS_ACCESS. connection 29

39 MS Access Parameter database Required Data source name. codepage Required The code page compatible with the MS Access database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 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=<po rt>&database=<database>&codepage=<code page>&agentid=<secure Agent ID>&responseType=<xml json> MySQL Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. 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. port Required Network port number used to connect to the database server. Default is database Required Database name for the MySQL database target. Database name is case sensitive if the database 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: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. 30 Chapter 2: Informatica Cloud REST API

40 MySQL Parameter agentid Required Secure Agent ID. 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. 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use ODBC. username Required User name for the database login. password Required Password for the database login. database Required Data source name. schema Required to connect to IBM DB2 Schema used for the target connection. Use uppercase letters when you specify the schema name for an Oracle database. Required to connect to an IBM DB2 database. codepage Required The code page of the database server or flat file defined in the connection. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. connection 31

41 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use Oracle. 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. port Required Network port number used to connect to the database server. Default is database Required Service name that uniquely identifies the Oracle database. If the connection fails, contact the database administrator. schema Schema used for the target connection. codepage Required The code page of the database server. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent that Informatica Cloud uses to access the database in the local area network. 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. 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 On Demand Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. 32 Chapter 2: Informatica Cloud REST API

42 Oracle CRM On Demand Parameter name Required Connection name. description of the connection. type Required Connection type. Use OCOD. username Required Oracle CRM On Demand user name. Use the following format: <domain>/<user name> For example: password Required Oracle CRM On Demand password. serviceurl Required URL of the Oracle CRM On Demand service. For example: securecompany.crmondemand.com. 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. 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 icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use Salesforce. username Required User name for the Salesforce account. password Required Password for the Salesforce account. securitytoken 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: connection 33

43 Salesforce Parameter 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. 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 name>&password=<password>&database=<destination entry>&languagecode=<language code>&clientcode=<client code>&codepage=<code page>&agentid=<secure Agent ID>&responseType=<xml json> SAP IDoc Writer Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. 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 as en for English. clientcode Required SAP client number. A three-letter code. codepage Required The code page compatible with the SAP target. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 34 Chapter 2: Informatica Cloud REST API

44 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 IDoc Reader Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. 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 the logical 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. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 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 SQL Server Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. connection 35

45 Microsoft SQL Server Parameter type Required Connection type. Use one of the following codes: - SqlServer. Use for SqlServer SqlServer SqlServer2008. 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. port Required Network port number used to connect to the database server. Default port number is instancename Instance name of the Microsoft SQL Server database. database Required Database name for the Microsoft SQL Server target. Database name is case sensitive if the database is case sensitive. Maximum length is 100 characters. Database names can include alphanumeric and underscore characters. schema Required for Microsoft SQL Server 2005 and 2008 Schema used for the target connection. Required for Microsoft SQL Server 2005 and Microsoft SQL Server 2008 databases. codepage Required The code page of the Microsoft SQL Server database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. 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. 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 36 Chapter 2: Informatica Cloud REST API

46 file>&privatekeypassword=<privatekeypassword>&privatekeyfiletype=pem&authenticationtype=<auth type>&agentid=<secure Agent ID>&responseType=<xml json> Web Service Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. name Required Connection name. description of the connection. type Required Connection type. Use WebServicesConsumer. username User name for the web service login. If the web service does not require a user name, leave this field empty. password Password for the web service login. If the web service does not require a user name, leave this field empty. domain Domain for authentication. serviceurl Endpoint URL for the web service that you want to access. The WSDL file specifies this URL in the location element. timeout Number of seconds Informatica Cloud waits for a connection to the web service provider before it closes the connection and fails the session. Also, the number of seconds the Informatica Cloud waits for a SOAP response after sending a SOAP request before it fails the session. Default is 60 seconds. trustcertificatesfile File containing the bundle of trusted certificates that Informatica Cloud uses when authenticating the SSL certificate of the web services provider. Default is cabundle.crt. certificatefile Client certificate that a web service provider uses when authenticating a client. You specify the client certificate file if the web service provider needs to authenticate Informatica Cloud. certificatefilepassword Password for the client certificate. You specify the certificate file password if the web service provider needs to authenticate Informatica Cloud. certificatefiletype File type of the client certificate. You specify the certificate file type if the web service provider needs to authenticate the Integration Service. Use one of the following codes: - PEM - DER privatekeyfile Private key file for the client certificate. You specify the private key file if the web service provider needs to authenticate Informatica Cloud. privatekeypassword Password for the private key of the client certificate. You specify the key password if the web service provider needs to authenticate Informatica Cloud. privatekeyfiletype File type of the private key of the client certificate. You specify the key file type if the web service provider needs to authenticate Informatica Cloud. connection 37

47 Web Service Parameter If necessary, use PEM. authenticationtype Authentication type to use when the web service provider does not return an authentication type to Informatica Cloud. Use one of the following options: - Auto. The Integration Service attempts to determine the authentication type of the web service provider. - Basic. Based on a non-encrypted user name and password. - Digest. Based on an encrypted user name and password. - NTLM. Based on encrypted user name, password, and domain. Default is Auto. agentid Required ID for the Secure Agent that Informatica Cloud uses to access the database in the local area network. 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 Return A code indicating the success or failure of the request: true. The request was successful. false. The request failed. DELETE Request Syntax To delete a connection, use the following syntax. You can use a connection GET request to retrieve the connection ID or name. connection?icsessionid=<ic session ID>&id=<connection ID>&name=<connection name>&responsetype=<xml json> Parameter icsessionid Required The Informatica Cloud REST API session ID. id Connection ID. To delete a connection, use id or name. name Connection name. To delete a connection, use id or name. 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. DELETE Response Return A code indicating the success or failure of the request: true. The request was successful. false. The request failed. 38 Chapter 2: Informatica Cloud REST API

48 Example To create an MSD connection that uses Microsoft Live authentication, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf name=msd Live type=msd authenticationtype=live username=user password=password organizationname=orgname serviceurl= responsetype=json dnbbatch Note: 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 Syntax To view the details of a D&B360 batch, use the following syntax. dnbbatch?icsessionid=<ic session ID>&responseType=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. 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. GET Response Return When you request details about the D&B360 batch, Informatica Cloud returns the following information: Parameter sfusername sfpassword sfsecuritytoken sfserviceurl rowlimit Salesforce user name. Salesforce password. Salesforce security token. Salesforce URL. Batch row limit. dnbbatch 39

49 Parameter enablenewbatch newbatchstarttime newbatchrepeatfrequency newbatchrepeatinterval enablerefreshbatch refreshbatchstarttime refreshbatchrepeatfrequency refreshbatchrepeatinterval Whether a new batch is enabled. New batch start time. New batch repeat frequency. New batch repeat interval. Whether a refresh batch is enabled. Refresh batch start time. Refresh batch repeat frequency. Refresh batch repeat interval. POST Request Syntax To 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> Parameter icsessionid Required Informatica Cloud REST API session ID. sfusername Required Salesforce user name. sfpassword Required Salesforce password. sfsecuritytoken Salesforce security token. rowlimit Batch row limit. enablenewbatch Whether a new batch is enabled. newbatchstarttime New batch start time. Required if a new batch is enabled. newbatchrepeatfrequency New batch repeat frequency. Required if a new batch is enabled. newbatchrepeatinterval New batch repeat interval. Required if a new batch is enabled. enablerefreshbatch Whether a refresh batch is enabled. refreshbatchstarttime Refresh batch start time. Required if a refresh batch is enabled. refreshbatchrepeatfrequency Refresh batch repeat frequency. Required if a refresh batch is enabled. 40 Chapter 2: Informatica Cloud REST API

50 Parameter refreshbatchrepeatinterval Refresh batch repeat interval. Required if a refresh batch is enabled. 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 Return A code that indicates the success or failure of the update. Example To view information about a D&B360 batch, you might use the following URL and parameter: Parameter: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf dnbworkflow Use this resource to view the details of a D&B360 workflow or the details of all D&B360 workflows in the organization. You can also create or update a D&B360 workflow, and you can delete a D&B360 workflow. For Informatica Cloud D&B360 partners only. GET Request Syntax To view the details of a D&B360 workflow, use the following syntax. To view details of all D&B360 workflows, omit the id, uname, and name parameters. dnbworkflow?icsessionid=<ic session ID>&id=<workflow ID>&uname=<workflow identifier>&name=<workflow name>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Workflow ID. To view the details of a D&B360 workflow, use id, uname, or name. uname Workflow unique identifier. To view the details of a D&B360 workflow, use id, uname, or name. name Workflow name. To view the details of a D&B360 workflow, use id, uname, or name. responsetype Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON. - xml. Returns information in XML. dnbworkflow 41

51 Parameter By default, Informatica Cloud responds in XML. GET Response Return When you request details of a single D&B360 workflow, Informatica Cloud returns the following information. When you request the details of all D&B360 workflows in the organization, Informatica Cloud returns the following information for each workflow. Parameter id name uname description createtime updatetime createdby updatedby rowlimit partnerprofile companycustomobject admincustomobject leadcustomobject odbcuser connections schedule dnbtasks Workflow ID. Workflow name. Workflow unique identifier. of the workflow. When the workflow was created. When the workflow was last updated. D&B360 user who created the workflow. D&B360 user who updated the workflow. Row limit for the workflow. Partner profile code. Company custom object number. Admin custom object number. Lead custom object number. ODBC user ID. Connections used in the workflow. Name of the schedule associated with the workflow. An ordered list of D&B360 tasks for each workflow. POST Request Syntax This 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. 42 Chapter 2: Informatica Cloud REST API

52 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 a workflow with the ID of 14. If it finds it, it updates the workflow name to SAP CRM1 as well as any other parameter updates that you pass. If it does not find the workflow ID, it creates a new workflow based on the parameters that you pass. Similarly, if you pass a name of "SFDC" and a uname of "NewBatchSalesforceAccountExtract", Informatica Cloud looks for a workflow named SFDC. If it finds it, it updates the workflow uname to NewBatchSalesforceAccountExtract. If it does not find not find the workflow name, it creates a new workflow based 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> Parameter icsessionid Required Informatica Cloud REST API session ID. id Workflow ID. To update a workflow, use id, uname, or name. uname Unique identifier for the workflow. To create a workflow, use uname or name. To update a workflow, use id, uname, or name. name Name of the workflow. To create a workflow, use uname or name. To update a workflow, use id, uname, or name. description of the workflow. connectionid Required Connection ID. connectionid2 Additional connection ID. Used for SAP IDoc Writer connections. scheduleid Schedule ID. rowlimit Workflow row limit. partnerprofile 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 Oracle CRM On Demand Company custom object number. Enter a number between To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. dnbworkflow 43

53 Parameter admincustomobject Oracle CRM On Demand Admin custom object number. Enter a number between To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. leadcustomobject Oracle CRM On Demand Lead custom object number. Enter a number between To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. odbcuser 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 Agent uses to access Siebel database tables. Enter your user ROW_ID value. To get this value, run the following query on the Siebel 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. 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 Return A code that indicates the success or failure of the action. DELETE Request Syntax To 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> Parameter icsessionid Required Informatica Cloud REST API session ID. id Workflow ID. uname Workflow unique identifier. 44 Chapter 2: Informatica Cloud REST API

54 Parameter name Workflow name. 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. Example To view the details of all available D&B360 workflows, you might use the following URL and parameter: Parameter: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf Note that because the response type was not defined, Informatica Cloud returns the response in XML. login Use this resource to log in to Informatica Cloud and create an Informatica Cloud REST API session. Returns a session ID that you can use to perform additional API calls without additional login requirements. POST Request Syntax You can log in using your Informatica Cloud user name and password. Or you can log in using a Salesforce session 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> Parameter username Required Informatica Cloud user name. password Required Informatica Cloud password. 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. You can log in using a Salesforce session ID and Salesforce server URL if you have included your Salesforce user name in your Informatica Cloud user account. Use the Salesforce Web Services API to generate a Salesforce session ID and to retrieve the Salesforce server URL. For more information, see the login resource in the Salesforce Web Services API Developer's Guide. login 45

55 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> Parameter sfsessionid Required Salesforce session ID. sfserverurl Required Salesforce server URL. For information about generating the Salesforce session ID, see the login resource in the Salesforce Web Services API Developer's Guide. You can retrieve the Salesforce server URL from the Salesforce Web Services API login resource response. 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 Return An Informatica Cloud REST API session ID that you can use for additional API calls, such as the following: ijjepc5k+iintsanvbkgimcdl3qbr8ruap4grrtohnyhzim2pkup7qrx2iy1ghmy The following is a sample return in XML: <?xml version="1.0" encoding="utf-8"?> <LoginResponse> <errorcode>no_error</errorcode> <errormsg></errormsg> <sessionid>ijjepc5k+iintsanvbkgimcdl3qbr8ruap4grrtohnyhzim2pkup7qrx2iy1ghmy</sessionid> </LoginResponse> Example To create a session ID using his Informatica Cloud user name and requesting the response in JSON, John Doe might use the following URL and parameters: Parameters: [email protected] password=jdoepassword responsetype=json To create a session ID using a Salesforce session ID and Salesforce server URL, you might use the following URL and parameters: Parameters: sfsessionid=34352 sfserverurl= org Use this resource to view or update the details of an Informatica Cloud organization. You can also use this resource to delete an Informatica Cloud sub-organization. 46 Chapter 2: Informatica Cloud REST API

56 GET Request Syntax To view the details of an Informatica Cloud organization, use the following syntax. org?icsessionid=<ic session ID>&id=<organization ID>&responseType=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Organization ID. 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. GET Response Return When you request the details of an organization, Informatica Cloud returns the following information. If the organization is a parent organization in an organization hierarchy, Informatica Cloud returns the IDs and names of all sub-organizations. Parameter id parentorgid orgname address address2 address3 city state zipcode country offercode description SubOrg: id Organization ID. Organization ID for the parent organization. Returns 0 if the organization is a stand-alone organization. Organization name. Address of organization. Additional address information for the organization. Additional address information for the organization. City where the organization is based. State where the organization is based. Postal code of the area where the organization is based. Country where the organization is based. Offer code assigned to Informatica Cloud partners. of the organization. Maximum length is 255 characters. ID of the sub-organization. For parent organizations in an organization hierarchy. org 47

57 Parameter SubOrg: name responsetype Name of the sub-organization. For parent organizations in an organization hierarchy. 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 Request You can update an Informatica Cloud organization if the user that started the Informatica Cloud REST API session has the Admin role and belongs to either the organization that you want to update or the parent organization. When you update an Informatica Cloud organization, you cannot update the organization ID, offer code, or organization administrator user account created with the organization. You can use 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 description>& =< address> &responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Required Organization ID. orgname Required 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. description of the organization. Maximum length is 255 characters. Default address for success, warning, or failure notification related to job completion. responsetype Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON. - xml. Returns information in XML. 48 Chapter 2: Informatica Cloud REST API

58 Parameter By default, Informatica Cloud responds in XML. POST Response Return When you update an Informatica Cloud organization, Informatica Cloud returns a code that indicates the success or failure of the request. DELETE Request You can delete an Informatica Cloud sub-organization if the user that started the Informatica Cloud REST API session has the Admin role and belongs the parent organization. To delete an Informatica Cloud organization, use the following syntax. org?icsessionid=<ic session ID>&id=<organization ID>&responseType=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Required Organization ID. 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. DELETE Response Return When you delete a user account, Informatica Cloud returns a code that indicates the success or failure of the request. Example To delete a sub-organization, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf id=org12345 register Use this resource to create an Informatica Cloud organization. You can use this resource to create a suborganization if your organization has the Org Hierarchy license. For Informatica Cloud partners only. register 49

59 POST Request Syntax When 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 the Salesforce login to create a Salesforce session ID and pass the session ID in the register syntax. When you use a Salesforce login, you cannot create a sub-organization. address and other account details. The information that you pass becomes the organization administrator user account. You can create a sub-organization if the user that started the Informatica Cloud REST API session has the Admin role and belongs to an organization with the Org Hierarchy license. You need an Informatica Cloud partner offer code to create an Informatica Cloud organization. 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> Parameter offercode Required Offer code assigned to Informatica Cloud partners. sfsessionid Required Salesforce session ID. sfserverurl Required Salesforce URL. The Salesforce login used to create the session ID becomes the Informatica Cloud user account for the organization. For information about generating the Salesforce session ID, see the login resource in the Salesforce Web Services API Developer's Guide. 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. To create an Informatica Cloud organization with an address and user account details, use the following syntax. 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>& =< address>&phone=<phone number>&timezone=<time zone>&address=<address>&city=<city> &state=<state>&zipcode=<zip code>&country=<country>&employees=<employees>&responsetype=<xml json> Parameter parentsessionid The Informatica Cloud REST API session ID. Use to create a sub-organization under your organization. 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. 50 Chapter 2: Informatica Cloud REST API

60 Parameter firstname Required First name of the organization administrator. lastname Required Last name of the organization administrator. title Title of the organization administrator. Required address for the organization administrator. phone Phone number for the organization administrator. register 51

61 Parameter timezone Time zone of the organization administrator. Time zone honors Daylight Saving Time. You can 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 52 Chapter 2: Informatica Cloud REST API

62 Parameter - 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/Kiritimat If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default. address Address where the organization is located. city City where the organization is located. state State where the organization is located. zipcode Zip code where the organization is located. country Country where the organization is located. employees Number of employees in the organization. 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 Return An Informatica Cloud organization ID, such as the following: Org12345 register 53

63 Example To create an organization using an offer code and Salesforce session ID, you might use the following URL and parameters: Parameters: offercode=35434 sfsessionid=34352 sfserverurl= runjob Use this resource to start an Informatica Cloud task or task flow. POST Syntax runjob?icsessionid=<ic session ID>&jobId=<task or taskflow ID>&jobName=<task or taskflow name>&jobtype=<task type>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. jobid Task or taskflow ID. To start a task or task flow, use jobid or jobname. jobname 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. 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. 54 Chapter 2: Informatica Cloud REST API

64 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> Parameter username Required Informatica Cloud user name. password Required Informatica Cloud password. jobid Task or taskflow ID. To start a task or task flow, use jobid or jobname. jobname 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. 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 Return A code indicating the success or failure of the request: true. The request was successful. false. The request failed. 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> Example To start a data replication task called Replicate_All, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf jobname=replicate_all jobtype=drs runjob 55

65 salesforceversion Use this resource to return the Salesforce version used by Informatica Cloud. GET Request Syntax salesforceversion?responsetype=<xml json> Parameter 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. GET Response Return The Salesforce version used by Informatica Cloud. The following is a sample return in XML: <?xml version="1.0" encoding="utf-8"?> <SalesforceVersionResponse> <errorcode>no_error</errorcode> <errormsg></errormsg> <versionno>19</versionno> </SalesforceVersionResponse> Example To verify the Salesforce version used by Informatica Cloud, you can use the following URL: schedule Use this resource to view the details of a schedule or the details of all schedules in the organization. You can also create or update a schedule, and you can delete a schedule. GET Request Syntax To view the details of a schedule, use the following syntax. To view the details of all schedules, omit the id and name parameters. schedule?icsessionid=<ic session ID>&id=<schedule ID>&name=<schedule name>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Schedule ID. To view the details of a schedule, use id or name. 56 Chapter 2: Informatica Cloud REST API

66 Parameter name Schedule name. To view the details of a schedule, use id or name. 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. GET Response Return When you request details of a single schedule, Informatica Cloud returns the following information. When you request the details of all schedules, Informatica Cloud returns the following information for each schedule. Parameter id name description createtime updatetime createdby updatedby starttime endtime interval frequency rangestarttime rangeendtime Schedule ID. Schedule name. of the schedule. Time the schedule was created. The last time the schedule was updated. User who created the schedule. User who last updated the schedule. Start time of the schedule. End time of the schedule. 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 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. The start of the time range within a day that tasks run. Minutely and Hourly intervals only. The end of the time range within a day that tasks run. Minutely and Hourly intervals only. schedule 57

67 Parameter sun mon tue wed thu fri sat 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. 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. 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. 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. 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. 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. 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 Monthly interval only. weekday weekofmonth 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. 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. 58 Chapter 2: Informatica Cloud REST API

68 Parameter dayofweek timezone 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. Time zone of the user who last updated the schedule. Time zone honors Daylight Saving Time. POST Request Syntax This 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, if you pass a schedule ID of 11 and a schedule name of Daily, Informatica Cloud looks for a schedule with an ID of 11. If it finds it, it updates the schedule name to Daily and updates any other parameters that you pass. If it does not 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> Parameter icsessionid Required Informatica Cloud REST API session ID. id Schedule ID. name Required Schedule name. description of the schedule. starttime Required Date and time when the schedule starts running. Use the following format: YYYY-MM-DDTHH24:MI:SSZ endtime Date and time when the schedule stops running. If you do not use this parameter, the schedule runs indefinitely. Use the following format: YYYY-MM-DDTHH24:MI:SSZ schedule 59

69 Parameter 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 dayofweek. Day of the week when you want tasks to run. - weekofmonth. Week of the month when you want tasks to run. - endtime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely. To indicate when tasks should run, use dayofweek with weekofmonth, such as the First Monday. Or use dayofmonth, such as 1. Tip: To run tasks on the last day of the month, use the Last weekofmonth parameter with the Day dayofweek parameter. frequency Required for Minutely and Hourly Intervals 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, 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 The start of the time range within a day that you want tasks to run. Enter a date and time using the following format. Only the time portion is used: YYYY-MM-DDTHH24:MI:SSZ Use with Minutely and Hourly intervals only. rangeendtime The end of the time range within a day that you want tasks to run. Enter a date and time using the following format. Only the time portion is used: YYYY-MM-DDTHH24:MI:SSZ 60 Chapter 2: Informatica Cloud REST API

70 Parameter Use with Minutely and Hourly intervals only. sun Runs tasks on Sunday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Sunday. - False. Does not run tasks on Sunday. Use with Minutely, Hourly, and Weekly intervals only. mon Runs tasks on Monday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Monday - False. Does not run tasks on Monday. Use with Minutely, Hourly, and Weekly intervals only. tue Runs tasks on Tuesday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Tuesday. - False. Does not run tasks on Tuesday. Use with Minutely, Hourly, and Weekly intervals only. wed Runs tasks on Wednesday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Wednesday. - False. Does not run tasks on Wednesday. Use with Minutely, Hourly, and Weekly intervals only. thu Runs tasks on Thursday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Thursday. - False. Does not run tasks on Thursday. Use with Minutely, Hourly, and Weekly intervals only. fri Runs tasks on Friday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Friday. - False. Does not run tasks on Friday. Use with Minutely, Hourly, and Weekly intervals only. sat Runs tasks on Saturday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Saturday. - False. Does not run tasks on Saturday. Use with Minutely, Hourly, and Weekly intervals only. schedule 61

71 Parameter weekday 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 Date of the month that tasks should run. Use a date between Use with the Monthly interval only. Tip: To run tasks on the last day of the month, use the Last weekofmonth parameter with the Day dayofweek parameter. weekofmonth Week of the month that tasks should run. Use with dayofweek to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month. Use one of the following options: - First - Second - Third - Fourth - Last Use with the Monthly interval only. dayofweek Day of the week that tasks should run. Use with weekofmonth to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month. Use one of the following options: - Day - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday Use with the Monthly interval only. 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 Return A code that indicates the success or failure of the request. DELETE Request Syntax You can delete a schedule by using the schedule ID or schedule name. You can use a schedule GET request to retrieve the schedule name or ID. 62 Chapter 2: Informatica Cloud REST API

72 To delete a schedule using the schedule ID, use the following syntax. schedule?icsessionid=<ic session ID>&id=<schedule id>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. id Required Schedule ID. 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. To delete a schedule using the schedule name, use the following syntax. schedule?icsessionid=<ic session ID>&name=<schedule name>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. name Required Schedule name. 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. DELETE Response Return A code that indicates the success or failure of the request. Example To view the details of a schedule named Daily, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf name=daily servertime Use this resource to return the local time for the Informatica Cloud server. servertime 63

73 GET Request Syntax servertime?responsetype=<xml json> Parameter 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. GET Return Response The local time for the Informatica Cloud server. Example To verify the local time for the Informatica Cloud server, you can use the following URL: user Use this resource to view the details of an Informatica Cloud user account or the details of all user accounts in the organization. You can also use this resource to create or update a user account and to delete a user account. To ensure organization security, this resource does not display or update the password for a user account. GET Request Syntax To view the details of an Informatica Cloud user account, use the following syntax. To view the details of all user accounts, omit the username parameter. user?icsessionid=<ic session ID>&username=<IC user name>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. username Informatica Cloud user name. 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. 64 Chapter 2: Informatica Cloud REST API

74 GET Response Return When you request details about a user account, Informatica Cloud returns the following information. When you request the details of all user accounts, Informatica Cloud returns the following information for each user account. Parameter username sfusername password firstname lastname title phone orgid description createtime updatetime createdby updatedby timezone Informatica Cloud user name. Salesforce user name. Salesforce password. First name for the user account. Last name for the user account. Title of the user. Phone number for the user. addresses to be notified when the user changes the account password. ID of the organization the user belongs to. of the user. When the user account was created. When the user account was last updated. Informatica Cloud user who created the user account. Informatica Cloud user who last updated the user account. Time zone of the user. Time zone honors Daylight Saving Time. POST Request Syntax To 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>& =< >&description=<description>&timezone=<time zone> &responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. username Required Informatica Cloud user name. sfusername Salesforce user name. user 65

75 Parameter 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. addresses to be notified when the user changes the account password. description of the user. 66 Chapter 2: Informatica Cloud REST API

76 Parameter timezone Time zone of the user. Time zone honors Daylight Saving Time. You can 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 user 67

77 Parameter - 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/Kiritimat If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default. 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 Return A code that indicates the success or failure of the update. DELETE Request Syntax You can delete a user account by using the user name. You can use a user GET request to retrieve a list of user names. 68 Chapter 2: Informatica Cloud REST API

78 To delete a user, use the following syntax. user?icsessionid=<ic session ID>&username=<user name>&responsetype=<xml json> Parameter icsessionid Required Informatica Cloud REST API session ID. username Required User name. 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. Delete Response Return A code that indicates the success or failure of the request. Example To view information about the John Doe user account, you might use the following URL and parameters: Parameters: icsessionid=r21wjdxxrfkgteckggc9duc65hnzk2ggjdgirjcb7xx5vasjlszxj19nqk5weecf [email protected] user 69

79 C H A P T E R 3 Informatica Cloud REST API - Version 2 This chapter includes the following topics: Informatica Cloud REST API Version 2 Overview, 70 REST API Guidelines, 79 Resource Quick Reference, 80 activitylog, 84 activitymonitor, 86 agent, 88 connection, 91 customfunc, 106 dnbworkflow, 110 field, 114 filerecord, 115 job, 118 login, 119 mastertemplate, 121 mttask, 132 org, 138 register, 154 salesforceversion, 164 schedule, 164 servertime, 171 user, 171 workflow, 176 Informatica Cloud REST API Version 2 Overview Informatica Cloud REST API version 2 allows you to access information from your Informatica Cloud organization. You can also perform tasks such as create, update, and delete connections, schedules, plug-ins, and workflows. 70

80 Use version 2 of the REST API for all new development. Version 1 will not be updated with the latest resources and enhancements. To use the Informatica Cloud REST API, you need a valid Informatica Cloud login and an understanding of REST API guidelines. To configure a request using the REST API, use the appropriate resource and method, along with the applicable attributes. Informatica Cloud returns the requested information, performs the requested task, or returns a error object and related messages. The Informatica Cloud REST API version 2 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. Also deletes a Secure Agent. connection. Returns the details of a connection or the details of all connections in the organization. Returns available source or target objects for a specified connection. Returns all connections of a specified type associated with a Secure Agent. Creates or updates a connection. Also deletes a connection. customfunc. Returns the details of a plug-in or of all plug-ins in the organization. Creates or updates a plugin. Also deletes a plug-in. dnbworkflow. Returns the details of a D&B360 workflow or the details of all D&B360 workflows in the organization. Creates or updates a D&B360 workflow. Also deletes a D&B360 workflow. (Available for Informatica Cloud D&B360 partners only.) field. Returns the field details for a source or target object. filerecord. Uploads an integration template XML file or image file. Also deletes an integration template XML file or image file. job. Starts a task or task flow. login. Logs in to an Informatica Cloud organization with Informatica Cloud or Salesforce credentials. Returns an Informatica Cloud REST API session ID that you can use for subsequent REST API requests. mastertemplate. Returns the details of an integration template or the details of all integration templates in the organization. Creates or updates an integration template. Also deletes an integration template. mttask. Returns the details of a custom integration task or the details of all custom integration tasks in the organization. Creates or updates a custom integration task. Also deletes a custom integration task. org. Returns details of an Informatica Cloud organization or related sub-organization. Updates an organization or related sub-organization. Also deletes a related sub-organization. register. Creates an Informatica Cloud organization or sub-organization using organization details. Also creates an organization using Salesforce credentials. (Available for Informatica Cloud partners only.) 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 or updates 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 or updates a user account. Also deletes a user account. workflow. Returns the details of a task flow or the details of all task flows in the organization. Creates or updates a task flow. Also deletes a task flow. Informatica Cloud REST API Version 2 Overview 71

81 XML Schema Definition You can access the xml schema definition (XSD) for the Informatica Cloud REST API version 2 at the following URL: To use the XSD URL, log into Informatica Cloud, then enter the XSD URL. Header and Body Configuration Request Header When you construct a REST API version 2 request header, use the following format: <METHOD> <serverurl>/<uri> HTTP/<HTTP version> Content-Type: application/<json xml> Accept: application/<json xml> icsessionid: <icsessionid> Header Element METHOD Required Method you want to use, such as GET, POST, or DELETE. serverurl Required for most resources Base URL for all resources except login, loginsf, register, and registersf. URI Required for most resources Resource URI. Use a placeholder for serverurl, and replace the placeholder with the Informatica Cloud URL returned by the login resource. For the login, loginsf, register, and registersf resources, use the URL listed in the resource. For the login, loginsf, register, and registersf resources, use the URL listed in the resource. HTTP version Required HTTP version that you are using. Content-Type Required for POST requests Format of the request. Use one of the following options: - application/json. Reads request as JSON. - application/xml. Reads request as XML. Default is json. Accept Request format that you want. Use one of the following options: - application/json. Sends response as JSON. - application/xml. Sends response as XML. 72 Chapter 3: Informatica Cloud REST API - Version 2

82 Header Element Default is json. icsessionid Required for most resources Informatica Cloud session ID. Required for all resources except login, loginsf, register, and registersf. Use a placeholder for icsessionid, and replace the placeholder with the session ID returned by the login resource. Request Body Use the request body to pass additional attributes for the resource. When you pass attributes in a request body, you pass the attributes as part of an object. For example, to log in with the login resource, you pass the required username and password attributes in a login object. Some requests include sub-objects for attributes. Declare the sub-objects before listing the related attributes. JSON Format When you use the JSON format, define a request object with attribute, as follows: { "@type": "<request object>", "<attribute1>": "<value1>", "<attribute2>": "<value2>", } When an attribute includes an object, state the attribute and use the object name as follows: { "@type": "<request object>", "<attribute1>": "<value1>", "<attribute2>": { "@type": "<attribute object>", "<attributea>": "<valuea>", "<attributeb>": "<valueb>",} "@type": "<attribute object>", "<attributed>": "<valued>", "<attributee>": "<valuee>",} "<attribute3>": "<value3>", } XML Format When you use the XML format, define a request object as an enclosing set of tags, as follows: <request object> <attribute1>value1</attribute1> <attribute2>value2</attribute2> </request object> When an attribute includes an object, enclose the attribute object within the attribute tags as follows: <request object> <attribute1>value1</attribute1> <attribute2> <attribute object> <attributea>valuea</attributea> <attributeb>valueb</attributeb> </attribute object> <attribute object> Informatica Cloud REST API Version 2 Overview 73

83 <attributec>valuec</attributec> <attributed>valued</attributed> </attribute object> </attribute2> <attribute3>value3</attribute3> </request object> Return Lists When the REST API version 2 returns a series of objects in XML, it encloses the list in the root tag. <root> <return object 1> <attribute1>value1</attribute1> <attribute2>value2</attribute2> </return object 1> <return object 2> <attribute1>value1</attribute1> <attribute2>value2</attribute2> </return object 2> </root> In JSON, it encloses the list in square brackets ( [ ] ). No additional attributes are used. [ { "@type": "<return object1>", "<attribute1>": "<value1>", "<attribute2>": "<value2>", }{ "@type": "<return object2>", "<attribute1>": "<value1>", "<attribute2>": "<value2>", } ] Examples JSON Example To log in using JSON, you might use the following request header and body: POST HTTP/1.0 Content-Type: application/json Accept: application/json { } "@type": "login", "username": "user @company.com", "password": "mypassword" The login might return the following information: { "@type" : "user", "id" : "00000B ", "orgid" : "00000B", "name" : "user @company.com", "description" : null, "createtime" : " T15:00:00.000Z", "updatetime" : " T15:00:00.000Z", "createdby" : "System", "updatedby" : "user @company.com", "sfusername" : null, "firstname" : "Firstname", "lastname" : "Lastname", "title" : "Senior Software Engineer", "password" : "********", "phone" : " ", " s" : null, 74 Chapter 3: Informatica Cloud REST API - Version 2

84 "timezone" : "America/Los_Angeles", "serverurl" : " "icsessionid" : "IV4wOrJmd6YUtmKa8t" } You can then use the icsessionid and the serverurl to construct a request to delete a schedule with the schedule ID of D : DELETE HTTP/1.0 Accept: application/xml icsessionid: IV4wOrJmd6YUtmKa8t Note that Content-Type is not required because the DELETE method does not have additional attributes to pass in the request body. XML Example To log in using XML, you might use the following header and body: POST HTTP/1.0 Content-Type: application/xml Accept: application/xml <login> <username>user @company.com</username> <password>mypassword</password> </login> The login might return the following information: <?xml version="1.0" encoding="utf-8" standalone="yes"?> <user> <id>00000b </id> <orgid>00000b</orgid> <name>[email protected]</name> <createtime> t15:00:00.000z</createtime> <updatetime> t15:00:00.000z</updatetime> <createdby>system</createdby> <updatedby>[email protected]</updatedby> <firstname>firstname</firstname> <lastname>lastname</lastname> <title>senior Software Engineer</title> <password>********</password> <phone> </phone> <timezone>america/los_angeles</timezone> <serverurl> <icsessionid>iv4worjmd6yutmka8t</icsessionid> </user> You can then use the icsessionid and the serverurl to construct a request to delete a schedule as follows. The schedule ID is D DELETE HTTP/1.0 Accept: application/xml icsessionid: IV4wOrJmd6YUtmKa8t Note that Content-Type is not required because the DELETE method does not have additional attributes to pass in the request body. Date/Time Values With the REST API version 2, Informatica Cloud uses the UTC date format to pass all date/time values. Informatica Cloud REST API Version 2 Overview 75

85 Use the following UTC date format for all date/time values that you pass in requests. The same format is used for all date/time values returned from Informatica Cloud. <yyyy>-<mm>-<dd>t<hh>:<mm>:<ss>.<sss>z Date Part yyyy MM dd T HH mm ss SSS Z Year expressed in four digits. Month expressed in two digits. Date of the month expressed in two digits. Indicates the time portion of the format. Hour in the 24-hour format. For example, 0 for 12:00:00 a.m. and 23 for 11:00:00 p.m. Minutes expressed in two digits. Seconds expressed in two digits. Microseconds expressed in three digits. UTC time indicator. For example, the following date string represents 3:00 pm on December 12, 2012: T15:00:00.000Z Object IDs Many requests require an object ID, such as a connection ID or task flow ID. To find the object ID that you need, you can use the related GET request. For example, to determine the task flow ID that you need to update a task flow, you can use a workflow GET request to view the details of all task flows in the organization. The return list of task flow details includes the task flow ID. Similarly, to determine the ID of a user, you can perform a user GET request. Object IDs are not readily available through the Informatica Cloud application. REST API Responses The following table describes the responses to REST API version 2 requests: REST API Request Successful Response Failure Response GET Returns the requested object. HTTP 403 error, including an Informatica REST API error object. POST Returns the object that you created or updated. HTTP 403 error, including an Informatica REST API error object. DELETE No response. HTTP 403 error, including an Informatica REST API error object. 76 Chapter 3: Informatica Cloud REST API - Version 2

86 For example, if you use a GET request to view a schedule, a successful response is the schedule object that you requested. Or, if you use a POST request to update the time that the schedule runs, a successful response is the schedule object that you updated, including the update. If you use a DELETE request to delete a schedule that is no longer being used, you receive no response unless the REST API was unable to delete the schedule. Error Object When the REST API version 2 encounters an error, it returns HTTP 403 error, including an Informatica REST API error object. The error object has the following structure: <xs:complextype name="error"> <xs:sequence> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> <xs:element name="statuscode" type="xs:int"/> </xs:sequence> </xs:complextype> Error Messages The REST API version 2 provides the following error messages: Error Code Response Key Response Text REST_UNKNOWN The REST API encountered an error: <info> REST_PARAMETERS_ARE_WRONG Wrong parameters <info> REST_ERROR_PARSING_JSON_OBJECT Error parsing JSON object REST_ERROR_WRITING_JSON_OBJECT Error writing JSON object REST_INVALID_OBJECT_ID Object identifier is invalid or missing, property is (<info>) REST_NO_OBJECTS Connection has no objects REST_INVALID_SUBORG_ID Sub org identifier is invalid, property is (<info>) REST_REGISTRATION_ERROR Error during user registration REST_INSUFFICIENT_SUBORG_PRIVILEGE Insufficient privileges to create suborg. User must have org hierarchy license and update org privilege to create suborg REST_MAX_SUBORG_LIMIT Maximum suborglimit reached REST_PARENT_ORG_HAS_PARENT_ORG Parent org which already has a parent org could not create a suborg REST_INSUFFICIENT_VIEW_USER_PRIVILEGE Insufficient privileges to view user REST_INSUFFICIENT_DELETE_USER_PRIVILEGE Insufficient privileges to delete user REST_DNB_EMPTY_ID_UNAME Empty value for id and uname. Informatica Cloud REST API Version 2 Overview 77

87 Error Code Response Key Response Text REST_INVALID_CONN_ID Invalid connection ID REST_INVALID_CONN_ID_TYPE Enter a valid connectionid with a valid connection type <type> for the application type <type> REST_INVALID_SCHEDULE_ID Invalid schedule ID REST_INVALID_USERNAME Invalid user name. It must be a valid address REST_INVALID_PASSWORD Invalid password REST_INVALID_FIRSTNAME Invalid first name REST_INVALID_LASTNAME Invalid last name REST_INVALID_PHONE Invalid phone REST_INVALID_ Invalid REST_INVALID_TIMEZONE Invalid time zone REST_INVALID_LICENSE You cannot use the REST API. You must have a valid REST API license to use the REST API. Contact Informatica Global Customer Support REST_INVALID_TASK_TYPE Invalid tasktype REST_INVALID_AGENT_ID Invalid Secure Agent ID REST_INVALID_CODE_PAGE Invalid codepage. It must be UTF-8 or MS REST_INVALID_TYPE Invalid type <type> REST_INVALID_TASK_ID Invalid taskid <id> REST_INVALID_TASK_NAME Invalid task name <name> REST_INVALID_RUN_TASK Invalid privileges when running <task> task with id <id> REST_INVALID_CERTIFICATE_FILE_TYPE Invalid certificatefiletype REST_INVALID_AUTHENTICATION_TYPE Invalid authenticationtype REST_INVALID_PRIVATE_KEY_FILE_TYPE Invalid privatekeyfiletype REST_INVALID_DATE_FORMAT Invalid date format. Valid values are <info> REST_INVALID_COUNTRY_CODE Invalid country code REST_INVALID_STATE_CODE Invalid state code REST_INVALID_TITLE Invalid title. 78 Chapter 3: Informatica Cloud REST API - Version 2

88 Error Code Response Key Response Text REST_NETSUITE_NOT_SUPPORTED NetSuite connection type not supported for create or update REST_TOOLKIT_NOT_SUPPORTED TOOLKIT connection type not supported for create or update REST API Guidelines Use the following guidelines when working with Informatica Cloud REST API version 2: Construct a request using the JSON or XML format. Specify the format of the request and response in the header. Use the Content-Type attribute to specify the request format and the Accept attribute to specify the response format. If a request or response type is not configured, Informatica Cloud uses JSON by default. Use a placeholder for the icsessionid in request headers for all resources except login, loginsf, register, and registersf. Replace the placeholder with the icsessionid data returned when you log in to a session. The login, loginsf, register, and registersf resources do not require the icsessionid in the request header. For all resources except login, loginsf, register, and registersf, use a placeholder for the base URL. Replace the placeholder with the serverurl data returned by the login resource. All resources and attributes are case sensitive. Where indicated, enclose POST request attributes in the specified object. When no object is specified, include attributes in the request body. For requests in JSON, use attribute to define an object. For requests in XML, use an enclosing <object name> tag to define an object. XML responses that include a list of objects return the objects enclosed in the <root> tag. Documentation Conventions Informatica Cloud REST API version 2 documentation uses the following conventions: Methods are in capital letters, such as GET. Request syntax uses the following conventions: - Variables are enclosed in angle brackets ( < > ), such as <id> for a user ID. - When listing a choice of attribute values, options are separated by a pipe ( ). - attributes are in italics. REST API Guidelines 79

89 Resource Quick Reference The following table contains the syntax and a brief description of the Informatica Cloud REST API version 2 resources: Resource Method URI and Attributes activitylog - Use the serverurl from the login response as the base URL. - For more information, see activitylog on page 84. GET /api/v2/activity/activitylog? rowlimit=<row limit> Returns information from the activity log. activitymonitor - Use the serverurl from the login response as the base URL. - For more information, see activitymonitor on page 86. GET /api/v2/activity/activitymonitor? details=<true false> Returns information from the activity monitor. agent - Use the serverurl from the login response as the base URL. - For more information, see agent on page 88. connection - Use the serverurl from the login response as the base URL. - For more information, see connection on page 91. GET /api/v2/agent/<id> Returns the details of a Secure Agent or of all Secure Agents in the organization. DELETE /api/v2/agent/<id> Deletes a Secure Agent. GET /api/v2/connection/<id> Returns the details of a connection or of all connections in the organization. /api/v2/connection/source/<id> /api/v2/connection/target/<id> Returns the objects that you can use as a source or target for the specified connection. /api/v2/connection/search? agentid=<agent ID>&uiType=<uiType> Returns a list of connections by Secure Agent ID and connection type. POST /api/v2/connection/<id> For a complete list of attributes based on the connection type, see the connection resource. Use a connection object for attributes. Creates or updates a connection. DELETE /api/v2/connection/<id> Deletes a connection. customfunc - Use the serverurl from the login response as the base URL. - For more information, see customfunc on page 106. GET /api/v2/customfunc/<id> Returns the details of a plug-in or of all plug-ins in the organization. POST /api/v2/customfunc/<id> Required attributes: file, name. Creates or updates a plug-in. 80 Chapter 3: Informatica Cloud REST API - Version 2

90 Resource Method URI and Attributes Define the attributes in the request body and encode the request body as multipart/ form-data. DELETE /api/v2/customfunc/<id> Deletes a plug-in. dnbworkflow - Use the serverurl from the login response as the base URL. - For more information, see dnbworkflow on page 110. GET /api/v2/dnbworkflow/<id> Returns the details of a D&B360 workflow or of all D&B360 workflows in the organization. POST /api/v2/dnbworkflow/<id> For a complete list of attributes, see the dnbworkflow resource. Use a dnbworkflow object for attributes. Creates or updates a D&B360 workflow. DELETE /api/v2/dnbworkflow/<id> Deletes a D&B360 workflow. field - Use the serverurl from the login response as the base URL. - For more information, see field on page 114. GET /api/v2/connection/source/<id>/ field/<objectname> /api/v2/connection/target/<id>/ field/<objectname> Returns the field details for a source or target object. filerecord - Use the serverurl from the login response as the base URL. - For more information, see filerecord on page 115. POST /api/v2/filerecord Required attributes: file, type. Define the attributes in the request body and encode the request body as multipart/ form-data. Upload an integration template XML file or image file. DELETE /api/v2/filerecord/<id> Delete an integration template file or image file. job - Use the serverurl from the login response as the base URL. - For more information, see job on page 118. POST /api/v2/job Required attributes: taskid, tasktype. Use a job object for attributes. Start a task or task flow. login - Use the listed URL. - Omit icsessionid from the request header. - For more information, see login on page 119. POST Use the following URL: app.informaticaondemand.com/ma/api/ v2/user/login Required attributes: username, password. Use a login object for attributes. Log in to an organization with your Informatica Cloud user name and password. Returns a session ID that you can use for other resource calls. app.informaticaondemand.com/ma/api/ v2/user/loginsf Required attributes: sfsessionid, sfserverurl. Log in to an organization with a Salesforce session ID and Salesforce server URL. Resource Quick Reference 81

91 Resource Method URI and Attributes Use a login object for attributes. Returns a session ID that you can use for other resource calls. mastertemplate - Use the serverurl from the login response as the base URL. - For more information, see mastertemplate on page 121. GET /api/v2/mastertemplate/<id> Returns the details of an integration template or of all integration templates in the organization. POST /api/v2/mastertemplate/<id>/tasks /api/v2/mastertemplate/<id> For a complete list of attributes, see the mastertemplate resource. Use a mastertemplate object for attributes. Returns a list of custom integration tasks that use an integration template. Creates or updates an integration template. DELETE /api/v2/mastertemplate/<id> Deletes an integration template. mttask - Use the serverurl from the login response as the base URL. - For more information, see mttask on page 132. GET /api/v2/mttask/<id> Returns the details of a custom integration task or of all custom integration tasks in the organization. POST /api/v2/mttask/<id> For a complete list of attributes, see the mttask resource. Use an mttask object for attributes. Creates or updates a custom integration task. DELETE /api/v2/mttask/<id> Deletes a custom integration task. org - Use the serverurl from the login response as the base URL. - For more information, see org on page 138. GET /api/v2/org/<id> Returns the details of your Informatica Cloud organization or a related suborganization. POST /api/v2/org/<id> For a complete list of attributes, see the org resource. Use an org object for attributes. Updates the details of an Informatica Cloud organization or a related suborganization. DELETE /api/v2/org/<id> Deletes a related suborganization. 82 Chapter 3: Informatica Cloud REST API - Version 2

92 Resource Method URI and Attributes register - To create an organization: - Use the listed URL. - Omit icsessionid from the request header. - To create a sub-organization: - Use the serverurl from the login response as the base URL. - Define icsessionid in the request header. - For more information, see register on page 154. POST app.informaticaondemand.com/ma/api/ v2/user/register For a complete list of attributes, see the register resource. Use a registration object for attributes. /api/v2/register For a complete list of attributes, see the register resource. Use a registration object for attributes. Creates an Informatica Cloud organization. Creates an Informatica Cloud sub-organization app.informaticaondemand.com/ma/api/ v2/user/registersf For a complete list of attributes, see the register resource. Use a registration object for attributes. Creates an Informatica Cloud organization. salesforceversion - Use the serverurl from the login response as the base URL. - For more information, see salesforceversion on page 164. schedule - Use the serverurl from the login response as the base URL. - For more information, see schedule on page 164. GET /api/v2/server/salesforceversion Returns the Salesforce version used by Informatica Cloud. GET /api/v2/schedule/<id> Returns the details of a schedule or of all schedules in the organization. POST /api/v2/schedule/<id> For a complete list of attributes, see the schedule resource. Use a schedule object for attributes. Creates or updates a schedule. DELETE /api/v2/schedule/<id> Deletes a schedule. servertime - Use the serverurl from the login response as the base URL. - For more information, see servertime on page 171. user - Use the serverurl from the login response as the base URL. - For more information, see user on page 171. GET /api/v2/server/servertime Returns the local time for the Informatica Cloud server. GET /api/v2/user/<id> Returns the details of an Informatica Cloud user account or of all user accounts in the organization. POST /api/v2/user/<id> For a complete list of attributes, see the user resource. Use a user object for attributes. Creates or updates an Informatica Cloud user account. DELETE /api/v2/user/<id> Deletes an Informatica user account. Resource Quick Reference 83

93 Resource Method URI and Attributes workflow - Use the serverurl from the login response as the base URL. - For more information, see workflow on page 176. GET /api/v2/workflow/<id> Returns the details of a task flow or of all task flows in the organization. POST /api/v2/workflow/<id> For a complete list of attributes, see the workflow resource. Use a workflow object for attributes. Creates or updates a task flow. DELETE /api/v2/workflow/<id> Deletes a task flow. activitylog Use this resource to request information from the activity log. GET Request To request information from the activity log, use the following URI: /api/v2/activity/activitylog?rowlimit=<row limit> You can use the following attribute in the URI: activitylog GET URI Attribute rowlimit The maximum number of rows to return. If you omit this optional attribute, activitylog returns all available rows. GET Response Returns an activitylogentry object for each row in the activity log. Returns the error object if errors occur. 84 Chapter 3: Informatica Cloud REST API - Version 2

94 The activitylogentry object includes the following attributes: activitylog Object Response Attribute id type objectname runid starttime endtime state failedsourcerows successsourcerows failedtargetrows successtargetrows errormsg entries Activity log entry ID. Task type. Returns one of the following codes: - AVS. Contact validation task. - DQA. Data assessment task. - DRS. Data replication task. - DSS. Data synchronization task. - MTT. Custom integration task. - PCS. PowerCenter task. - WORKFLOW. Task flow. - DNB_TASK. D&B360 task. - DNB_WORKFLOW. D&B360 workflow. Task name. ID for the task run. Start time for the task or task flow. End time for the task or task flow. Whether the task completed successfully. Returns one of the following codes: - 1. The task completed successfully - 2. The task completed with errors The task failed to complete. Number of rows that were not read from the source. Number of rows that were successfully read from the source. Number of rows that were not written to the target. Number of rows that were successfully written to the target. Error message associated with the job. Indicates the start of information for a child object. A child object might be a task within a task flow, or an object in a data replication task or D&B360 workflow. GET Example To request 20 rows of information returned from the activity log in JSON format, you might use the following request: GET <serverurl>/api/v2/activity/activitylog?rowlimit=20 HTTP/1.0 Accept:application/json icsessionid: <icsessionid> A successful request returns a list: an activitylogentry object for each entry returned from the activity log. The following is a sample return in JSON: [ { "@type": "activitylogentry", "id": "000001C D", "type": "DSS", activitylog 85

95 "objectname": "dss-f2f", "runid": 0, "starttime": " T13:30:00.000Z", "endtime": " T13:30:30.000Z", "state": 3, "failedsourcerows": 0, "successsourcerows": 0, "failedtargetrows": 0, "successtargetrows": 0, "errormsg": "Exception class org.apache.axis.axisfault is caught with message=; nested exception is: \n\tjava.net.connectexception: Connection refused: connect.", "entries": }, { "@type": "activitylogentry", "id": "000001C C", "type": "DRS", "objectname": "drstask1", "runid": 1, "starttime": " T13:30:30.000Z", "endtime": " T13:32:30.000Z", "state": 1, "failedsourcerows": 0, "successsourcerows": 39, "failedtargetrows": 0, "successtargetrows": 39, "errormsg": null, "entries": [ { "@type": "activitylogentry", "id": "12", "type": "DRS", "objectname": "Contact", "runid": 0, "starttime": " T13:32:31.000Z", "endtime": " T13:35:31.000Z", "state": 1, "failedsourcerows": 0, "successsourcerows": 39, "failedtargetrows": 0, "successtargetrows": 39, "errormsg": "No errors encountered.", "entries": [] }, ] } ] activitymonitor Use this resource to request information from the activity monitor. GET Request To request information from the activity monitor, use the following URI: /api/v2/activity/activitymonitor?details=<true false> 86 Chapter 3: Informatica Cloud REST API - Version 2

96 You can use the following attribute in the URI: activitymonitor GET URI Attribute details Activity monitor detail to be returned from Informatica Cloud. Use one of the following options: - true. Returns activity monitor information for tasks, task flows, and child objects. Child objects can include tasks within task flows, and objects within data replication tasks and D&B360 workflows. - false. Returns activity monitor information for tasks and task flows. Default is false. If you omit this optional attribute, activitymonitor does not return additional details. GET Response Returns an activitymonitorentry object for each row in the activity monitor. Returns the error object if errors occur. The activitymonitorentry object includes the following attributes: activitymonitor GET Response Attribute id type taskname objectname runid starttime endtime executionstate failedsourcerows successsourcerows Activity monitor entry ID. Task type. Returns one of the following codes: - AVS. Contact validation task. - DQA. Data assessment task. - DRS. Data replication task. - DSS. Data synchronization task. - MTT. Custom integration task. - PCS. PowerCenter task. - WORKFLOW. Task flow. - DNB_TASK. D&B360 task. - DNB_WORKFLOW. D&B360 workflow. Task name. Source object used in the task, or the data replication or D&B360 object being processed. ID for the task run. Start time for the task or task flow. End time for the task or task flow. State of the task. Returns one of the following codes: - INITIALIZED - RUNNING - STOPPING - COMPLETED - FAILED Number of rows that were not read from the source. Number of rows that were successfully read from the source. activitymonitor 87

97 activitymonitor GET Response Attribute failedtargetrows successtargetrows errormsg entries Number of rows that were not written to the target. Number of rows that were successfully written to the target. Error message associated with the job. Indicates the start of information for a child object. A child object might be a task within a task flow, or an object in a data replication task or D&B360 workflow. GET Example To return activity monitor information including details about child objects in XML, you might use the following request: GET <serverurl>/api/v2/activity/activitymonitor?details=true HTTP/1.0 Content-Type: application/xml Accept: application/xml icsessionid: <icsessionid> A successful request returns a list: an activitymonitorentry object for each item returned from the activity monitor. The following is a sample return in XML: <root> <activitymonitorentry> <id>000001c d</id> <type>dss</type> <objectname>dss-f2f</objectname> <runid>0</runid> <starttime> t13:30:00.000z</starttime> <endtime></endtime> <executionstate>running</executionstate> <failedsourcerows>0</failedsourcerows> <successsourcerows>938</successsourcerows> <failedtargetrows>0</failedtargetrows> <successtargetrows>596</successtargetrows> <errormsg> </errormsg> <entries> </entries> </activitymonitorentry> <activitymonitorentry> <id>000001c l</id> <type>pcs</type> <objectname>pcs-lookup</objectname> <runid>2</runid> <starttime> t13:30:03.001z</starttime> <endtime> t13:30:03.010z</endtime> <executionstate>complete</executionstate> <failedsourcerows>0</failedsourcerows> <successsourcerows>688</successsourcerows> <failedtargetrows>0</failedtargetrows> <successtargetrows>688</successtargetrows> <errormsg> </errormsg> <entries> </entries> </activitymonitorentry> </root> agent Use this resource to request the details of an Informatica Cloud Secure Agent or the details of all Secure Agents in the organization. You can also delete a Secure Agent. 88 Chapter 3: Informatica Cloud REST API - Version 2

98 GET Request To request the details of a Secure Agent, use the following URI. To request the details of all Secure Agents in the organization, omit the optional Secure Agent ID. /api/v2/agent/<id> GET Response Returns the agent object for the requested Secure Agent ID. If you request information for all Secure Agents in the organization, returns an agent object without the packages and agentconfigs attributes for each Secure Agent in the organization. Returns the error object if errors occur. The agent object includes the following attributes: agent Object Request Attribute id orgid name description createtime updatetime createdby updatedby active platform agenthost password proxyhost proxyport proxyuser proxypassword agentversion upgradestatus Secure Agent ID. Organization ID. Secure Agent name. of the Secure Agent. Time the Secure Agent was created. Last time the Secure Agent was updated. User who created the Secure Agent. User who updated the Secure Agent. Whether the Secure Agent is active. Returns one of the following values: - true. Active. - false. Inactive. Platform of the Secure Agent machine. Returns one of the following values: - win32 - linux32 Host name of the Secure Agent machine. Password of the Secure Agent machine. Host name of the outgoing proxy server that the Secure Agent uses. Port number of the outgoing proxy server. User name to connect to the outgoing proxy server. Password to connect to the outgoing proxy server. Secure Agent version. Upgrade status. agent 89

99 agent Object Request Attribute lastupgraded lastupgradecheck laststatuschange packages agentconfigs name type subtype value customized overridden defaultvalue platform configupdatetime Last time the Secure Agent was upgraded. Last time the Secure Agent was checked for upgrade. Last time the Secure Agent status was updated. Informatica Cloud Connector packages. Attribute that defines Secure Agent properties. Includes the following attributes in an agentconfig object for each Secure Agent property. Configuration property name. Configuration type. Returns one of the following values: - Secure Agent Core - Secure Agent Manager - DTM - Apache Tomcat JRE - Secure Agent Core JRE Configuration subtype. Returns one of the following values: - INFO - DEBUG Value of the property. Whether the property is in the custom configuration details. Returns one of the following values: - true. - false. Whether the property has been overridden. Returns one of the following values: - true. - false. Default value. Platform. Returns one of the following values: - win32 - linux32 Last time a user updated Secure Agent properties. DELETE Request You can delete a Secure Agent if it is not associated with any connections. Before you delete a Secure Agent, update associated connections to use another Secure Agent. To delete a Secure Agent, use the Secure Agent ID in the following URI: /api/v2/agent/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. 90 Chapter 3: Informatica Cloud REST API - Version 2

100 GET Example To request the details about the Secure Agent with an ID of 000H1L , to be returned in JSON format, you might use the following request: GET <serverurl>/api/v2/agent/000h1l HTTP/1.0 Accept:application/json icsessionid: <icsessionid> A successful request returns the agent object. connection Use this resource to request the details of a connection or the details of all connections in the organization. You can request a list of available sources or targets for a connection. You can also request a list of connections of a specified type associated with a Secure Agent. You can create or update a connection, and you can delete a connection. GET Request To request the details of a connection, use the following URI. To request the details of all connections in the organization, omit the optional connection ID. /api/v2/connection/<id> To request the objects that you can use as a source available through the specified connection, use the source connection ID in the following URI: /api/v2/connection/source/<id> To request the objects that you can use as a target available through the specified connection, use the source connection ID in the following URI: /api/v2/connection/target/<id> To request a list of connections by Secure Agent ID and connection type, use the following URI: /api/v2/connection/search?agentid=<agent ID>&uiType=<uiType> connection 91

101 Use the following attributes in the URI: connection Request URI Attribute agentid Required Secure Agent ID. uitype Required Connection type. Use one of the following options: - CSVFile. CSV flat file. - FTP. - MS_ACCESS. - MSD. Microsoft Dynamics CRM. - MySQL. - ODBC. - Oracle. - OCOD. Oracle CRM On Demand. - Salesforce. - SFTP. Secure FTP. - SAP_ALE_IDoc_Reader. SAP IDoc Reader. - SAP_ALE_IDoc_Writer. SAP IDoc Writer. - SqlServer. Microsoft SQL Server SqlServer2005. Microsoft SQL Server SqlServer2008. Microsoft SQL Server TOOLKIT. Informatica Cloud Connector. Also use for NetSuite connections. - WebServicesConsumer. Web Service. GET Response Returns the connection object for the requested connection ID. If you request information for all connections in the organization, returns a connection object for each connection in the organization. If you request a list of connections based on the Secure Agent and connection type, returns a connection object for each connection that matches the requirements. If you request a list of source or target objects available for the requested connection ID, returns the connlistitem object for each available object. Returns the error object if errors occur. A connection object includes the following attributes. The connection object includes different information based on connection type. For NetSuite connections, only name, orgid and connectionid information is returned. connection Object Response Attribute id orgid name description createtime updatetime Connection ID. Organization ID. Connection name. of the connection. Time the connection was created. Last time the connection was updated. 92 Chapter 3: Informatica Cloud REST API - Version 2

102 connection Object Response Attribute createdby updatedby agentid instancename host escapechar enclosingchar domain delimiter dateformat database codepage clientcode authenticationtype adjustedjdbchostname accountnumber languagecode remotedirectory schema serviceurl short User who created the connection. User who last updated the connection. Secure Agent ID for Flat File, FTP/SFTP, Microsoft SQL Server, MS Access, MySQL, ODBC, Oracle, and Web Service connections. Microsoft SQL Server instance name. Host name for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. Escape character for Flat File, FTP, and SFTP connections. Text qualifier for Flat File, FTP, and SFTP connections. Domain name for Microsoft Dynamics CRM connections that use IFD or Active Directory authentication, and Web Service connections. Delimiter for Flat File, FTP, and SFTP connections. Date format for Flat File, FTP, and SFTP connections. Returns the following information: - For Microsoft SQL Server and MySQL connections, returns the database name. - For Flat File connections, returns the directory. - For FTP and SFTP connections, returns the local directory. - For MS Access and ODBC connections, returns the data source name. - For Oracle connections, returns the service name. - For SAP IDoc Writer and Reader connections, returns the destination entry. - For Web Service connections, returns the service URL. Code page for Flat File, FTP, SFTP, Microsoft SQL Server, MySQL, MS Access, ODBC, Oracle, and SAP. Client code for SAP IDoc Writer connections. Authentication type for Microsoft Dynamics CRM and Web Service connections. Host name. Or host and instance name for Microsoft SQL Server connections. Account ID. Language code for SAP IDoc Writer connections. Remote directory for FTP/SFTP connections. Schema name for Microsoft SQL Server, ODBC, Oracle, and Web Service connections. Service URL for Microsoft Dynamics CRM, Oracle CRM On Demand, and Salesforce connections. The first 50 letters of the description. connection 93

103 connection Object Response Attribute type port password username securitytoken stsurl organizationname timeout trustcertificatesfile certificatefile certificatefilepassword certificatefiletype privatekeyfile privatekeypassword privatekeyfiletype Connection type. Returns one of the following responses: - CSVFile. CSV flat file. - FTP. - MS_ACCESS. - MSD. Microsoft Dynamics CRM. - MySQL. - ODBC. - Oracle. - OCOD. Oracle CRM On Demand. - Salesforce. - SFTP. Secure FTP. - SAP_ALE_IDoc_Reader. SAP IDoc Reader. - SAP_ALE_IDoc_Writer. SAP IDoc Writer. - SqlServer. Microsoft SQL Server SqlServer2005. Microsoft SQL Server SqlServer2008. Microsoft SQL Server TOOLKIT. Informatica Cloud Connector. - WebServicesConsumer. Web Service. Port number for FTP/SFTP, Microsoft SQL Server, MySQL, and Oracle connections. Password for the connection. User name for the connection. Security token for a Salesforce connection. Security token service URL for Microsoft Dynamics CRM connections that use Active Directory authentication. Organization name for Microsoft Dynamics CRM connections. Timeout for Web Service connections. Trust certificates file name for Web Service connections. Certificates file name for Web Service connections. Certificates file password for Web Service connections. Certificates file type for Web Service connections. Private key file name for Web Service connections. Private key password for Web Service connections. Private key file type for Web Service connections. 94 Chapter 3: Informatica Cloud REST API - Version 2

104 The connlistitem object includes the following attributes: connlistitem Object Response Attribute id name Source or target ID. Source or target name. POST Request You can create or update any connection type except the Informatica Cloud Connector. To update a connection, use the connection ID with the following URI. To create a connection, omit the optional connection ID. /api/v2/connection/<id> With this URI, use the additional attributes in the connection object. For a list of attributes based on the connection type, see the connection type table below. The following table lists the attributes that you can use to create or update a CSV Flat File connection. CSV Flat File Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use CSVFile. database Required Directory where flat files are stored. connection 95

105 CSV Flat File Attribute dateformat Required Date format for date fields in the flat file. Use one of the following formats: - MM/dd/yyyy - MM-dd-yyyy - MM.dd.yyyy - dd/mm/yyyy - dd-mm-yyyy - dd.mm.yyyy - MM/dd/yyyy HH:mm - MM-dd-yyyy HH:mm - MM.dd.yyyy HH:mm - dd/mm/yyyy HH:mm - dd-mm-yyyy HH:mm - dd.mm.yyyy HH:mm - MM/dd/yyyy HH:mm:ss - MM-dd-yyyy HH:mm:ss - MM.dd.yyyy HH:mm:ss - dd/mm/yyyy HH:mm:ss - dd-mm-yyyy HH:mm:ss - dd.mm.yyyy HH:mm:ss - yyyy-mm-dd - yyyy-mm-dd HH:mm - yyyy-mm-dd HH:mm:ss - yyyy-mm-ddthh:mm:ss.sssz codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update an FTP or SFTP connection. FTP/SFTP Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use FTP or SFTP. username Required User name. password Required Password. host Required Name of the machine hosting the database server or FTP/SFTP host. For a FTP/SFTP connection, enter the host name or IP address. 96 Chapter 3: Informatica Cloud REST API - Version 2

106 FTP/SFTP Attribute port Required Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP 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 one of the following formats: - MM/dd/yyyy - MM-dd-yyyy - MM.dd.yyyy - dd/mm/yyyy - dd-mm-yyyy - dd.mm.yyyy - MM/dd/yyyy HH:mm - MM-dd-yyyy HH:mm - MM.dd.yyyy HH:mm - dd/mm/yyyy HH:mm - dd-mm-yyyy HH:mm - dd.mm.yyyy HH:mm - MM/dd/yyyy HH:mm:ss - MM-dd-yyyy HH:mm:ss - MM.dd.yyyy HH:mm:ss - dd/mm/yyyy HH:mm:ss - dd-mm-yyyy HH:mm:ss - dd.mm.yyyy HH:mm:ss - yyyy-mm-dd - yyyy-mm-dd HH:mm - yyyy-mm-dd HH:mm:ss - yyyy-mm-ddthh:mm:ss.sssz codepage Required The code page of the system that hosts the flat file. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update a Microsoft Dynamics CRM connection. Microsoft Dynamics CRM Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. connection 97

107 Microsoft Dynamics CRM Attribute description of the connection. type Required Connection type. Use MSD. authenticationtype Required Authentication type for the connection. Select a valid authentication type. Use one of the following authentication types: - LIVE. Microsoft Live. Use for data synchronization tasks or PowerCenter tasks. - IFD. Internet Facing Development (IFD). Use for data synchronization tasks or PowerCenter tasks. - AD. Active Directory. Use for PowerCenter tasks only. username Required Microsoft Dynamics CRM user name. password Required Microsoft Dynamics CRM password. organizationname Required Microsoft Dynamics CRM organization name. domain Required for IFD and Active Directory authentication 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: <orgname>.crm.dynamics.com For IFD authentication, use the following format: For Active Directory, use the following format: stsurl agentid Required for IFD authentication Required for Active Directory authentication Microsoft Dynamics CRM security token service URL. For example, sts1.company.com. IFD authentication only. Secure Agent ID. Active Directory authentication only. The following table lists the attributes that you can use to create or update a Microsoft SQL Server connection. Microsoft SQL Server Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. 98 Chapter 3: Informatica Cloud REST API - Version 2

108 Microsoft SQL Server Attribute description of the connection. type Required Connection type. Use one of the following codes: - SqlServer. Microsoft SQL Server SqlServer2005. Microsoft SQL Server SqlServer2008. Microsoft SQL Server 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. port Required Network port number used to connect to the database server. Default port number is instancename Instance name of the Microsoft SQL Server database. database Required Database name for the Microsoft SQL Server target. Database name is case sensitive if the database is case sensitive. Maximum length is 100 characters. Database names can include alphanumeric and underscore characters. schema Required for Microsoft SQL Server 2005 and 2008 Schema used for the target connection. Required for Microsoft SQL Server 2005 and Microsoft SQL Server 2008 databases. codepage Required The code page of the Microsoft SQL Server database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update an MS Access connection. MS Access Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use MS_ACCESS. database Required Data source name. connection 99

109 MS Access Attribute codepage Required The code page compatible with the MS Access database. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update a MySQL connection. MySQL Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. 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. port Required Network port number used to connect to the database server. Default is database Required Database name for the MySQL database target. Database name is case sensitive if the database 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: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update an ODBC connection. ODBC Attribute id Required Connection ID. orgid Required Organization ID. 100 Chapter 3: Informatica Cloud REST API - Version 2

110 ODBC Attribute name Required Connection name. description of the connection. type Required Connection type. Use ODBC. username Required User name for the database login. password Required Password for the database login. database Required Data source name. schema Required to connect to IBM DB2 Schema used for the target connection. Use uppercase letters when you specify the schema name for an Oracle database. Required to connect to an IBM DB2 database. codepage Required The code page of the database server or flat file defined in the connection. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update an Oracle connection. Oracle Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use Oracle. 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. port Required Network port number used to connect to the database server. Default is database Required Service name that uniquely identifies the Oracle database. If the connection fails, contact the database administrator. connection 101

111 Oracle Attribute schema Schema used for the target connection. codepage Required The code page of the database server. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent that Informatica Cloud uses to access the database in the local area network. The following table lists the attributes that you can use to create or update an Oracle CRM On Demand connection. Oracle CRM On Demand Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use OCOD. username Required Oracle CRM On Demand user name. Use the following format: <domain>/<user name> For example: domain/[email protected]. password Required Oracle CRM On Demand password. serviceurl Required URL of the Oracle CRM On Demand service. For example: securecompany.crmondemand.com. The following table lists the attributes that you can use to create or update a Salesforce connection. Salesforce Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use Salesforce. username Required User name for the Salesforce account. 102 Chapter 3: Informatica Cloud REST API - Version 2

112 Salesforce Attribute password Required Password for the Salesforce account. securitytoken Security token associated with the user name and password. serviceurl Required URL of the Salesforce service. Maximum length is 100 characters. The following table lists the attributes that you can use to create or update an SAP IDoc Writer connection. SAP IDoc Writer Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. 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 as en for English. clientcode Required SAP client number. A three-letter code. codepage Required The code page compatible with the SAP target. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update an SAP IDoc Reader connection. SAP ALE IDoc Reader Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. connection 103

113 SAP ALE IDoc Reader Attribute description of the connection. 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 the logical 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. Use one of the following options: - UTF-8. Unicode Transformation Format, multibyte. - MS1252. MS Windows Latin1 (ANSI), superset of Latin1. agentid Required Secure Agent ID. The following table lists the attributes that you can use to create or update a Web Service connection. Web Service Attribute id Required Connection ID. orgid Required Organization ID. name Required Connection name. description of the connection. type Required Connection type. Use WebServicesConsumer. username User name for the web service login. If the web service does not require a user name, leave this field empty. password Password for the web service login. If the web service does not require a user name, leave this field empty. domain Domain for authentication. serviceurl Endpoint URL for the web service that you want to access. The WSDL file specifies this URL in the location element. timeout Number of seconds Informatica Cloud waits for a connection to the web service provider before it closes the connection and fails the session. Also, the number of seconds the Informatica Cloud waits for a SOAP response after sending a SOAP request before it fails the session. Default is 60 seconds. trustcertificatesfile File containing the bundle of trusted certificates that Informatica Cloud uses when authenticating the SSL certificate of the web services provider. Default is cabundle.crt. 104 Chapter 3: Informatica Cloud REST API - Version 2

114 Web Service Attribute certificatefile Client certificate that a web service provider uses when authenticating a client. You specify the client certificate file if the web service provider needs to authenticate Informatica Cloud. certificatefilepassword Password for the client certificate. You specify the certificate file password if the web service provider needs to authenticate Informatica Cloud. certificatefiletype File type of the client certificate. You specify the certificate file type if the web service provider needs to authenticate the Integration Service. Use one of the following codes: - PEM - DER privatekeyfile Private key file for the client certificate. You specify the private key file if the web service provider needs to authenticate Informatica Cloud. privatekeypassword Password for the private key of the client certificate. You specify the key password if the web service provider needs to authenticate Informatica Cloud. privatekeyfiletype File type of the private key of the client certificate. You specify the key file type if the web service provider needs to authenticate Informatica Cloud. If necessary, use PEM. authenticationtype Authentication type to use when the web service provider does not return an authentication type to Informatica Cloud. Use one of the following options: - Auto. The Integration Service attempts to determine the authentication type of the web service provider. - Basic. Based on a non-encrypted user name and password. - Digest. Based on an encrypted user name and password. - NTLM. Based on encrypted user name, password, and domain. Default is Auto. agentid Required ID for the Secure Agent that Informatica Cloud uses to access the database in the local area network. POST Response If successful, returns the connection object for the connection that was created or updated. Returns the error object if errors occur. DELETE Request To delete a connection, use the connection ID in the following URI. /api/v2/connection/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. POST Example To update a flat file connection with an ID of 0002D J using XML, you might use the following request: POST <serverurl>/api/v2/user/connection/0002d j HTTP/1.0 Content-Type: application/xml connection 105

115 Accept: application/xml icsessionid: <icsessionid> <connection> <id>0002d j</id> <orgid> </orgid> <name>test dir</name> <type>csvfile</type> <database>c:\test files</database> <dateformat>mm/dd/yyyy</dateformat> <codepage>ms1252</codepage> <agentid>000h1l </agentid> </connection> A successful request returns the connection object that you updated. customfunc Use this resource to request the details of a plug-in or to request a list of all plug-ins in the organization. You can also use this resource to create or update a plug-in, and to delete a plug-in. GET Request To request the details of a single plug-in, use the plug-in ID in the following URI. To request a list of all plug-ins in the organization, omit the optional plug-in ID. /api/v2/customfunc/<id> GET Response If the request for a list of plug-ins is successful, returns the customfunc object for every plug-in in the organization without the input, output, and connection details. If the request for the details of a single plug-in is successful, returns the customfunc object. Returns the error object if errors occur. The customfunc object includes the following attributes: customfunc Object Response Attribute id orgid name description createtime updatetime createdby updatedby mappletname Plug-in ID. Organization ID. Plug-in name. Plug-in description. Time the plug-in was created. Time the plug-in was last updated. User who created the plug-in. User who last updated the plug-in. Name of the Mapplet transformation used in the plug-in. 106 Chapter 3: Informatica Cloud REST API - Version 2

116 customfunc Object Response Attribute active mappletxmlfile inputs Whether the plug-in is active: - true. The plug-in is active. - false. The plug-in is passive. The plug-in XML file. Input fields for the plug-in. Includes the following information in for each field in the fields object: - id - name - type - uniquename - label - parentobject - precision - scale - columnindex - iskey - isexternalid - isnullable - isunique - iscreateable - isupdateable - isfilterable - relatedinfos. Includes the following information in the fieldrelatedinfo object: - referenceobject - relationshipname customfunc 107

117 customfunc Object Response Attribute outputs connections Output fields for the plug-in. Includes the following information in for each field in the fields object: - id - name - type - uniquename - label - parentobject - precision - scale - columnindex - iskey - isexternalid - isnullable - isunique - iscreateable - isupdateable - isfilterable - relatedinfos. Includes the following information in the fieldrelatedinfo object: - referenceobject - relationshipname Connection information for the plug-in. Includes the following attributes in the pcsconnection object for each connection: - id - name - type - subtype - description - connectionid POST Request To update an existing plug-in, use the plug-in ID in the following URI. To create a new plug-in, omit the optional ID parameter: /api/v2/customfunc/<id> Note: Encode the request body as multipart/form-data. With this URI, you can use the following attributes in the request body: customfunc Object Request Attribute file Required Plug-in XML file. name Required Plug-in name. File content should be in binary format, UTF-8 encoding. description Plug-in description 108 Chapter 3: Informatica Cloud REST API - Version 2

118 In addition to the POST attributes, pass the following information in the request body: Boundary value. Used to define different parts of the request body. File name. Name of the plug-in XML file. icsessionid. Informatica Cloud session ID returned by the login resource. You can pass this information in the request body for clients that do not allow custom headers. If you can pass icsessionid as part of the request header, you can omit this information in the request body. Use the following template for the customfunc POST request: URL: <serverurl>/api/v2/customfunc/ HTTP method: POST Content-Type:multipart/form-data;boundary=<boundary value> --<boundary value> Content-Disposition:form-data; name="file";filename="<filename.xml>";content-type:text/<xml json> <content of the plug-in/mapplet XML file encoded as UTF-8> --<boundary value> Content-Disposition: form-data; name="name" <plug-in name> --<boundary value> Content-Disposition: form-data; name="desc" <description of the plug-in> --<boundary value> Content-Disposition: form-data; name="icsessionid" <icsessionid returned from login resource> --<boundary value>-- POST Response If successful, returns the customfunc response object for the plug-in that was created or updated. Returns the error object if errors occur. DELETE Request To delete a plug-in, use the plug-in ID in the following URI: /api/v2/customfunc/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. POST Example To update a plug-in with an ID of 3 with an icsessionid of IV4wOrJmd6YUtmKa8t, you might use the following request. The updated plug-in is named Lookup Plug-in and uses the lookup_plug-in.xml file. XML data should be encoded in UTF-8. URL: HTTP method: POST Content-Type:multipart/form-data;boundary= Content-Disposition:form-data; name="file";filename="<lookup_plug-in.xml>";content-type:text/xml <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE POWERMART SYSTEM "powrmart.dtd"> <POWERMART CREATION_DATE="05/14/ :17:26" REPOSITORY_VERSION="181.90"> <REPOSITORY NAME="pc91hf1" VERSION="181" CODEPAGE="UTF-8" DATABASETYPE="Oracle"> <FOLDER NAME="test" GROUP="" OWNER="Administrator" SHARED="SHARED" DESCRIPTION="" PERMISSIONS="rwx--- r--" UUID="96f9d03b-c2c e3a bbf6e8"> <SOURCE BUSINESSNAME ="" DATABASETYPE ="Oracle" DBDNAME ="ddicst" DESCRIPTION ="" NAME customfunc 109

119 ="CUSTOMERMASTER" OBJECTVERSION ="1" OWNERNAME ="C01" VERSIONNUMBER ="1"> <SOURCEFIELD BUSINESSNAME ="" DATATYPE ="nvarchar2" DESCRIPTION ="" FIELDNUMBER ="1" FIELDPROPERTY ="0" FIELDTYPE ="ELEMITEM" HIDDEN ="NO" KEYTYPE ="PRIMARY KEY" LENGTH ="0" LEVEL ="0" NAME ="CUSTOMERID" NULLABLE ="NOTNULL" OCCURS ="0" OFFSET ="0" PHYSICALLENGTH ="30" PHYSICALOFFSET ="0" PICTURETEXT ="" PRECISION ="30" SCALE ="0" USAGE_FLAGS =""/>... <ATTRIBUTE NAME ="Parameter Filename" VALUE =""/> <ATTRIBUTE NAME ="Write Backward Compatible Workflow Log File" VALUE ="NO"/> <ATTRIBUTE NAME ="Workflow Log File Name" VALUE ="wf_plugin_lookup.log"/> <ATTRIBUTE NAME ="Workflow Log File Directory" VALUE ="$PMWorkflowLogDir\"/> <ATTRIBUTE NAME ="Save Workflow log by" VALUE ="By runs"/> <ATTRIBUTE NAME ="Save workflow log for these runs" VALUE ="0"/> <ATTRIBUTE NAME ="Service Name" VALUE =""/> <ATTRIBUTE NAME ="Service Timeout" VALUE ="0"/> <ATTRIBUTE NAME ="Is Service Visible" VALUE ="NO"/> <ATTRIBUTE NAME ="Is Service Protected" VALUE ="NO"/> <ATTRIBUTE NAME ="Fail task after wait time" VALUE ="0"/> <ATTRIBUTE NAME ="Enable HA recovery" VALUE ="NO"/> <ATTRIBUTE NAME ="Automatically recover terminated tasks" VALUE ="NO"/> <ATTRIBUTE NAME ="Service Level Name" VALUE ="Default"/> <ATTRIBUTE NAME ="Allow concurrent run with unique run instance name" VALUE ="NO"/> <ATTRIBUTE NAME ="Allow concurrent run with same run instance name" VALUE ="NO"/> <ATTRIBUTE NAME ="Maximum number of concurrent runs" VALUE ="0"/> <ATTRIBUTE NAME ="Assigned Web Services Hubs" VALUE =""/> <ATTRIBUTE NAME ="Maximum number of concurrent runs per Hub" VALUE ="1000"/> <ATTRIBUTE NAME ="Expected Service Time" VALUE ="1"/> </WORKFLOW> </FOLDER> </REPOSITORY> </POWERMART> Content-Disposition: form-data; name="name" Lookup Plug-in Content-Disposition: form-data; name="icsessionid" IV4wOrJmd6YUtmKa8t A successful request returns the customfunc response object for the plug-in that you updated, dnbworkflow Use this resource to request the details of a D&B360 workflow or the details of all D&B360 workflows in the organization. You can also create or update a D&B360 workflow, and you can delete a D&B360 workflow. For Informatica Cloud D&B360 partners only. GET Request To request the details of a D&B360 workflow, use the following syntax. To view details of all D&B360 workflows, omit the optional workflow ID. /api/v2/dnbworkflow/<id> GET Response Returns the dnbworkflow object for the requested D&B360 workflow. Or, if you requested information for all D&B360 workflows, returns the dnbworkflow object for each D&B360 workflow in the organization. Returns the error object if errors occur. 110 Chapter 3: Informatica Cloud REST API - Version 2

120 The dnbworkflow object includes the following attributes: dnbworkflow Object Response Attribute id orgid name description createtime updatetime createdby updatedby uname batchname batchtype applicationtype objecttype rowlimit partnerprofile Workflow ID. Organization ID. Workflow name. of the workflow. When the workflow was created. When the workflow was last updated. D&B360 user who created the workflow. D&B360 user who updated the workflow. Workflow unique identifier. Returns one of the following values: - NewBatchSalesforceAccount - NewBatchOCODAccount - NewBatchOSCAccount - NewBatchMSDAccount - NewBatchSAPCRMAccount - RefreshBatchSalesforceAccount - RefreshBatchOCODAccount - RefreshBatchOSCAccount - RefreshBatchMSDAccount - RefreshBatchSAPCRMAccount - ImportBatchSalesforceAccount - ImportBatchOCODAccount - ImportBatchOSCAccount - ImportBatchMSDAccount - ImportBatchSAPCRMAccount Display name of the D&B360 batch that the D&B360 workflow belongs to. Batch type for the D&B360 workflow. Returns one of the following values: - NewBatch - RefreshBatch - ImportBatch Type of application for the D&B360 workflow. Returns one of the following values: - Salesforce. - OCOD. Oracle CRM On Demand. - OSC. - MSD. Microsoft Dynamics CRM. - SAPCRM. Type of object for the D&B360 workflow. Returns one of the following values: - Account Row limit for the workflow. Partner profile code. dnbworkflow 111

121 dnbworkflow Object Response Attribute companycustomobject admincustomobject leadcustomobject odbcuser connections schedule dnbtasks id name description ordernum Company custom object number. Admin custom object number. Lead custom object number. ODBC user ID. Returns the connection response object each connection used in the workflow. For more information, see the connection resource. Name of the schedule associated with the workflow. D&B360 tasks included in the workflow. Includes the following information for each task in a dnbtask object. Task ID. Task Name.. Order number. POST Request To update a D&B360 workflow, use the following URI. To create a D&B360 workflow, omit the optional workflow ID. /api/v2/dnbworkflow/<id> With this URI, use the following attributes in the dnbworkflow object. dnbworkflow Object Request Attribute uname Required Unique identifier for the workflow. rowlimit Workflow row limit. partnerprofile 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 Oracle CRM On Demand Company custom object number. Enter a number between To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. admincustomobject Oracle CRM On Demand Admin custom object number. Enter a number between Chapter 3: Informatica Cloud REST API - Version 2

122 dnbworkflow Object Request Attribute To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. leadcustomobject Oracle CRM On Demand Lead custom object number. Enter a number between To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number. Oracle CRM On Demand D&B360 workflows only. odbcuser 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 Agent uses to access Siebel database tables. Enter your user ROW_ID value. To get this value, run the following query on the Siebel CRM database: Select ROW_ID from S_USER where LOGIN = <Secure Agent login name>. The default value is 0-1. connectionid Required Connection ID. Siebel D&B360 workflows only. connectionid2 Additional connection ID. Used for SAP IDoc Writer connections. scheduleid Schedule ID. POST Response Returns the dnbworkflow object if the D&B360 workflow is successfully created or updated. Returns the error object if errors occur. DELETE Request To delete a D&B360 workflow, use the D&B360 workflow ID in the following URI. /api/v2/dnbworkflow/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. DELETE Example To delete a D&B360 workflow with an ID of , you might use the following request DELETE <serverurl>/api/v2/dnbworkflow/ HTTP/1.0 Accept:application/json icsessionid: <icsessionid> A successful request returns no response. dnbworkflow 113

123 field Use this resource to request field details for a source or target object. GET Request To request the field details of a source object, use the source connection ID and the object name in the following URI: /api/v2/connection/source/<id>/field/<objectname> To request the field details of a target object, use the target connection ID and the object name in the following URI: /api/v2/connection/target/<id>/field/<objectname> Note: The object name is case-sensitive. GET Response Returns the field object for each field in the requested object. Returns the error object if errors occur. A field object includes the following attributes. The field object includes different information based on the connection type. field Object Response Attribute id name type uniquename label parentobject precision scale columnindex iskey isexternalid isnullable isunique iscreateable isupdateable Field ID. Field name. Field type. Field unique name. Field label. Parent object, if applicable. Precision. Scale. Column index. Whether the field is a used as a key. Whether the field is used as an external ID. Whether the field can contain null values. Values are True or False. Whether the field requires unique values. Values are True or False. Whether the field accepts new values. Values are True or False. Whether the field allows updates. Values are True or False. 114 Chapter 3: Informatica Cloud REST API - Version 2

124 field Object Response Attribute isfilterable relatedinfos id referenceobject relationshipname Whether the field can be filtered. Values are True or False. Information about related fields. Includes the following attributes in a fieldrelatedinfo object for each related field. Field ID. Object that includes the field. Relationship to object. GET Example To use XML to get the field details for the Customer object available through the source connection (ID: 0002D J), you might use the following request: GET <serverurl>/api/v2/connection/source/0002d j/field/customer HTTP/1.0 Content-Type: application/xml Accept: application/xml icsessionid: <icsessionid> A successful request returns the fields object for each field in the Customer source object. filerecord Use this resource to upload an integration template XML file or image file to your organization. You can also use this resource to delete an integration template XML file or image file from the organization. POST Request To upload an integration template XML file or image file, use the following URI. /api/v2/filerecord You can upload a file up to 5 MB in size. Note: Encode the request body as multipart/form-data. Use the following attributes in the request body: filerecord POST Request Attribute file Required Content of the file that you want to upload. filerecord 115

125 filerecord POST Request Attribute File content should be in binary format, UTF-8 encoding. type Required Type of file that you want to upload. Use one of the following values: - MAPPING. Use to upload an integration template XML file. Use for XML files only. - IMAGE. Use to update an image file for an integration template. Use for JPEG or PNG files only. In addition to the POST attributes, pass the following information in the request body: Boundary value. Used to define different parts of the request body. File name. The file name of the content you want to upload. icsessionid. Informatica Cloud session ID returned by the login resource. You can pass this information in the request body for clients that do not allow custom headers. If you can pass icsessionid as part of the request header, you can omit this information in the request body. Use the following template for the filerecord POST request: URL: <serverurl>/api/v2/filerecord/ HTTP method: POST Content-Type:multipart/form-data;boundary=<boundary value> --<boundary value> Content-Disposition:form-data; name="file";filename="<filename.ext>";content-type:text/<xml json> <content of the file you want to upload encoded as UTF-8> --<boundary value> Content-Disposition: form-data; name="type" <MAPPING IMAGE> --<boundary value> Content-Disposition: form-data; name="icsessionid" <icsessionid returned from login resource> --<boundary value>-- POST Response Returns the filerecord object if the upload is successful. Returns the error object if errors occur. The filerecord object includes the following attributes: filerecord Object Attribute id orgid name ID for the uploaded file. You can use this ID to identify the file when you create or update an integration template with the mastertemplate resource. Organization Id. File name. 116 Chapter 3: Informatica Cloud REST API - Version 2

126 filerecord Object Attribute description createtime updatetime createdby updatedby type size attachtime of the file. Time the file was uploaded to the organization. Last time the file was updated. User who first uploaded the file. User who last updated the file. File type. File size. Time the file was associated with an integration template. DELETE Request You can delete an integration template XML or image file if the integration template is not used by an integration template. To delete a file, use the file ID in the following URI: /api/v2/filerecord/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. POST Example To upload the IntegrationTemplate.xml file with an icsessionid of IV4wOrJmd6YUtmKa8t, you might use the following request. XML data should be encoded in UTF-8. URL: HTTP method: POST Content-Type:multipart/form-data;boundary= Content-Disposition:form-data; name="file";filename="<integrationtemplate.xml>";content-type:text/xml <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Graph SYSTEM "graph.dtd"> <Graph Name="" ="" UItype="" DlgSize=""> <Groups /> <Parameters> <Parameter Name="$EXTERNALID C$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" ="" /> <Parameter Name="$TGT$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="Combo_Ctrl" Data="Targets" ="" /> <Parameter Name="$GroupBy$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" ="" /> <Parameter Name="$o_PERCENT_FLD C$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" ="" /> <Parameter Name="$SRC$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="Combo_Ctrl" Data="Sources" ="" /> </Parameters> <Node NameID="Source Definition" Name="$SRC$" Reusable="" Type="Source Definition" InstanceName="$SRC $" ="" isparameterized="true"> <CustomProperty Name="Source Table" Value="$SRC$" isparameterized="true" /> <CustomProperty Name="Database Name" Value="" isparameterized="false" /> <CustomProperty Name="Owner Name" Value="" isparameterized="false" /> filerecord 117

127 <CustomProperty Name="Business Name" Value="" isparameterized="false" /> <CustomProperty Name="Database Type" Value="" isparameterized="false" /> <CustomProperty Name="Is ShortCut" Value="False" isparameterized="false" /> </Node>... <Link Name="Sheet.7" FromNameID="Aggregator" ToNameID="Target Definition" MasterInputSet="False" isparameterized="false"> <Rule Text="Datatype:string" isparameterized="false" /> <Rule Text="EXCLUDE Named:AUTO C (TO) AUTO C" isparameterized="false" /> <Rule Text="Datatype:date/time" isparameterized="false" /> <Rule Text="Pattern:_o$" isparameterized="false" /> <Rule Text="Datatype:nstring" isparameterized="false" /> <Rule Text="Datatype:ntext" isparameterized="false" /> <Rule Text="Datatype:text" isparameterized="false" /> </Link> </Graph> Content-Disposition: form-data; name="type" MAPPING Content-Disposition: form-data; name="icsessionid" IV4wOrJmd6YUtmKa8t If the upload is successful, returns the filerecord response object. job Use this resource to start an Informatica Cloud task or task flow. POST Request To start a task or task flow, use the following URI: /api/v2/job With this URI, use the following attributes in a job object: job Object Request Attribute taskid Required Task or taskflow ID. tasktype Required Type of task or taskflow. Use one of the following options: - AVS. Contact Validation task. - DLS. Data loader task. - DQA. Data assessment task. - DRS. Data replication task. - DSS. Data synchronization task. - MTT. Custom integration task. - PCS. PowerCenter task. - Workflow. Task flow. - DNB_WORKFLOW. D&B360 workflow. 118 Chapter 3: Informatica Cloud REST API - Version 2

128 POST Response Returns no response if the request is successful. Returns an error object if errors occur. POST Example To start a task flow with an ID of 0034J M in JSON, you might use the following request: POST <serverurl>/api/v2/job HTTP/1.0 Content-Type: application/json Accept: application/json icsessionid: <icsessionid> { "@type": "job", "taskid": "0034J M", "tasktype": "Workflow" } Returns no response if the request is successful. login Use this resource to log in to an Informatica Cloud organization with Informatica Cloud or Salesforce credentials. Returns a REST API session ID that you can use for subsequent REST API requests. POST Request You can log in to an organization with your Informatica Cloud user name and password. Or you can log in with a Salesforce session ID and Salesforce server URL. To log in with your Informatica Cloud user name and password, use the following URL: With this URL, use the following attributes in a login object: login Object Request Attribute username Required Informatica Cloud user name. password Required Informatica Cloud password. To log in using a Salesforce session ID and Salesforce server URL, use the following URL: You can use Salesforce information to log in to Informatica Cloud if you have included your Salesforce user name in your Informatica Cloud user account. You can use the Salesforce Web Services API to generate a Salesforce session ID and to retrieve the Salesforce server URL. For more information, see the login resource in the Salesforce Web Services API Developer's Guide. login 119

129 With this URL, use the following attributes in a login object: login Object Request Attribute sfsessionid Required Salesforce session ID. sfserverurl Required Salesforce server URL. For information about generating the Salesforce session ID, see the login resource in the Salesforce Web Services API Developer's Guide. You can retrieve the Salesforce server URL from the Salesforce Web Services API login resource response. POST Response Returns the user object if the request is successful. Returns the error object if errors occur. The user object includes the following attributes: user Object Response Attribute id orgid name description createtime updatetime createdby updatedby sfusername password firstname lastname title phone timezone User ID. ID of the organization the user belongs to. Informatica Cloud user name. of the user. When the user account was created. When the user account was last updated. Informatica Cloud user who created the user account. Informatica Cloud user who last updated the user account. Salesforce user name. Salesforce password. First name for the user account. Last name for the user account. Title of the user. Phone number for the user. addresses to be notified when the user changes the account password. Time zone of the user. Time zone honors Daylight Saving Time. 120 Chapter 3: Informatica Cloud REST API - Version 2

130 user Object Response Attribute serverurl icsessionid Informatica Cloud URL for the organization the user belongs to. Use the serverurl as a base for most REST API resource URIs. Informatica Cloud REST API session ID. Use in most REST API request headers. POST Example To log in to your Informatica Cloud organization using Informatica Cloud credentials, you might use the following request: POST HTTP/1.0 Content-Type: application/json Accept: application/json { "@type": "login", "username": "user @company.com", "password": "mypassword" } If successful, returns the user object. mastertemplate Use this resource to request the details for an integration template or the details of all integration templates in the organization. You can create or update an integration template, and request a list of custom integration tasks that use the template. You can also delete an integration template. GET Request To request the details of an integration template, use the integration template ID with the following URI. To request the details of all integration templates in the organization, omit the optional integration template ID: /api/v2/mastertemplate/<id> To request a list of custom integration tasks that use an integration template, use the integration template ID in the following URI: /api/v2/mastertemplate/<id>/tasks GET Response If successful, returns the mastertemplate object for the requested integration template. If you request the details for all integration templates, returns the mastertemplate object without parameter details for every integration template in the organization. Returns the error object if errors occur. mastertemplate 121

131 The mastertemplate object includes the following attributes: mastertemplate Object Response Attribute id orgid name description createtime updatetime createdby updatedby difilerecordid templateimageid parameters id name label type description customfuncid Integration template ID. Organization ID. Integration template name. of the integration template. Time the integration template was created. Last time the integration template was updated. User who created the integration template. User who last updated the integration template. ID of the integration template XML file. ID of the integration template image file. Parameters used in the integration template. Includes the following attributes in the mtparameter object for each parameter. Parameter ID. Parameter name. Parameter label. Parameter type. Parameter description. Plug-in ID for mapplet type parameters. 122 Chapter 3: Informatica Cloud REST API - Version 2

132 mastertemplate Object Response Attribute sessionattrs uiproperties Display property for the parameter. Includes the following information: - cnxtype. Connection type for the parameter. - logcnx. Logical connection. - order. Display order. - wizstep. Wizard step to display the parameter. - default. Default value. - visible. Whether the parameter is visible. - editable. Whether the parameter is editable. - required. Whether the parameter is required. - paramtype. UI control type for string parameters. Returns one of the following responses: - Condition. Filter condition input control. - Expression. Expression editor input control. - Field. Field selection input control. - Fieldmap. Field mapping input control. Includes the following attributes: - lefttitle. Left title for the field mapping display. - righttitle. Right title for the field mapping display. - leftfs. Set of fields to display in the left table of the field mapping display. - rightfs. Set of fields to display in the right table of the field mapping display. - leftfilter. Regular expression to limit the fields that display in the left table of the field mapping display. - rightfilter. Regular expression to limit the fields that display in the right table of the field mapping display. - staticlist. List of fields to display on the right side of the field mapping display. General and performace session properties for the task. Can include the following attributes. mastertemplate 123

133 mastertemplate Object Response Attribute Write Backward Compatible Session Log File Session Log File Name Session Log File Directory $Source Connection Value $Target Connection Value Treat Source Rows as Commit Type Commit Interval Commit on End of File Rollback Transactions on Errors Writes the session log to a file. Name for the session log. Directory where the session log is saved. Source connection name. Target connection name. When the Custom Integration application reads source data, it marks each row with an indicator to specify the operation to perform when the row reaches the target: - Insert. All rows are marked for insert into the target. - Update. All rows are marked for update in the target. - Delete. All rows are marked for delete from the target. - Data Driven. The application uses the Update Strategyobject in the data flow to mark the operation for each source row. Commit type to use: - Source. Performs commits based on the number of source rows. - Target. Performs commits based on the number of target rows. - User Defined. Performs commits based on the commit logic defined in the integration template. If you do not configure a commit type, the application performs a target commit. Interval in rows between commits. If you do not configure a commit interval, the application commits every 10,000 rows. Commits data at the end of the file: - true. - false. If the application encounters a non-fatal error, you can choose to 124 Chapter 3: Informatica Cloud REST API - Version 2

134 mastertemplate Object Response Attribute roll back the transaction at the next commit point. When the application encounters a transformation error, it rolls back the transaction if the error occurs after the effective transaction generator for the target. Java Classpath DTM Buffer Size Incremental Aggregation Reinitialize Aggregate Cache Enable High Precision Session Retry on Deadlock Java classpath to use. Amount of memory allocated to the task from the DTM process. Performs incremental aggregation. - true. - false. Overwrites existing aggregate files for an incremental aggregation task. - true. - false. Processes the Decimal datatype to a precision of true. - false. The Custom Integration application retries a write on the target when a deadlock occurs. - true. - false. POST Request To update an integration template, use the integration template ID in the following URI. To create a new integration template, omit the optional integration template ID. /api/v2/mastertemplate/<id> With this attribute, you can use the following attributes in a mastertemplate object: mastertemplate Object Request Attribute name Required Name of the integration template. description of the integration template. difilerecordid Required Integration template XML file ID. mastertemplate 125

135 mastertemplate Object Request Attribute Use the ID returned when you upload the file to the organization with the filerecord resource. templateimageid Integration template image file ID. This ID is returned when you upload the file to the organization with the filerecord resource. parameters Object that defines parameters associated with the template. Use an mtparameter object to define the following attributes for each parameter. name Required Parameter name. label Parameter label. type Required Parameter type. Use one of the following values: - STRING - SOURCE - TARGET - MAPPLET - LOOKUP description Parameter description. customfuncid Plug-in ID for mapplet type parameters. uiproperties Display properties for the parameter. Use a UIPropertyType object to define the following display properties: - cnxtype. Connection type for the parameter. Use a valid connection type. For more information, see 126 Chapter 3: Informatica Cloud REST API - Version 2

136 mastertemplate Object Request Attribute connection on page logcnx. Logical connection. - order. Display order. - wizstep. Wizard step to display parameter. - default. Default value. - visible. Whether the parameter is visible. Use True or False. - editable. Whether the parameter is editable. Use True or False. - required. Whether the parameter is required. Use True or False. - paramtype. UI control type for string parameters. Use one of the following values: - Condition. Filter condition control. - Expression. Expression editor control. - Field. Field selection control. - Fieldmap. Field mapping input control. Includes the following attributes: - lefttitle. Left title for the field mapping display. - righttitle. Right title for the field mapping display. - leftfs. Set of fields to display in the left table of the field mapping display. - rightfs. Set of fields to display in the right table of the field mapping display. - leftfilter. Regular expression to limit the fields that display in the left table of the field mapping display. - rightfilter. Regular mastertemplate 127

137 mastertemplate Object Request Attribute expression to limit the fields that display in the right table of the field mapping display. - staticlist. List of fields to display on the right side of the field mapping display. Use instead of rightfs. List field names and associated datatypes separated by a line break or semicolon. For more information about the syntax for field filtering or staticlist, see "Importing or Editing an Integration Template" in the Informatica Cloud User Guide or online help. sessionattrs Object that defines the general and performace session properties for the task. Use a SessionAttrsType object to define any of the following properties that you want to use. Write Backward Compatible Session Log File Writes the session log to a file. - true. - false. Session Log File Name Name for the session log. Use any valid file name. You can use the following variables as part of the session log name: - $CurrentTaskName. Replaced with the task name. - $CurrentTime. Replaced with the current time. 128 Chapter 3: Informatica Cloud REST API - Version 2

138 mastertemplate Object Request Attribute Session Log File Directory Directory where the session log is saved. By default, the session log is saved to the following directory: <SecureAgent_InstallDir >/main/rdtmdir/logs. $Source Connection Value Source connection name. $Target Connection Value Target connection name. Treat Source Rows as When the Custom Integration application reads source data, it marks each row with an indicator to specify the operation to perform when the row reaches the target. Use one of the following values: - Insert. All rows are marked for insert into the target. - Update. All rows are marked for update in the target. - Delete. All rows are marked for delete from the target. - Data Driven. The application uses the Update Strategyobject in the data flow to mark the operation for each source row. Commit Type Commit type to use. Use one of the following values: - Source. Performs commits based on the number of source rows. - Target. Performs commits based on the number of target rows. - User Defined. Performs commits based on the commit logic defined in the integration template. If you do not configure a commit type, the mastertemplate 129

139 mastertemplate Object Request Attribute application performs a target commit. Commit Interval Interval in rows between commits. If you do not configure a commit interval, the application commits every 10,000 rows. Commit on End of File Commits data at the end of the file. - true. - false. Rollback Transactions on Errors If the application encounters a non-fatal error, you can choose to roll back the transaction at the next commit point. When the application encounters a transformation error, it rolls back the transaction if the error occurs after the effective transaction generator for the target. - true. - false. Java Classpath Java classpath to use. The Java Classpath that you enter is added to the beginning of the system classpath when the task runs. Use this option if you use third-party Java packages, builtin Java packages, or custom Java packages in a Java transformation. DTM Buffer Size Amount of memory allocated to the task from the DTM process. By default, a minimum of 12 MB is allocated to the buffer at run time. You can specify auto or a numeric value. If you enter 2000, the Custom Integration application interprets the number as 2000 bytes. Append KB, 130 Chapter 3: Informatica Cloud REST API - Version 2

140 mastertemplate Object Request Attribute MB, or GB to the value to specify other units. Increase the DTM buffer size in the following circumstances: - A task contains large amounts of character data. Increase the DTM buffer size to 24 MB. - A session contains n partitions. Increase the DTM buffer size to at least n times the value for the task with one partition. - A source contains a large binary object with a precision larger than the allocated DTM buffer size. Increase the DTM buffer size so that the task does not fail. Incremental Aggregation Performs incremental aggregation. - true. - false. Reinitialize Aggregate Cache Overwrites existing aggregate files for an incremental aggregation task. - true. - false. Enable High Precision Processes the Decimal datatype to a precision of true. - false. Session Retry on Deadlock The Custom Integration application retries a write on the target when a deadlock occurs. - true. - false. POST Response If the request to create or update an integration template is successful, returns the master template object for the integration template that you created or updated. Returns the error code if errors occur. mastertemplate 131

141 DELETE Request To delete an integration template, use the integration template ID in the following URI: /api/v2/mastertemplate/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. GET Example To request a list of tasks that use an integration template with an ID of T G, you might use the following request: GET <serverurl>/api/v2/mastertemplate/000043t g/tasks HTTP/1.0 Accept: application/xml icsessionid: <icsessionid> If successful, returns the mttask object with id, orgid, name, and mastertemplateid for each task that uses the integration template. mttask Use this resource to request the details of a custom integration task or the details of all custom integration tasks in the organization. You can also create or update a custom integration task, and you can delete a custom integration task. GET Request To request the details of a custom integration task, use the task ID in the following URI. To view the details of all custom integration tasks in the organization, omit the optional task ID. /api/v2/mttask/<id> GET Response Returns the mttask object for the requested task ID. Or, if you request information for all custom integration tasks, returns an mttask object for each custom integration task in the organization. Returns the error object if errors occurred. The mttask object includes the following attributes: mttask Object Response Attribute id orgid name description createtime Task ID. Organization ID. Task name.. Time the task was created. 132 Chapter 3: Informatica Cloud REST API - Version 2

142 mttask Object Response Attribute updatetime createdby updatedby errortask id s successtask id s warningtask id s parameters id name type indx text label description sourceconnectionid targetconnectionid lookupconnectionid sourceobject targetobject lookupobject Last time the task was updated. User who created the task. User who last updated the task. Attribute that includes the following attributes in the task object. ID. addresses to receive notification if the task fails to complete. Attribute that includes the following attributes in the task object. ID. addresses to receive notification if the task completes successfully. Attribute that includes the following attributes in the task object. ID. addresses to receive notification if the task completes with errors. Parameters associated with the task. Includes the following attributes in the mttaskparameter object for each parameter. Parameter ID. Parameter name. Parameter type. Sort index. Not used. Parameter value. Parameter label. Parameter description. Source connection ID. Target connection ID. Lookup connection ID. Source object name. Target object name. Lookup object name. mttask 133

143 mttask Object Response Attribute newflatfile flatfilename truncatetarget srcffattrs tgtffattrs lkpffattrs customfunccfg agentid lastruntime mastertemplateid scheduleid short Whether Informatica Cloud creates a new flat file target: - True. Creates a new target file. - False. Does not create a target file. Name of the flat file target. Whether Informatica Cloud truncates a database target before writing to it: - True. Truncates the target. - False. Does not truncate the target. Object for the source file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. Object for the target file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. Object for the target file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. Attribute that defines configuration for plug-ins used in the task. Includes the following attributes in the customfuncconfig object for each plug-in: - id. Plug-in ID. - connections. Object to define connections used in a plug-in. Includes the following attributes in the pcsconnection object for each connection: - id. - name. Connection name. - type. Connection type. - subtype. Connection subtype. - description - connectionid. Connection ID. ID for the Secure Agent to run the task. Time the task last run. ID of the integration template used in the task. Schedule associated with the task flow, if any. The first 50 characters of the description. POST Request To update a custom integration task, use custom integration task ID in the following URI. To create a custom integration task, omit the optional task ID. /api/v2/mttask/<id> 134 Chapter 3: Informatica Cloud REST API - Version 2

144 With this URI, you can use the following attributes in an mttask object: mttask Object Request Attribute errortask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task fails to complete. successtask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task completes successfully. warningtask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task completes with errors. parameters Attribute that defines parameters associated with the task. Use an mttaskparameter object to define the the following attributes for each parameter. id System generated parameter ID. You cannot update this value. name Parameter name. type Parameter type. Use one of the following values: - STRING - SOURCE - TARGET - MAPPLET - LOOKUP mttask 135

145 mttask Object Request Attribute indx Sort index. No longer used. text Parameter value. label Parameter label. description Parameter description. sourceconnectionid Source connection ID. targetconnectionid Target connection ID. lookupconnectionid Lookup connection ID. newflatfile Whether Informatica Cloud creates a new flat file target. Use one of the following values: - True. Creates a new target file. - False. Does not create a target file. flatfilename Name of the flat file target. truncatetarget Whether Informatica Cloud truncates a database target before writing to it. Use one of the following values: - True. Truncates the target. - False. Does not truncate the target. srcffattrs Object for the source file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. tgtffattrs Object for the target file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. 136 Chapter 3: Informatica Cloud REST API - Version 2

146 mttask Object Request Attribute lkpffattrs Object for the target file attributes. Includes the following attributes: - id. - delimiter. - textqualifier. - escapechar. customfunccfg Attribute to define configuration for plug-ins used in the task. Use a customfuncconfig object to define the following attributes for each plugin: - id. - connections. Attribute to define connections used in a plug-in. Use a pcsconnection object to define the following attributes for each connection: - id. - name. Connection name. - type. Connection type. - subtype. Connection subtype. - description - connection Id. Connection ID. For more information about connections, see connection on page 91 agentid Required ID for the Secure Agent to run the task. mastertemplateid Required ID of the integration template used in the task. scheduleid Schedule associated with the task flow, if any. POST Response If successful, returns the mttask object that you created or updated. Returns the error object if errors occur. DELETE Request To delete a custom integration task, use the task ID in the following URI: /api/v2/mttask/<id> mttask 137

147 DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. POST Example To create a new custom integration task with XML, you might use the following request: POST <serverurl>/api/v2/mttask HTTP/1.0 Content-Type: application/xml Accept: application/xml icsessionid: <icsessionid> <mttask> <errortask > <task > < s> [email protected], [email protected]</ s> </task > </errortask > <successtask > <task > < s>[email protected]</ s> </task > </successtask > <warningtask > <task > < s> [email protected], [email protected]</ s> </task > </warningtask > <parameters> <mttaskparameter> <name>sort convert plugin</name> <type>mapplet</type> </mttaskparameter> </parameters> <parameters> <mttaskparameter> <name>db lookup</name> <type>lookup</type> </mttaskparameter> </parameters> <agentid> d </agentid> <mastertemplateid> m00000r</mastertemplateid> </mttask> A successful request returns the mttask object that you just created. org Use this resource to request the details of your Informatica Cloud organization or a related sub-organization. You can use this resource to update an organization or related sub-organization. You can also delete a suborganization. GET Request To request the details of a sub-organization related to your organization, use the sub-organization ID in the following URI. To request the details of your organization, omit the optional sub-organization ID. /api/v2/org/<id> GET Response When you request the details of an organization, Informatica Cloud returns the org object in list format. 138 Chapter 3: Informatica Cloud REST API - Version 2

148 If the organization is a parent organization in an organization hierarchy, the org object includes the IDs and names of all sub-organizations. Returns the error object if errors occurred. The org object includes the following attributes: org Object Response Attribute id orgid name description createtime updatetime createdby updatedby parentorgid address1 address2 address3 city Organization ID. Organization ID. Organization name. of the organization. Time the organization was created. Last time the organization was updated. User who created the organization. Last user who updated the organization. Organization ID for the parent organization. Returns 0 if the organization is a stand-alone or parent organization. Address for the organization. Additional address information for the organization. Additional address information for the organization. City where the organization is based. org 139

149 org Object Response Attribute state zipcode State where the organization is based. Returns one of the following two-letter codes: - AL. Alabama. - AK. Alaska. - AZ. Arizona. - AR. Arkansas. - CA. California. - CO. Colorado. - CT. Connecticut. - DE. Delaware. - FL. Florida. - GA. Georgia. - HI. Hawaii. - ID. Idaho. - IL. Illinois. - IN. Indiana. - IA. Iowa. - KS. Kansas. - KY. Kentucky. - LA. Louisiana. - ME. Maine. - MD. Maryland. - MA. Massachusetts. - MI. Michigan. - MN. Minnesota. - MS. Mississippi. - MO. Missouri. - MT. Montana. - NE. Nebraska. - NV. Nevada. - NH. New Hampshire. - NJ. New Jersey. - NM. New Mexico. - NY. New York. - NC. North Carolina. - ND. North Dakota. - OH. Ohio. - OK. Oklahoma. - OR. Oregon. - PA. Pennsylvania. - RI. Rhode Island. - SC. South Carolina. - SD. South Dakota. - TN. Tennessee. - TX. Texas. - UT. Utah. - VT. Vermont. - VA. Virginia. - WA. Washington. - WV. West Virginia. - WI. Wisconsin. - WY. Wyoming. Postal code of the area where the organization is based. 140 Chapter 3: Informatica Cloud REST API - Version 2

150 org Object Response Attribute country Country where the organization is based. Returns one of the following two-letter codes: - AF. Afghanistan. - AX. Aland Islands. - AL. Albania. - DZ. Algeria. - AS. American Samoa. - AD. Andorra. - AO. Angola. - AI. Anguilla. - AQ. Antarctica. - AG. Antigua and Barbuda. - AR. Argentina. - AM. Armenia. - AW. Aruba. - AU. Australia. - AT. Austria. - AZ. Azerbaijan. - BS. Bahamas. - BH. Bahrain. - BD. Bangladesh. - BB. Barbados. - BY. Belarus. - BZ. Belize. - BE. Belgium. - BJ. Benin. - BM. Bermuda. - BT. Bhutan. - BO. Bolivia. - BA. Bosnia and Herzegovina. - BW. Botswana. - BV. Bouvet Island. - BR. Brazil. - IO. British Indian Ocean Territory. - BN. Brunei Darussalam. - BG. Bulgaria. - BF. Burkina Faso. - BI. Burundi. - KH. Cambodia. - CM. Cameroon. - CA. Canada. - CV. Cape Verde. - KY. Cayman Islands. - CF. Central African Republic. - TD. Chad. - CL. Chile. - CN. China. - CX. Christmas Island. - CC. Cocos (Keeling) Islands. - CO. Colombia. - KM. Comoros. - CG. Congo. - CD. Congo, the Democratic Republic of the. - CK. Cook Islands. - CR. Costa Rica. - CI. Cote d'ivoire. - HR. Croatia. - CU. Cuba. - CY. Cyprus. - CZ. Czech Republic. org 141

151 org Object Response Attribute - DK. Denmark. - DM. Dominica. - DO. Dominican Republic. - DJ. Djibouti. - EC. Ecuador. - EG. Egypt. - SV. El Salvador. - GQ. Equatorial Guinea. - ER. Eritrea. - EE. Estonia. - ET. Ethiopia. - FK. Falkland Islands (Malvinas). - FO. Faroe Islands. - FJ. Fiji. - FI. Finland. - FR. France. - GF. French Guiana. - PF. French Polynesia. - TF. French Southern Territories. - GA. Gabon. - GM. Gambia. - GE. Georgia. - DE. Germany. - GH. Ghana. - GI. Gibraltar. - GR. Greece. - GL. Greenland. - GD. Grenada. - GP. Guadeloupe. - GU. Guam. - GT. Guatemala. - GG. Guernsey. - GN. Guinea. - GW. Guinea-Bissau. - GY. Guyana. - HT. Haiti. - HM. Heard Island and McDonald Islands. - HN. Honduras. - HK. Hong Kong. - HU. Hungary. - IS. Iceland. - IN. India. - ID. Indonesia. - IR. Iran, Islamic Republic of. - IQ. Iraq. - IE. Ireland. - IL. Israel. - IM. Isle of Man. - IT. Italy. - JM. Jamaica. - JP. Japan. - JE. Jersey. - JO. Jordan. - KZ. Kazakhstan. - KE. Kenya. - KI. Kiribati. - KP. Korea, Democratic People's Republic of. - KR. Korea, Republic of. - KW. Kuwait. 142 Chapter 3: Informatica Cloud REST API - Version 2

152 org Object Response Attribute - KG. Kyrgyzstan. - LA. Lao People's Democratic Republic. - LV. Latvia. - LB. Lebanon. - LS. Lesotho. - LR. Liberia. - LY. Libyan Arab Jamahiriya. - LI. Liechtenstein. - LT. Lithuania. - LU. Luxembourg. - MO. Macao. - MK. Macedonia, the former Yugoslav Republic of. - MG. Madagascar. - MW. Malawi. - MY. Malaysia. - MV. Maldives. - ML. Mali. - MT. Malta. - MH. Marshall Islands. - MR. Mauritania. - MU. Mauritius. - MQ. Martinique. - YT. Mayotte. - MX. Mexico. - FM. Micronesia, Federated States of. - MD. Moldova, Republic of. - MC. Monaco. - MN. Mongolia. - ME. Montenegro. - MS. Montserrat. - MA. Morocco. - MZ. Mozambique. - MM. Myanmar. - NA. Namibia. - NR. Nauru. - NP. Nepal. - NL. Netherlands. - NC. New Caledonia. - NZ. New Zealand. - NI. Nicaragua. - NE. Niger. - NG. Nigeria. - NU. Niue. - NF. Norfolk Island. - MP. Northern Mariana Islands. - OM. Oman. - PK. Pakistan. - PW. Palau. - PS. Palestinian Territory, Occupied. - PA. Panama. - PG. Papua New Guinea. - PY. Paraguay. - PE. Peru. - PH. Philippines. - PN. Pitcairn. - PL. Poland. - PT. Portugal. - PR. Puerto Rico. - QA. Qatar. org 143

153 org Object Response Attribute - RE. Reunion. - RO. Romania. - RU. Russian Federation. - RW. Rwanda. - BL. Saint Barthelemy. - SH. Saint Helena. - KN. Saint Kitts and Nevis. - LC. Saint Lucia. - MF. Saint Martin (French part). - PM. Saint Pierre and Miquelon. - VC. Saint Vincent and the Grenadines. - WS. Samoa. - SM. San Marino. - ST. Sao Tome and Principe. - SA. Saudi Arabia. - SN. Senegal. - RS. Serbia. - SC. Seychelles. - SL. Sierra Leone. - SG. Singapore. - SK. Slovakia. - SI. Slovenia. - SB. Solomon Islands. - SO. Somalia. - ZA. South Africa. - GS. South Georgia and the South Sandwich Islands. - ES. Spain. - LK. Sri Lanka. - SD. Sudan. - SR. Suriname. - SJ. Svalbard and Jan Mayen. - SZ. Swaziland. - SY. Syrian Arab Republic. - SE. Sweden. - CH. Switzerland. - TW. Taiwan. - TJ. Tajikistan. - TZ. Tanzania, United Republic of. - TH. Thailand. - TL. Timor-Leste. - TG. Togo. - TK. Tokelau. - TO. Tonga. - TT. Trinidad and Tobago. - TN. Tunisia. - TR. Turkey. - TC. Turks and Caicos Islands. - TM. Turkmenistan. - TV. Tuvalu. - UG. Uganda. - UA. Ukraine. - AE. United Arab Emirates. - GB. United Kingdom. - US. United States. - UM. United States Minor Outlying Islands. - UY. Uruguay. - UZ. Uzbekistan. - VU. Vanuatu. - VA. Holy See (Vatican City State). 144 Chapter 3: Informatica Cloud REST API - Version 2

154 org Object Response Attribute - VE. Venezuela. - VN. Viet Nam. - VG. Virgin Islands, British. - VI. Virgin Islands, U.S. - WF. Wallis and Futuna. - EH. Western Sahara. - YE. Yemen. - ZM. Zambia. - ZW. Zimbabwe. employees success s warning s error s offercode campaigncode atlasprojectid zuoraaccountid maxlogrows minpasswordlength minpasswordcharmix passwordreuseindays passwordexpirationindays suborglimit parentorgid jobexecuserprofile Range of employees in the organization. addresses to receive notification of tasks that complete successfully. addresses to receive notification of tasks that complete with errors. addresses to receive notification of tasks that fail to complete. Offer code assigned to Informatica Cloud partners. Campaign code. Atlas project ID. Zuora account ID. Maximum number of rows to keep in the activity log. Minimum number of characters for a user account password. Mix of characters each password must contain. Passwords can contain a mix of the following character sets: lowercase letters, capital letters, numbers, and special characters. Returns one of the following values: - 1. Contains at least one of the character sets Contains at least two of the character sets Contains at least three of the character sets Contains all four character sets. Number of days until a previous password can be used again. 0 = Always. Number of days until the password expires. 0 = Never. Number of sub-organizations allowed. Organization ID of the parent organization. 0 indicates the organization is a stand-alone or parent organization. Informatica Cloud user account configured to run contact validation tasks. org 145

155 org Object Response Attribute twofactorauthentication ipaddressranges connectorlicenses uuid orgid connectorname licensetype expirationdate suborg id name A security option that allows the configuration of trusted IP address ranges as an addition to account password authentication: - False. Informatica Cloud requires account passwords for access to the organization. - True. Informatica Cloud requires account passwords for access to the organization, and the user must login from within configured IP address ranges. For Two-Factor Authentication. One or more trusted IP address rangesthat use IP format version 4 (IPv4) or version 6 (IPv6). Object that contains the following information for each Informatica Cloud Connector uploaded to the organization. Unique identifier for the connector. Organization ID. Name of the Informatica Cloud Connector. License type for the connector. Returns one of the following values: - TRIAL. - SUBSCRIPTION. Expiration date of the connector. Object that contains the following information for each sub-organization. ID of the sub-organization. Name of the sub-organization. POST Request You can update an Informatica Cloud organization if the user that started the REST API session has the Admin role and belongs to either the organization that you want to update or the parent organization. When you update an Informatica Cloud organization, you cannot update the organization ID, offer code, or organization administrator user account created with the organization. You can use this resource to update a sub-organization if your organization has the Org Hierarchy license and if the user that started the REST API session has the Admin role in the parent organization. To update the details of a sub-organization related to your parent organization, use the organization ID in the following URI. To update the details of your organization, omit the optional ID. /api/v2/org/<id> With this URI, you can use the following attributes in the org object: org Object Request Attribute name Required Organization name. address1 Required Address of organization. 146 Chapter 3: Informatica Cloud REST API - Version 2

156 org Object Request Attribute address2 Additional address information for the organization. address3 Additional address information for the organization. city Required City where the organization is based. org 147

157 org Object Request Attribute state zipcode Required when Country is set to US Required when Country is set to US State where the organization is based. Use one of the following two-letter codes: - AL. Alabama. - AK. Alaska. - AZ. Arizona. - AR. Arkansas. - CA. California. - CO. Colorado. - CT. Connecticut. - DE. Delaware. - FL. Florida. - GA. Georgia. - HI. Hawaii. - ID. Idaho. - IL. Illinois. - IN. Indiana. - IA. Iowa. - KS. Kansas. - KY. Kentucky. - LA. Louisiana. - ME. Maine. - MD. Maryland. - MA. Massachusetts. - MI. Michigan. - MN. Minnesota. - MS. Mississippi. - MO. Missouri. - MT. Montana. - NE. Nebraska. - NV. Nevada. - NH. New Hampshire. - NJ. New Jersey. - NM. New Mexico. - NY. New York. - NC. North Carolina. - ND. North Dakota. - OH. Ohio. - OK. Oklahoma. - OR. Oregon. - PA. Pennsylvania. - RI. Rhode Island. - SC. South Carolina. - SD. South Dakota. - TN. Tennessee. - TX. Texas. - UT. Utah. - VT. Vermont. - VA. Virginia. - WA. Washington. - WV. West Virginia. - WI. Wisconsin. - WY. Wyoming. Postal code of the area where the organization is based. 148 Chapter 3: Informatica Cloud REST API - Version 2

158 org Object Request Attribute country Required Country where the organization is based. Use one of the following two-letter codes: - AF. Afghanistan. - AX. Aland Islands. - AL. Albania. - DZ. Algeria. - AS. American Samoa. - AD. Andorra. - AO. Angola. - AI. Anguilla. - AQ. Antarctica. - AG. Antigua and Barbuda. - AR. Argentina. - AM. Armenia. - AW. Aruba. - AU. Australia. - AT. Austria. - AZ. Azerbaijan. - BS. Bahamas. - BH. Bahrain. - BD. Bangladesh. - BB. Barbados. - BY. Belarus. - BZ. Belize. - BE. Belgium. - BJ. Benin. - BM. Bermuda. - BT. Bhutan. - BO. Bolivia. - BA. Bosnia and Herzegovina. - BW. Botswana. - BV. Bouvet Island. - BR. Brazil. - IO. British Indian Ocean Territory. - BN. Brunei Darussalam. - BG. Bulgaria. - BF. Burkina Faso. - BI. Burundi. - KH. Cambodia. - CM. Cameroon. - CA. Canada. - CV. Cape Verde. - KY. Cayman Islands. - CF. Central African Republic. - TD. Chad. - CL. Chile. - CN. China. - CX. Christmas Island. - CC. Cocos (Keeling) Islands. - CO. Colombia. - KM. Comoros. - CG. Congo. - CD. Congo, the Democratic Republic of the. - CK. Cook Islands. - CR. Costa Rica. - CI. Cote d'ivoire. - HR. Croatia. - CU. Cuba. org 149

159 org Object Request Attribute - CY. Cyprus. - CZ. Czech Republic. - DK. Denmark. - DM. Dominica. - DO. Dominican Republic. - DJ. Djibouti. - EC. Ecuador. - EG. Egypt. - SV. El Salvador. - GQ. Equatorial Guinea. - ER. Eritrea. - EE. Estonia. - ET. Ethiopia. - FK. Falkland Islands (Malvinas). - FO. Faroe Islands. - FJ. Fiji. - FI. Finland. - FR. France. - GF. French Guiana. - PF. French Polynesia. - TF. French Southern Territories. - GA. Gabon. - GM. Gambia. - GE. Georgia. - DE. Germany. - GH. Ghana. - GI. Gibraltar. - GR. Greece. - GL. Greenland. - GD. Grenada. - GP. Guadeloupe. - GU. Guam. - GT. Guatemala. - GG. Guernsey. - GN. Guinea. - GW. Guinea-Bissau. - GY. Guyana. - HT. Haiti. - HM. Heard Island and McDonald Islands. - HN. Honduras. - HK. Hong Kong. - HU. Hungary. - IS. Iceland. - IN. India. - ID. Indonesia. - IR. Iran, Islamic Republic of. - IQ. Iraq. - IE. Ireland. - IL. Israel. - IM. Isle of Man. - IT. Italy. - JM. Jamaica. - JP. Japan. - JE. Jersey. - JO. Jordan. - KZ. Kazakhstan. - KE. Kenya. 150 Chapter 3: Informatica Cloud REST API - Version 2

160 org Object Request Attribute - KI. Kiribati. - KP. Korea, Democratic People's Republic of. - KR. Korea, Republic of. - KW. Kuwait. - KG. Kyrgyzstan. - LA. Lao People's Democratic Republic. - LV. Latvia. - LB. Lebanon. - LS. Lesotho. - LR. Liberia. - LY. Libyan Arab Jamahiriya. - LI. Liechtenstein. - LT. Lithuania. - LU. Luxembourg. - MO. Macao. - MK. Macedonia, the former Yugoslav Republic of. - MG. Madagascar. - MW. Malawi. - MY. Malaysia. - MV. Maldives. - ML. Mali. - MT. Malta. - MH. Marshall Islands. - MR. Mauritania. - MU. Mauritius. - MQ. Martinique. - YT. Mayotte. - MX. Mexico. - FM. Micronesia, Federated States of. - MD. Moldova, Republic of. - MC. Monaco. - MN. Mongolia. - ME. Montenegro. - MS. Montserrat. - MA. Morocco. - MZ. Mozambique. - MM. Myanmar. - NA. Namibia. - NR. Nauru. - NP. Nepal. - NL. Netherlands. - NC. New Caledonia. - NZ. New Zealand. - NI. Nicaragua. - NE. Niger. - NG. Nigeria. - NU. Niue. - NF. Norfolk Island. - MP. Northern Mariana Islands. - OM. Oman. - PK. Pakistan. - PW. Palau. - PS. Palestinian Territory, Occupied. - PA. Panama. - PG. Papua New Guinea. - PY. Paraguay. - PE. Peru. org 151

161 org Object Request Attribute - PH. Philippines. - PN. Pitcairn. - PL. Poland. - PT. Portugal. - PR. Puerto Rico. - QA. Qatar. - RE. Reunion. - RO. Romania. - RU. Russian Federation. - RW. Rwanda. - BL. Saint Barthelemy. - SH. Saint Helena. - KN. Saint Kitts and Nevis. - LC. Saint Lucia. - MF. Saint Martin (French part). - PM. Saint Pierre and Miquelon. - VC. Saint Vincent and the Grenadines. - WS. Samoa. - SM. San Marino. - ST. Sao Tome and Principe. - SA. Saudi Arabia. - SN. Senegal. - RS. Serbia. - SC. Seychelles. - SL. Sierra Leone. - SG. Singapore. - SK. Slovakia. - SI. Slovenia. - SB. Solomon Islands. - SO. Somalia. - ZA. South Africa. - GS. South Georgia and the South Sandwich Islands. - ES. Spain. - LK. Sri Lanka. - SD. Sudan. - SR. Suriname. - SJ. Svalbard and Jan Mayen. - SZ. Swaziland. - SY. Syrian Arab Republic. - SE. Sweden. - CH. Switzerland. - TW. Taiwan. - TJ. Tajikistan. - TZ. Tanzania, United Republic of. - TH. Thailand. - TL. Timor-Leste. - TG. Togo. - TK. Tokelau. - TO. Tonga. - TT. Trinidad and Tobago. - TN. Tunisia. - TR. Turkey. - TC. Turks and Caicos Islands. - TM. Turkmenistan. - TV. Tuvalu. - UG. Uganda. - UA. Ukraine. 152 Chapter 3: Informatica Cloud REST API - Version 2

162 org Object Request Attribute - AE. United Arab Emirates. - GB. United Kingdom. - US. United States. - UM. United States Minor Outlying Islands. - UY. Uruguay. - UZ. Uzbekistan. - VU. Vanuatu. - VA. Holy See (Vatican City State). - VE. Venezuela. - VN. Viet Nam. - VG. Virgin Islands, British. - VI. Virgin Islands, U.S. - WF. Wallis and Futuna. - EH. Western Sahara. - YE. Yemen. - ZM. Zambia. - ZW. Zimbabwe. description of the organization. Maximum length is 255 characters. Default address for success, warning, or failure notification related to job completion. POST Response If successful, returns the org request object for the organization that you created or updated. Returns the error object if errors occur. DELETE Request You can delete an Informatica Cloud sub-organization if the user that started the Informatica Cloud REST API session has the Admin role and belongs the parent organization. To delete an Informatica Cloud organization, use the organization ID with the following URI: /api/v2/org/<id> DELETE Response Returns no response if successful. Returns the error object if errors occur. POST Example To update a sub-organization with an ID of , you might use the following request: GET <serverurl>/api/v2/org/ HTTP/1.0 Content-Type: application/xml Accept: application/xml icsessionid: <icsessionid> <org> <name>dev Org</name> <address1>333 Main Street</address1> <city>city</city> <state>md</state> <zipcode>90001</zipcode> <country>us</country> </org> A successful request returns the org request object for the sub-organization that you updated. org 153

163 register Use this resource to create an Informatica Cloud organization or sub-organization. For Informatica Cloud partners only. POST Request When 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: address and other account details. The information that you pass becomes the organization administrator user account. You can create a suborganization if the user that started the Informatica Cloud REST API session has the Admin role and belongs to an organization with the Org Hierarchy license. Salesforce login. The Salesforce login becomes the organization administrator user account. Use the Salesforce login to create a Salesforce session ID and pass the session ID in the register syntax. When you use a Salesforce login, you cannot create a sub-organization. You need an Informatica Cloud partner offer code to create an Informatica Cloud organization. To create an Informatica Cloud organization with an address and user account details, use the following URL. To create an Informatica Cloud sub-organization, use the following URI. /api/v2/register You can create an Informatica Cloud sub-organization if your organization has the Org Hierarchy license and if the user that started the REST API session has the Admin role in the parent organization. Use the icsessionid from the login response in the request header. Use the serverurl from the login response as the base URL. With both the register URL and URI, you can use the following attributes in a registration object: register POST Request Attribute org Attribute that defines an Informatica Cloud organization. Include the following attributes in an org object. offercode Required Offer code assigned to Informatica Cloud partners. orgname Required Name for the new Informatica Cloud organization. address Address where the organization is located. city City where the organization is located. 154 Chapter 3: Informatica Cloud REST API - Version 2

164 register POST Request Attribute state State where the organization is located. Use one of the following two-letter values: - AL. Alabama. - AK. Alaska. - AZ. Arizona. - AR. Arkansas. - CA. California. - CO. Colorado. - CT. Connecticut. - DE. Delaware. - FL. Florida. - GA. Georgia. - HI. Hawaii. - ID. Idaho. - IL. Illinois. - IN. Indiana. - IA. Iowa. - KS. Kansas. - KY. Kentucky. - LA. Louisiana. - ME. Maine. - MD. Maryland. - MA. Massachusetts. - MI. Michigan. - MN. Minnesota. - MS. Mississippi. - MO. Missouri. - MT. Montana. - NE. Nebraska. - NV. Nevada. - NH. New Hampshire. - NJ. New Jersey. - NM. New Mexico. - NY. New York. - NC. North Carolina. - ND. North Dakota. - OH. Ohio. - OK. Oklahoma. - OR. Oregon. - PA. Pennsylvania. - RI. Rhode Island. - SC. South Carolina. - SD. South Dakota. - TN. Tennessee. - TX. Texas. - UT. Utah. - VT. Vermont. - VA. Virginia. - WA. Washington. - WV. West Virginia. - WI. Wisconsin. - WY. Wyoming. zipcode Zip code where the organization is located. register 155

165 register POST Request Attribute country Country where the organization is located. Use one of the following two letter values: - AF. Afghanistan. - AX. Aland Islands. - AL. Albania. - DZ. Algeria. - AS. American Samoa. - AD. Andorra. - AO. Angola. - AI. Anguilla. - AQ. Antarctica. - AG. Antigua and Barbuda. - AR. Argentina. - AM. Armenia. - AW. Aruba. - AU. Australia. - AT. Austria. - AZ. Azerbaijan. - BS. Bahamas. - BH. Bahrain. - BD. Bangladesh. - BB. Barbados. - BY. Belarus. - BZ. Belize. - BE. Belgium. - BJ. Benin. - BM. Bermuda. - BT. Bhutan. - BO. Bolivia. - BA. Bosnia and Herzegovina. - BW. Botswana. - BV. Bouvet Island. - BR. Brazil. - IO. British Indian Ocean Territory. - BN. Brunei Darussalam. - BG. Bulgaria. - BF. Burkina Faso. - BI. Burundi. - KH. Cambodia. - CM. Cameroon. - CA. Canada. - CV. Cape Verde. - KY. Cayman Islands. - CF. Central African Republic. - TD. Chad. - CL. Chile. - CN. China. - CX. Christmas Island. - CC. Cocos (Keeling) Islands. - CO. Colombia. - KM. Comoros. - CG. Congo. - CD. Congo, the Democratic Republic of the. - CK. Cook Islands. - CR. Costa Rica. - CI. Cote d'ivoire. - HR. Croatia. - CU. Cuba. 156 Chapter 3: Informatica Cloud REST API - Version 2

166 register POST Request Attribute - CY. Cyprus. - CZ. Czech Republic. - DK. Denmark. - DM. Dominica. - DO. Dominican Republic. - DJ. Djibouti. - EC. Ecuador. - EG. Egypt. - SV. El Salvador. - GQ. Equatorial Guinea. - ER. Eritrea. - EE. Estonia. - ET. Ethiopia. - FK. Falkland Islands (Malvinas). - FO. Faroe Islands. - FJ. Fiji. - FI. Finland. - FR. France. - GF. French Guiana. - PF. French Polynesia. - TF. French Southern Territories. - GA. Gabon. - GM. Gambia. - GE. Georgia. - DE. Germany. - GH. Ghana. - GI. Gibraltar. - GR. Greece. - GL. Greenland. - GD. Grenada. - GP. Guadeloupe. - GU. Guam. - GT. Guatemala. - GG. Guernsey. - GN. Guinea. - GW. Guinea-Bissau. - GY. Guyana. - HT. Haiti. - HM. Heard Island and McDonald Islands. - HN. Honduras. - HK. Hong Kong. - HU. Hungary. - IS. Iceland. - IN. India. - ID. Indonesia. - IR. Iran, Islamic Republic of. - IQ. Iraq. - IE. Ireland. - IL. Israel. - IM. Isle of Man. - IT. Italy. - JM. Jamaica. - JP. Japan. - JE. Jersey. - JO. Jordan. - KZ. Kazakhstan. - KE. Kenya. register 157

167 register POST Request Attribute - KI. Kiribati. - KP. Korea, Democratic People's Republic of. - KR. Korea, Republic of. - KW. Kuwait. - KG. Kyrgyzstan. - LA. Lao People's Democratic Republic. - LV. Latvia. - LB. Lebanon. - LS. Lesotho. - LR. Liberia. - LY. Libyan Arab Jamahiriya. - LI. Liechtenstein. - LT. Lithuania. - LU. Luxembourg. - MO. Macao. - MK. Macedonia, the former Yugoslav Republic of. - MG. Madagascar. - MW. Malawi. - MY. Malaysia. - MV. Maldives. - ML. Mali. - MT. Malta. - MH. Marshall Islands. - MR. Mauritania. - MU. Mauritius. - MQ. Martinique. - YT. Mayotte. - MX. Mexico. - FM. Micronesia, Federated States of. - MD. Moldova, Republic of. - MC. Monaco. - MN. Mongolia. - ME. Montenegro. - MS. Montserrat. - MA. Morocco. - MZ. Mozambique. - MM. Myanmar. - NA. Namibia. - NR. Nauru. - NP. Nepal. - NL. Netherlands. - NC. New Caledonia. - NZ. New Zealand. - NI. Nicaragua. - NE. Niger. - NG. Nigeria. - NU. Niue. - NF. Norfolk Island. - MP. Northern Mariana Islands. - OM. Oman. - PK. Pakistan. - PW. Palau. - PS. Palestinian Territory, Occupied. - PA. Panama. - PG. Papua New Guinea. - PY. Paraguay. - PE. Peru. 158 Chapter 3: Informatica Cloud REST API - Version 2

168 register POST Request Attribute - PH. Philippines. - PN. Pitcairn. - PL. Poland. - PT. Portugal. - PR. Puerto Rico. - QA. Qatar. - RE. Reunion. - RO. Romania. - RU. Russian Federation. - RW. Rwanda. - BL. Saint Barthelemy. - SH. Saint Helena. - KN. Saint Kitts and Nevis. - LC. Saint Lucia. - MF. Saint Martin (French part). - PM. Saint Pierre and Miquelon. - VC. Saint Vincent and the Grenadines. - WS. Samoa. - SM. San Marino. - ST. Sao Tome and Principe. - SA. Saudi Arabia. - SN. Senegal. - RS. Serbia. - SC. Seychelles. - SL. Sierra Leone. - SG. Singapore. - SK. Slovakia. - SI. Slovenia. - SB. Solomon Islands. - SO. Somalia. - ZA. South Africa. - GS. South Georgia and the South Sandwich Islands. - ES. Spain. - LK. Sri Lanka. - SD. Sudan. - SR. Suriname. - SJ. Svalbard and Jan Mayen. - SZ. Swaziland. - SY. Syrian Arab Republic. - SE. Sweden. - CH. Switzerland. - TW. Taiwan. - TJ. Tajikistan. - TZ. Tanzania, United Republic of. - TH. Thailand. - TL. Timor-Leste. - TG. Togo. - TK. Tokelau. - TO. Tonga. - TT. Trinidad and Tobago. - TN. Tunisia. - TR. Turkey. - TC. Turks and Caicos Islands. - TM. Turkmenistan. - TV. Tuvalu. - UG. Uganda. - UA. Ukraine. register 159

169 register POST Request Attribute - AE. United Arab Emirates. - GB. United Kingdom. - US. United States. - UM. United States Minor Outlying Islands. - UY. Uruguay. - UZ. Uzbekistan. - VU. Vanuatu. - VA. Holy See (Vatican City State). - VE. Venezuela. - VN. Viet Nam. - VG. Virgin Islands, British. - VI. Virgin Islands, U.S. - WF. Wallis and Futuna. - EH. Western Sahara. - YE. Yemen. - ZM. Zambia. - ZW. Zimbabwe. user Attribute that defines the organization administrator user account. Include the following attributes in a user object. username Required address for the organization administrator account. password Required Password for the organization administrator account. firstname Required First name of the organization administrator. lastname Required Last name of the organization administrator. title Title of the organization administrator. phone Phone number for the organization administrator. Required address that receives notification from Informatica Cloud. 160 Chapter 3: Informatica Cloud REST API - Version 2

170 register POST Request Attribute timezone Time zone of the organization administrator. Time zone honors Daylight Saving Time. You can 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 161

171 register POST Request Attribute - 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/Kiritimat If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default. registratoncode Registration code. To create an Informatica Cloud organization with a Salesforce login for the user account, use the following URL: With this URL, use the following attributes in the registrationsf object: registersf POST Request Attribute sfsessionid Required Salesforce session ID. sfserverurl Required Salesforce URL. The Salesforce login used to create the session ID becomes the Informatica Cloud user account for the organization. For information about generating the Salesforce session ID, see the login resource in the Salesforce Web Services API Developer's Guide. 162 Chapter 3: Informatica Cloud REST API - Version 2

172 registersf POST Request Attribute offercode Required Offer code assigned to Informatica Cloud partners. registrationcode Registration code. POST Response Returns the user object if the request is successful. Returns the error object if errors occur. The user object includes the following attributes: user Object Response Attribute id orgid name description createtime updatetime createdby updatedby sfusername password firstname lastname title phone timezone serverurl icsessionid User ID. ID of the organization the user belongs to. Informatica Cloud user name. of the user. When the user account was created. When the user account was last updated. Informatica Cloud user who created the user account. Informatica Cloud user who last updated the user account. Salesforce user name. Salesforce password. First name for the user account. Last name for the user account. Title of the user. Phone number for the user. addresses to be notified when the user changes the account password. Time zone of the user. Time zone honors Daylight Saving Time. Informatica Cloud URL for the organization the user belongs to. Use the serverurl as a base for most REST API resource URIs. Informatica Cloud REST API session ID. Use in most REST API request headers. register 163

173 POST Example To register a new organization using Salesforce credentials in JSON, you might use the following request: POST HTTP/1.0 Content-Type: application/json Accept: application/json { "@type": "registrationsf", "sfsessionid": "salesforceid00003", "sfserverurl": " "offercode": "OFFERCODE" } A successful request returns the user object that was created, which includes the organization ID for the organization that was created. salesforceversion Use this resource to return the Salesforce version used by Informatica Cloud. GET Request Use the following URI to request the version of Salesforce used by default by Informatica Cloud: /api/v2/server/salesforceversion GET Response Returns the salesforceversion object if the request is successful. Returns the error object if errors occur. The salesforceversion object includes the following attribute: schedule GET Response Attribute versionno Salesforce version number. GET Example To check the Salesforce version, you might use the following request: GET <serverurl>/api/v2/server/salesforceversion HTTP/1.0 Accept: application/json icsessionid: <icsessionid> schedule Use this resource to request the details of a schedule or the details of all schedules in the organization. You can create or update a schedule. You can also delete a schedule. 164 Chapter 3: Informatica Cloud REST API - Version 2

174 GET Request To request the details of a schedule, use the schedule ID with the following URI. To view the details of all schedules in the organization, omit the optional schedule ID. /api/v2/schedule/<id> GET Response If successful, returns the schedule object for the requested schedule. Or, if you request the details for all schedules, returns the schedule object for each schedule in the organization. Returns the error object if errors occur. The schedule object includes the following attributes: schedule Object Response Attribute id orgid name description createtime updatetime createdby updatedby starttime endtime interval frequency rangestarttime rangeendtime Schedule ID. Organization ID. Schedule name. of the schedule. Time the schedule was created. The last time the schedule was updated. User who created the schedule. User who last updated the schedule. Start time of the schedule. End time of the schedule. 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 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. The start of the time range within a day that tasks run. Minutely and Hourly intervals only. The end of the time range within a day that tasks run. Minutely and Hourly intervals only. schedule 165

175 schedule Object Response Attribute sun mon tue wed thu fri sat weekday 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. 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. 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. 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. 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. 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. 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. Tasks run on weekdays only. Returns one of the following codes: - true. The tasks run on weekdays. - false. The tasks run every day. Daily interval only. dayofmonth Date of the month that tasks run. Returns a date between Monthly interval only. weekofmonth Week of the month that tasks run. Returns one of the following codes: - First. The tasks run in the first week of the month. - Second. The tasks run in the second week of the month. - Third. The tasks run in the third week of the month. - Fourth. The tasks run in the fourth week of the month. - Last. The tasks run in the last week of the month. Monthly interval only. 166 Chapter 3: Informatica Cloud REST API - Version 2

176 schedule Object Response Attribute dayofweek timezone Day of the week that tasks run. Returns one of the following codes: - Day. Tasks run on the first day or last day of the month, based on the selected weekofmonth option. - Sunday. The tasks run on Sunday. - Monday. The tasks run on Monday. - Tuesday. The tasks run on Tuesday. - Wednesday. The tasks run on Wednesday. - Thursday. The tasks run on Thursday. - Friday. The tasks run on Friday. - Saturday. The tasks run on Saturday. Monthly interval only. Time zone of the user who last updated the schedule. Time zone honors Daylight Saving Time. POST Request To update a schedule, use the schedule ID with the following URI. To create a schedule, omit the optional schedule ID. /api/v2/schedule/<id> With this URI, you can use the following attributes in a schedule object. schedule Object Request Attribute id Required Schedule ID. orgid Required Organization ID. name Required Schedule name. description of the schedule. starttime Required Date and time when the schedule starts running. Use the following format: YYYY-MM-DDTHH24:MI:SSZ endtime Date and time when the schedule stops running. If you do not use this parameter, the schedule runs indefinitely. Use the following format: YYYY-MM-DDTHH24:MI:SSZ schedule 167

177 schedule Object Request Attribute 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 dayofweek. Day of the week when you want tasks to run. - weekofmonth. Week of the month when you want tasks to run. - endtime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely. To indicate when tasks should run, use dayofweek with weekofmonth, such as the First Monday. Or use dayofmonth, such as 1. Tip: To run tasks on the last day of the month, use the Last weekofmonth parameter with the Day dayofweek parameter. frequency 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, 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 The start of the time range within a day that you want tasks to run. Enter a date and time using the following format. Only the time portion is used: YYYY-MM-DDTHH24:MI:SSZ Use with Minutely and Hourly intervals only. rangeendtime The end of the time range within a day that you want tasks to run. Enter a date and time using the following format. Only the time portion is used: YYYY-MM-DDTHH24:MI:SSZ 168 Chapter 3: Informatica Cloud REST API - Version 2

178 schedule Object Request Attribute Use with Minutely and Hourly intervals only. sun Runs tasks on Sunday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Sunday. - False. Does not run tasks on Sunday. Use with Minutely, Hourly, and Weekly intervals only. mon Runs tasks on Monday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Monday - False. Does not run tasks on Monday. Use with Minutely, Hourly, and Weekly intervals only. tue Runs tasks on Tuesday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Tuesday. - False. Does not run tasks on Tuesday. Use with Minutely, Hourly, and Weekly intervals only. wed Runs tasks on Wednesday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Wednesday. - False. Does not run tasks on Wednesday. Use with Minutely, Hourly, and Weekly intervals only. thu Runs tasks on Thursday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Thursday. - False. Does not run tasks on Thursday. Use with Minutely, Hourly, and Weekly intervals only. fri Runs tasks on Friday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Friday. - False. Does not run tasks on Friday. Use with Minutely, Hourly, and Weekly intervals only. sat Runs tasks on Saturday at the configured time. You can use the sun - sat parameters to run tasks on several days of the week. Use one of the following options: - True. Runs tasks on Saturday. - False. Does not run tasks on Saturday. Use with Minutely, Hourly, and Weekly intervals only. schedule 169

179 schedule Object Request Attribute weekday 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 Date of the month that tasks should run. Use a date between Use with the Monthly interval only. Tip: To run tasks on the last day of the month, use the Last weekofmonth parameter with the Day dayofweek parameter. weekofmonth Week of the month that tasks should run. Use with dayofweek to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month. Use one of the following options: - First - Second - Third - Fourth - Last Use with the Monthly interval only. dayofweek Day of the week that tasks should run. Use with weekofmonth to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month. Use one of the following options: - Day - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday Use with the Monthly interval only. POST Response Returns the schedule response object for the schedule that you created or updated. Returns an error object if errors occur. DELETE Request To delete a schedule, use the schedule ID with the following URI: /api/v2/schedule/<id> DELETE Response Returns no response if the request is successful. Returns an error object if errors occur. 170 Chapter 3: Informatica Cloud REST API - Version 2

180 GET Example To request information about all schedules in the organization, you might use the following request: GET <serverurl>/api/v2/schedule HTTP/1.0 Accept: application/json icsessionid: <icsessionid> A successful request returns a schedule object for each schedule in the organization. servertime Use this resource to return the local time for the Informatica Cloud server. GET Request To request the local time of the Informatica Cloud server, use the following URI. /api/v2/server/servertime GET Response Returns the servertime object if the request is sucessful. Returns an error object if errors occur. The servertime object includes the following attribute: servertime Object Response Attribute time Local time of the Informatica Cloud server. GET Example To check the local time of the Informatica Cloud server, you might use the following request: GET <serverurl>/api/v2/server/servertime HTTP/1.0 Accept: application/xml icsessionid: <icsessionid> user Use this resource to request the details of an Informatica Cloud user account or the details of all user accounts in the organization. You can also use this resource to create or update a user account and to delete a user account. To ensure organization security, this resource does not display or update the password for a user account. GET Request To request the details of an Informatica Cloud user account, use the user account ID in the following URI. To request the details of all user accounts, omit the optional user account ID. /api/v2/user/<id> servertime 171

181 GET Response When you request the details for a user account, Informatica Cloud returns the user object for the requested user account. When you request the details of all user accounts, Informatica Cloud returns the user object for each user account in the organization. user Object Response Attribute id orgid name description createtime updatetime createdby updatedby sfusername password firstname lastname title phone timezone serverurl icsessionid User ID. ID of the organization the user belongs to. Informatica Cloud user name. of the user. When the user account was created. When the user account was last updated. Informatica Cloud user who created the user account. Informatica Cloud user who last updated the user account. Salesforce user name. Salesforce password. First name for the user account. Last name for the user account. Title of the user. Phone number for the user. addresses to be notified when the user changes the account password. Time zone of the user. Time zone honors Daylight Saving Time. Informatica Cloud URL for the organization the user belongs to. Use the serverurl as a base for most REST API resource URIs. Informatica Cloud REST API session ID. Use in most REST API request headers. POST Request To update the details of an existing user account, use the user account ID in the following URI. To create a new Informatica Cloud user account, omit the optional user account ID. /api/v2/user/<id> 172 Chapter 3: Informatica Cloud REST API - Version 2

182 With this URI, you can use the following attributes in a user object: user Object Request Attribute name Required Informatica Cloud user name. sfusername Salesforce user name. password Salesforce password. firstname Required First name for the user account. lastname Required Last name for the user account. title Required Title of the user. phone Phone number for the user. s addresses to be notified when the user changes the account password. user 173

183 user Object Request Attribute description of the user. timezone Time zone of the user. Time zone honors Daylight Saving Time. You can 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 174 Chapter 3: Informatica Cloud REST API - Version 2

184 user Object Request Attribute - Asia/Bahrain - Africa/Nairobi - Asia/Kuwait - Asia/Qatar - Asia/Riyadh - Asia/Baghdad - Europe/Moscow - Asia/Dubai - Indian/Mauritius - Asia/Muscat - Asia/Karachi - IST - Asia/Katmandu - BST - Asia/Rangoon - VST - Australia/Perth - Asia/Hong_Kong - Asia/Kuala_Lumpur - Asia/Singapore - CTT - Asia/Seoul - JST - ACT - AET - Australia/Lord_Howe - Asia/Magadan - Pacific/Norfolk - Pacific/Fiji - Pacific/Chatham - Pacific/Enderbury - Pacific/Kiritimat If no valid time zone is passed, Informatica Cloud uses America/Los_Angeles by default. POST Response Returns the user response object for the requested user account. Or, if you requested information for all user accounts, returns the user response object for each user account in the organization. Returns an error object if errors occur. DELETE Request To delete a user, use the user account ID in the following URI. /api/v2/user/<id> DELETE Response Returns no response if the request is successful. Returns an error object if errors occur. POST Example To create a new user, you might use the following request: POST <serverurl>/api/v2/user/ HTTP/1.0 Content-Type: application/xml Accept: application/xml icsessionid: <icsessionid> user 175

185 <user> <firstname>user</firstname> <lastname>name</lastname> <title>developer</title> <timezone>america/chicago</timezone> </user> workflow Use this resource to request the details of task flow or the details of all task flows in the organization. You can also create or update a task flow, and you can delete a task flow. GET Request To request the details of a task flow, use the task flow ID in the following URI. To request the details of all task flows in the organization, omit the optional task flow ID: /api/v2/workflow/<id> GET Response If successful, returns the workflow object for the requested task flow ID. Or, if you request the details for all task flows in the organization, returns a workflow object for each task flow in the organization. Returns an error object if errors occurred. The workflow object includes the following attributes: workflow Object Response Attribute id orgid name description createtime updatetime createdby updatedby errortask id s successtask Task flow ID. Organization ID. Task flow name.. Time the task flow was created. Last time the task flow was updated. User who created the task flow. User who last updated the task flow. Attribute that includes the following attributes in the task object. ID. addresses to receive notification if the task flow fails to complete. Attribute that includes the following attributes in the task object. 176 Chapter 3: Informatica Cloud REST API - Version 2

186 workflow Object Response Attribute id s warningtask id s scheduleid tasks taskid type name stoponerror ID. addresses to receive notification if the task flow completes successfully. Attribute that includes the following attributes in the task object. ID. addresses to receive notification if the task flow completes with errors. Schedule associated with the task flow, if any. Attribute that defines each task associated with the workflow. Includes the following information for each task in a workflowtask object: Task ID. Task type. Returns one of the following codes: - AVS. Contact validation task. - DLS. Data loader task. - DQA. Data assessment task. - DRS. Data replication task. - DSS. Data synchronization task. - MTT. Custom integration task. - PCS. PowerCenter task. Task name. Stops the task flow if an error occurs. POST Request To update a task flow, use the following URI. To create a task flow, omit the optional task flow ID. /api/v2/workflow/<id> When you update a task flow, Informatica Cloud replaces the existing task flow with the update. With this URI, you can use the following attributes in the workflow object: workflow Object Request Attribute errortask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task flow fails to complete. workflow 177

187 workflow Object Request Attribute successtask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task flow completes successfully. warningtask Attribute that includes the following attributes in the task object. s List of comma-separated addresses that receive notification when a task flow completes with errors. name Required Name of the task flow. description of the task flow. tasks Attribute that defines the tasks used in the workflow. Use a workflowtask object to define the following attributes for each task you want to use. taskid Required Task ID. type Required Task type. Use one of the following codes: - AVS. Contact validation task. - DLS. Data loader task. - DQA. Data assessment task. - DRS. Data replication task. - DSS. Data synchronization task. - MTT. Custom integration task. - PCS. PowerCenter task. name Required Task name. 178 Chapter 3: Informatica Cloud REST API - Version 2

188 workflow Object Request Attribute stoponerror Stops the task flow if the task fails to complete. Use one of the following options: - 1. True. Stop on error False. Do not stop on error. scheduleid Schedule for the task flow. POST Response If successful, returns the workflow response object for the task flow that you created or updated. Returns the error object if errors occur. DELETE Request To delete a task flow, use the task flow ID in the following URI: /api/v2/workflow/<id> DELETE Response Returns no response if the request is successful. Returns the error object if errors occur. POST Example To update an existing task flow with an ID of J0000K, you might use the following request: POST <serverurl>/api/v2/workflow/ j0000k HTTP/1.0 Content-Type: application/json Accept: application/json icsessionid: <icsessionid> { "@type": "workflow", "name": "task flow", "tasks":{ "@type": "tasks", "taskid": "000034K0000M", "type": "MTT", "name": "Date Cleanup", "stoponerror": "1", }, "tasks":{ "@type": "tasks", "taskid": "000023R0000D", "type": "DSS", "name": "MSQ to SFDC", }, "scheduleid": " " } A successful request returns the workflow object that you updated. workflow 179

189 I N D E X A activitylog REST API resource 19 activitylog resource, REST API (v2) 84 activitymonitor REST API resource 21 activitymonitor resource, REST API (v2) 86 agent resource, REST API (v2) 89 REST API resource 23 API Informatica Cloud REST API 11 Informatica Cloud REST API (v2) 71 B best practices Informatica Cloud Toolkit 2 body configuration REST API (v2) 73 C Cloud Developer community URL iv connection resource, REST API (v2) 91 REST API resource 24 customfunc resource, REST API (v2) 106 D date/time values REST API (v2) 75 dnbbatch REST API resource 39 dnbworkflow REST API resource 41 dnbworkflow resource, REST API (v2) 110 E error messages REST API (v2) 77 error object REST API (v2) 77 F field resource, REST API (v2) 114 filerecord resource, REST API (v2) 115 G guidelines REST API (v2) 79 H header configuration REST API (v2) 72 I IConnection Informatica Cloud Toolkit connection interface 9 IDataOperation Informatica Cloud Toolkit data operation interface 9 IMetadata Informatica Cloud Toolkit metadata interface 8 Informatica Cloud REST API 11 REST API (v2) 71 Informatica Cloud Community URL iv Informatica Cloud Connectors best practices 2 development process 2 rules and guidelines for development 2 Informatica Cloud Toolkit IConnection interface 9 IDataOperation interface 9 IMetadata interface 8 interface architecture 5 IPlugin interface 6 IRead interface 9 IRegistrationInfo 7 ITypeSystem interface 8 IWrite interface 10 overview 1 sample project 1 tasks and related interfaces and methods 5 Informatica Cloud web site URL iv Informatica Global Customer Support contact information v IPlugin Informatica Cloud Toolkit top-level interface 6 180

190 IRead Informatica Cloud Toolkit read interface 9 IRegistrationInfo Informatica Cloud Toolkit registration interface 7 ITypeSystem Informatica Cloud Toolkit datatype interface 8 IWrite Informatica Cloud Toolkit write interface 10 J job resource, REST API (v2) 118 JSON using with the REST API 12 L logging configuring for Informatica Cloud Connectors 2 login resource, REST API (v2) 119 REST API resource 45 M mastertemplate resource, REST API (v2) 121 mttask resource, REST API (v2) 132 O object configuration for XML and JSON (REST API (v2) 73 object IDs retrieving, REST API (v2) 76 org resource, REST API (v2) 138 REST API resource 47 P process for developing Informatica Cloud Connectors 2 Q quick reference for resources, REST API (v2) 80 REST API 15 R register resource, REST API (v2) 154 REST API resource 50 request and response formats REST API 12 response codes REST API 12 responses REST API (v2) 76 REST API documentation conventions 14 guidelines 14 overview 11 quick reference 15 request and response formats 12 response codes 12 XML schema definition (XSD) 13 REST API (v2) activitylog resource 84 activitymonitor resource 86 agent resource 89 body configuration 73 connection resource 91 customfunc resource to work with plug-ins 106 date/time values 75 dnbworkflow resource 110 documentation conventions 79 error messages 77 error object 77 examples 74 field resource 114 filerecord resource 115 guidelines 79 header configuration 72 job resource to start a task or task flow 118 login resource 119 mastertemplate resource for working with integration templates 121 mttask resource to work with custom integration tasks 132 org resource 138 overview 71 register resource 154 resource quick reference 80 responses 76 retrieving and using object IDs 76 return lists 74 salesforceversion resource 164 servertime resource 171 user resource 171 workflow resource to work with task flows 176 XML schema definition (XSD) 72 return list configuration for XML and JSON (REST API (v2) 74 rules and guidelines for developing Informatica Cloud Connectors 2 runjob REST API resource 54 S salesforceversion REST API resource 56 salesforceversion resource, REST API (v2) 164 sample project Informatica Cloud Toolkit 1 schedule REST API resource 56, 165 servertime REST API resource 64 servertime resource, REST API (v2) 171 Index 181

191 T trust site description use with JSON (REST API (v2) 73 U user resource, REST API (v2) 171 REST API resource 64 X XML using with the REST API 12 XML schema definition REST API 13 REST API (v2) 72 XSD See XML schema definition W workflow resource, REST API (v2) Index