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 Required/ Optional
Description
icSessionId Required Informatica Cloud REST API session ID.
id Optional Workflow ID. To view the details of a D&B360 workflow, use id, uname, or name.
uname Optional Workflow unique identifier. To view the details of a D&B360 workflow, use id, uname, or name. name Optional Workflow name. To view the details of a D&B360 workflow, use id, uname, or name. responseType Optional Format for the response from Informatica Cloud. Use one of the following options:
- json. Returns information in JSON. - xml. Returns information in XML.
Parameter Required/ Optional
Description
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 Description
id Workflow ID.
name Workflow name.
uname Workflow unique identifier. description Description of the workflow. createTime When the workflow was created. updateTime When the workflow was last updated. createdBy D&B360 user who created the workflow. updatedBy D&B360 user who updated the workflow. rowLimit Row limit for the workflow.
partnerProfile Partner profile code.
companyCustomObject Company custom object number. adminCustomObject Admin custom object number. leadCustomObject Lead custom object number. odbcUser ODBC user ID.
connections Connections used in the workflow.
schedule Name of the schedule associated with the workflow. dnbTasks An ordered list of D&B360 tasks for each workflow.
POST Request 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.
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 Required/ Optional
Description
icSessionId Required Informatica Cloud REST API session ID.
id Optional Workflow ID. To update a workflow, use id, uname, or name.
uname Optional Unique identifier for the workflow. To create a workflow, use uname or name. To update a workflow, use id, uname, or name.
name Optional Name of the workflow. To create a workflow, use uname or name. To update a workflow, use id, uname, or name.
description Optional Description of the workflow. connectionId Required Connection ID.
connectionId2 Optional Additional connection ID. Used for SAP IDoc Writer connections. scheduleId Optional Schedule ID.
rowLimit Optional Workflow row limit.
partnerProfile Optional The partner profile used by D&B360 for the SAP CRM package, such as INFA. Contact your SAP CRM administrator for a Partner Profile code.
SAP CRM D&B360 workflows only.
companyCustomObject Optional Oracle CRM On Demand Company custom object number. Enter a number between 1 - 10.
To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number.
Oracle CRM On Demand D&B360 workflows only.
Parameter Required/ Optional
Description
adminCustomObject Optional Oracle CRM On Demand Admin custom object number. Enter a number between 1 - 10.
To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number.
Oracle CRM On Demand D&B360 workflows only. leadCustomObject Optional Oracle CRM On Demand Lead custom object number.
Enter a number between 1 - 10.
To get the number, login into your Oracle CRM On Demand instance and navigate to Admin > Application Customization > Customize Record Types. Omit the leading 0 when entering the number.
Oracle CRM On Demand D&B360 workflows only.
odbcUser Optional ODBC user ID for batch jobs that interact with Siebel CRM through an ODBC driver. The ODBC user ID is a dedicated Siebel database account that the Secure 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 Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
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 Required/ Optional
Description
icSessionId Required Informatica Cloud REST API session ID. id Optional Workflow ID.
Parameter Required/ Optional
Description
name Optional Workflow name.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
Example
To view the details of all available D&B360 workflows, you might use the following URL and parameter:
https://app.informaticaondemand.com/saas/api/1/dnbworkflow Parameter:
icSessionId=r21WJdXxrfKgTEcKgGc9Duc65hnZk2ggJdgiRjCB7XX5vAsjLSZxJ19NQK5WEECf
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 Required/ Optional
Description
username Required Informatica Cloud user name. password Required Informatica Cloud password.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
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.
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 Required/ Optional
Description
sfSessionId Required Salesforce session ID.
For information about generating the Salesforce session ID, see the login resource in the Salesforce Web Services API Developer's Guide.
sfServerUrl Required Salesforce server URL.
You can retrieve the Salesforce server URL from the Salesforce Web Services API login resource response.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
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:
https://app.informaticaondemand.com/saas/api/1/login 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: https://app.informaticaondemand.com/saas/api/1/login Parameters: sfSessionID=34352 sfServerURL=https://na3-api.salesforce.com/services/Soap/u/22.0
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.
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 Required/ Optional
Description
icSessionId Required Informatica Cloud REST API session ID. id Optional Organization ID.
responseType Optional Format for the response from Informatica Cloud. Use one of the following options: - json. Returns information in JSON.
- xml. Returns information in XML.
By default, Informatica Cloud responds in XML.
GET Response 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 Description
id Organization ID.
parentOrgId Organization ID for the parent organization.
Returns 0 if the organization is a stand-alone organization. orgName Organization name.
address Address of organization.
address2 Additional address information for the organization. address3 Additional address information for the organization. city City where the organization is based.
state State where the organization is based.
zipcode Postal code of the area where the organization is based. country Country where the organization is based.
offerCode Offer code assigned to Informatica Cloud partners.
description Description of the organization. Maximum length is 255 characters.
SubOrg: id ID of the sub-organization. For parent organizations in an organization hierarchy.
Parameter Description
SubOrg: name Name of the sub-organization. For parent organizations in an organization hierarchy. responseType Format for the response from Informatica Cloud. Use one of the following options:
- json. Returns information in JSON. - xml. Returns information in XML.
By default, Informatica Cloud responds in XML.