Webservices
1 like2,640 views
This document provides an overview and guide to using Oracle Web Services On Demand. It describes the core technologies behind web services, how Oracle CRM On Demand exposes objects through web services APIs, and best practices for designing client applications that integrate with Oracle CRM On Demand via web services. The document also provides reference information on the various parent and child objects exposed by Oracle CRM On Demand web services and details the specific API calls available.
![Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand
Objects
Table 3. Web Services v1.0 and Web Services v2.0 Differences
Web Services v1.0 Web Services v2.0
Outputs all the children even if the Outputs only the specific child whose condition was
condition is true for one child. met.
For example, the QueryPage call returns For example, QueryPage returns only the specific
all partner children from an account even partner child from the account for which the condition
if the condition is true for only one partner was true
child
UseChildAnd argument of QueryPage call The UseChildAnd argument is not available.
is available for using OR/AND logic
Instead, by default, all parent records matching the
between parent and child
parent criteria and only children matching the child
criteria are returned.
Operators cannot be used to construct The SearchSpec argument of QueryPage can be used
complex queries across multiple fields to construct complex queries across multiple fields in
a request. For example, the OR operator can be used
to find all records that match the specified condition
for [Field A] OR the specified condition for [Field B].
Sort order is not customizable Sortorder and sortsequence arguments are available
to customize the sorting order of the records
Update call removes child objects not An Execute call with “operation=update” at the
specified in the request parent level removes the unspecified children in the
request
InsertChild call is used to insert the For Web Services v2.0:
children for existing parent objects
■ Insert call can be used to insert both parent
records and child records.
■ If a child node is specified in the request, the
Insert call inserts the child and associates it with
the existing parent record.
■ If a child node is missing, the Insert call inserts
only the new parent record.
UpdateChild call is used to update child For Web Services v2.0:
records
■ Update call can be used to update parent records
and child records
■ If a child node is specified in the request, the
Update call updates the child in the existing
parent record
■ If the child node is missing, the Insert call
updates only the existing parent record
Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 21
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-21-320.jpg)
![Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand
Objects
Table 3. Web Services v1.0 and Web Services v2.0 Differences
Web Services v1.0 Web Services v2.0
DeleteChild call is used to delete the child For Web Services v2.0:
records
■ Delete call can be used to delete both parent
records and child records
■ If the child node specified in the request is
available, the Delete call deletes the child in the
existing parent record, and leaves the parent
record undeleted.
■ If the child node is missing, the Delete call deletes
the existing parent record.
InsertChild, UpdateChild, and DeleteChild In an Execute request, a specific node within the
methods are used to perform operations request can be skipped using the
on child records “operation=skipnode” attribute.
This can be used to simulate InsertChild, UpdateChild
or DeleteChild by skipping the parent node and only
performing the specified actions on the child records.
LOVLanguageMode argument is not The LOVLanguageMode argument is an input
available argument for all of the Web Services v2.0 calls. It
determines whether the processing for picklist fields
occurs using language independent codes (LIC) or
language dependent codes (LDC).
ViewMode argument is not available The ViewMode argument, which specifies the level of
access to records specified in the method call, is
available for all of the Web Services v2.0 calls
There are some differences between the format of the WSDL files for Web Services v1.0 and Web
Services v2.0:
■ In the Web Services v2.0 API, strong data typing is supported. Therefore, in the Web Services
v2.0 WSDL files, fields are represented by a range of xsd: data types, while in Web Services v1.0
WSDL files, all fields have the xsd:string data type. For more information, see “Field Types
Supported by Oracle CRM On Demand” on page 24.
■ In Web Services v2.0, messages do not include the business service name, and have the format:
[Objectname][Method]_[Input/Output]
For example:
AccountInsert_Input, ContactQueryPage_Output
as opposed to the following for Web Services v1.0:
AccountWS_AccountInsert_Input, ContactWS_ContactQueryPage_Output
■ The target namespace of the WSDL for Web Services v2.0 is:
22 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-22-320.jpg)
![Establishing and Managing the Web Services Session ■ Stateful Login Mechanisms
Stateful Login Mechanisms
The following topics describe the various mechanisms for logging in and making integration requests
when making stateful Web services requests.
Logging in Using HTTP GET
An HTTPS request can be used to instantiate an Oracle CRM On Demand Web services session and
obtain a valid session ID. A client invokes login by sending an HTTP GET request to a URL like the
following:
https://secure-ausomx[ENV].crmondemand.com/Services/Integration?command=login
where [ENV] is the three-letter identifier for your company’s environment. If you do not know what
this value is for your company, refer to the URL you use to access the Oracle CRM On Demand UI.
NOTE: The login parameter value is case sensitive.
Login Input
There are different mechanisms for login depending on whether the login header contains URL
encoding with the UTF-8 encoding system. This is necessary when login credentials contain multi-
byte characters.
The input to login is provided in the URL parameters and the HTTP headers, as follows:
■ Two URL parameters:
■ command, which has the value login
■ isEncoded, which is used if the HTTP headers are URL encoded using UTF-8. This parameter
must have the value Y or y if encoding is required. The default value is N or n.
■ Two HTTP headers, UserName and Password, must be set with the appropriate values for your
system. For example:
■ UserName: johndoe@email.com
■ Password: mypass
The HTPP headers can be in clear text, or can be URL encoded.
Login Output
The login command returns the following items:
■ A session cookie, JSESSIONID. The client must use this cookie when submitting subsequent
requests, including logoff requests.
■ A status code of 200, if the session does not encounter any errors. This indicates that the request
succeeded.
38 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-38-320.jpg)
![Establishing and Managing the Web Services Session ■ Logging Out of the Web
Services Session
2 Login using SSO Token. The following steps are used to obtain a session ID using the SSO
token:
a The third party application makes a request with the following command specifying the SSO
token:
b https://server/Services/Integration?command=ssologin&odSsoToken="ssotoken value"
c The server returns the session ID in the response, which is used for access to data within Oracle
CRM On Demand.
For detailed information about outbound SSO, refer to the Customer Care Portal - Web services
resource library.
Integration Requests for the Web Services Session
An integration request is an HTTPS request to invoke a Web service to perform data creation,
retrieval, update, and deletion operations. An integration request is made by an HTTP POST
command to a URL like the following:
https://secure-ausomx[ENV].crmondemand.com/Services/Integration/object
where object is the name of the relevant Oracle CRM On Demand object (record type). This Oracle
CRM On Demand object is determined from the contents of the SOAP request.
Integration request input. The JSESSIONID returned to the client during login must be included
with the request. The request must contain the JSESSIONID either as a cookie or as a URL parameter,
as follows:
https://secure-ausomx[ENV].crmondemand.com/Services/Integration/object;
jsessionid=xyZ12489w3482413
The Web service input is provided as a SOAP command in the body of the HTTP POST request.
Integration request output. The properties returned by the HTTP server populate the response
headers and the response body. Table 6 shows the top-level properties that specify key properties of
the HTTP response.
Table 6. Properties of the HTTP Response
Property Comments
HttpStatus Status code returned in the response. If no value is provided, the response
is given the value 200 (indicating success).
Content-Type Content type returned in the response. If no value is provided, the response
is given the value text/xml.
Logging Out of the Web Services Session
A client logs out by sending an HTTP POST or HTTP GET request to a URL. For example:
40 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-40-320.jpg)
![Establishing and Managing the Web Services Session ■ Logging Out of the Web
Services Session
https://secure-ausomx[ENV].crmondemand.com/Services/Integration?command=logoff;
NOTE: The parameter value logoff is case sensitive.
Logoff Input
The preferred method is where the JSESSIONID returned to the client during login must be included
with the request as a cookie with the same name. There are no other URL parameters or HTTP
headers, and there is no HTTP body.
Logoff Output
A status code of 200 is returned if the request is received by the Oracle CRM On Demand server. This
does not guarantee that the logoff request has been processed, and there may be a delay until the
session resources are released for use by a new Web services session.
Alternative Logoff
The JSESSIONID can be included in the URL instead of a cookie if the user wants. The following URL
is what the user would use, where XXXX is the JSESSIONID.
https://secure-ausomx[ENV].crmondemand.com/Services/
Integration;jsessionid=XXXX?command=logoff
Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 41
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-41-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
■ If the size of the record set is greater than pagesize, and this is a subsequent query where there
are less than pagesize number of records remaining to be returned, all of the remaining records
are returned and lastpage attribute has a value of true.
Even though the QueryPage method returns a limited number of records, it keeps the data in the
cache, which you can then retrieve by calling the QueryPage method again with a new value for the
startrownum argument.
Using Search Specifications
You can use the searchspec argument of QueryPage to return only those records matching specified
search criteria for an object. You can also specify the sort order and sort sequence for returned
records using the sortorder and sortsequence arguments respectively. For more information, see
“Specifying the Sort Order and Sort Sequence” on page 90.
The searchspec argument is specified as an attribute of an Object element in requests, for example:
<Contact searchspec=”[ContactFirstName] = ‘Jo*’”>
which would return only contact records for which the ContactFirstName field value begins with Jo.
The search specification can be set on any field type. The query syntax is described in the following
topic.
Query Syntax
The query syntax for the searchspec argument supports only a small subset of binary and unary
operators. No Siebel Query Language constructs or functions are supported. The query syntax is
summarized in Table 27.
Table 27. Query Syntax for QueryPage
Syntax Type Notes
expression
[XML Tag] {Operator} {Value} Operator can be binary or unary. The {Value} need
only be specified for binary operators.
(expression) conjunction (expression) A conjugated expression must be enclosed in
parentheses to avoid ambiguity. However,
nonconjugated expressions must not be enclosed in
parentheses.
conjunction
OR
AND
unary operator
IS NULL Used to find a match for a value that has no value
IS NOT NULL
86 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-86-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
Table 27. Query Syntax for QueryPage
Syntax Type Notes
EXISTS
NOT EXISTS
binary operator
=
~= Denotes a case-insensitive exact search (no
wildcards used)
< Must be specified as &lt; to ensure well-
formed XML.
<= Must be specified as &lt;=
>
>=
<> Must be specified as &lt;>
LIKE Wildcard characters are treated as such only in the
context of the operator LIKE.
~LIKE Denotes a case-insensitive wildcard search
value
'literal' Literal data is always enclosed in single quotes.
To use a single quote within a literal, place another
single quote immediately beside that quote. In this
way, the query recognizes the quote as a literal and
not as an operator. For example, the string ab'c is
specified as ab''c.
To use the special characters such as asterisk (*),
question mark (?), and backslash () in queries,
preceded them with the character. For example,
to use the ? wildcard operator in a query, precede
it with the character as follows:
?
The following is an example from a request that follows the query syntax:
<Contact searchspec=”[ContactFirstName] = ‘John’”>
where XML Tag is Contact FirstName, the operator is = and the value is the literal value John.
An example of an expression with a conjunction is as follows:
<Contact searchspec=”([ContactFirstName] = ‘Jane’”) AND ([ContactLastName] = ‘Doe’”)>
Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 87
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-87-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
Examples of searchspec usage are given in Table 28.
Table 28. Searchspec Examples
Operator Usage of searchspec in request Description
Case <ListOfContact startrownum="0" pagesize="100" Returns all contacts
Sensitive recordcountneeded="true"> whose ContactFirstName
LIKE with * <Contact searchspec=”[ContactFirstName] LIKE value starts with
wildcard ‘Contact*’”> "Contact" and ends with
<ContactFirstName/> zero or more characters
</Contact></ListOfContact>
Case <ListOfContact><Contact Returns all contacts
Insensitive searchspec=”[ContactFirstName] ~LIKE whose ContactFirstName
~ LIKE with ‘Contact*’”> value starts with, for
* wildcard <ContactFirstName/> example, "Contact" or
</Contact></ListOfContact> "contact" or "CoNtAcT"
and ends with zero or
more characters
Case <ListOfContact><Contact Returns all contacts
Sensitive searchspec=”[ContactFirstName] LIKE whose ContactFirstName
LIKE with ? ‘Contact???’”> value starts with
wildcard <ContactFirstName/> "Contact" and ends with
</Contact></ListOfContact> any three characters
Case <ListOfContact><Contact Returns all contacts
Insensitive searchspec=”[ContactFirstName] ~LIKE whose ContactFirstName
~ LIKE with ‘Contact???’”> value starts with, for
? wildcard <ContactFirstName/> example, "Contact" or
</Contact></ListOfContact> "contact" or "CoNtAcT",
and ends with any three
characters
Case <ListOfContact><Contact Returns all contacts
Sensitive = searchspec=”[ContactFirstName] = whose ContactFirstName
‘ContactInsert’”> value is equal to
<ContactFirstName/> "ContactInsert"
</Contact></ListOfContact>
Case <ListOfContact><Contact Returns all contacts
Insensitive searchspec=”[ContactFirstName] ~= whose ContactFirstName
~= ‘ContactInsert’”> value is equal to, for
<ContactFirstName/> example,
</Contact></ListOfContact> "ContactInsert","contactin
sert" or "CoNtAcTiNsErT"
IS NULL <ListOfContact><Contact searchspec=”[TEXTLG_000] Returns all contacts
IS NULL> whose TEXTLG_000 value
<ContactFirstName/> is NULL
</Contact></ListOfContact>
88 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-88-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
Table 28. Searchspec Examples
Operator Usage of searchspec in request Description
IS NOT <ListOfContact><Contact searchspec=”[TEXTLG_000] Returns all contacts
NULL IS NOT NULL> whose TEXTLG_000 value
<ContactFirstName/> is not NULL
</Contact></ListOfContact>
AND <ListOfContact><Contact searchspec=”[BOOL_000] = Returns all contacts
'Y' AND [IndexedBoolean0] = 'N'"> whose BOOL_000 value is
Y AND IndexedBoolean0
<ContactFirstName/><IndexedBoolean0/>
value is N
</Contact></ListOfContact>
Or
<ListOfContact>
<Contact searchspec=”[BOOL_000] = 'Y'">
<ContactFirstName/>
<IndexedBoolean0>='N'</IndexedBoolean0>
</Contact></ListOfContact>
Or
<ListOfContact><Contact>
<ContactFirstName/>
<BOOL_000>='Y'</BOOL_000>
<IndexedBoolean0>='N'</IndexedBoolean0>
</Contact></ListOfContact>
OR <ListOfContact><Contact searchspec=”[BOOL_000] = Returns all contacts
'Y' OR [IndexedBoolean0] = 'N'"> whose BOOL_000 value is
<ContactFirstName/> Y OR IndexedBoolean0
<BOOL_000/> value is N
<IndexedBoolean0/>
</Contact></ListOfContact>
> <ListOfContact><Contact Returns all contacts
searchspec=”[IndexedNumber0] > '500'"> whose IndexedNumber0
(greater <ContactFirstName/> value is greater than 500
than) <IndexedNumber0/>
</Contact></ListOfContact>
>= <ListOfContact><Contact Returns all contacts
searchspec=”[IndexedNumber0] >= '500'"> whose IndexedNumber0
(greater <ContactFirstName/> value is greater than or
than or <IndexedNumber0/> equal to 500
equal to) </Contact></ListOfContact>
Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 89
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-89-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
Table 28. Searchspec Examples
Operator Usage of searchspec in request Description
< <ListOfContact><Contact Returns all contacts
searchspec=”[IndexedNumber0] < '500'"> whose IndexedNumber0
(less than) <ContactFirstName/> value is less than 500
<IndexedNumber0/>
</Contact></ListOfContact>
<= <ListOfContact><Contact Returns all contacts
searchspec=”[IndexedNumber0] <= '500'"> whose IndexedNumber0
(less than <ContactFirstName/> value is less than or equal
or equal to) <IndexedNumber0/> to 500
</Contact></ListOfContact>
<> <ListOfContact><Contact Returns all contacts
searchspec=”[IndexedNumber0] <> '500'"> whose IndexedNumber0
(not equal <ContactFirstName/> value is not equal to 500
to) <IndexedNumber0/>
</Contact></ListOfContact>
Specifying the Sort Order and Sort Sequence
You can specify the sort order and sort sequence for returned records using the sortorder and
sortsequence arguments respectively.
The sortorder and sortsequence arguments are specified as attributes of a FieldName element in
requests, for example:
<CampaignName sortorder=”ASC” sortsequence=”1”/>
which specifies that the records returned are sorted on the CampaignName field in an ascending
order, with a sortsequence of 1.
90 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-90-320.jpg)
![Web Services On Demand API Calls ■ Web Services v2.0 API Calls
Examples of sortorder and sortsequence usage are given in Table 29.
Table 29. Sortorder and sortsequence Examples
Sort type Usage of sortoder and sortsequence Description
Sort in <ListOfContact startrownum="0" Returns all contacts whose
ascending pagesize="100" recordcountneeded="true"> ContactFirstName value starts
order <Contact searchspec=”[ContactFirstName] with "Contact" and ends with
LIKE ‘Contact*’”> zero or more characters and
<ContactLastName sortorder="ASC"></ sorts them by ContactLastName
ContactLastName>
in ascending order
</Contact></ListOfContact>
Sort in <ListOfContact startrownum="0" Returns all contacts whose
descending pagesize="100" recordcountneeded="true"> ContactLastName value starts
order <Contact> with "Contact" and ends with
<ContactLastName sortorder="DESC">~LIKE zero or more characters and
'Contact*'</ContactLastName> sorts them by ContactLastName
</Contact></ListOfContact>
in descending order
Sort More <ListOfContact startrownum="0" Returns all contacts whose
than One pagesize="100" recordcountneeded="true"> ContactFirstName value starts
Fields <Contact searchspec=”[ContactFirstName] with "Contact" and ends with
LIKE ‘Contact*’”> zero or more characters and
<ContactLastName sortorder="DESC" sorts them by CreatedDate in
sortsequence="1"></ContactLastName>
descending order and then by
<ExternalSystemId sortorder="ASC"
ExternalSystemId in ascending
sortsequence="-3"></ExternalSystemId>
<CreatedDate sortorder="DESC" order and then by
sortsequence="-4"></CreatedDate> ContactLastName in descending
</Contact></ListOfContact> order
Specifying Books in Queries
For queries on record types that support books, you can use the BookId or BookName arguments to
constrain the query to only the records in a particular book. For more information about the use of
books, see the online help for Oracle CRM On Demand.
Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 91
Release 18)](https://image.slidesharecdn.com/webservices-101231121504-phpapp02/85/Webservices-91-320.jpg)
Webservices
- 1. CRM On Demand Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18) August 2010
- 2. Copyright © 2005, 2010 Oracle. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error- free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party. Oracle, JD Edwards, and PeopleSoft are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
- 3. Contents Oracle Web Services On Demand Guide 1 Chapter 1: What’s New in This Release Chapter 2: Overview of Web Services On Demand About Web Services 15 Web Services Core Technologies 15 Oracle CRM On Demand Web Services Toolkit 16 Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand 16 Web Services Security 17 Web Services Reliability 19 Web Services and the Oracle CRM On Demand Objects 19 Web Service APIs 19 About Parent-Child Relationships 23 Web Services On Demand and Custom Fields 23 Stateless Web Services and Session Management 24 Field Types Supported by Oracle CRM On Demand 24 Web Services v1.0 25 Web Services v2.0 25 Special Search Fields 26 Support for Multi-Select Picklists 27 Locale-Dependent Access to Oracle CRM On Demand 27 Validation of Email Fields 28 Web Services Utilization 29 Chapter 3: Getting Started with Web Services Accessing Data in Oracle CRM On Demand 31 Requesting Web Services Integration 31 Enabling Stateless Web Services Support 32 Downloading WSDL files and Schema Files 32 Downloading Schema Files 33 Incorporating WSDL Files into the Development Environment 34 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 3 Release 18)
- 4. Contents ■ Chapter 4: Establishing and Managing the Web Services Session About Establishing and Managing the Web Services Session 35 Server-Side Management 35 Client-Side Management 36 Server-Side Session Management 36 Client-Side Session Management 37 Stateful Login Mechanisms 38 Logging in Using HTTP GET 38 Logging in Using Single Sign-On 39 Integration Requests for the Web Services Session 40 Logging Out of the Web Services Session 40 Logoff Input 41 Logoff Output 41 Alternative Logoff 41 41 Chapter 5: Best Practices for Designing Client Applications Best Practices for Integration Design 43 Sending of Web Services Requests to Oracle CRM On Demand 44 Flushing of Caches 44 Using Stateless Web Services 45 Setting and Querying Blank Values 46 Working with Opportunity Product Revenue Records 47 Error Handling and Logging 47 Handling Outages and Failures 47 Best Practices for Generating Web Services Proxy Classes in Java Environments 48 Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit 49 Entering Telephone Number Values through Web Services 52 Best Practices for Integration Performance 54 Batch Processing 54 Session Management and Pooling 55 API Calls 56 Best Practices for Integration Management 58 Moving Customers Between Pods 58 Handling Outages 58 Maintaining SSL Certificates 59 4 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 5. Contents ■ Chapter 6: Web Services On Demand API Calls Web Services v1.0 API Calls 62 User Keys 62 The Echo Argument 63 Delete 63 DeleteChild 66 Insert 67 InsertChild 68 InsertOrUpdate 68 QueryPage 69 Update 78 UpdateChild 79 Web Services v2.0 API Calls 79 The Echo Argument 80 The ViewMode Argument 81 The LOVLanguageMode Argument 81 Delete 82 Execute 83 Insert 84 QueryPage 85 Specifying the Sort Order and Sort Sequence 90 Update 93 Service API Calls 94 DeletedItemQueryPage 95 DeleteEvents 99 GetEvents 100 GetMapping 103 GetPicklistValues 104 GetServerTime 105 LoginHistoryQueryPage 106 MergeRecords 107 MetadataChangeSummaryQueryPage 109 SalesProcessQueryPage 110 SetPasswordAPI 112 SetSessionTimeZone 113 UpdatePicklist 114 UpdateCascadingPicklists 115 UserUsageQueryPage 117 Administrative Services API Calls 119 AccessProfileRead 121 AccessProfileReadAll 121 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 5 Release 18)
- 6. Contents ■ AccessProfileUpsert 122 ActionBarLayoutReadAll 123 ActionBarLayoutUpsert 124 CascadingPicklistRead 125 CascadingPicklistReadAll 126 CustomRecordTypeRead 127 CustomRecordTypeReadAll 127 CustomRecordTypeUpsert 128 CustomWebLinkRead 129 CustomWebLinkReadAll 130 CustomWebLinkUpsert 131 CustomWebTabDelete 132 CustomWebTabRead 133 CustomWebTabReadAll 133 CustomWebTabUpsert 134 FieldManagementCreate 135 FieldManagementRead 136 FieldManagementReadAll 136 FieldManagementUpsert 137 HomepageLayoutReadAll 138 PageLayoutFieldRead 140 PageLayoutFieldReadAll 140 PageLayoutFieldUpsert 141 PageLayoutRelatedInformationReadAll 142 PageLayoutRelatedInformationUpsert 143 PicklistRead 144 PicklistReadAll 144 PicklistUpsert 145 RoleReadAll 146 RoleUpsert 147 Data Loader API Calls 149 BulkOpImportCreateRequest 149 BulkOpImportSendData 151 BulkOpImportGetRequestDetail 153 Chapter 7: Oracle CRM On Demand Objects Exposed Through Web Services Reference Information About the Parent Objects 155 Oracle CRM On Demand User Keys 156 Audit Fields 156 Oracle CRM On Demand Status Keys 157 6 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 7. Contents ■ Oracle CRM On Demand Pick Maps 157 Filterable Fields 158 Parent Objects (Web Services v1.0) 158 Account 159 Activity 178 Asset 187 Book 189 Campaign 192 Contact 201 Current User 220 CustomObject1 - CustomObject3 222 Dealer 231 Household 235 Lead 239 MedEd 246 Note 249 Opportunity 251 Portfolio 263 Product 268 Product Category 270 Service Request 272 Solution 277 Territory 280 User 282 User Group 285 Vehicle 287 Child Objects (Web Services v1.0) 290 Address 291 Attachment 292 Audit Trail 292 BookUser 292 Competitor 292 DelegatedUser 293 HouseholdTeam 293 Interests 294 Invitee 294 Login History 294 Multiple Contact Roles 294 OpportunityTeam 294 PortfolioTeam 295 ProductsDetailed 295 Quota 295 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 7 Release 18)
- 8. Contents ■ Recipient 296 Related Account 296 Related Contact 296 Revenue 296 SampleDropped 297 SubBook 297 Team 297 Core Parent Objects (Web Services v2.0) 297 Account 298 Activity 301 Asset 305 Book 308 Campaign 309 Category 312 Contact 313 CustomObject 317 Group 320 Lead 322 Note 324 Opportunity 325 Product 328 Service Request 330 Solution 332 Territory 334 User 336 Partner Relationship Management Edition Objects (Web Services v2.0) 338 Accreditation 339 Accreditation Request 341 Application 343 Certification 346 Certification Request 348 Course 350 Course Enrollment 352 Deal Registration 355 Exam 357 Exam Registration 359 Fund 362 MDF Request 364 Partner 366 Price List 368 Price List Line Item 370 Special Pricing Request 372 8 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 9. Contents ■ Special Pricing Request Line Item 374 Life Sciences Edition Parent Objects (Web Services v2.0) 376 Allocation 377 Business Plan 379 Contact Best Time 382 Contact State License 384 Inventory Audit Report 386 Inventory Period 388 MedEd 390 Message Response 392 Messaging Plan 394 Messaging Plan Item 397 Messaging Plan Item Relation 399 Modification Tracking 401 Objective 403 Plan Account 405 Plan Contact 407 Plan Opportunity 409 Sample Disclaimer 411 Sample Inventory 413 Sample Lot 415 Sample Transaction 417 Signature 420 Transaction Item 421 Financial Services Edition Parent Objects (Web Services v2.0) 424 Claim 424 Coverage 427 Damage 429 Financial Account 431 Financial Account Holder 433 Financial Account Holding 435 Financial Plan 437 Financial Product 439 Financial Transaction 441 Household 443 Insurance Property 446 Involved Party 448 Policy 450 Policy Holder 452 Portfolio 454 Automotive Edition Parent Objects (Web Services v2.0) 456 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 9 Release 18)
- 10. Contents ■ Dealer 456 Vehicle 458 Child Objects (Web Services v2.0) 461 Account 462 Activity 464 Address 466 Asset 467 Attachment 469 Book 470 471 Contact 471 Contact Team 473 Custom Object 4 and Higher 474 Delegated User 476 Interests 477 Invitee 478 Lead 480 Note 482 Opportunity 483 Products Detailed 485 Promotional Items Dropped 486 Recipient 487 Related Contact 488 Revenue 490 Sample Dropped 492 Service Request 493 User 495 Appendix A: Using Attachments With Web Services On Demand About Attachments 497 The Attachment Element 497 Specifying File Attachment Content 499 Attaching Binary Data 499 Attaching a Text File 500 Attaching a File to Multiple Records 501 Retrieving or Querying File Attachments 503 Specifying URL Attachments 505 10 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 11. Contents ■ Appendix B: Mapping of Display Names to Service API Object Names Appendix C: Web Services On Demand Limiters Web Services Request Rate 512 Index Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 11 Release 18)
- 12. Contents ■ 12 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 13. 1 What’s New in This Release What’s New in Oracle Web Services On Demand Guide, Version 6.0 (Oracle CRM On Demand Release 18) Table 1 lists changes described in this version of the documentation to support Version 6.0 (Oracle CRM On Demand Release 18) of the software. Table 1. What’s New in Oracle Web Services On Demand Guide, Version 6.0 (Oracle CRM On Demand Release 18) Topic Description “Web Services On Demand and Custom Standard custom field support has been added for the Fields” on page 23 Account Relationship and the Contact Relationship objects. “Entering Telephone Number Values Information about best practices for entering telephone through Web Services” on page 52 numbers through Web services has been added. “Using the QueryPage Method” on More information about the best practices for using the page 57 QueryPage method has been added. “DeleteEvents” on page 99 The DeleteEvents and GetEvents methods now support Custom Object 04 and higher and a number of Life “GetEvents” on page 100 Sciences related objects. “Preparing the Integration Event WSDL In previous releases, to generate a WSDL file for the File and Schema Files” on page 102 Integration Events Web service, users downloaded a .zip file containing both the WSDL and generic Schema files for all supported objects. In this release, only a WSDL file is generated when users click the Download Custom WSDL or Download Generic WSDL button on the Web Services Administration page. You must download Schema files separately for supported objects that you wish to track. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 13 Release 18)
- 14. What’s New in This Release ■ Table 1. What’s New in Oracle Web Services On Demand Guide, Version 6.0 (Oracle CRM On Demand Release 18) Topic Description “Administrative Services API Calls” on The Administrative API, used to automate the page 119 administration of company configurations, has been extended. The calls for the following services are described: ■ Action Bar Layout ■ Custom Web Link ■ Homepage Layout ■ Page Layout Field ■ Page Layout Related Information ■ Role Management “Accreditation” on page 339 For Web Services v2.0 only, a number of new objects available with the Oracle CRM On Demand Partner “Accreditation Request” on page 341 Relationship Management Edition have been exposed: “Certification” on page 346 ■ Accreditation “Certification Request” on page 348 ■ Accreditation Request “Course” on page 350 ■ Certification “Course Enrollment” on page 352 ■ Certification Request “Exam” on page 357 ■ Course “Exam Registration” on page 359 ■ Course Enrollment ■ Exam ■ Exam Registration “Partner” on page 366 The QueryPage method is now supported for the Partner object. “Invitee” on page 478 The Invitee child object of MedEd has been exposed. Appendix B, “Mapping of Display Names Details of new objects have been added to the table to Service API Object Names,” showing the mapping of display names to Service API object names. 14 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 15. 2 Overview of Web Services On Demand This chapter provides an overview of Oracle CRM On Demand’s support for Web services. It contains the following topics: ■ “About Web Services” ■ “Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand” on page 16 ■ “Web Services and the Oracle CRM On Demand Objects” on page 19 ■ “Stateless Web Services and Session Management” on page 24 ■ “Field Types Supported by Oracle CRM On Demand” on page 24 ■ “Web Services Utilization” on page 29 About Web Services The term Web services describes a standardized way of integrating Web-based applications over the Web. Web services allow businesses to communicate with each other and with other clients, without intimate knowledge of each other’s IT systems. Web services share business logic, data, and processes through a Web services application programming interface (API). Application developers can then add the Web services to a software application (such as a Web page or executable program) to offer specific functionality to users. Web Services Core Technologies The Web services core technologies are a set of standards-based technologies that include: ■ Extensible Markup Language (XML). The standard markup language that allows the definition of message structures and facilitates the passing of data between software applications. ■ Web Services Description Language (WSDL). The XML-formatted language that is used to describe a Web service. A WSDL file defines the available methods, message structures, and network addresses required for using a specific Web service. ■ Simple Object Access Protocol (SOAP). The XML-based protocol that is used to send Web services request and response messages. Web services messages are sent between the customer implementation of Web services and the SOAP handler on the Oracle Web Server. For more information on Web services technologies, see: http://www.w3.org/2002/ws. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 15 Release 18)
- 16. Overview of Web Services On Demand ■ Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand Oracle CRM On Demand Web Services Toolkit The Web Services Toolkit provides access to an application programming interface (API) that companies can use to build programs to integrate with Oracle CRM On Demand. The Toolkit includes a set of WSDL files that describes the interface to the Oracle CRM On Demand objects. This provides a programmatic interface for accessing your company's Oracle CRM On Demand information. A customer application can use the WSDL files through standard Web services development tools, such as those provided by the Oracle SOA Suite. The API for this release of Oracle CRM On Demand is backward-compatible with previous releases. Figure 1 shows how the Web Services Toolkit interacts with the Oracle CRM On Demand database. The customer uses the Web Services Toolkit (WSDL fields) to define the objects and methods that are contained in the Oracle CRM On Demand Hosted Service. The customer application communicates with Oracle CRM On Demand over the Internet using the secure HTTPS protocol. It invokes the Web services implementation contained in the Oracle CRM On Demand Hosted Service. Figure 1. How Web Services Communicate with Oracle CRM On Demand Oracle CRM On Demand is designed to be backward-compatible with previous releases. Therefore WSDL files from previous releases will continue to work with newer releases of Oracle CRM On Demand, and there is no need for customers to modify their code when upgrading to a new release of Oracle CRM On Demand. Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand The Web Services On Demand API allows companies to build programs to integrate with Oracle CRM On Demand. Some common examples of client integrations include the following: 16 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 17. Overview of Web Services On Demand ■ Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand ■ Integrations of CRM and back-office applications. You can retrieve real-time sales, marketing, and service information from Oracle CRM On Demand and use it in financial and other back-office applications. For example, you can retrieve information about recently closed opportunities through the Web services interface and insert this information into an order entry system that has a Web services user interface. In addition, you can store information from back- office applications in Oracle CRM On Demand for instant access by users, visible in custom fields on any Oracle CRM On Demand page. ■ Web-based portal applications. You can create customized Web-based applications using Active Server Pages (ASPs), Java Server Pages (JSPs), or similar Web technology that accesses Oracle CRM On Demand through the Web services interface. For example, an Oracle CRM On Demand customer can deploy a customized Web form on its corporate Web site, allowing visitors to enter requests for more information. The application creates new lead records in Oracle CRM On Demand for these requests through the Web services interface. Another Web page can allow visitors to browse through solutions to common problems stored in Oracle CRM On Demand and retrieved in real time through the Web services interface. ■ Custom add-on modules. Customers can also extend Oracle CRM On Demand functionality. For example, a company can create a custom add-on module to streamline its unique quote creation process, or a company can create additional utilities to perform mass data cleanup operations. These modules access data in Oracle CRM On Demand directly through the Web services interface. Oracle CRM On Demand administrators and users can run these modules while concurrently accessing the Oracle CRM On Demand user interface. Web Services Security The Oracle CRM On Demand Web Services Integration framework includes the following security features: ■ The mustUnderstand attribute of Simple Object Access Protocol (SOAP) 1.1 is supported. This allows a client to specify that the target server must be capable of processing all parameters in the SOAP request header, otherwise the requests must be rejected. SOAP message validation is performed, for example, to check for badly formed SOAP requests or for SOAP header elements that are not namespace-qualified. ■ Support is provided for the WS-I Basic Security Profile Version 1.0. For more information, see “Support for the WS-I Basic Security Profile Version 1.0” on page 18. ■ All communications are encrypted with Secure Sockets Layer (SSL) for security (minimum 128- bit). ■ Access is session-based, requiring authorization with a valid Oracle CRM On Demand user name and password. ■ Inactive sessions are reused or closed automatically after a period of inactivity. ■ The same data visibility and access capabilities that apply to users in the Oracle CRM On Demand hosted service are applied to users connected through the Web services interface. Data visibility and access are restricted by the role that your company assigns. Permissions are checked for every data access. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 17 Release 18)
- 18. Overview of Web Services On Demand ■ Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand ■ A full audit trail of Web services activity is available through Oracle CRM On Demand's Administration pages. These pages display both current and historical usage statistics. ■ A number of other proprietary solutions protect Oracle CRM On Demand against malicious use of the Web services interface. These solutions are constantly reviewed and improved as new technologies and techniques become available. A session with a standard HTTPS request is created to establish a connection with Oracle CRM On Demand through the Web services interface. A client can create a new session with the login operation and close it with the logoff operation. When a session is created, an encrypted session identifier is provided to the client. which for stateful Web services requests, must be included in all subsequent requests during that session. For more information, see “About Establishing and Managing the Web Services Session” on page 35. Support for the WS-I Basic Security Profile Version 1.0 Support is provided for the WS-I Basic Security Profile Version 1.0, which describes the set of parameters used to authenticate a Web services transaction. Oracle CRM On Demand has implemented support for the Username and PasswordType parameters, which are part of the UserNameToken standards. This allows a username and password to be passed with a SOAP request, which removes the necessity for a separate login operation. For more information, see “Server-Side Session Management” on page 36. Passwords can be specified as type PasswordText only, which mean that the password is in clear text format. WSSE Namespace Support The SOAP header of messages received by Oracle CRM On Demand are validated to ensure they are namespace-qualified. Oracle CRM On Demand supports the following namespace values when specifying the WSSE namespace in a SOAP request: ■ Draft Namespaces: ■ wsse="http://schemas.xmlsoap.org/ws/2002/04/secext" ■ wsse="http://schemas.xmlsoap.org/ws/2002/07/secext" ■ Version 1.0 Namespace: wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss- wssecurity-secext-1.0.xsd" The WSSE Version 1.0 namespace must be specified to perform a stateless transaction. (In addition, the Web Services R16 Compatibility Mode check box must be cleared in the Company Profile page and the Username and PasswordText tokens must be provided in the request.) For more information about stateless transactions and the use of the WSSE namespace, see Chapter 4, “Establishing and Managing the Web Services Session.” 18 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 19. Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand Objects Web Services Reliability All server components of Oracle CRM On Demand, including those responsible for the Web services interface, incorporate load balancing and other high-availability mechanisms. These mechanisms prevent the service from being interrupted by server or network infrastructure failure. Web Services and the Oracle CRM On Demand Objects The Oracle CRM On Demand Web services allow applications to integrate with Oracle CRM On Demand. They provide the ability to find and invoke the core Oracle On Demand Web Services across the Web from any client application language. This ability makes the process of using Oracle CRM On Demand Web Services easy for those who want to use them. The Oracle CRM On Demand services provide a basis for customers to perform integration with Oracle CRM On Demand based on SOAP technology. All major Oracle CRM On Demand business objects are exposed in the Web services, with the names of the Web services matching the default names of the business objects. Chapter 7, “Oracle CRM On Demand Objects Exposed Through Web Services” details the Oracle CRM On Demand parent and child objects that are exposed through Oracle CRM On Demand Web Services. Web Service APIs Starting with Web Services On Demand Version 4.0 (CRM On Demand Release 16) , objects are accessible through two APIs: ■ Web Services v1.0. Used to interact with Custom Objects 01-03, as well as out-of-the-box objects. ■ Web Services v2.0. Used to interact with all Oracle CRM On Demand Custom Objects, as well as out-of-the-box objects. Before Web Services On Demand Version 4.0, only the Web Services v1.0 was available. For the Web Services v1.0 API, operations work on the parent objects and all child components are synchronized with the parent. The Web Services v2.0 API, however, works on a node basis, where parent and child components are treated as separate nodes. The Web Services v2.0 API provides an Execute method for performing multiple operations on separate nodes, and the Web Services v2.0 QueryPage method offers additional options (through the searchspec, sortorder, and sortsequence arguments) for issuing queries compared to the Web Services v1.0 QueryPage method. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 19 Release 18)
- 20. Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand Objects Table 2 shows the methods available through the Web Services v1.0 and Web Services v2.0 APIs for access to objects. Table 2. Web Services v1.0 and Web Services v2.0 Methods Web Services Web Services v1.0 v2.0 Comments Delete Delete Finds records in the Oracle CRM On Demand database that match specified field values, and then deletes them (in other words, puts them into the Deleted Items area). DeleteChild Not applicable Deletes child records from the Oracle CRM On Demand database, or removes the association between the child and the parent object. Not applicable Execute Executes multiple update, insert, and delete operations on separate records in the Oracle CRM On Demand database within the same Web services request. Insert Insert Inserts new records into the Oracle CRM On Demand database. InsertChild Not applicable Inserts new child records into the Oracle CRM On Demand database. InsertOrUpdate Not applicable Updates existing records or inserts a new record if one did not exist. QueryPage QueryPage Executes a query against a specified list of records, and returns a subset of the records that match the search criteria set by the method arguments. Update Update Updates records with a new value. UpdateChild Not applicable Updates child records with a new value. Table 3 shows differences between Web Services v1.0 and Web Services v2.0. Table 3. Web Services v1.0 and Web Services v2.0 Differences Web Services v1.0 Web Services v2.0 Supports an upsert operation through Does not support an upsert operation InsertOrUpdate call Pagination parameters are supported only Pagination parameters are supported at both the at the parent level parent and child level 20 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 21. Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand Objects Table 3. Web Services v1.0 and Web Services v2.0 Differences Web Services v1.0 Web Services v2.0 Outputs all the children even if the Outputs only the specific child whose condition was condition is true for one child. met. For example, the QueryPage call returns For example, QueryPage returns only the specific all partner children from an account even partner child from the account for which the condition if the condition is true for only one partner was true child UseChildAnd argument of QueryPage call The UseChildAnd argument is not available. is available for using OR/AND logic Instead, by default, all parent records matching the between parent and child parent criteria and only children matching the child criteria are returned. Operators cannot be used to construct The SearchSpec argument of QueryPage can be used complex queries across multiple fields to construct complex queries across multiple fields in a request. For example, the OR operator can be used to find all records that match the specified condition for [Field A] OR the specified condition for [Field B]. Sort order is not customizable Sortorder and sortsequence arguments are available to customize the sorting order of the records Update call removes child objects not An Execute call with “operation=update” at the specified in the request parent level removes the unspecified children in the request InsertChild call is used to insert the For Web Services v2.0: children for existing parent objects ■ Insert call can be used to insert both parent records and child records. ■ If a child node is specified in the request, the Insert call inserts the child and associates it with the existing parent record. ■ If a child node is missing, the Insert call inserts only the new parent record. UpdateChild call is used to update child For Web Services v2.0: records ■ Update call can be used to update parent records and child records ■ If a child node is specified in the request, the Update call updates the child in the existing parent record ■ If the child node is missing, the Insert call updates only the existing parent record Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 21 Release 18)
- 22. Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand Objects Table 3. Web Services v1.0 and Web Services v2.0 Differences Web Services v1.0 Web Services v2.0 DeleteChild call is used to delete the child For Web Services v2.0: records ■ Delete call can be used to delete both parent records and child records ■ If the child node specified in the request is available, the Delete call deletes the child in the existing parent record, and leaves the parent record undeleted. ■ If the child node is missing, the Delete call deletes the existing parent record. InsertChild, UpdateChild, and DeleteChild In an Execute request, a specific node within the methods are used to perform operations request can be skipped using the on child records “operation=skipnode” attribute. This can be used to simulate InsertChild, UpdateChild or DeleteChild by skipping the parent node and only performing the specified actions on the child records. LOVLanguageMode argument is not The LOVLanguageMode argument is an input available argument for all of the Web Services v2.0 calls. It determines whether the processing for picklist fields occurs using language independent codes (LIC) or language dependent codes (LDC). ViewMode argument is not available The ViewMode argument, which specifies the level of access to records specified in the method call, is available for all of the Web Services v2.0 calls There are some differences between the format of the WSDL files for Web Services v1.0 and Web Services v2.0: ■ In the Web Services v2.0 API, strong data typing is supported. Therefore, in the Web Services v2.0 WSDL files, fields are represented by a range of xsd: data types, while in Web Services v1.0 WSDL files, all fields have the xsd:string data type. For more information, see “Field Types Supported by Oracle CRM On Demand” on page 24. ■ In Web Services v2.0, messages do not include the business service name, and have the format: [Objectname][Method]_[Input/Output] For example: AccountInsert_Input, ContactQueryPage_Output as opposed to the following for Web Services v1.0: AccountWS_AccountInsert_Input, ContactWS_ContactQueryPage_Output ■ The target namespace of the WSDL for Web Services v2.0 is: 22 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 23. Overview of Web Services On Demand ■ Web Services and the Oracle CRM On Demand Objects urn:crmondemand/ws/ecbs/objectname/ compared to the following for Web Services v1.0: urn:crmondemand/ws/objectname/ About Parent-Child Relationships Many of the Oracle CRM On Demand objects interact with each other through parent-child relationships. A parent object refers to the main or base object of interest and the child object refers to objects that are related to the parent in some way—for example, if the child is contained in the parent, or if the child has records that refer to the parent. These parent-child relationships can be one-to-many or many-to-many. For example, a lead can be associated with a particular account, but an account can have many leads associated with it. In this case, you can think of the relationship between the account and its leads as a one-to-many parent- child relationship. Other relationships can be many-to-many, meaning that many children are associated with many parents. For example, a contact can be associated with several opportunities, or an opportunity can have several contacts associated with it. In this case, you can think of the relationship between contacts and their opportunities as a many-to-many parent-child relationship. The parent-child relationship between contacts and opportunities can be treated with either the opportunity as the parent with contacts as children, or with the contact as the parent and the opportunities as children. Web Services On Demand and Custom Fields Oracle CRM On Demand allows company administrators to create custom fields that capture information specific to the company’s needs. Web Services On Demand allows customers to interact with the data stored in these custom fields. Each custom field has an associated integration tag that is used by Web services and Web links to reference data in custom fields. This feature allows administrators to change the display name of a field without making modifications to the existing Web services integration. Fields are labeled as iField_Name in the Custom WSDL files and Custom FieldType# in the Generic WSDL files. To view or modify integration tag information for a record type 1 Navigate to the Field Setup Administration page for the required record type. For example: Admin, Application Customization, Account, Account Field Setup, Rename Fields. 2 Click Advanced. The integration tag information is displayed for you to view or modify. You can download custom WSDL files in which the XML tags for the custom fields are based on the integration tags. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 23 Release 18)
- 24. Overview of Web Services On Demand ■ Stateless Web Services and Session Management To download a WSDL file that is specific to your company’s customization 1 Navigate to the Web Services Administration page. 2 Select Web Services v1.0 or Web Services v2.0, and click Go. 3 Select the required record type, and click Download Custom WSDL. A record type’s WSDL that is specific to your company’s customization is downloaded. For more information about downloading WSDL files, refer to the online help for Oracle CRM On Demand. Stateless Web Services and Session Management From Release 17, Oracle CRM On Demand supports stateless Web services transactions, and server- side session management capabilities removing the need for customers to implement session management within their client applications. Stateless Web services transactions are those in which the client application does not need to maintain a session identifier (a JSESSIONID value) to perform multiple requests to Oracle CRM On Demand using the same session. As all Oracle CRM On Demand Web Services methods (with the exception of QueryPage) are stateless, each request can be performed and authenticated independently. Stateless Web services are ideally suited for situations in which an interactive application is used to integrate with Oracle CRM On Demand. In an interactive application that issues requests through Web services calls to update, insert, or delete records in Oracle CRM On Demand, the client can be implemented so that the user’s credentials are supplied in the request. The Oracle CRM On Demand server checks to see if there is already a session established for that user in the session pool. If a session is found, it is reused for the request. If no session is found for that user, a new session is established. By limiting the number of sessions on a per user basis, it is possible to ensure that no single user can use all of the available sessions in an Oracle CRM On Demand environment. Sessions that are idle can be reused to process incoming requests, removing the necessity to explicitly log off from a session, or to wait for a session to time out before a new session can be established. For more information about session management, see “About Establishing and Managing the Web Services Session” on page 35 and “Server-Side Session Management” on page 36. Field Types Supported by Oracle CRM On Demand The field types supported depend on whether the Web Services v1.0 or Web Services v2.0 API is used, as described in the following topics. 24 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 25. Overview of Web Services On Demand ■ Field Types Supported by Oracle CRM On Demand Web Services v1.0 For the Web Services v1.0 API, all fields in Web services On Demand are transmitted and received as strings. It is the client’s responsibility to cast these to and from the required data type in any application. The proper type can usually be determined from the name, purpose, or application of the field. There is no dynamic method for determining field types. You can derive clues about a field’s type from its name as follows: ■ A name ending in the suffix Id is usually a key field, such as a primary key, foreign key, or user key Id. It can usually be treated as a unique text string. ■ Fields with names containing Date or Time, such as LastUpdated, DueDate, StartTime, or EndTime might be date fields. ■ Telephone number fields can be treated as numeric phone numbers or as plain text. When performing queries on phone number type fields the following formats must be used in Query operations: ■ U.S. Format: +1 872 9269923 ■ France: +33 01 40359564 ■ Japan: +81 3 54579623 ■ Other numeric fields, such as currency, size, revenue, or probability can be treated as integer, floating point, or text fields depending on the application. ■ Boolean fields have the value Y for true or N for false. ■ Most other fields can be treated as ordinary text. NOTE: If you attempt to query a field of type Date with syntax like <CloseDate>>'01/01/2004 00:00:00'</CloseDate> you get an error, because the time parameter 00:00:00 is only valid for fields of type Date/Time and not for fields of type Date. Web Services v2.0 The Web Services v2.0 API supports strong data types for fields, so fields are represented by appropriate XSD data types. Table 4 shows the list of supported XSD data types. Table 4. Data Type Mapping in the Web Services v2.0 API Data Type Mapped XSD Data Type BOOL xsd:boolean CURRENCY xsd:decimal NUMBER xsd:decimal DATE xsd:date DATETIME xsd:dateTime UTCDATETIME xsd:dateTime Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 25 Release 18)
- 26. Overview of Web Services On Demand ■ Field Types Supported by Oracle CRM On Demand Table 4. Data Type Mapping in the Web Services v2.0 API Data Type Mapped XSD Data Type ID xsd:string NOTE xsd:string PHONE xsd:string TEXT xsd:string INTEGER xsd:int TIME xsd:time Others xsd:string If an incorrect data type is provided in a Web services request, the field is updated to NULL or a default value for that specific data type, as shown in Table 5. Table 5. Updating of Fields When Incorrect Data Types are Provided in the Web Services v2.0 API XSD Data Type Default Value/Null xsd:boolean N xsd:decimal NULL xsd:date NULL xsd:dateTime NULL xsd:string NULL xsd:int 0 xsd:time NULL For example, Activity has a field named Cost, which takes integer values. If you provide a text value for the field in an update request, the previous value is replaced with a 0. You can find further details about the definition of XSD data types here: http://www.w3.org/TR/xmlschema-2/#built-in-datatypes Special Search Fields Some field names are prefixed with CI_ to denote that they are special fields that provide better search functionality. These fields do not exist for all objects but are easily identified in the WSDL files as shown in the following excerpt from the Account WSDL file: <xsd:element name="CI_AccountName" maxOccurs="1" minOccurs="0" type="xsd:string"></ xsd:element> 26 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 27. Overview of Web Services On Demand ■ Field Types Supported by Oracle CRM On Demand <xsd:element name="CI_Location" maxOccurs="1" minOccurs="0" type="xsd:string"></ xsd:element> Support for Multi-Select Picklists A multi-select picklist is a picklist from which the user can select multiple values. In Web Services On Demand, multi-select picklists are only exposed for the following record types: ■ Account ■ Activity ■ Contact ■ Custom Object 01 ■ Custom Object 02 ■ Custom Object 03 ■ Lead ■ Opportunity ■ Service Request For these record types, all standard and custom multi-select picklist fields are exposed. You can add, remove, replace or query selections in parent-level multi-select picklist fields, however child-level multi-select picklist fields are not supported. Input and output values are language-independent code (LIC) delimited, but the multi-select picklist delimiter is always a semicolon regardless of locale for input and output: <LIC1>;<LIC2>. Locale-Dependent Access to Oracle CRM On Demand Oracle CRM On Demand Web Services does not provide any specialized localization interfaces. Oracle CRM On Demand supports full localization, so that the data created through Web services is localized for users. The localized fields in the Web services interfaces follow the formats outlined in the following topics. Date and Time Fields Date and time fields for Web services v1.0 are in the following format: MM/DD/YYYY hh:mm:ss For Web services v2.0, the data in SOAP requests conforms to XSD data formats. The XSD dateTime datatype has the format: yyyy '-' mm '-' dd 'T' hh ':' mm ':' ss ('.' s+)? (zzzzzz)? For example: Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 27 Release 18)
- 28. Overview of Web Services On Demand ■ Field Types Supported by Oracle CRM On Demand 2009-10-10T12:00:00-05:00 represents noon on 10th October 2002, Central Daylight Savings Time, which is equivalent to Eastern Standard Time in the US. As a further example: 2009-10-09T17:00:00Z represents noon on 9th October 2009, UCT, which is equivalent to the GMT time zone. For the QueryPage method of Web Services v2.0, either the XSD formats (recommended) or the locale-specific formats can be used. Number and Currency Fields Number and currency fields in Oracle CRM On Demand are in raw number format. In other words, number and currency fields hold only digits with no currency symbols, decimal separators, or other numeric separators (different locales use different symbols as the decimal point). Validation of Email Fields When Oracle CRM On Demand validates fields containing email addresses, it identifies the following as invalid: ■ Empty string ■ String too long ■ No characters before the at sign (@) character, for example: @riqhtequip.com ■ No at sign (@) character, for example:isampleriqhtequip.com ■ No period (.) character, for example: isample@riqhtequipcom ■ No domain, for example: isample@ ■ No domain suffix such as com, for example: isample@riqhtequip ■ Multiple at signs (@), for example: isample@@riqhtequip.com ■ Consecutive period (.) characters, for example: isample@riqhtequip..com ■ Spaces in the string, for example: isa mple@riqhtequip ■ Characters other than the following in the local part of an email address: ■ Uppercase and lowercase letters (case insensitive) ■ The digits 0 through 9 ■ The characters: ❏ Exclamation point (!) ❏ Hash symbol (#) ❏ Dollar sign ($) 28 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 29. Overview of Web Services On Demand ■ Web Services Utilization ❏ Percent (%) ❏ Ampersand (&) ❏ Single quotation sign (') ❏ Asterisk (*) ❏ Plus sign (+) ❏ Minus sign (-) ❏ Slash (/) ❏ Equal sign (=) ❏ Question mark (?) ❏ Caret (^) ❏ Underscore (_) ❏ Back single quotation mark (`) ❏ Left curly brace ({) ❏ Vertical bar (|) ❏ Right curly brace (}) ❏ Tilde (~) ■ Any special characters in the domain name of an email address. These special characters are the same as those allowed in the local part of the email address, and also the left and right parentheses (). Web Services Utilization In the Oracle CRM On Demand application, the Web Services Utilization page provides useful information on Web services usage, both current and historical, for a company. In the Web Services utilization page, the source of Web services calls is logged to determine whether the calls originated, for example, from a PDA application, or from a generic custom application. You can also use the UserUsageQueryPage method to get information about Web services utilization. For more information about this method, see “UserUsageQueryPage” on page 117. See the Oracle CRM On Demand online help for more information on using the Web Services Utilization page. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 29 Release 18)
- 30. Overview of Web Services On Demand ■ Web Services Utilization 30 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 31. 3 Getting Started with Web Services This chapter provides an overview of how to get started with Oracle CRM On Demand Web Services. It contains the following topics: ■ “Accessing Data in Oracle CRM On Demand” on page 31 ■ “Requesting Web Services Integration” on page 31 ■ “Downloading WSDL files and Schema Files” on page 32 ■ “Incorporating WSDL Files into the Development Environment” on page 34 Accessing Data in Oracle CRM On Demand A customer who wants to access data in Oracle CRM On Demand from a Web services-enabled client must perform the following tasks: 1 Request Web Services Integration. 2 Download WSDL files, and Schema files if required. 3 Incorporate WSDL files into the development environment. Requesting Web Services Integration On request, an Oracle CRM On Demand Customer Care representative enables the Oracle CRM On Demand Integration capability for your company by limiting access to Web services to particular roles. Starting with Oracle CRM On Demand Release 17, Customer Care can grant two privileges: ■ Enable Web Services Access. Users whose roles have been granted this privilege can log in to Oracle CRM On Demand through Web services, and issue requests using the Web services API. By default, this privilege is enabled for the Administrator role for new companies. ■ Manage Access to Web Services. Users (usually administrators) who have been granted this privilege can grant other roles the Enable Web Services Access privilege. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 31 Release 18)
- 32. Getting Started with Web Services ■ Downloading WSDL files and Schema Files These privileges replace the Web Services Enabled check box on the Company Profile page in the Oracle CRM On Demand application, which was the means of enabling Web services access before Release 17. To maintain backwards compatibility, all roles for companies existing before Release 17 have the privilege to enable access to Web services. if your company existed before Release 17, and you have access to Web services, you do not need to take any action unless you wish to restrict access to Web services, in which case you must do the following: 1 Contact Customer Care and request that the Administrator (or equivalent custom role) be granted the Manage Access to Web Services Integration privilege. 2 Configure roles. The Administrator grants or revoke access to Web services on a per role basis. Enabling Stateless Web Services Support Support for stateless Web services requests is enabled by Customer Care or the company administrator through the Web Services R16 Compatibility Mode setting on the Company Profile page in Oracle CRM On Demand. This check box controls whether Web services requests are processed as stateless requests or as stateful requests as in Release 16 of Oracle CRM On Demand. The Web Services R16 Compatibility Mode check box is cleared by default for all new companies, therefore support for stateless Web services is enabled by default for new customers, and disabled by default for companies who were customers before Release 17. It is recommended to clear the check box and thus enable stateless Web Services. If stateless Web services support is enabled, the namespace specified in requests is used to determine whether or not a request is processed as a stateless request: ■ Specifying the WSSE Version 1.0 security namespace results in the request being treated as a stateless request. In this case, session pooling is used to manage user sessions (that is, no session ID is returned in the response). This conforms to WS-I specifications. ■ Specifying the WSSE draft namespace results in the request being treated as a stateful request, in which a session ID value is returned in the response (this was the behavior before Release 17). For more information about these namespaces, see “WSSE Namespace Support” on page 18. If stateless Web services support is disabled, requests containing the username and password tokens are treated as stateful requests, regardless of the specified namespace value. Responses are returned with a session ID that can be used in subsequent requests to reuse an existing session. Downloading WSDL files and Schema Files Your company’s designated Oracle CRM On Demand administrator accesses the Web Services Administration page in Oracle CRM On Demand to download Web Service Description Language (WSDL) files that have been published for the desired Oracle CRM On Demand objects (record types). The administrator can also download WSDL files for the Service API; the API for managing administrative tasks through Web services, and WSDL files for the Administrative Services. 32 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 33. Getting Started with Web Services ■ Downloading WSDL files and Schema Files You can download WSDL files for both the Web Services v1.0 and Web Services v2.0 API, and for both of these services, you can download Custom or Generic WSDL files. For Web Services v1.0, and Web Services v2.0 objects for which Integration Events support is offered, you can also download Schema files, as described in Downloading Schema Files. To download a WSDL file 1 Navigate to the Web Services Administration page. 2 From the Select Service drop-down list, select Web Services v1.0, Web Services v2.0, Service, or Administrative Services APIs as required. 3 From the WSDL Object drop-down list, select the required record type, for example, Account, or the name of the service API. The objects displayed in the WSDL Object drop-down list depend on the record types that are set up for your company. 4 Click one of the following buttons, to display a page containing the WSDL. Depending on whether you select Download Custom WSDL, or Download Generic WSDL, custom fields are displayed differently in the WSDL: ■ Download Custom WSDL. For Custom WSDL, the XML tags for the custom fields are based on the Integration tags from Field Setup. Custom WSDL allows you to generate WSDL specific to your company that uses your company's field naming conventions. ■ Download Generic WSDL. For Generic WSDL, the custom fields are based on generic XML tags: CustomNumber0, CustomCurrency0, and so on. Using these placeholders, together with the Mapping Service allows applications to map to the field names that your company uses. 5 Save the WSDL file to your computer. Downloading Schema Files The Integration Events Web service (part of the Service API) imports Schema (XSD) files from its WSDL, therefore you must download the required Schema files for the objects included in the WSDL file. You can download Custom or Generic Schema files for all objects for the Web Services v1.0 API, as well as Web Services v2.0 objects for which Integration Events support is offered. If you create custom fields or rename fields for a record type, you cannot use the Generic XSD files for tracking these fields. Instead, you must download a Custom XSD file using the Download Custom Schema button in the Web Services Administration page. For more information about the Integration Events Web service, see “Preparing the Integration Event WSDL File and Schema Files” on page 102. To download a Schema file 1 Navigate to the Web Services Administration page. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 33 Release 18)
- 34. Getting Started with Web Services ■ Incorporating WSDL Files into the Development Environment 2 From the Select Service drop-down list, select Web Services v1.0 or Web Services v2.0. 3 From the WSDL Object drop-down list, select the required record type, for example, Account. The objects displayed in the WSDL Object drop-down list depend on the record types that are set up for your company. 4 Click one of the following buttons: ■ Download Custom Schema. ■ Download Generic Schema. A page containing the Schema is displayed. Depending on whether you select Download Custom Schema, or Download Generic Schema, custom fields are displayed differently in the Schema. For Custom Schema, the XML tags for the custom fields are based on the Integration tags from Field Setup. For Generic Schema, the custom fields are based on generic XML tags. NOTE: If you selected Web Services v2.0, and Schema file generation is not supported for the selected record type, an error message is displayed. 5 Save the Schema file to your computer. Incorporating WSDL Files into the Development Environment To use the downloaded WSDL files, the company incorporates the WSDL files into its Web services development environment—for example, by generating .NET, Java, or C# (C Sharp) proxy classes. For some information about best practices when generating proxy classes, see “Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit” on page 49. 34 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 35. 4 Establishing and Managing the Web Services Session This chapter describes the different ways in which an Oracle CRM On Demand Web services session can be established and maintained. It contains the following topics: ■ “About Establishing and Managing the Web Services Session” on page 35 ■ “Server-Side Session Management” on page 36 ■ “Client-Side Session Management” on page 37 ■ “Stateful Login Mechanisms” on page 38 ■ “Logging Out of the Web Services Session” on page 40 About Establishing and Managing the Web Services Session A Web services-enabled client (that is, a client written in any language that interacts with the Web services framework), must establish a secure session with Oracle CRM On Demand. After authentication, the client interacts with the published Oracle CRM On Demand Web Services to perform data retrieval, modification, creation, and deletion operations. Oracle CRM On Demand and the client format requests and resulting data as standard XML/SOAP messages. There are multiple ways in which client applications can establish authenticated sessions with Oracle CRM On Demand. These sessions can be managed by the client or by the Oracle CRM On Demand server based on the login mechanism used to establish the session. Server-Side Management To establish a session that is managed on the Oracle CRM On Demand server: ■ A company must have stateless Web services support enabled, see “Enabling Stateless Web Services Support” on page 32. ■ The WS-I login mechanism must be used with the correct namespace and formats as described by the WS-I basic security profile http://www.ws-i.org/Profiles/BasicSecurityProfile- 1.0.html#UsernameToken: ■ The user's login credentials must be supplied in the request. ■ The WSSE security namespace (http://docs.oasis-open.org/wss/2004/01/oasis-200401- wss-wssecurity-secext-1.0.xsd) must be specified in the request. Requests that meet these criteria qualify as stateless requests. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 35 Release 18)
- 36. Establishing and Managing the Web Services Session ■ Server-Side Session Management Client-Side Management All other login methods establish sessions that must be managed by the client application. These login methods include: ■ HTTP GET Request ■ Single Sign On ■ Sending a request with login credentials. Server-Side Session Management Interactive applications can be developed such that a user's credentials are supplied within a request sent to Oracle CRM On Demand, eliminating the need for an explicit login request. If the request qualifies as a stateless request (see “Server-Side Management” on page 35), the Oracle CRM On Demand server checks to see whether a session has already been established for that user. If a session is found, it is re-used for the new request. If no existing session is found for the user, a new session is established. Each user is limited in the number of concurrent sessions that they can establish. When a request is received by the server, a server ID value is returned in the response. This value does not identify a specific user session, but rather is used to identify the server in the Oracle CRM On Demand environment on which the session has been created. Subsequent requests can be sent that include the server ID value, thus ensuring that the request is routed to the same server as the original request. NOTE: Providing a server ID in subsequent requests is optional, however it is recommended that this value is included. The ability to supply a user’s credentials is due to support for the UserNameToken profile of the WS- I Basic Security Profile Version 1.0. In this case, the SOAP header contains the element <wsse:UsernameToken>, which has child elements containing a username and password: <soap:Header> <wsse:Security soap:mustUnderstand="1"> <wsse:UsernameToken> <wsse:Username>admin@test.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss- username-token-profile-1.0#PasswordText">adminOnDemand</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soap:Header> NOTE: URL encoding of login credentials is not supported when they are provided in the SOAP security headers. 36 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 37. Establishing and Managing the Web Services Session ■ Client-Side Session Management You cannot explicitly log off from a stateless session; it will eventually time out or be reused, or could be destroyed by server-side session management routines. Client-Side Session Management In instances in which the application manages the creation and release of user sessions, the following apply: ■ Clients must make login and logoff calls in their code to manage the session. ■ The login step returns an HTTP cookie that contains the session identifier that must be used for making additional requests. ■ A session remains active until the user explicitly logs out or until the session times out. Web services session management is HTTP-based and uses a session ID (also known as a JSESSIONID), which is contained in HTTP Session cookies, to uniquely identify a session established with Oracle CRM On Demand. Oracle CRM On Demand Web Services enable session management by first creating a session using the login call, which is then referenced in any subsequent SOAP operations. In an Oracle SOAP session, after a session ID has been created in a login request, it can be referenced in one of these ways: ■ The session ID can be attached as a parameter to the URL request line. When a session ID is present in the URL line, it is identified by the string “jsessionid” in lowercase, followed by the exact session ID, which is coded using URL syntax. ■ The session ID can be part of the cookie header line. When a session ID is referenced as a cookie, a cookie header line must appear in the SOAP request with the name JSESSIONID=. In this case, the session ID appears in uppercase, and the value of the cookie is exactly the same as the session ID received from the login request. NOTE: This is the recommended approach to referencing the session ID, for several reasons. The Java servlet specification advises the use of cookies and not the URL wherever possible. Most development environments and programming languages are efficient in using cookies rather than adding arguments to the URL. Furthermore, it is much simpler to implement cookies because the cookie container from the Oracle CRM On Demand login response can be copied onto further requests being sent to Oracle CRM On Demand. Unless the SOAP operation qualifies as stateless, a valid Oracle session ID must be provided for the request to be processed. When a login request is made, the session ID is returned as a cookie in the response to the request. The client is responsible for extracting this session ID and using it throughout the session. If the session times out for any reason, the error returned reports that the session is not valid and the client must then request a new session. In this case, no explicit logoff operation is required. To issue a logoff request to terminate a session, the request must identify the session using the JSESSIONID value. All requests must use Secure Sockets Layer (SSL) over HTTP (HTTPS). Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 37 Release 18)
- 38. Establishing and Managing the Web Services Session ■ Stateful Login Mechanisms Stateful Login Mechanisms The following topics describe the various mechanisms for logging in and making integration requests when making stateful Web services requests. Logging in Using HTTP GET An HTTPS request can be used to instantiate an Oracle CRM On Demand Web services session and obtain a valid session ID. A client invokes login by sending an HTTP GET request to a URL like the following: https://secure-ausomx[ENV].crmondemand.com/Services/Integration?command=login where [ENV] is the three-letter identifier for your company’s environment. If you do not know what this value is for your company, refer to the URL you use to access the Oracle CRM On Demand UI. NOTE: The login parameter value is case sensitive. Login Input There are different mechanisms for login depending on whether the login header contains URL encoding with the UTF-8 encoding system. This is necessary when login credentials contain multi- byte characters. The input to login is provided in the URL parameters and the HTTP headers, as follows: ■ Two URL parameters: ■ command, which has the value login ■ isEncoded, which is used if the HTTP headers are URL encoded using UTF-8. This parameter must have the value Y or y if encoding is required. The default value is N or n. ■ Two HTTP headers, UserName and Password, must be set with the appropriate values for your system. For example: ■ UserName: johndoe@email.com ■ Password: mypass The HTPP headers can be in clear text, or can be URL encoded. Login Output The login command returns the following items: ■ A session cookie, JSESSIONID. The client must use this cookie when submitting subsequent requests, including logoff requests. ■ A status code of 200, if the session does not encounter any errors. This indicates that the request succeeded. 38 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 39. Establishing and Managing the Web Services Session ■ Stateful Login Mechanisms For code samples for logging in, see: https://codesamples.samplecode.oracle.com/servlets/Scarab/ action/ExecuteQuery?query=crm_on_demand It is also possible to log in at the same time as making an integration request; for more information, see “Integration Requests for the Web Services Session” on page 40. Logging in Using Single Sign-On The Single Sign-On (SSO) feature of CRM On Demand allows companies to integrate the hosted Oracle CRM On Demand service with other systems that have the ability to manage user credentials and authentication. If your company has been set up to use SSO for Oracle CRM On Demand, the following steps are used to log in and retrieve the session ID. 1 The Web service client makes a request with the following command specifying the SSO Company Identifier. https://server/Services/Integration?command=ssoitsurl&ssoid=company-sso-id 2 The server returns the SSO ITS URL in the "X-SsoItsUrl" HTTP header of the response 3 The Web service makes a request with the ITS URL and retrieves a session ID. For detailed information about Single Sign-On, refer to the White Paper available from Customer Care. For code samples for single sign-on see: https://codesamples.samplecode.oracle.com/servlets/ Scarab/action/ExecuteQuery?query=crm_on_demand The outbound SSO feature allows users who have signed into Oracle CRM On Demand using SSO to pass the SSO credentials from Oracle CRM On Demand to third-party sites such as corporate Web pages or intranets. This allows users to embed or access third-party sites from within Oracle CRM On Demand. Outbound SSO in Oracle CRM On Demand uses a proprietary method to generate a hashed message authentication code (HMAC) token that is passed to the third-party site. This third-party site makes a request back to Oracle CRM On Demand with the token. Oracle CRM On Demand then validates the token and provides a username back to the third-party site, or authenticates the token and provides a session ID to the user. Outbound SSO Methods Two methods are available as part of outbound SSO: 1 SSO Token Validation. The following steps are used to validate an SSO token: a The third-party application makes a request with the following command specifying the SSO token: b https://server/Services/SSOTokenValidate?odSsoToken = "ssotoken value" c The server returns the username in the response. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 39 Release 18)
- 40. Establishing and Managing the Web Services Session ■ Logging Out of the Web Services Session 2 Login using SSO Token. The following steps are used to obtain a session ID using the SSO token: a The third party application makes a request with the following command specifying the SSO token: b https://server/Services/Integration?command=ssologin&odSsoToken="ssotoken value" c The server returns the session ID in the response, which is used for access to data within Oracle CRM On Demand. For detailed information about outbound SSO, refer to the Customer Care Portal - Web services resource library. Integration Requests for the Web Services Session An integration request is an HTTPS request to invoke a Web service to perform data creation, retrieval, update, and deletion operations. An integration request is made by an HTTP POST command to a URL like the following: https://secure-ausomx[ENV].crmondemand.com/Services/Integration/object where object is the name of the relevant Oracle CRM On Demand object (record type). This Oracle CRM On Demand object is determined from the contents of the SOAP request. Integration request input. The JSESSIONID returned to the client during login must be included with the request. The request must contain the JSESSIONID either as a cookie or as a URL parameter, as follows: https://secure-ausomx[ENV].crmondemand.com/Services/Integration/object; jsessionid=xyZ12489w3482413 The Web service input is provided as a SOAP command in the body of the HTTP POST request. Integration request output. The properties returned by the HTTP server populate the response headers and the response body. Table 6 shows the top-level properties that specify key properties of the HTTP response. Table 6. Properties of the HTTP Response Property Comments HttpStatus Status code returned in the response. If no value is provided, the response is given the value 200 (indicating success). Content-Type Content type returned in the response. If no value is provided, the response is given the value text/xml. Logging Out of the Web Services Session A client logs out by sending an HTTP POST or HTTP GET request to a URL. For example: 40 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 41. Establishing and Managing the Web Services Session ■ Logging Out of the Web Services Session https://secure-ausomx[ENV].crmondemand.com/Services/Integration?command=logoff; NOTE: The parameter value logoff is case sensitive. Logoff Input The preferred method is where the JSESSIONID returned to the client during login must be included with the request as a cookie with the same name. There are no other URL parameters or HTTP headers, and there is no HTTP body. Logoff Output A status code of 200 is returned if the request is received by the Oracle CRM On Demand server. This does not guarantee that the logoff request has been processed, and there may be a delay until the session resources are released for use by a new Web services session. Alternative Logoff The JSESSIONID can be included in the URL instead of a cookie if the user wants. The following URL is what the user would use, where XXXX is the JSESSIONID. https://secure-ausomx[ENV].crmondemand.com/Services/ Integration;jsessionid=XXXX?command=logoff Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 41 Release 18)
- 42. Establishing and Managing the Web Services Session ■ Logging Out of the Web Services Session 42 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 43. 5 Best Practices for Designing Client Applications This chapter provides best practice recommendations that allow you to design client applications that interface optimally with Oracle CRM On Demand using Web Services On Demand. It contains the following topics: ■ “Best Practices for Integration Design” on page 43 ■ “Sending of Web Services Requests to Oracle CRM On Demand” on page 44 ■ “Flushing of Caches” on page 44 ■ “Using Stateless Web Services” on page 45 ■ “Setting and Querying Blank Values” on page 46 ■ “Working with Opportunity Product Revenue Records” on page 47 ■ “Error Handling and Logging” on page 47 ■ “Handling Outages and Failures” on page 47 ■ “Best Practices for Generating Web Services Proxy Classes in Java Environments” on page 48 ■ “Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit” on page 49 ■ “Entering Telephone Number Values through Web Services” on page 52 ■ “Best Practices for Integration Performance” on page 54 ■ “Batch Processing” on page 54 ■ “Session Management and Pooling” on page 55 ■ “API Calls” on page 56 ■ “Best Practices for Integration Management” on page 58 ■ “Moving Customers Between Pods” on page 58 ■ “Handling Outages” on page 58 ■ “Maintaining SSL Certificates” on page 59 Best Practices for Integration Design This topic describes best practices for optimizing the design of client applications. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 43 Release 18)
- 44. Best Practices for Designing Client Applications ■ Best Practices for Integration Design Sending of Web Services Requests to Oracle CRM On Demand Oracle CRM On Demand processes Web services requests in a synchronous manner, therefore client applications using a single session must send requests in a synchronous manner. If the client application needs to send messages asynchronously, multiple sessions must be used. Flushing of Caches In Oracle CRM On Demand, there are internal caches that store metadata information such as field customization data, access or privilege settings, book information and so on. For stateless Web services only, users can flush the caches to reload any metadata information that has changed recently. You use the MetadataChangeSummaryQueryPage method to determine whether there have been any metadata changes; see “MetadataChangeSummaryQueryPage” on page 109. In the case of session-based Web services (stateful Web Services), the same flushing of caches would only occur on logging in again. Best Practices The best practices for flushing of the caches are as follows: ■ You are advised not to flush caches unless really necessary, because it affects throughput. ■ If you detect stale metadata, you use a flush cache flag to reload the caches. You can use the MetadataChangeSummaryQueryPage method to check whether the metadata has changed. Usage To flush the caches, you include the SOAP header element <FlushCache> in requests. The element can contain the values true or 1 to indicate that caches are to be flushed. Any other value is considered as false. The following shows a SOAP message containing the <FlushCache> element: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:/ /www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext- 1.0.xsd"> <soap:Header> <wsse:Security> <wsse:UsernameToken> 44 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 45. Best Practices for Designing Client Applications ■ Best Practices for Integration Design <wsse:Username>user@ondemand.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss- username-token-profile-1.0#PasswordText">password</wsse:Password> </wsse:UsernameToken> </wsse:Security> <FlushCache xmlns=”urn:crmondemand/ws”>true</FlushCache> </soap:Header> <soap:Body> ... Input request or payload here ...... </soap:Body> </soap:Envelope> Using Stateless Web Services It is recommended that you use stateless Web services as opposed to stateful Web services whenever possible. Stateless Web services use server resources more efficiently and reduce the cost of implementation as customers do not need to implement session pooling and so on in client applications. The best practices for stateless Web services are described in the following sections. NOTE: The best practices for stateful Web services operations must also be applied to the use of stateless Web services; see “Session Management and Pooling” on page 55. Using Sessions IDs It is recommended that stateful and stateless Web services calls are not mixed. For example, the following is not recommended: 1 Login is performed and the JSESSIONID captured. 2 A stateless Web services call is issued along with the JSESSIONID. This sequence results in the stateless Web service call using the session associated with the JSESSIONID and will therefore not be a stateless request. The JSESSIONID will not be invalidated after processing the request and the user must perform a log off because the session was created through an implicit login. Hence, ideally users must not mix the two mechanisms. You should only use a session ID value when it is necessary to maintain a session across multiple requests, for example, when paging across multiple pages of records in a QueryPage request when a snapshot of the data is required, or when an SSO Token is used to establish a session with Oracle CRM On Demand. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 45 Release 18)
- 46. Best Practices for Designing Client Applications ■ Best Practices for Integration Design For stateless requests, a session ID is returned to the client application. To maintain server affinity, the session ID returned by the initial request must be returned in subsequent requests. (This is the default behavior of most development platforms, in that the cookie is returned with the next request). This session ID does not identify a specific session as it does for stateful requests, however it does identify the specific server on which the session resides. Including this session ID for subsequent requests ensures that the request is routed to the correct server (not doing so may result in the subsequent request being routed to another server and the establishment of a new session on that server). Avoid Multiple Concurrent Requests Avoid issuing multiple concurrent requests for the same application unless absolutely required. If you do send multiple concurrent requests, and if you receive a RIP_WAIT error, or server unavailable error, the server might be busy due to the number of concurrent requests it is handling. If this happens, do one of the following: ■ If possible, try the request again later, as the load on the server may decrease. Most load conditions should be rare and temporary. You may never see one during development. ■ Retry with an exponential backoff. The client can be implemented such that retries are issued automatically using an exponential retry rate (that is, retries occur after 100ms, 200ms, 400ms, 1600ms and so on). ■ Contact Oracle CRM On Demand Customer Care to increase the resources. Use Sort Criteria when Using QueryPage If the QueryPage method is used as a stateless transaction, each request for an additional page of data returns any records that have been added or updated since the initial query. Any records that have been deleted since the first request will no longer appear in the result set. Therefore, always use sort criteria to avoid returning the same record when paging through results using the QueryPage method: ■ Use sort criteria on the Id field, which helps in most simple cases. ■ Use a stateful QueryPage Web service request, if it is required to paginate through a snapshot of data. Setting and Querying Blank Values When updating or querying for blank values the best practice is to specify isNull instead of leaving the value blank. As an example, the AccountName and Location fields form a user key for updating or querying Account records. Location is not a required field, therefore a null or blank value can be set for this field. The best practice is therefore to specify isNull for Location instead of blank. 46 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 47. Best Practices for Designing Client Applications ■ Best Practices for Integration Design Working with Opportunity Product Revenue Records When implementing a client application that inserts or both inserts and updates Product Revenue records associated with an Opportunity, it is important to ensure that the Revenue record is associated not only with the Opportunity but also with a Product record. This is because Opportunity Revenue records that do not have an associated Product will not appear within the Oracle CRM On Demand UI. These records will appear in Forecast and Opportunity revenue roll-up but are not editable using the UI or Web services. Error Handling and Logging Error handling and logging are essential when developing a client application. The client application must provide for: ■ Logging of detailed information about the error observed. ■ Logging of the body and header information of all SOAP requests and responses. For the resolution of some errors, the actual SOAP request can be extremely useful in identifying the root cause of a problem. ■ A call stack, which can be extremely important when analyzing problems and can provide useful hints that may reveal contributing factors to the problem. ■ Entry points wrapped in log messages. The ability to identify entry and exit of Web service calls is important when analyzing issues. ■ If a Web service request returns an error, the ability to analyze the result, stop immediately, or continue depending on the severity of the issue reported. ■ End points that are not hard-coded. ■ Dynamic server name and protocol configuration Handling Outages and Failures The client application must contain a mechanism to recognize when the Oracle CRM On Demand application is not available, and be able to persist in a dormant state. This mechanism can either be achieved manually or programmatically; for example: ■ A process can become dormant if it receives a HTTP 404 error message and retry after several minutes. ■ A process can alert an administrator and shut down after x failed attempts. A situation may arise where it is unknown if an operation has succeeded or not. In this situation, if the client application can detect duplicate errors, you can retry an insert operation with Oracle CRM On Demand user keys allowing you to uniquely identify records. You can identify lost updates by examining modification dates on records. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 47 Release 18)
- 48. Best Practices for Designing Client Applications ■ Best Practices for Integration Design Best Practices for Generating Web Services Proxy Classes in Java Environments This topic provides information on commonly encountered issues while generating Web services proxy classes in the Java integrated development environments (IDE) JDeveloper and Axis. Solutions and workarounds are provided to successfully generate the Web Services v2.0 API proxy classes in these Java IDEs. JDeveloper Workaround For WSDLS that have a large number of fields, proxy generation succeeds for all WSDL files, but compilation may fail due to the doSerialize() or doDeserialize() method being more than 64KB in size. To work around the failure 1 Refer to “Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit” on page 49 2 Increase the Java heap size in the jdev.conf file. Axis Workaround Proxy generation can fail for large WSDL files, and throw the following exception: java.lang.OutOfMemoryError: Java heap space To work around the failure 1 Remove unused child objects from WSDL files 2 Increase the Java heap size in the wsdl2java.bat/wsdl2java.sh file. To remove child objects from Web Services v2.0 WSDL files 1 In the <Types> section in the WSDL, find the <xsd:schema> element with the target namespace "urn:/crmondemand/xml/ParentName/Query". a Traverse to the <xsd:complexType> element with the name "ParentNameQuery". b Remove the <xsd:element> element with the name "ListOfChildNameQuery". c Remove the <xsd:complexType> element with the name "ListOfChildNameQuery". d Remove the <xsd:complexType> element with the name "ChildNameQuery". 2 Find the <xsd:schema> element with the target namespace "urn:/crmondemand/xml/ ParentName/Data". a Traverse to the <xsd:complexType> element with the name "ParentNameData". b Remove the <xsd:element> element with the name "ListOfChildNameData". c Remove the <xsd:complexType> element with the name "ListOfChildNameData". 48 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 49. Best Practices for Designing Client Applications ■ Best Practices for Integration Design d Remove the <xsd:complexType> element with the name "ChildNameData". Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit The Java language enforces a size limit on member functions, which cannot exceed the size of 64KB (see http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html#9279). As part of the process of generating proxy classes from the Oracle CRM On Demand WSDL files, the serializer and deserializer methods that are generated can exceed 64KB in size. Therefore, a process like the following can result in a compilation error: 1 Generate proxy classes using Oracle JDeveloper 11g or any other Java integrated development environment (IDE). 2 Compile the proxy classes. An out of memory error message is thrown due to the 64KB limit on member functions. For example, the error message for JDeveloper 11g is: code segment of method doDeserialize(oracle.j2ee.ws.common.streaming.XMLReader, oracle.j2ee.ws.common.encoding.SOAPDeserializationContext) too large This occurs for any Java compiler depending on the number of fields that are generated in the doSerialize or doDeserialize methods, as the 64KB limit is a Java VM limitation. There are two possible workarounds: ■ Split the doSerialize method. You can split the doDeserialize () and doSerialize () methods into multiple smaller methods to bypass the 64KB limit. The sample code snippets in Figure 2 and Figure 3 illustrate the splitting of the doSerialize method. TIP: This is the recommended approach, as it is more consistent and is a more generic solution that can be implemented across all client integrations. ■ Delete unused fields generated in the serialize methods. You can trim the doSerialize method by deleting unused fields, which is specific to each client integration. Figure 2. A doSerialize() Method Before Splitting: public void doSerialize(java.lang.Object obj, XMLWriter writer, SOAPSerializationContext context) throws Exception { // @GeneratedBlockBegin (value={"oracle.j2ee.ws"} ); activity.proxy.types.crmondemand.xml.activity.data.ActivityData instance = (activity.proxy.types.crmondemand.xml.activity.data.ActivityData)obj; if (instance.getModifiedDate() != null) { Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 49 Release 18)
- 50. Best Practices for Designing Client Applications ■ Best Practices for Integration Design myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.setNullable( false ); myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.serialize(instance.getModifiedDate(), ns2_ModifiedDate_QNAME, null, writer, context); } if (instance.getCreatedDate() != null) { myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.setNullable( false ); myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.serialize(instance.getCreatedDate(), ns2_CreatedDate_QNAME, null, writer, context); } if (instance.getModifiedById() != null) { myns3_string__java_lang_String_String_Serializer.setNullable( false ); myns3_string__java_lang_String_String_Serializer.serialize(instance.getModifiedById(), ns2_ModifiedById_QNAME, null, writer, context); } if (instance.getCreatedById() != null) { myns3_string__java_lang_String_String_Serializer.setNullable( false ); myns3_string__java_lang_String_String_Serializer.serialize(instance.getCreatedById(), ns2_CreatedById_QNAME, null, writer, context); } if (instance.getModId() != null) { myns3__int__java_lang_Integer_Int_Serializer.setNullable( false ); myns3__int__java_lang_Integer_Int_Serializer.serialize(instance.getModId(), ns2_ModId_QNAME, null, writer, context); } ... } Figure 3. A doSerialize() Method After Splitting public void doSerialize(java.lang.Object obj, XMLWriter writer, SOAPSerializationContext context) throws Exception { // @GeneratedBlockBegin (value={"oracle.j2ee.ws"} ); activity.proxy.types.crmondemand.xml.activity.data.ActivityData instance = (activity.proxy.types.crmondemand.xml.activity.data.ActivityData)obj; instance = doSerialize1(instance, writer, context); instance = doSerialize2(instance, writer, context); ... 50 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 51. Best Practices for Designing Client Applications ■ Best Practices for Integration Design } public activity.proxy.types.crmondemand.xml.activity.data.ActivityData doSerialize1(activity.proxy.types.crmondemand.xml.activity.data.ActivityData instance, XMLWriter writer, SOAPSerializationContext context) throws Exception { if (instance.getModifiedDate() != null) { myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.setNullable( false ); myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.serialize(instance.getModifiedDate(), ns2_ModifiedDate_QNAME, null, writer, context); } if (instance.getCreatedDate() != null) { myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.setNullable( false ); myns3_dateTime__java_util_Calendar_DateTimeCalendar_Serializer.serialize(instance.getCreatedDate(), ns2_CreatedDate_QNAME, null, writer, context); } ... return instance; } public activity.proxy.types.crmondemand.xml.activity.data.ActivityData doSerialize2(activity.proxy.types.crmondemand.xml.activity.data.ActivityData instance, XMLWriter writer, SOAPSerializationContext context) throws Exception { if (instance.getModifiedById() != null) { myns3_string__java_lang_String_String_Serializer.setNullable( false ); myns3_string__java_lang_String_String_Serializer.serialize(instance.getModifiedById(), ns2_ModifiedById_QNAME, null, writer, context); } if (instance.getCreatedById() != null) { myns3_string__java_lang_String_String_Serializer.setNullable( false ); myns3_string__java_lang_String_String_Serializer.serialize(instance.getCreatedById(), ns2_CreatedById_QNAME, null, writer, context); } if (instance.getModId() != null) { myns3__int__java_lang_Integer_Int_Serializer.setNullable( false ); Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 51 Release 18)
- 52. Best Practices for Designing Client Applications ■ Best Practices for Integration Design myns3__int__java_lang_Integer_Int_Serializer.serialize(instance.getModId(), ns2_ModId_QNAME, null, writer, context); } ... return instance; } Entering Telephone Number Values through Web Services Telephone number values entered through Web service requests and the Oracle CRM On Demand UI are displayed differently both in the UI and in the response to the QueryPage operation. Table 7 shows how telephone number values are displayed in the UI or within the response to a QueryPage request. Table 7. Formatting of telephone number values entered through Web services or the UI Formatting in Web Input Mechanism Formatting in UI Service Response Input through Web service 14042621601123 1 (140) 426-2160 #1123 +1 404 2621601 #123 14042621601 1 (140) 426-2160 #1 +1 140 4262160 #1 +14042621601,123 1 (4042621601) 123 +1 4042621601 123 Input through UI 14042621601123 14042621601123 +1 4042621601123 14042621601 1 (404) 262-1601 +1 404 2621601 +14042621601,123 1 (404) 262-1601 #123 +1 404 2621601 #123 Telephone number values differ from other values in that the format of the value impacts the accuracy of the value. When querying for a telephone number value, it is necessary to return the value with formatting. Best Practices When determining the value to be input through Web Services you must take into account how the telephone number should appear in the UI and in the Web service response. The following formats are recommended for telephone numbers entered through the UI or Web services, as they are formatted the same way in the UI and in Web service responses: 1 (404) 262-1601 123 52 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 53. Best Practices for Designing Client Applications ■ Best Practices for Integration Design 1 (404) 262-1601 #123 1 (140) 426-2160 #1 1 (140) 426-2160 The following is an example of a request that uses one of the above formats to insert a Contact with telephone number fields. <ListOfContact> <Contact> <ContactFirstName>Contact</ContactFirstName> <ContactLastName>Name</ContactLastName> <WorkPhone>1 (404) 262-1601 #123</WorkPhone> <PHONE_000>1 (404) 262-1601 #123</PHONE_000> </Contact> </ListOfContact> The following is the query response: <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data" lastpage="true"> <Contact> <ContactFirstName>qq2</ContactFirstName> <ContactLastName>ww2</ContactLastName> <WorkPhone>1 (404) 262-1601 #123</WorkPhone> <PHONE_000>1 (404) 262-1601 #123</PHONE_000> </Contact> </ListOfContact> Other Considerations for Telephone Numbers If you use the + character and parentheses () characters together in a Web services request, the number is displayed differently in the UI and Web service response. For example, the input: +1 (404) 262-1601 #123 is displayed as the following in the Web service response: +1 404 2621601 #123 and as the following in the UI: 1 (404) 262-1601 #123 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 53 Release 18)
- 54. Best Practices for Designing Client Applications ■ Best Practices for Integration Performance It is not possible to modify the telephone number in the UI to display a + prefix for a telephone number, or to remove the parentheses () from a telephone number using Web services. For example, the input: +1 404 262-1601 #123 is displayed as the following in the Web service response: 1 404 2621601 #123 and as the following in the UI: 1 (404) 262-1601 #123 Telephone numbers submitted through Web services requests must begin with a numeric value. For example, updating a telephone number field with the value: DO NOT CALL would result in an error being returned to the client, however, specifying the value: 1DONOTCALL would succeed. Best Practices for Integration Performance This topic describes best practices for optimizing the performance of client applications. Batch Processing With Web Services On Demand, you can perform batch operations that optimize performance by combining multiple requests into one. Oracle CRM On Demand batch processing has a limit of 20 top-level records for each request and is supported for the following operations: ■ Insert ■ Delete ■ Update ■ InsertOrUpdate (Web Services v1.0 only) ■ QueryPage Because batch calls take longer to process than single operations they should only be used in instances where longer response time would not impact the user experience. However, for such interactive applications, if the application needs to process multiple records of the same type, batch operations increase the performance. 54 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 55. Best Practices for Designing Client Applications ■ Best Practices for Integration Performance If a single record in a batch causes an error, the entire batch is not processed. For example, a batch of 20 Account inserts where one record contains an error will require all records to be re-inserted. A batch error could result from a data error or other error (for example, network outage, session expiry, and so on). If the error is not data-related, it is recommended that the user logs in again and tries the Web service call again. If the error is data-related, the batch can be split into smaller batches so that the records that do not cause errors can be processed. Session Management and Pooling It is recommended that you use stateless Web services as opposed to stateful Web services whenever possible, as described in “Using Stateless Web Services” on page 45. This topic however discusses the best practices for the situations when you use stateful Web services. For stateful Web services requests, Web Services On Demand uses a session-based security mechanism for which each operation is synchronous. It is recommended that a user: ■ Always closes sessions if the application process is not likely to be used multiple times within the session idle time-out period (10 minutes by default). ■ Always keeps sessions open and reuses them when the application process is likely to be used multiple times within the session idle time-out period. It is important to reuse sessions that are not in use, as frequent logins add overhead to your process and slow it down. Client applications must not reuse sessions that are in use, in other words, they must not submit several simultaneous requests using the same session. Client applications should not send multiple requests simultaneously using the same session ID, rather, the client should wait for a response before sending a new request using the same session ID. The client time-out on a single Web service call should be set to at least 10 minutes, so that the client does not time out when a request is still pending. For information about Web services sessions, see “About Establishing and Managing the Web Services Session” on page 35. Session Pooling Session pooling is another option for increasing the performance of your application further. Session pooling involves maintaining a list of active sessions on the client application. The client application must ensure that each session is active and valid (it must have a valid session ID) before using it in a request. The application might determine whether the session is active based on the success of the login operation and the time that has passed since the session was used. If all active sessions are in use for pending Web service requests, add a new session to the pool. You can use session pooling to improve performance in both a single-threaded or multi-threaded application. In a single-threaded application, session pooling can avoid the unnecessary overhead of re-logging into the application for each request. In a multi-threaded application session, you can use session pooling to run multiple requests at the same time. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 55 Release 18)
- 56. Best Practices for Designing Client Applications ■ Best Practices for Integration Performance API Calls Whenever possible, it is recommended that queries be as specific as possible to reduce the number of records in the result set. You should restrict the fields returned by queries to only the fields that are required by your process. Queries that involve related child objects (that is child objects that are top-level objects), or complex queries that involve criteria from both parent and related child objects, may perform better if they are separated into multiple requests. The following are also recommended: ■ For Web Services v1.0 calls, use the child methods DeleteChild, InsertChild, and UpdateChild for child delete, insert, and update operations. ■ Whenever possible, store your company's unique identifiers in the external system ID field on objects. Performance of the Update and Insert Methods Versus the InsertOrUpdate Method If you use Web Services v1.0, designing your application to use the Insert and Update methods may result in an increase in throughput compared to using the InsertOrUpdate method. This is due to the additional business logic and SQL statements executed during the InsertOrUpdate operation to determine whether the submitted records match any existing records in the Oracle CRM On Demand database. The performance and throughput improvement may not be apparent at lower volumes, but high volume applications could benefit from the direct update and insert operation, which does not require the additional business logic to determine whether the records already exist. Working with Attachments For a number of record types, you can include attachments with Web services requests. If you add attachments, remember that: ■ Requests with large attachments perform more slowly than those with smaller attachments or no attachments. The maximum attachment size supported is 9MB. ■ Requests with many attachments perform more slowly than those with a single attachment or no attachments. If you are adding the same attachment to multiple records, you can take advantage of a reuse facility for attachments, see “Attaching a File to Multiple Records” on page 501. In this way, you do not include the content for each record in the request, you use the ContentId on one record and reference that ContentId from other records. For more information about using attachments in Web Services On Demand, see Appendix A, “Using Attachments With Web Services On Demand”. 56 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 57. Best Practices for Designing Client Applications ■ Best Practices for Integration Performance Querying Login History and User Usage When you use the LoginHistoryQueryPage and UserUsageQueryPage methods, the queries should be as specific as possible, that is, you should not query for all records with every request. For example, you can narrow the search results by: ■ Querying for records owned by a specific UserID ■ Querying for records covering a period of time For more information, see “LoginHistoryQueryPage” on page 106 and “UserUsageQueryPage” on page 117. Using the QueryPage Method The following are best practices for using the QueryPage method and similar methods like MetadataChangeSummaryQueryPage and SalesProcessQueryPage: ■ When formulating a query, use indexed fields, which are highlighted in green in the New List page in the Oracle CRM On Demand UI. Indexed fields are optimized for fast retrieval. ■ Specify the best operators to make queries faster. For example, use the equality (=) operator instead of the * wildcard. Other operators may provide some functional flexibility, but can severely impair performance. Therefore, you should only use other operators when absolutely required. ■ If filtering on a non-equality operator and not combining with any other filter criteria, change the sort order so that you are sorting on the same field that you are filtering. ■ Specify only fields that are required. Adding all fields or specifying fields that are not required impacts the response time or throughput. ■ If filtering on a custom field, make sure that the custom field is an indexed custom field. It may be required to migrate data from the existing field to the indexed custom field. For more information, see “Using Indexed Custom Fields” on page 58. ■ Constrain filter criteria to return the least number of records possible (that is, queries should be as specific as possible). ■ If you must return many sorted records, make sure that you sort on an indexed field. ■ If you are using manager visibility (ViewMode=”Manager” or ViewMode=”EmployeeManager”), the query should contain an equality operator on an indexed field. For more information about the QueryPage method, see “QueryPage” on page 69, or “QueryPage” on page 85. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 57 Release 18)
- 58. Best Practices for Designing Client Applications ■ Best Practices for Integration Management Using Indexed Custom Fields To optimize performance, you can use custom fields that have been indexed for specific record types. Indexed fields are special fields that improve the response time during the search process or sorting on a particular list. Indexed custom fields are preconfigured in the application database. You can change the labels on the indexed custom fields, but you cannot change the integration tags. NOTE: As an option, you can choose to migrate your data from nonindexed to indexed custom fields to increase the performance of the Web services queries that your users execute. To migrate the existing data to the available record types, use Oracle CRM On Demand's export and import functionality or Web services. For more information about exporting and importing data, see the online help for Oracle CRM On Demand. Indexed custom fields are prefixed with Indexed as a default. Best Practices for Integration Management This topic describes best practices for system management when using client applications that make Web services calls. Moving Customers Between Pods To reduce the impact on customers when they move between pods (Oracle CRM On Demand instances), it is important that the server URL values for pods are parameterized, so that they can be changed easily. Web services clients should be implemented in such a way that moving a customer to a new pod does not require any code changes within the Web services client. A best practice is to use an .ini file to store the server URL, so that changing the server value in the .ini file results in the Web services request being routed to the new Oracle CRM On Demand instance. Web links, Web tabs, and custom Web applets that refer to Oracle CRM On Demand should be parameterized so that they can easily be redirected. A best practice is to pass the server URL or POD value (that is, the 3 letter pod identifier) so that it can be parsed from the URL, and the page being called can continue to interact with Oracle CRM On Demand through Web services. Handling Outages Outages can be due to: ■ Scheduled Maintenance Downtime. From time to time, Oracle CRM On Demand will have scheduled downtime when the application is shut down to perform regular maintenance and upgrades. It is important for your client applications to be able to identify and respond correctly to this scenario. 58 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 59. Best Practices for Designing Client Applications ■ Best Practices for Integration Management ■ Application Failures. If there is a failure within Oracle CRM On Demand, it is important for the client application to respond appropriately. Performing proper error handling and logging is extremely important because it will not only help you resolve issues on your own but, if necessary, help you engage with Oracle CRM On Demand Customer Support and provide them with critical information. For more information, see “Handling Outages and Failures” on page 47. Maintaining SSL Certificates Oracle CRM On Demand is accessible only through HTTPS and Oracle servers using Secure Sockets Layer (SSL) certificates issued by common certificate authorities (CA) such as Verisign. Approximately yearly these SSL certificates are renewed, so it is important that any clients (including browsers and integration clients) are configured to trust the root CA certificates and not the specific server certificates. Occasionally the certificate authority may issue new root certificates or start issuing server SSL certificates to Oracle that use a different root or intermediate certificate. It is the responsibility of customers to ensure that their clients (browser or integration platform) are kept up to date with the latest root certificates from Verisign or others. See, for example, the Verisign Web site for details of how to update your client. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 59 Release 18)
- 60. Best Practices for Designing Client Applications ■ Best Practices for Integration Management 60 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 61. 6 Web Services On Demand API Calls This chapter describes the methods that the Oracle CRM On Demand Web services can call: ■ The methods of the Web Services v1.0 API that are called on Oracle CRM On Demand objects to insert, update, delete, and find data within a specified Oracle CRM On Demand instance. ■ The methods of the Web Services v2.0 API that are called on Oracle CRM On Demand objects to insert, update, delete, and find data within a specified Oracle CRM On Demand instance. ■ The service API methods that are used to perform queries and other operations on non-data records through Web services. ■ The methods of the Administrative Services API that are used to automate the administration of a company's configurations. ■ The methods of the Data Loader API that are used to perform bulk data import operations. For each of these methods, usage, arguments taken, and return values are detailed. TIP: Sample XML code for the various APIs may be available in the Oracle Sample Code public repository on the Oracle Technology Network. You must have an account to access the samples. See, for example: https://codesamples.samplecode.oracle.com/servlets/tracking/action/ ExecuteQuery?query=crm_on_demand. This chapter contains the following topics: ■ “Web Services v1.0 API Calls” ■ “Web Services v2.0 API Calls” on page 79 ■ “Service API Calls” on page 94 ■ “Administrative Services API Calls” on page 119 ■ “Data Loader API Calls” on page 149 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 61 Release 18)
- 62. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Web Services v1.0 API Calls The Web Services v1.0 methods are listed in Table 8. These methods can be called on most Oracle CRM On Demand objects (record types), for example, Account, Contact, Opportunity, and so on, including Custom Objects 01 through 03, but not Custom Objects from 04 onwards. NOTE: The actual method names consist of the object name prefix and Delete, Insert, and so on, for example, AccountDelete and AccountInsert are methods of the Account service. Table 8. Web Services v1.0 Methods Method Comments Delete Finds records in the Oracle CRM On Demand database that match specified field values, and then deletes them (in other words, puts them into the Deleted Items area). DeleteChild Deletes child records from the Oracle CRM On Demand database, or removes the association between the child and the parent object. Insert Inserts new records into the Oracle CRM On Demand database. InsertChild Inserts new child records into the Oracle CRM On Demand database. InsertOrUpdate Updates existing records or inserts a new record if one did not exist. QueryPage Executes a query against a specified list of records, and returns a subset of the records that match the search criteria set by the method arguments. Update Updates records with a new value. UpdateChild Updates child records with a new value. For each object, the methods are defined in the WSDL file for that object. Many of the methods described in this chapter can be called on all of the objects. Depending on whether an object is a parent or child object, Web services methods can act in different ways on the object in question. These differences are described in the following topics. User Keys The objects (both child and parent level) provided in the input arguments for the Web Services v1.0 methods must provide data in at least one of the user keys for the given object. You use the user key information to uniquely identify records. If no user key values are provided, or if there is a conflict with the user keys of an existing record, the method fails, and a SOAP error is thrown by the API. 62 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 63. Web Services On Demand API Calls ■ Web Services v1.0 API Calls The Echo Argument Oracle CRM On Demand Web services using the methods Insert, Update, InsertAndUpdate, Delete, InsertChild, UpdateChild, and DeleteChild can specify an Echo input argument. The Echo string is used only for Integration events and is not required. Echo is case-sensitive and controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions. The default value is On. When the Echo value is On or missing, the transaction is recorded. When the Echo value is Off, the transaction is not recorded. NOTE: For Java users, the Echo string is required for all input methods. The echo string can be set to Off. Delete Removes records of a specified record type from the Oracle CRM On Demand database. Usage You use the Delete method to remove one or more records of a particular object from an Oracle CRM On Demand instance. The deleted records appear in the Deleted Items folder and can be restored through the Oracle CRM On Demand UI. NOTE: To conform with Oracle CRM On Demand’s business logic, be careful about the order in which objects are deleted. You cannot delete some objects unless some action is performed on its child objects. For example, you cannot delete an account unless you re-associate all its service requests with a different account. For information about the behavior of the Delete method on child objects, see Table 9. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 63 Release 18)
- 64. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 9 illustrates the behavior of the Delete method on child objects that are related to the parent object being deleted. For more information about deleting records, see the online help for Oracle CRM On Demand. NOTE: If you update an object, and the child is not in the input, that child is deleted from Oracle CRM On Demand. For more information, see Table 20. Table 9. Behavior of Delete Method on Child Objects Action When Parent Is Parent Object Child Deleted Account Activity Delete Asset Delete Competitor None Contact None Lead Delete Note Delete Opportunity Delete Partner None ServiceRequest None Team Delete Activity Attachment Delete Campaign Activity Delete Contact None Lead Delete Note Delete Opportunity None Contact Account None Activity Delete Asset None Campaign None Interests Delete Lead Delete Note Delete Opportunity None ServiceRequest None 64 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 65. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 9. Behavior of Delete Method on Child Objects Action When Parent Is Parent Object Child Deleted Household HouseholdTeam None Lead Activity Delete MedEd Invitees Delete Opportunity Activity Delete Competitor None Contact None Lead Delete Note Delete OpportunityTeam None Partner None ServiceRequest Activity Delete AuditTrail None Note None Solution Not Specified Solution ServiceRequest None Arguments Table 10 describes the arguments taken by the Delete method. Table 10. Arguments Taken by the Delete Method Name Description Required Default I/O ListOf(Object). For The list of object instances to Yes Not Input/ example, ListOfAccount be deleted. applicable Output Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the deleted objects. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 65 Release 18)
- 66. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Related Topic Update. DeleteChild Removes child records from the Oracle CRM On Demand database. Usage You use the DeleteChild method to remove one or more child records of a particular object from an Oracle CRM On Demand instance, or remove the association between the child and parent object. Table 9 on page 64 is also applicable for the DeleteChild method. The deletion of child records or removal of association follows the same pattern as for deletion in the UI of the Oracle CRM On Demand application. For example, if you use AccountDeleteChild on a Contact child record, the association is removed, but the Contact is not deleted. On the other hand, if you use AccountDeleteChild on a Team child record, that record is deleted. However, the integration events generated in the UI and from Web services requests differ for child objects of Account, Contact, and Opportunity. For more information about these differences in integration events and about deleting records, see the information about workflow rules in the online help for Oracle CRM On Demand. CAUTION: The parent object may be deleted by the DeleteChild method in some cases when a child object is not specified when executing the different DeleteChild methods. Nodes with at least one child are called internal nodes and nodes without children are called leaf nodes. DeleteChild operates on leaf nodes, so that if the request specifies a parent that has no children, the parent is deleted.You can avoid this situation by calling the Update method on the parent with an empty container for the children. Arguments Table 11 describes the arguments taken by the DeleteChild method. Table 11. Arguments Taken by the DeleteChild Method Name Description Required Default I/O ListOf(Object). For The list of child object instances Yes Not Input/ example, ListOfAccount to be deleted. Each child object applicable Output has an associated parent object. Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. 66 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 67. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Return Value of the Call The status key for each of the deleted child records. Insert Inserts new records in the Oracle CRM On Demand database. Usage You use the Insert method to create one or more records of a particular object in an Oracle CRM On Demand instance. When inserting a batch of records, the batch is treated as a single transaction. If one record fails to insert during a batch insertion, the entire operation is rolled back and no records are inserted. Table 12 outlines how the Insert method acts on parent and child objects to create or update an object instance. Table 12. Effect of Insert on Parent and Child Objects Existing Existing Child Method New Parent New Child Parent Record Insert New parent New child Error Associate to new instance instance parent instance Arguments Table 13 describes the arguments taken by the Insert method. Table 13. Arguments Taken by the Insert Method Name Description Required Default I/O ListOf(Object). For The list of object instances to be Yes Not Input/ example, ListOfAccount inserted. applicable Output Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the Oracle CRM On Demand objects. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 67 Release 18)
- 68. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Related Topic Update. InsertChild Inserts new child records in the Oracle CRM On Demand database. Usage You use the InsertChild method to create one or more child records of a particular object in an Oracle CRM On Demand instance. Arguments Table 14 describes the arguments taken by the InsertChild method. Table 14. Arguments Taken by the InsertChild Method Name Description Required Default I/O ListOf(Object). For The list of child object instances Yes Not Input/ example, ListOfAccount to be inserted. Each child object applicable Output has an associated parent object Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the inserted child records. InsertOrUpdate Updates existing records or inserts a new record if one did not exist for an instance of the object. Usage You use the InsertOrUpdate method to update one or more records of a particular object in an Oracle CRM On Demand instance. Use the user key specified for the parent level objects in the input argument to determine whether to insert each of the parent records, or to update an existing parent record. 68 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 69. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 15 outlines how the InsertOrUpdate method acts on parent and child objects to create or update an object instance. Table 15. Effect of InsetOrUpdate on Parent and Child Objects Existing Existing Child Method New Parent New Child Parent Record InsertOrUpdate New parent New child Update Update child parent Arguments Table 16 describes the arguments taken by the InsertOrUpdate method. Table 16. Arguments Taken by the InsertOrUpdate Method Name Description Required Default I/O ListOf(Object). For The object instances to be Yes Not available Input/ example, ListOfAccount inserted or updated. Output Echo Controls whether data sent No On Input to Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the inserted or updated objects. Related Topic Update, Insert QueryPage Executes a query against the set of records for an object, and returns the subset of the records that match the search criteria set by the method arguments. Query by Template To improve performance, the QueryPage result contains only those fields and objects that are included in the QueryPage request. To retrieve the values of fields that are not a part of the search criteria, the field must be included in the search request with a blank value. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 69 Release 18)
- 70. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Query by Children For all Oracle CRM On Demand object methods, it is possible to query using one operation within a parent-child relationship. This type of query is called Query By Children. The query can be assembled using parent attributes as well as child attributes. You can query for all children of a particular parent or set of parents, all parents of a particular child or set of children, or for both parents and children of a particular set. As an example of how you can search for parent records using criteria on a child: <UseChildAnd>true</UseChildAnd> <ListOfContact> <Contact> <ContactFirstName>=’John’</ContactFirstName> <ContactLastName/> <ListOfAddress> <Address> <Country>=’Canada’</Country> <Address> </ListOfAddress> </Contact> </ListOfContact> This query would return all contacts where the first name is John and at least one of John’s addresses is for Canada. The child criteria are appended to the parent using an AND or OR operator based on the value of the argument UseChildAnd. When UseChildAnd is true, the child criteria are “ANDed”, otherwise they are “ORed”. Using the PageSize and StartRowNum Arguments The PageSize argument, which has a maximum value of 100, is used to specify the maximum number of records to be returned in a QueryPage response. The pagesize and startrownum arguments are specified in requests as follows: <StartRowNum>0</StartRowNum> <PageSize>20</PageSize> <ListOfAccount> Depending on the value of PageSize, records are returned as follows: ■ If the number of records in the record set is less than the PageSize value, the full record set is returned, and the LastPage argument is set to true. 70 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 71. Web Services On Demand API Calls ■ Web Services v1.0 API Calls ■ If the number of records in the record set exceeds the PageSize value, only the number of records specified by the PageSize parameter is returned, and the LastPage value is false. ■ For a query whose record set exceeds the PageSize value, setting the StartRowNum argument to PageSize+1 (setting StartRowNum to PageSize returns the next PageSize number of records) returns the next PageSize number of records. ■ If the size of the record set is greater than PageSize, and this is a subsequent query where there are less than PageSize number of records remaining to be returned, all of the remaining records are returned and the LastPage attribute has a value of true. Even though the QueryPage method returns a limited number of records, the results are cached, and can then be retrieved by calling the QueryPage method with a value of PageSize+1 for the StartRowNum argument. To retrieve all records in the result set, StartRowNum must be incremented by PageSize for each subsequent QueryPage request until a QueryPage response is returned with LastPage equal to true. About Oracle CRM On Demand Query Syntax The query syntax supports only a small subset of binary and unary operators. No Siebel Query Language constructs or functions are supported. The query syntax is summarized in Table 17. Table 17. Query Syntax for QueryPage Syntax Type Notes expression {Operator} {Value} Operator can be binary or unary. The {Value} need only be specified for binary operators. Every expression must start with an operator to avoid ambiguity. There is no default operator. (expression) conjunction (expression) A conjugated expression must be enclosed in parentheses to avoid ambiguity. However, nonconjugated expressions must not be enclosed in parentheses. conjunction OR None AND None unary operator None IS NULL Used to find a match for a value that has no value binary operator = None ~= Denotes a case-insensitive exact search (no wildcards used) Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 71 Release 18)
- 72. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 17. Query Syntax for QueryPage Syntax Type Notes < Must be specified as &lt; to ensure well- formed XML. <= Must be specified as &lt;= > None >= None <> Must be specified as &lt;> LIKE Wildcard characters are treated as such only in the context of the operator LIKE. ~LIKE Denotes a case-insensitive wildcard search value 'literal' Literal data is always enclosed in single quotes. To use a single quote within a literal, place another single quote immediately beside that quote. In this way, the query recognizes the quote as a literal and not as an operator. For example, the string ab'c is specified as ab''c. To use the special characters such as asterisk (*), question mark (?), and backslash () in queries, preceded them with the character. For example, to use the ? wildcard operator in a query, precede it with the character as follows: ? Querying Oracle CRM On Demand Data Using Web Services The QueryPage functions require a list of object instances as input to perform a query. This input argument is called ListOf(Object). For example, the ContactQueryPage method requires the ListOfContact argument. Each ListOf(Object) argument requires at least one instance of the Object to specify a valid query. To query an object by a certain field, specify the expression that corresponds to the desired result. The examples in this topic cover the corner cases of quote and wildcard escaping. Assume that a table in the Oracle CRM On Demand database contains the following values for a particular column that is being queried: ?abc abcd 'abc' = 'abc' abc?d abc*d 72 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 73. Web Services On Demand API Calls ■ Web Services v1.0 API Calls aBc*D abcd abc*d abcd abc*d abc*d abcd abc*'d abc?"d abc*"d abc*'"d (NULL value) Table 18 specifies the returned record sets for various values of each field value that maps to the preceding list. Table 18. Returned Record Sets Field Value Returned Record Set Comments abc Not applicable An unquoted value without an explicit operator is invalid input. 'abc' Not applicable A quoted value without an explicit operator is invalid input. = '''abc ''''abc' None = "'abc'" Not applicable Double quotes are not allowed by the Oracle CRM On Demand Validator. Consequently, this example returns an error message. = 'abc 'abc None = '= ''abc '''= 'abc' None = '= 'abc'' Not applicable The caller is responsible for correctly formatting quotes in Query* methods. This example does not have correctly formatted quotes, so it results in an error. = 'abc?d 'abc?d None = 'abc?d 'abc?d None LIKE 'abc?d 'abc?d None LIKE 'abc?d 'abc?d None abc*d abcd ~LIKE 'abc?d 'abc?d None aBc*D abc*d abcd Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 73 Release 18)
- 74. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 18. Returned Record Sets Field Value Returned Record Set Comments = 'abc*d' abc*d Any wildcard character that has not been formatted with quotes is treated as if it were formatted with quotes. = 'abc*d 'abc*d None = 'abc*d 'abc*d None LIKE 'abc*d 'abcd None abc*d abc*d abcd abc*'d abc?"d abc*"d abc*'"d = 'abc*"d 'abc*"d None = 'abc?"d 'abc?"d None = 'abc?"d 'abc*"d None LIKE 'abc?"d 'abc?"d None abc*"d LIKE 'abc?"d 'abc?"d None LIKE 'abc*"d 'abc?"d None abc*"d abc*'"d LIKE 'abc*"d 'abc*"d None = 'abc*''d 'abc*'d None ~ LIKE 'abc*d 'aBc*D None abc*d abcd abc*d LIKE 'abc*d 'abc*d None abcd abc*d (empty field) Not applicable An empty field value does not influence the search specification in Query by Template. IS NULL (empty field) None (( > 'abc*' ) AND ( < 'abcd' )) OR (~= 'abc*d') abc*d None aBc*D abc*d 74 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 75. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Table 18. Returned Record Sets Field Value Returned Record Set Comments NOT LIKE 'abc?d' Not applicable The Oracle CRM On Demand Query Validator does not support the NOT operator, so this query returns an error. > 'abc' BUT < 'abcd' Not applicable BUT is not a valid conjunction. Consequently, this query returns an error. Querying Multiple Fields To specify a query on multiple fields, expressions must be provided for each field comprising the search specification. When multiple fields in an object instance have expressions, the QueryPage method result is the intersection of all the expressions, or in other words, all of the expressions are combined using the AND operator. This is outlined in “Example 1: Combining Expressions Using the AND Operator.” Example 1: Combining Expressions Using the AND Operator The Web service client requires the first name, last name, and job title of all the contacts in Oracle CRM On Demand that have a job title equal to CEO and a last name equal to Doe. The XML representation of the ListOfContact object that must be sent in the ContactQueryPage call is as follows: <ListOfContact> <Contact> <JobTitle>=‘CEO’</JobTitle> <ContactLastName>='Doe'</ContactLastName> <ContactFirstName /> </Contact> </ListOfContact> Multiple Expressions on a Single Field If you want to apply multiple expressions to a single field, you can combine each expression using either the AND or the OR operator. The result is either the intersection or the union of the object instances respectively. NOTE: For multiple expressions on a single field, each expression must be enclosed in brackets. Example 2: Combining Multiple Expressions Using the AND Operator The Web service client requires the first name, last name, and job title of all the contacts that have been updated between July 28, 2009 6:30am and July 28, 2009 6:45 am. Send the following XML representation of the ListOfContact object in the ContactQueryPage call: Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 75 Release 18)
- 76. Web Services On Demand API Calls ■ Web Services v1.0 API Calls <ListOfContact> <Contact> <JobTitle /> <ContactLastName /> <ContactFirstName /> <LastUpdated> (>='07/28/2009 06:30:00') AND (<='07/28/2009 06:45:00')</ LastUpdated > </Contact> </ListOfContact> Example 3: Combining Multiple Expressions Using the OR Operator The Web service client requires the first name, last name, and job title of all the contacts in Oracle CRM On Demand that have a last name equal to Doe or Brown. Send the following XML representation of the ListOfContact object in the ContactQueryPage call: <ListOfContact> <Contact> <JobTitle /> <ContactLastName>(='Doe') OR (=’Brown’)</ContactLastName> <ContactFirstName /> </Contact> </ListOfContact> Specifying Books in Queries For queries on record types that support books, you can use the BookId or BookName arguments to constrain the query to only the records in a particular book. For more information about the use of books, see the online help for Oracle CRM On Demand. 76 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 77. Web Services On Demand API Calls ■ Web Services v1.0 API Calls Arguments Table 19 describes the arguments taken by the QueryPage method. Table 19. Arguments Taken by the QueryPage Method Name Description Required Default I/O ListOf(Object). For The list of object instances queried (input), Yes Not Input/ example, and after query execution, the list of object applicable Output ListOfAccount instances returned (output). PageSize The maximum number of records displayed No 10 Input on a page following a query. StartRowNum Indicates the row from which the QueryPage No 0 Input method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. UseChildAnd If this argument is set to true, the query No False Input result set returns the set of records that satisfy both parent and child search criteria. (That is, the query set returned is the AND combination of parent and child queries.) If this argument is set to false (or not set at all), the query result set returns the set of records that satisfy either the parent or the child search criteria. (That is, the query set returned is the OR combination of parent and child queries.) BookId The book Id. No Not Input applicable BookName The book name. This argument is ignored if No Not Input a value for BookId is supplied. applicable IncludeSubBooks Whether subbooks should be included. No Input Return Value of the Call An object or list of objects of the type on which the method was called. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 77 Release 18)
- 78. Web Services On Demand API Calls ■ Web Services v1.0 API Calls ■ LastPage. A Boolean value that indicates whether or not the last value in the query set has been returned. Update Updates records with a new value. Usage You use the Update method to update one or more records of a particular object in an Oracle CRM On Demand instance. NOTE: If the company administrator customizes a record type to add a required field, Oracle CRM On Demand does not check for the required field when existing records are updated. When you update the record without the required field through a Web services request, or merge it with a record that does not have the required field, the record is updated or merged without error. This is the intended behavior; when a field is made required, it is the responsibility of the administrator to update all existing records to populate the required field. On inserting new records however, Oracle CRM On Demand checks for the required field. Table 20 outlines how the Update method acts on parent and child objects to update an object instance. Table 20. Effect of Update on Parent and Child Objects Existing Child Existing Existing Child Record But Not Method New Parent New Child Parent Record in Input Update Error New child Update Update child Child is removed parent Arguments Table 21 describes the arguments taken by the Update method. Table 21. Arguments Taken by the Update Method Name Description Required Default I/O ListOf(Object). For The object instance to be updated. Yes Not Input/ example, ListOfAccount applicable Output Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. 78 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 79. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Return Value of the Call The status key for each of the updated records. UpdateChild Updates a child record with a given value in the Oracle CRM On Demand database. Usage You use the UpdateChild method to update one or more child records of a particular object in an Oracle CRM On Demand instance. Arguments Table 22 describes the arguments taken by the UpdateChild method. Table 22. Arguments Taken by the UpdateChild Method Name Description Required Default I/O ListOf(Object). For The list of child object instances to Yes Not Input/ example, ListOfAccount be updated. Each child object has applicable Output an associated parent object. Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the updated child records. Web Services v2.0 API Calls The Web Services v2.0 API methods are listed in Table 23. These methods can be called on all Oracle CRM On Demand objects (record types), for example, Account, Contact, Opportunity, and so on, including all Custom Objects. The objects provided in the input arguments for the methods must provide data in at least one of the user keys for the given object. You use the user key information to uniquely identify records. If no user key values are provided, or if there is a conflict with the user keys of an existing record, the method fails, and a SOAP error is thrown by the API. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 79 Release 18)
- 80. Web Services On Demand API Calls ■ Web Services v2.0 API Calls If a request supplies an ID value in a reference field, an association is created between two records through, for example, the insert operation. Joined in fields from a referenced object are read-only. NOTE: The actual method names consist of the object name prefix and Delete, Insert, and so on, for example, AccountDelete and AccountInsert are methods of the Account service. Table 23. Web Services v2.0 API Methods Method Comments Delete Finds records in the Oracle CRM On Demand database that match specified field values, and then deletes them (in other words, puts them into the Deleted Items area). Execute Executes multiple update, insert, and delete operations on separate records in the Oracle CRM On Demand database. Insert Inserts new records into the Oracle CRM On Demand database. QueryPage Executes a query against a specified list of records, and returns a subset of the records that match the search criteria set by the method arguments. Update Updates records with a new value. For each object, the methods are defined in the WSDL file for that object. Many of the methods described in this chapter can be called on all of the objects. The Echo Argument Oracle CRM On Demand Web services using the methods Insert, Update, InsertOrUpdate, Delete, InsertChild, UpdateChild, and DeleteChild can specify an Echo input argument; for example: <Echo>Off</Echo> The Echo value is case-sensitive and is used to indicate whether a Web services transaction should trigger the creation of an integration event (assuming that a workflow and integration event action have been configured to capture that particular transaction type). The default value of Echo is On, therefore when this parameter is provided in the request with a value of On, or is not included in the request, the integration event action is triggered and the transaction is recorded. When the Echo parameter is included with a value of Off, the transaction is not recorded. NOTE: For Java users, the Echo string is required for all input methods. The echo string can be set to Off. 80 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 81. Web Services On Demand API Calls ■ Web Services v2.0 API Calls The ViewMode Argument The ViewMode argument is an input argument for all of the Web Services v2.0 API methods. It applies to parent objects only, and specifies the level of access to parent records identified in the method call. ViewMode can take one of the following values: ■ Manager. Provides access to records for which the current user or a subordinate of the current user owns the records, or is part of the team that owns the records. ■ EmployeeManager. Provides access to records for which the current user or a subordinate of the current user owns the records. This value is similar to Manager, but teams are not considered. ■ Sales Rep. Provides access to records for which the current user is part of the team that owns the records. ■ Personal. Provides access to records owned by the user. ■ Organization. Provides access to records within the current user's organization. ■ Broadest. Provides access to the maximum set of records allowed for the user. This is the default value. ■ AllBooks. For objects that support book, provides access to all books. This value is similar to Broadest, and works like All+ with the Book Selector in the Oracle CRM On Demand UI. ■ Context. For objects that support books, provides access to the default book. For access to a specific book, the QueryPage method must use the BookId and BookName arguments. The order of preference from most restrictive to least restrictive is: ■ Personal ■ Sales Rep ■ Organization Performance may be improved when a restricted set of records is accessed. The LOVLanguageMode Argument The LOVLanguageMode argument is an input argument for all of the Web Services v2.0 API methods. It determines whether the processing for picklist fields should occur using language independent codes (LIC) or language dependent codes (LDC). The argument is applicable only to simple picklist fields (which have an Edit Picklist link in the Field Setup page in the Oracle CRM On Demand application). The LOVLanguageMode argument can take one of two values: LIC or LDC. LIC is the default value. For methods other than QueryPage: ■ If LIC is specified, then Web Services On Demand expects LIC values and converts them to LDV (based on the user’s current setting) and performs the processing. ■ If LDC is specified, no translation is performed and values are expected to be in the user’s language. For the QueryPage method: Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 81 Release 18)
- 82. Web Services On Demand API Calls ■ Web Services v2.0 API Calls ■ If LIC is specified in the query, the response contains picklist fields with language independent values. ■ If LDC is specified in the query, the response contains picklist values in the user’s language. Delete Removes records of a specified record type from the Oracle CRM On Demand database. Usage You use the Delete method to remove one or more records of a particular object from an Oracle CRM On Demand instance. The deleted records appear in the Deleted Items folder and can be restored through the Oracle CRM On Demand UI. The Delete call can be used to delete both parent record and child records. If the child node specified in the request is available, it deletes the child in the existing parent record, and leaves the parent record undeleted. However, if the child node is missing, it deletes the existing parent record. Arguments Table 24 describes the arguments taken by the Delete method. Table 24. Arguments Taken by the Delete Method Name Description Required Default I/O ListOf(Object). For The list of object instances to Yes Not Input/ example, ListOfAccount be deleted. applicable Output LOVLanguageMode The language mode for No LIC Input picklists, see “The LOVLanguageMode Argument” on page 81. Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. ViewMode Specifies the level of access to No Broadest Input records specified in the method call, see “The ViewMode Argument” on page 81. 82 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 83. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Return Value of the Call The status key for each of the deleted objects. Execute Executes multiple insert, delete, or update operations on separate records within a single Web services request. Usage You use the Execute method to perform different operations on records within the same Web services request for a single object. The operations are defined by the operation attribute on the object element in the SOAP request, for example: <Account operation=’insert”> specifies an insert operation for an Account object. The operation attribute can have one of the following values: ■ update. Updates the specified record ■ insert. Inserts the specified record. ■ delete. Deletes the matching record. ■ skipnode. Skips the parent object and processes the child objects. Every object specified in the call requires one valid operation. Mixed node operations are allowed for the Execute method. Arguments Table 25 describes the arguments taken by the Execute method. Table 25. Arguments Taken by the Execute Method Name Description Required Default I/O ListOf(Object). For The list of object instances to be Yes Not Input/ example, ListOfAccount inserted, deleted, or updated. applicable Output LOVLanguageMode The language mode for picklists, No LIC Input see “The LOVLanguageMode Argument” on page 81. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 83 Release 18)
- 84. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Table 25. Arguments Taken by the Execute Method Name Description Required Default I/O ViewMode Specifies the level of access to No Broadest Input records specified in the method call, see “The ViewMode Argument” on page 81. Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. Return Value of the Call The status key for each of the Oracle CRM On Demand objects. Insert Inserts a new record in the Oracle CRM On Demand database. Usage You use the Insert method to create one or more records of a particular object in an Oracle CRM On Demand instance. When inserting a batch of records, the batch is treated as a single transaction. If one record fails to insert during a batch insertion, the entire operation is rolled back and no records are inserted. The Insert method can be used to insert both parent records and child records. If a child node is specified in the request, the Insert method inserts the child and associates it with the existing parent record. If a child node is missing, the Insert call inserts only the new parent record. Arguments Table 26 describes the arguments taken by the Insert method. Table 26. Arguments Taken by the Insert Method Name Description Required Default I/O ListOf(Object). For The list of object instances to be Yes Not Input/ example, ListOfAccount inserted. applicable Output LOVLanguageMode The language mode for picklists, No LIC Input see “The LOVLanguageMode Argument” on page 81. 84 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 85. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Table 26. Arguments Taken by the Insert Method Name Description Required Default I/O Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. ViewMode Specifies the level of access to No Broadest Input records specified in the method call, see “The ViewMode Argument” on page 81. Return Value of the Call The status key for each of the Oracle CRM On Demand objects. QueryPage Executes a query against the set of records for an object, and returns the subset of the records that match the search criteria set by the method arguments. NOTE: For fields of all data types apart from xsd:string, if the field has a blank or no value, it does not appear in the query response. Query by Template To improve performance, the QueryPage result contains only those fields and objects that are included in the QueryPage request. To retrieve the values of fields that are not a part of the search criteria, the field must be included in the search request with a blank value. Using the pagesize and startownum Arguments The pagesize argument, which has a maximum value of 100, is used to specify the maximum number of records to be returned in a QueryPage response. The pagesize and startrownum arguments are specified as attributes of the ListOf(Object) element in requests, for example: <ListOfAccount pagesize=”20” startrownum=”0” recordcountneeded=”true”> Depending on the value of pagesize, records are returned as follows: ■ If the number of records in the record set is less than the pagesize value, the full record set is returned, and the lastpage attribute is set to true. ■ If the number of records in the record set exceeds the pagesize value, only the number of records specified by the pagesize parameter is returned, and the lastpage attribute is false. ■ For a query whose record set exceeds the pagesize value, setting the startrownum attribute to pagesize+1 (setting startrownum to pagesize returns the next pagesize number of records) returns the next pagesize number of records. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 85 Release 18)
- 86. Web Services On Demand API Calls ■ Web Services v2.0 API Calls ■ If the size of the record set is greater than pagesize, and this is a subsequent query where there are less than pagesize number of records remaining to be returned, all of the remaining records are returned and lastpage attribute has a value of true. Even though the QueryPage method returns a limited number of records, it keeps the data in the cache, which you can then retrieve by calling the QueryPage method again with a new value for the startrownum argument. Using Search Specifications You can use the searchspec argument of QueryPage to return only those records matching specified search criteria for an object. You can also specify the sort order and sort sequence for returned records using the sortorder and sortsequence arguments respectively. For more information, see “Specifying the Sort Order and Sort Sequence” on page 90. The searchspec argument is specified as an attribute of an Object element in requests, for example: <Contact searchspec=”[ContactFirstName] = ‘Jo*’”> which would return only contact records for which the ContactFirstName field value begins with Jo. The search specification can be set on any field type. The query syntax is described in the following topic. Query Syntax The query syntax for the searchspec argument supports only a small subset of binary and unary operators. No Siebel Query Language constructs or functions are supported. The query syntax is summarized in Table 27. Table 27. Query Syntax for QueryPage Syntax Type Notes expression [XML Tag] {Operator} {Value} Operator can be binary or unary. The {Value} need only be specified for binary operators. (expression) conjunction (expression) A conjugated expression must be enclosed in parentheses to avoid ambiguity. However, nonconjugated expressions must not be enclosed in parentheses. conjunction OR AND unary operator IS NULL Used to find a match for a value that has no value IS NOT NULL 86 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 87. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Table 27. Query Syntax for QueryPage Syntax Type Notes EXISTS NOT EXISTS binary operator = ~= Denotes a case-insensitive exact search (no wildcards used) < Must be specified as &lt; to ensure well- formed XML. <= Must be specified as &lt;= > >= <> Must be specified as &lt;> LIKE Wildcard characters are treated as such only in the context of the operator LIKE. ~LIKE Denotes a case-insensitive wildcard search value 'literal' Literal data is always enclosed in single quotes. To use a single quote within a literal, place another single quote immediately beside that quote. In this way, the query recognizes the quote as a literal and not as an operator. For example, the string ab'c is specified as ab''c. To use the special characters such as asterisk (*), question mark (?), and backslash () in queries, preceded them with the character. For example, to use the ? wildcard operator in a query, precede it with the character as follows: ? The following is an example from a request that follows the query syntax: <Contact searchspec=”[ContactFirstName] = ‘John’”> where XML Tag is Contact FirstName, the operator is = and the value is the literal value John. An example of an expression with a conjunction is as follows: <Contact searchspec=”([ContactFirstName] = ‘Jane’”) AND ([ContactLastName] = ‘Doe’”)> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 87 Release 18)
- 88. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Examples of searchspec usage are given in Table 28. Table 28. Searchspec Examples Operator Usage of searchspec in request Description Case <ListOfContact startrownum="0" pagesize="100" Returns all contacts Sensitive recordcountneeded="true"> whose ContactFirstName LIKE with * <Contact searchspec=”[ContactFirstName] LIKE value starts with wildcard ‘Contact*’”> "Contact" and ends with <ContactFirstName/> zero or more characters </Contact></ListOfContact> Case <ListOfContact><Contact Returns all contacts Insensitive searchspec=”[ContactFirstName] ~LIKE whose ContactFirstName ~ LIKE with ‘Contact*’”> value starts with, for * wildcard <ContactFirstName/> example, "Contact" or </Contact></ListOfContact> "contact" or "CoNtAcT" and ends with zero or more characters Case <ListOfContact><Contact Returns all contacts Sensitive searchspec=”[ContactFirstName] LIKE whose ContactFirstName LIKE with ? ‘Contact???’”> value starts with wildcard <ContactFirstName/> "Contact" and ends with </Contact></ListOfContact> any three characters Case <ListOfContact><Contact Returns all contacts Insensitive searchspec=”[ContactFirstName] ~LIKE whose ContactFirstName ~ LIKE with ‘Contact???’”> value starts with, for ? wildcard <ContactFirstName/> example, "Contact" or </Contact></ListOfContact> "contact" or "CoNtAcT", and ends with any three characters Case <ListOfContact><Contact Returns all contacts Sensitive = searchspec=”[ContactFirstName] = whose ContactFirstName ‘ContactInsert’”> value is equal to <ContactFirstName/> "ContactInsert" </Contact></ListOfContact> Case <ListOfContact><Contact Returns all contacts Insensitive searchspec=”[ContactFirstName] ~= whose ContactFirstName ~= ‘ContactInsert’”> value is equal to, for <ContactFirstName/> example, </Contact></ListOfContact> "ContactInsert","contactin sert" or "CoNtAcTiNsErT" IS NULL <ListOfContact><Contact searchspec=”[TEXTLG_000] Returns all contacts IS NULL> whose TEXTLG_000 value <ContactFirstName/> is NULL </Contact></ListOfContact> 88 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 89. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Table 28. Searchspec Examples Operator Usage of searchspec in request Description IS NOT <ListOfContact><Contact searchspec=”[TEXTLG_000] Returns all contacts NULL IS NOT NULL> whose TEXTLG_000 value <ContactFirstName/> is not NULL </Contact></ListOfContact> AND <ListOfContact><Contact searchspec=”[BOOL_000] = Returns all contacts 'Y' AND [IndexedBoolean0] = 'N'"> whose BOOL_000 value is Y AND IndexedBoolean0 <ContactFirstName/><IndexedBoolean0/> value is N </Contact></ListOfContact> Or <ListOfContact> <Contact searchspec=”[BOOL_000] = 'Y'"> <ContactFirstName/> <IndexedBoolean0>='N'</IndexedBoolean0> </Contact></ListOfContact> Or <ListOfContact><Contact> <ContactFirstName/> <BOOL_000>='Y'</BOOL_000> <IndexedBoolean0>='N'</IndexedBoolean0> </Contact></ListOfContact> OR <ListOfContact><Contact searchspec=”[BOOL_000] = Returns all contacts 'Y' OR [IndexedBoolean0] = 'N'"> whose BOOL_000 value is <ContactFirstName/> Y OR IndexedBoolean0 <BOOL_000/> value is N <IndexedBoolean0/> </Contact></ListOfContact> > <ListOfContact><Contact Returns all contacts searchspec=”[IndexedNumber0] > '500'"> whose IndexedNumber0 (greater <ContactFirstName/> value is greater than 500 than) <IndexedNumber0/> </Contact></ListOfContact> >= <ListOfContact><Contact Returns all contacts searchspec=”[IndexedNumber0] >= '500'"> whose IndexedNumber0 (greater <ContactFirstName/> value is greater than or than or <IndexedNumber0/> equal to 500 equal to) </Contact></ListOfContact> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 89 Release 18)
- 90. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Table 28. Searchspec Examples Operator Usage of searchspec in request Description < <ListOfContact><Contact Returns all contacts searchspec=”[IndexedNumber0] < '500'"> whose IndexedNumber0 (less than) <ContactFirstName/> value is less than 500 <IndexedNumber0/> </Contact></ListOfContact> <= <ListOfContact><Contact Returns all contacts searchspec=”[IndexedNumber0] <= '500'"> whose IndexedNumber0 (less than <ContactFirstName/> value is less than or equal or equal to) <IndexedNumber0/> to 500 </Contact></ListOfContact> <> <ListOfContact><Contact Returns all contacts searchspec=”[IndexedNumber0] <> '500'"> whose IndexedNumber0 (not equal <ContactFirstName/> value is not equal to 500 to) <IndexedNumber0/> </Contact></ListOfContact> Specifying the Sort Order and Sort Sequence You can specify the sort order and sort sequence for returned records using the sortorder and sortsequence arguments respectively. The sortorder and sortsequence arguments are specified as attributes of a FieldName element in requests, for example: <CampaignName sortorder=”ASC” sortsequence=”1”/> which specifies that the records returned are sorted on the CampaignName field in an ascending order, with a sortsequence of 1. 90 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 91. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Examples of sortorder and sortsequence usage are given in Table 29. Table 29. Sortorder and sortsequence Examples Sort type Usage of sortoder and sortsequence Description Sort in <ListOfContact startrownum="0" Returns all contacts whose ascending pagesize="100" recordcountneeded="true"> ContactFirstName value starts order <Contact searchspec=”[ContactFirstName] with "Contact" and ends with LIKE ‘Contact*’”> zero or more characters and <ContactLastName sortorder="ASC"></ sorts them by ContactLastName ContactLastName> in ascending order </Contact></ListOfContact> Sort in <ListOfContact startrownum="0" Returns all contacts whose descending pagesize="100" recordcountneeded="true"> ContactLastName value starts order <Contact> with "Contact" and ends with <ContactLastName sortorder="DESC">~LIKE zero or more characters and 'Contact*'</ContactLastName> sorts them by ContactLastName </Contact></ListOfContact> in descending order Sort More <ListOfContact startrownum="0" Returns all contacts whose than One pagesize="100" recordcountneeded="true"> ContactFirstName value starts Fields <Contact searchspec=”[ContactFirstName] with "Contact" and ends with LIKE ‘Contact*’”> zero or more characters and <ContactLastName sortorder="DESC" sorts them by CreatedDate in sortsequence="1"></ContactLastName> descending order and then by <ExternalSystemId sortorder="ASC" ExternalSystemId in ascending sortsequence="-3"></ExternalSystemId> <CreatedDate sortorder="DESC" order and then by sortsequence="-4"></CreatedDate> ContactLastName in descending </Contact></ListOfContact> order Specifying Books in Queries For queries on record types that support books, you can use the BookId or BookName arguments to constrain the query to only the records in a particular book. For more information about the use of books, see the online help for Oracle CRM On Demand. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 91 Release 18)
- 92. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Arguments Table 30 describes the arguments taken by the QueryPage method. Table 30. Arguments Taken by the QueryPage Method Require Name Description d Default I/O ListOf(Object). For The list of object instances queried Yes Not Input/ example, (input), and after query execution, the list applicable Output ListOfAccount of object instances returned (output). pagesize The maximum number of records No 10 Input displayed on a page following a query. startrownum Indicates the row from which the No 0 Input QueryPage method starts to return records. For example, if you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. recordcountneeded Indicates whether a record count for the No false Input object is to be returned. searchspec Indicates the search specification for a No Not Input field or for all the fields of an object. applicable sortsequence An integer value that determines the order No Input of the sort specification. sortorder Determines the sort order for the records No ASC Input returned by the query, either ASC for ascending or DESC for descending. LOVLanguageMode The language mode for picklists, see “The No LIC Input LOVLanguageMode Argument” on page 81. ViewMode Specifies the level of access to records Yes Broadest Input specified in the method call, see “The ViewMode Argument” on page 81. BookId The book ID. No Not Input applicable BookName The book name. This argument is ignored No Not Input if a value for BookId is supplied. applicable IncludeSubBooks Whether subbooks should be included. No Input 92 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 93. Web Services On Demand API Calls ■ Web Services v2.0 API Calls Return Value of the Call An object or list of objects of the type on which the method was called: ■ LastPage. A Boolean value that indicates whether or not the last value in the query set has been returned. ■ recordcount. An integer value that indicates the record count for the object. Update Updates the selected record with the new value. Usage You use the Update method to update one or more records of a particular object in an Oracle CRM On Demand instance. The Update method can be used to update parent records and child records. If a child node is specified in the request, the Update method updates the child in the existing parent record. If the child node is missing, the Insert call updates only the existing parent record. NOTE: If the administrator customizes a record type to add a required field, Oracle CRM On Demand does not check for the required field when existing records are updated. When you update the record without the required field through a Web services request, or merge it with a record that does not have the required field, the record is updated or merged without error. This is the intended behavior; when a field is made required, it is the responsibility of the administrator to update all existing records to populate the required field. When inserting new records however, Oracle CRM On Demand checks for the required field. Arguments Table 31 describes the arguments taken by the Update method. Table 31. Arguments Taken by the Update Method Name Description Required Default I/O ListOf(Object). For The object instance to be updated. Yes Not Input/ example, ListOfAccount applicable Output LOVLanguageMode The language mode for picklists, No LIC Input see “The LOVLanguageMode Argument” on page 81. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 93 Release 18)
- 94. Web Services On Demand API Calls ■ Service API Calls Table 31. Arguments Taken by the Update Method Name Description Required Default I/O Echo Controls whether data sent to No On Input Oracle CRM On Demand through integration Web services are recorded as transactions. ViewMode Specifies the level of access to Yes Broadest Input records specified in the method call, see “The ViewMode Argument” on page 81. Return Value of the Call The status key for the updated objects. Service API Calls The Oracle CRM On Demand Web Services service methods are listed in Table 32. The service methods are those methods that are not called on Oracle CRM On Demand record types. Instead, they are used to perform administrative tasks. The table also shows the Web service for each of the methods. You can download the WSDL file for each service from the Web Services Administration page in the Oracle CRM On Demand application. Table 32. Web Services On Demand Service Methods Method Name Web Service Comments “DeletedItemQueryPage” on page 95 Deleted Item Gets information about deleted items. “DeleteEvents” on page 99 Integration Event Deletes events from an integration event queue. “GetEvents” on page 100 Integration Event Gets events from an integration event queue. “GetMapping” on page 103 Mapping Service Gets a list of the display names of fields for a particular record type and their associated XML tags. “GetPicklistValues” on page 104 Picklist Gets lists of picklist values. “GetServerTime” on page 105 Time Gets the server time. “LoginHistoryQueryPage” on page 106 Login History Gets information about user login history. “MergeRecords” on page 107 Merge Merges records. 94 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 95. Web Services On Demand API Calls ■ Service API Calls Table 32. Web Services On Demand Service Methods Method Name Web Service Comments “MetadataChangeSummaryQueryPage” Metadata Change Gets a summary of changes to on page 109 Summary metadata. “SalesProcessQueryPage” on page 110 Sales Process Gets sales process information. “SetPasswordAPI” on page 112 Password Sets the passwords of users who use the application. “SetSessionTimeZone” on page 113 Time Sets the time zone for a session. “UpdatePicklist” on page 114 Picklist Updates picklist values. “UpdateCascadingPicklists” on Picklist Updates cascading picklist values. page 115 “UserUsageQueryPage” on page 117 User Usage Gets information about Web services utilization. DeletedItemQueryPage Returns details of deleted items. Objects Supported DeletedItemQueryPage is supported for all Web Services v1.0 and Web Services v2.0 accessible objects that can be deleted. Usage You use the DeletedItemQueryPage method to execute a query against the list of deleted records, and returns a subset of the records that match the search criteria set by the method arguments. The Type of the DeletedItems object returned by the DeletedItemQueryPage method is not always the same as that used in the UI of the Oracle CRM On Demand application, as shown in Table 33. NOTE: In Table 33, the * characters are asterisk characters, and do not represent wildcard characters. You must use the types shown in the table in queries for deleted item records. (The type is language independent.) Table 33. Deleted Item Types Returned by DeletedItemQueryPage Method UI Record Type Deleted Item Type Account Account Contact Contact Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 95 Release 18)
- 96. Web Services On Demand API Calls ■ Service API Calls Table 33. Deleted Item Types Returned by DeletedItemQueryPage Method UI Record Type Deleted Item Type Opportunity Opportunity Lead Lead Service Request Service Request Campaign Campaign Appointment Action***Appointment Solution Solution Account Note Account Note Account Private Note Account Private Note Contact Note Contact Note Contact Private Note Contact Private Note Note Note Opportunity Note Opportunity Note Opportunity Private Note Opportunity Private Note Organizations Note Organizations Note Service Request Note Service Request Note Account Attachment Account Attachment Action Attachment Action Attachment Contact Attachment Contact Attachment Opportunity Attachment Opportunity Attachment Service Request Attachment Service Request Attachment Organization Organization Position Position Task Action***Task Revenue Revenue Lead Attachment Lead Attachment Solution Attachment Solution Attachment Campaign Attachment Campaign Attachment Campaign Note Campaign Note Forecast Revenue Forecast Revenue Asset Asset Mgmt - Asset Referral VONDINS Referral***Referral 96 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 97. Web Services On Demand API Calls ■ Service API Calls Table 33. Deleted Item Types Returned by DeletedItemQueryPage Method UI Record Type Deleted Item Type Sales Stage Attachment Sales Stage Attachment Portfolio VONDINS Portfolio***Portfolio Household Household Portfolio Child VONDINS Portfolio Child***Portfolio Medical Education Event Pharma ME Event Vehicle Auto Vehicle Channel Partner Channel Partner Fund Attachment Fund Attachment Fund Request Attachment Fund Request Attachment Smart Call Pharma Template Call Custom Object 01 OnDemand Custom Object 1 Custom Object 02 OnDemand Custom Object 2 Custom Object 03 OnDemand Custom Object 3 Custom Object n (where n = 04 and higher) CustomObjectn (where n = 4 and higher) Sample Dropped Pharma Call Sample Dropped Product Detailed Pharma Call Product Detailed Contact Interest Contact Interests Fund Fund Fund Request Fund Request Fund Note Fund Note Fund Request Note Fund Request Note Custom Object 01 Note OnDemand Custom Object 1 Note Custom Object 02 Note OnDemand Custom Object 2 Note Custom Object 03 Note OnDemand Custom Object 3 Note Custom Object 01 Attachment OnDemand Custom Object 1 Attachment Custom Object 02 Attachment OnDemand Custom Object 2 Attachment Custom Object 03 Attachment OnDemand Custom Object 3 Attachment Dealer Note Dealer Note Dealer Attachment Dealer Attachment Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 97 Release 18)
- 98. Web Services On Demand API Calls ■ Service API Calls Arguments Table 34 describes the arguments taken by the DeletedItemQueryPage method. Table 34. Arguments Taken by the DeletedItemQueryPage Method Name Description Required Default I/O ListOfDeletedItem The list of object instances queried Yes Not Input/ (input), and after query execution, the applicable Output list of object instances returned (output). PageSize The maximum number of records No 10 Input displayed on a page following a query. StartRowNum Indicates the row from which the No 0 Input DeletedItemQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. LastPage A value that indicates whether or not Not Not Output the last value in the query set has applicable applicable been returned. Return Value of the Call The following information is returned for deleted items: ■ DeletedItemId. The ID of the deleted item. ■ DeletedById. The user ID of the user who deleted the item. ■ DeletedBy. The name of the user who deleted the item. ■ DeletedDate. The date on which the item was deleted. ■ Name. The name of the deleted record. ■ ObjectId. The object ID of the deleted record. ■ Type. The type of the deleted record. ■ ExternalSystemId. The external system ID of the item. 98 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 99. Web Services On Demand API Calls ■ Service API Calls DeleteEvents Deletes events from an integration event queue. Objects Supported DeleteEvents is supported for the following objects: Account, Activity, Allocation, Asset, Business Plan, Campaign, Contact, Contact State License, Custom Object 01 - 03, Custom Object 04 and higher, Dealer, Household, Inventory Period, Lead, MedEvent, Objective, Opportunity, Period, Portfolio, Product, ProductCategory, Sample Inventory, Sample Transaction, Sample Lot, Service Request, Solution, Territory, Transaction Item, Vehicle. Usage You use the DeleteEvents method of the Integration Event Web service to delete events from an integration event queue. Integration events are actions that are triggered based on meeting certain workflow criteria. An integration event stores information about data that has changed: ■ User key information about the changed record, for example: objectID, externalsystemID ■ Audit information, for example, created date, createdby, modified date, modified by Integration events are stored in one or more company queues on the hosted environment. The maximum number of events in the queues is set by Customer Care. Contact Customer Care to request support for the Integration Event Web Service and to specify the maximum total size of the integration queues you require. For more information about integration events and setting up workflow criteria, refer to the Oracle CRM On Demand online help. The QueueName argument, if specified, must match the name of a queue defined for a company within Oracle CRM On Demand. The QueueName value is the localized display name value for the user. If the supplied name is not valid, an error message is returned. If QueueName is not specified, the value is empty, or if the value is Default Queue, events are deleted from the default queue. If the DateTime argument is supplied, all events older than the specified date and time are deleted. If the LastEventId argument is supplied, all events older than the specified event are deleted. If DateTime and LastEventId are not specified, all events are deleted from the queue. If a valid queue name is provided but the LastEventId value provided does not match an event in that queue, an error is returned. When there is a pending request to a queue, another call to the same queue cannot be invoked until the previous request completes. However, another call to a different queue can be invoked before the previous request completes. You can delete events for all of the supported record types, or a subset of record types, depending on how you prepare the WSDL and Schema files associated with the Integration Event service, see “Preparing the Integration Event WSDL File and Schema Files” on page 102. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 99 Release 18)
- 100. Web Services On Demand API Calls ■ Service API Calls Arguments Table 35 describes the arguments taken by the DeleteEvents method. Table 35. Arguments Taken by the DeleteEvents Method Name Description Required Default I/O QueueName The name of the integration event No Default Input/ queue. Queue Output DateTime A date and time. No Not Input applicable LastEventId An event ID No Not Input/ applicable Output Return Value of the Call The ID of the last event deleted. GetEvents Returns events from an integration event queue. Objects Supported GetEvents is supported for the following objects: Account, Activity, Allocation, Asset, Business Plan, Campaign, Contact, Contact State License, Custom Object 01 - 03, Custom Object 04 and higher, Dealer, Household, Inventory Period, Lead, MedEvent, Objective, Opportunity, Period, Portfolio, Product, ProductCategory, Sample Inventory, Sample Transaction, Sample Lot, Service Request, Solution, Territory, Transaction Item, Vehicle. Usage You use the GetEvents method of the Integration Event Web service to return events from an integration event queue. Integration events are actions that are triggered based on meeting certain workflow criteria. An integration event stores information about data that has changed: ■ User key information about the changed record, for example: objectID, externalsystemID ■ Audit information, for example, created date, created by, modified date, modified by Integration events are stored in one or more company queues on the hosted environment. The maximum number of events in the queues is set by Customer Care. Contact Customer Care to request support for the Integration Event Web Service and to specify the maximum total size of the integration queues you require. For more information about integration events and setting up workflow criteria, refer to the Oracle CRM On Demand online help. 100 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 101. Web Services On Demand API Calls ■ Service API Calls If the EventCount argument is not supplied, all events are returned. The QueueName argument, if specified, must match the name of a queue defined for a company within Oracle CRM On Demand. The QueueName value is the localized display name value for the user. If the supplied name is not valid, an error message is returned. If QueueName is not specified, the value is empty, or if the value is Default Queue, events are returned from the default queue. When there is a pending request to a queue, another call to the same queue cannot be invoked until the previous request completes. However, another call to a different queue can be invoked before the previous request completes. You can return events for all supported record types, or a subset of record types, depending on how you prepare the WSDL and Schema files associated with the Integration Event service, see “Preparing the Integration Event WSDL File and Schema Files” on page 102. In some cases the names of objects in the list of events returned differ from the name of the object used in the UI of the application, as shown in Appendix B, “Mapping of Display Names to Service API Object Names”. Arguments Table 36 describes the arguments taken by the GetEvents method. Table 36. Arguments Taken by the GetEvents Method Name Description Required Default I/O EventCount The maximum number of No Not applicable Input events to be returned. QueueName The integration event No Default queue Input/ queue name. Output ListOfEvent A list of events Not applicable Not applicable Output LastEventID An event ID Not applicable Not applicable Output Return Value of the Call A list of the events returned from the integration event queue. Also, the ID of the last event returned. The QueueName value is returned, if it is specified in the GetEvents request. For each event in the list of events, there are the following attributes: ■ name. The name of the associated Workflow. ■ object. The record type. ■ operation. The operation performed. The attribute values can be: ■ insert - for items inserted ■ update - for items updated Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 101 Release 18)
- 102. Web Services On Demand API Calls ■ Service API Calls ■ purge - for items that have been purged from the Deleted Items area ■ delete - for items that have been deleted and are still in the Deleted Items area ■ associate - for child items that have been associated with a parent record type ■ dissociate - for child items that have been dissociated from a parent record type NOTE: Only the Account, Contact, and Opportunity objects support the associate and dissociate operations. The integration events generated for these objects vary depending on whether the request is made through a Web service request or the UI. For more information, about these differences in integration events, see the information about workflow rules in the online help for Oracle CRM On Demand. Preparing the Integration Event WSDL File and Schema Files You can use the methods of the Integration Events service to track changes for the supported record types. You must download the integrationevent.wsdl file and the XSD file for each record type that you require to track. The integration event WSDL file imports the XSD files for each record type. The integrationevent.wsdl file is dynamically generated based on which objects have an active workflow rule with an integration event action configured. For each object with an integration event action configured, a child element of <SiebelMessage> is added to the WSDL files, for example, <ListOfAccount>. For child objects, an element is added for the parent object, for example, an entry for the Account parent object is added for the Account Team child. For child objects with multiple parents, an element is added for each possibe parent, for example, Account, Contact, and Opportunity parent entries would be added for a Revenue child. Also, for each object, an <import> element is added to the WSDL file with the correct namespace and schema location for the XSD file for the object. For example: <xsd:import namespace="urn:/crmondemand/xml/account" schemaLocation="Account.xsd" /> Either the Web Services v1.0 or Web Services 2.0 namespace is used, depending on the object. You can download XSD Schema files for all objects for the Web Services v1.0 API, and for the Web Services v2.0 objects for which Integration Events support is offered. The correct namespace is generated in the WSDL file accordingly. To prepare the WSDL 1 Go to the Web Services Administration page in the Oracle CRM On Demand application. 2 Download the Integration Events WSDL. 3 Download the Generic Schema files for objects for which you wish to generate integration events and copy these to the folder where you downloaded the WSDL file. NOTE: You can download Custom or Generic Schema files for all objects for the Web Services v1.0 API, and for the Web Services v2.0 API objects for which Integration Events support is offered. 102 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 103. Web Services On Demand API Calls ■ Service API Calls 4 If you have created custom fields or renamed fields for an object, download the Custom XSD file for the object. 5 In the integrationevent.wsdl file, remove references to any Schema files for objects you will not be using. 6 Add the integrationevent.wsdl file to your development environment. NOTE: You must repeat steps 3 through 6 each time a new custom field is added that will be tracked through integration events, or when you begin tracking a new object type. Otherwise, the client application cannot process events containing these newly added fields or objects. GetMapping Returns the display names and XML tags of the fields of a record type or one of its child components. Objects Supported GetMapping is supported for all objects accessible through Web Services V1.0 and Web Services 2.0 and all of their child components. Usage You use the GetMapping method to return the mapping between the display names of all the fields in a particular record type and the XML tags for each field. In some cases, the names of objects used in the ObjectName argument differ from the name of the object used in the UI of the application, as shown in Appendix B, “Mapping of Display Names to Service API Object Names”. The GetMapping method works with all Custom Objects. However, you must use a different naming convention for Custom Objects 1-3, compared to Custom Object 4 and higher, where there are no spaces in the object name. SOAP requests must use the following naming convention for object names: ■ Custom Object 1-3. Custom Object 1, Custom Object 2, Custom Object 3 ■ Custom Object 4 and higher. CustomObject4...CustomObject14, and so on Arguments Table 37 describes the arguments taken by the GetMapping method. Table 37. Arguments Taken by the GetMapping Method Name Description Required Default I/O ObjectName The name of the record type for which Yes Not Input/ you wish to return a list of mappings. applicable Output Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 103 Release 18)
- 104. Web Services On Demand API Calls ■ Service API Calls Return Value of the Call A list of the display names for fields and their associated XML mappings: ■ LastUpdated. The date the field was last updated. ■ DisplayName. The display name of the field, in the user’s language. ■ ElementName. The XML element name for the field. ■ DataType. The field type of the field, for example, Check box, Picklist, and so on. GetPicklistValues Gets picklist values from Oracle CRM On Demand. Objects Supported GetPicklistValues is supported for all Web Services v1.0 and v2.0 accessible parent-level objects. Usage You use the GetPicklistValues method to enable external applications to present lists of values to users, typically in a language-dependent manner. The method can get lists of possible values for both cascading and regular picklist fields. Because On Demand Web Services is language-independent, it is the client application’s responsibility to convert code from the language-independent code (LIC) used by Oracle CRM On Demand to language-dependent values (LDVs) typically used by the external presentation layer. The returned list of values corresponds to the organization to which the current user belongs (that is, the user whose credentials have been passed during the log-in call). Cascading picklists restrict the values of one picklist, the related picklist, based on the value selected in another picklist, the parent picklist. For example, a parent picklist might present a list of IT areas and drive the value of a related picklist called SubAreas. When the user selects, for example, the value Installation for Area, the SubAreas picklist is dynamically constrained to show only the picklist values that are associated with the Installation area, for example, Server Crash and No Admin Login. If the provided picklist has a parent, only the values that have a parent are returned. When a picklist has a parent, the result set includes the parent and the child values and at the end includes an empty set that contains all values available for the requested picklist. If a picklist is not cascading, the following elements are returned empty: ■ ParentFieldName ■ ParentDisplayValue ■ ParentCode If a “10/2004” namespace is used, the FieldName and ParentFieldName elements respectively accept and return the integration tag value for custom fields, otherwise, they accept and return the generic custom field tag names (that is, CustomPicklist1 and so on). 104 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 105. Web Services On Demand API Calls ■ Service API Calls Arguments Table 38 describes the arguments taken by the GetPicklistValues method. Table 38. Arguments Taken by the GetPicklistValues Method Name Description Required Default I/O RecordType The record type; this is case insensitive Yes Not Input applicable FieldName The name of the picklist field. Yes Not Input applicable LanguageCode The code of the language in which No User’s Input language-dependent values are to be Default returned, for example, ENU, DEU, FRA, Language ESN, and so on. If the code is not specified, the default language for the current session’s user is used. ListOfParentPicklistV A sequence of ParentPicklistValue Yes Not Output alue elements. applicable Return Value of the Call A list of picklist values. For a cascading picklist, this includes the values for the related picklist that apply for particular values of the parent picklist. For a regular picklist, values for parent picklist are not included. The ParentPicklistValue element contains the following child elements: ■ Language. The language. ■ ParentFieldName. The parent picklist field name as an integration tag. ■ ParentDisplayValue. A display value translated into the specified language. ■ ParentCode. A parent Language Independent Code (LIC). ■ ListOfPickListValue. A sequence of PicklistValue elements containing the related picklist values that correspond to the parent picklist value. The PicklistValue element contains the following child elements: ■ DisplayValue. The display value translated into the specified language. ■ Code. The Language Independent Code (LIC). GetServerTime Returns the time from a server. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 105 Release 18)
- 106. Web Services On Demand API Calls ■ Service API Calls Usage You use the GetServerTime method to get the time at the server involved in a Web services API session. The time returned is converted to the time for the locale of the user ID making the request. Return Value of the Call The current server time. LoginHistoryQueryPage Executes a query against the list of user login history, and returns a subset of the records that match the search criteria set by the method arguments. Usage You use the LoginHistoryQueryPage method to view the Login History for a user. This is the same information that is displayed in the Company Administration, Sign In Audit page in the Oracle CRM On Demand application. As an example of how you might use this data, you might save the data in a CSV file and then import it into a spreadsheet. You could then use the spreadsheet to generate a report showing, for example, how often a user logs into Oracle CRM On Demand. Arguments Table 39 describes the arguments taken by the LoginHistoryQueryPage method. Table 39. Arguments Taken by the LoginHistoryQueryPage Method Name Description Required Default I/O ListOfLoginHistory The list of object instances queried Yes Not Input/ (input), and after query execution, the applicable Output list of object instances returned (output). PageSize The maximum number of records No 10 Input displayed on a page following a query. 106 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 107. Web Services On Demand API Calls ■ Service API Calls Table 39. Arguments Taken by the LoginHistoryQueryPage Method Name Description Required Default I/O StartRowNum Indicates the row from which the No 0 Input LoginHistoryQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. LastPage A value that indicates whether or not Not Not Output the last value in the query set has applicable applicable been returned. Return Value of the Call The following information is returned for each usage record. A list of user login history. The following are the child elements of ListOfLoginHistory: ■ UserId. The user ID of the user. ■ FirstName. The user’s first name. ■ LastName. The user’s last name. ■ UserAlias. The user alias of the user. ■ LoginName. The login name for the user. ■ LoginStatus. The login status for the user. ■ LoginTimestamp. The time at which the user last logged in. ■ ClientType. The type of client from which the user logged in. ■ IPAddress. The source IP address for the user. ■ AdditionalInformation. Additional information for the user. MergeRecords Merges records for certain record types. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 107 Release 18)
- 108. Web Services On Demand API Calls ■ Service API Calls Objects Supported MergeRecords is only supported for the Account, Contact, Household, Lead, and Portfolio record types. If an invalid record type is provided, an error message is displayed. Usage You use the MergeRecords method to merge records. When you merge two records, you specify the record that you want to keep, which is called the primary record, and the record that is to be deleted, which is called the duplicate record. The following rules apply to merging records: ■ Fields in the primary parent record that contain data are retained. ■ Fields in the primary record that are blank get the value from the duplicate record, if it has a value and if the MergeWhenPrimaryBlank argument is set to true. ■ Fields in the primary parent record that are blank remain blank, if the MergeWhenPrimaryBlank argument is not set, or is set to a value other than true. The Merge Web service has the same security restrictions as in the Oracle CRM On Demand UI regarding privilege and record permissions. Table 40 describes the arguments taken by MergeRecords. Table 40. Arguments taken by MergeRecords Field Name Required Default I/O PrimaryId The ID of the primary Yes Not Input record. applicable PrimaryExternalSystemId The externalsystemID of Yes Not Input the primary record. applicable DuplicateId The ID of the duplicate No Not Input record. applicable DuplicateExternalSystemId The externalsystemID of No Not Input the duplicate record. applicable MergeWhenPrimaryBlank Determines how records No False Input are merged when fields in the primary record are blank. True values are set as Y, Yes, True, or 1. False values are any other values including blanks. RecordType The record type; this is Yes Not Input case sensitive. applicable 108 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 109. Web Services On Demand API Calls ■ Service API Calls Return Value of the Call The following four values are returned: ■ MergedRecordId. The ID of the merged record, that is, the primary record. ■ MergedRecordExternalId. The externalsystemID of the merged record. ■ DeletedRecordId. The ID of the deleted record, that is, the duplicate record. ■ DeletedRecordExternalId. The externalsystemID of the merged record. MetadataChangeSummaryQueryPage Gets a summary of changes to various categories of metadata. Usage You use the MetadataChangeSummaryQueryPage method to determine whether there have been any metadata changes in Oracle CRM On Demand. Only the relevant changes can be extracted and applied to client applications. With the Administration Services API, field and picklist data, for example, can be accessed and modified (see, for example, “FieldManagementUpsert” on page 137 and “PicklistUpsert” on page 145). Arguments Table 41 describes the arguments taken by the MetadataChangeSummaryQueryPage method. Table 41. Arguments Taken by the MetadataChangeSummaryQueryPage Method Name Description Required Default I/O ListOfMetadataChange The metadata to be queried and Yes Not Input/ Summary returned. applicable Output recordcountneeded Indicates whether a record count for No false Input the query is to be returned. PageSize The maximum number of records No 10 Input displayed on a page following a query. StartRowNum Indicates the row from which the No 0 Input method starts to return records. searchspec Indicates the search specification. No Not Input applicable sortsequence An integer value that determines the No Input order of the sort specification. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 109 Release 18)
- 110. Web Services On Demand API Calls ■ Service API Calls Table 41. Arguments Taken by the MetadataChangeSummaryQueryPage Method Name Description Required Default I/O sortorder Determines the sort order for the No ASC Input records returned by the query, either ASC for ascending or DESC for descending. LastPage A value that indicates whether or not Not Not Output the last value in the query set has applicable applicable been returned. recordcount An integer value that indicates the Not Not Output record count. applicable applicable Return Value of the Call The following information is returned: ■ LOVLastUpdated. The date and time of the last picklist update. ■ CascPicklistsLastUpdated. The date and time of the last cascading picklist update. ■ FieldManagementLastUpdated. The date and time of the last field management data update. ■ WorkflowLastUpdated. The date and time of the last workflow update. ■ AccessProfileLastUpdated. The date and time of the last access profile update. ■ BookOfBusinessLastUpdated. The date and time of the last book update. ■ ThemesLastUpdated. The date and time of the last theme update. SalesProcessQueryPage Returns sales process information for a particular user, the default sales process, or all sales processes for a company. Usage You use the SalesProcessQueryPage method to retrieve sales process information including sales stages, order of the sales stages, default probability, and associated opportunity types. The ListOfSalesProcess argument contains elements for the various fields of a sales process, and for the associated sales stages and opportunity types. There are child elements ListofSalesStage and ListofOpportunityType. In requests, if the <SalesProcessId> element does not contain a value, information for all of the sales processes for the company are returned. If the <SalesProcessId> element contains a value, information for sales processes for the user or role with that sales process ID are returned. You can use the User service to query for the SalesProcId value for a user. 110 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 111. Web Services On Demand API Calls ■ Service API Calls If the <Default> element contains the value Y, information for the default sales process is returned. For most of the child elements of ListOfSalesProcess, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales process information are sorted. NOTE: The Name and Description fields of SalesProcess do not support the sort specification. Arguments Table 42 describes the arguments taken by the SalesProcessQueryPage method. Table 42. Arguments Taken by the SalesProcessQueryPage Method Name Description Required Default I/O ListOfSalesProcess The list of sales processes queried Yes Not Input/ (input), and after query execution, the applicable Output list of sales processes returned (output). PageSize The maximum number of records No 10 Input displayed on a page following a query. StartRowNum Indicates the row from which the No 0 Input SalesProcessQueryPage method starts to return records. For example, if you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. searchspec Indicates the search specification for a No Not Input field or for all the fields of an object. applicable sortsequence An integer value that determines the No Input order of the sort specification. sortorder Determines the sort order for the No ASC Input records returned by the query, either ASC for ascending or DESC for descending. LOVLanguageMode The language mode for picklists, see No LIC Input “The LOVLanguageMode Argument” on page 81. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 111 Release 18)
- 112. Web Services On Demand API Calls ■ Service API Calls Table 42. Arguments Taken by the SalesProcessQueryPage Method Name Description Required Default I/O LastPage A value that indicates whether or not Not Not Output the last value in the query set has applicable applicable been returned. recordcount An integer value that indicates the Not Not Output record count for the object applicable applicable Return Value of the Call The following information is returned by ListOfsalesProcess which contains a <SalesProcess> element for each sales process that matches the query: ■ Description. The description of the sales process. ■ Name. The sales process name. ■ Translate. Whether the sales process is marked for translation. ■ SalesProcessId. The sales process ID. ■ Default. Whether this sales process is the default sales process. ■ ListOfOpportunityType. Information contained in the following child elements for each opportunity type: ■ OpportunityTypeId. The opportunity type ID. ■ OpportunityTypeName. The opportunity type name. ■ ListOfSalesStage. Information contained in the following child elements for each sales stage: ■ Name. The name of the sales stage. ■ SalesCategoryName. The category that the sales stage falls under. ■ Order. The sequence of the sales stages as they appear in the picklist. ■ Probability. The default probability for the sales stage. ■ Description. The description of the sales stage. ■ TranslationLanguage. The translation language. For more information about sales process information, see the Oracle CRM On Demand online help SetPasswordAPI Allows the system administrator to set the passwords of users who use the application. 112 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 113. Web Services On Demand API Calls ■ Service API Calls Usage You use the SetPasswordAPI method to enable external applications to synchronize user passwords. For security reasons the password API is not available by default. If customers want to use SetPasswordAPI, they can call Customer Care to have the functionality enabled. There are two privileges: ■ Change Company Passwords using Web Services. Enables access to SetPasswordAPI. ■ Manage Company Password Access. Users (usually administrators) who have been granted this privilege can grant other roles the Change Company Passwords using Web Services privilege. The API allows for the setting of passwords for one or more users at the same time. For each password that is updated, a corresponding user Audit Trail record is created. A user with the ability to set passwords does not have the ability to update the password of another user who has the ability to set passwords. Arguments Table 43 describes the arguments taken by SetPasswordAPI. Allows the system administrator to set the passwords of users who use the application. Table 43. Arguments Taken by SetPasswordAPI Field Name Description Required Default I/O UserId The row ID value of the Yes Not Input/Output user record. applicable EmailAddr The user’s email No Not Input/Output address applicable UserIntegrationID The integration Id for No Not Input/Output the user. applicable IntegrationId The integration Id No Not Input/Output applicable Password The password for the Yes Not Input/Output user. applicable SetSessionTimeZone Sets the time zone for a Web Services API session. Usage This method sets the time zone for a Web services API session. The time zone is set according to the locale of the user making the request. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 113 Release 18)
- 114. Web Services On Demand API Calls ■ Service API Calls Arguments Table 44 describes the arguments taken by the SetSessionTimeZone method. Table 44. Arguments Taken by the SetSessionTimeZone Method Name Description Required Default I/O TimeZone The time zone of the user. Yes Not Input applicable CurrentServerTime The current server time Not Not Output converted to the specified time applicable applicable zone. Return Value of the Call The current server time. UpdatePicklist Updates picklist values in Oracle CRM On Demand. Objects Supported UpdatePicklist is supported for the same objects as supported by the GetPicklistValues method, see “GetPicklistValues” on page 104. Usage You use the UpdatePicklist method to update lists of values, typically in a language-dependent manner. The ListOfPicklistValues argument contains a sequence of PicklistValues elements, each of which has the following child elements: ■ DisplayValue. The display value in the specified language. ■ Code. The Language Independent Code (LIC). ■ Order. The order of the value in the list. ■ MarkTranslate. Whether the value is marked for translation. ■ Disabled. Whether the value is disabled. If the CreateNew argument is set to Y, new picklist values are created with the specified values. If the CreateNew argument is set to Y, new picklist values are created with the specified values from DisplayValue and Order, which are required values. 114 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 115. Web Services On Demand API Calls ■ Service API Calls If the CreateNew argument is set to N, existing picklist values are updated with the specified values from DisplayValue or Code, as long as these values are valid. You cannot use the UpdatePicklist method to create custom picklists or multiselect picklists. You must create new picklist fields through the Oracle CRM On Demand application UI. You cannot update read-only picklist fields. Arguments Table 45 describes the arguments taken by the UpdatePicklist method. Table 45. Arguments Taken by the UpdatePicklist Method Name Description Required Default I/O RecordType The record type; this is case insensitive Yes Not Input applicable FieldName The name of the picklist field. Yes Not Input applicable CreateNew Whether new picklist values are to be No N Input created. A value of Y specifies that new picklist values are to be created, the default value of N specifies that picklist values are to be updated. ListOfPicklistValue A sequence of PicklistValue elements Yes Not Input containing the picklist values to be applicable updated or added. LanguageCode The language code for the picklist No User’s Input values to be updated, for example, Default ENU, DEU, FRA, ESN, and so on. If the Language code is not specified, the default language for the current session’s user is used. Status A string indicating the success of the Not Not Output call or an error message if applicable applicable unsuccessful. Return Value of the Call Returns a status string indicating the success or otherwise of the call. UpdateCascadingPicklists Updates cascading picklist values in Oracle CRM On Demand. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 115 Release 18)
- 116. Web Services On Demand API Calls ■ Service API Calls Objects Supported UpdateCascadingPicklists is supported for the same objects as supported by the GetPicklistValues method, see “GetPicklistValues” on page 104. Usage You use the UpdateCascadingPicklists method to update cascading picklists, typically in a language- dependent manner. The ListOfCascadingPicklistsValue argument contains a sequence of ParentCascPicklistsValue elements, which have the following child elements: ■ ParentDisplayValue. A display value in the specified language. ■ ParentCode. A parent Language Independent Code (LIC). ■ ListOfChildPickListValue. A sequence of ChildPicklistValue elements containing the related picklist values that correspond to the parent picklist value. The ChildPicklistValue element contains the following child elements: ■ DisplayValue. The display value in the specified language. ■ Code. The Language Independent Code (LIC). If the CreateNew argument is set to Y, a new set of cascading picklist relationships is created with the specified values. You cannot create a new Picklist field using the UpdateCascadingPicklist method. Arguments Table 46 describes the arguments taken by the UpdateCascadingPicklists method. Table 46. Arguments Taken by the UpdateCascadingPicklists Method Name Description Required Default I/O RecordType The record type; this is case insensitive Yes Not Input applicable ParentFieldName The name of the parent picklist field. Yes Not Input applicable FieldName The name of the related picklist field. Yes Not Input applicable CreateNew Whether a new set of cascading picklist No N Input relationships between parent and related picklists is to be created with the input values. A value of Y specifies that a new set of relationships is to be created, the default value of N specifies that picklist values are to be updated. 116 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 117. Web Services On Demand API Calls ■ Service API Calls Table 46. Arguments Taken by the UpdateCascadingPicklists Method Name Description Required Default I/O Description A description of the cascading picklist. No Not Input applicable ListOfCascadingPickl A sequence of ParentCascPicklistValue Yes Not Input istValue elements containing the parent picklist applicable values to be updated or added. LanguageCode The language code for the picklist No User’s Input values to be updated, for example, Default ENU, DEU, FRA, ESN, and so on. If the Language code is not specified, the default language for the current session’s user is used. Status A string indicating the success of the Not Not Output call or an error message if applicable applicable unsuccessful. Return Value of the Call Returns a status string indicating the success or otherwise of the call. UserUsageQueryPage Executes a query against the list of Web Services utilization, and returns a subset of the records that match the search criteria set by the method arguments. Usage You use the UserUsageQueryPage method to query the details of your company's Web services utilization. This is the same data that you can view on the Web Services Utilization page in the Oracle CRM On Demand application. As an example of how you might use this data, you might save the data in a CSV file and then import it into a spreadsheet. You could then use the spreadsheet to generate a report showing, for example, how often a user updates his or her records. In the input request, if you supply a value for UserId in the ListOfUserUsage argument, the method returns the utilization records for the specified user. If you do not have Administrator privileges, you can only specify your own user ID. If you do not supply a value for UserId in the input request, the method returns: ■ The utilization records for the current user, if you do not have Administrator privileges. ■ The utilization records for the whole company, if you do have Administrator privileges. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 117 Release 18)
- 118. Web Services On Demand API Calls ■ Service API Calls Arguments Table 47 describes the arguments taken by the UserUsageQueryPage method. Table 47. Arguments Taken by the UserUsageQueryPage Method Name Description Required Default I/O ListOfUserUsage The list of Web service utilization Yes Not Input/ queried (input), and after query applicable Output execution, the list of Web service utilization returned (output). PageSize The maximum number of records No 10 Input displayed on a page following a query. LastPage A value that indicates whether or not Not Not Output the last value in the query set has applicable applicable been returned. Return Value of the Call The following information is returned for each usage record. A list of Web service utilization. The following are the child elements of ListOfUserUsage: ■ SessionId. The session identifier of the Web service request. ■ UserAlias. The user alias of the user who executed the Web service request. ■ UserId. The user ID of the user who executed the Web service request. ■ WebServiceName. The name of the Web service to which the request was made. ■ WebServiceNameSpace. The namespace used in the request. ■ Operation. The operation for the Web service request. ■ StartTime. The start time of the Web service request. ■ EndTime. The end time of the Web service request. ■ EntryType. The entry type for the Web service request. ■ InputMessageSize. The size of the input message. ■ OutputMessageSize. The size of the output message. ■ ErrorMsg. Any error message associated with the Web service request. 118 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 119. Web Services On Demand API Calls ■ Administrative Services API Calls Administrative Services API Calls The Administrative Services are used to automate the administration of your company's configurations. The Oracle Migration Tool On Demand client is the command-line based utility that eliminates the need to manually copy customized configurations from one environment to another. You can use this downloadable client to extract and import specific configuration details and the Administrative Web services provide programmatic access to the configurations. NOTE: The Administrative Services must be enabled for your company. To request enablement of the Administrative Services, contact Customer Care. For more information about the downloadable client, see the Oracle Migration Tool On Demand Guide. The Administrative Services and their methods are as shown in Table 48. There are the following methods for each service, though not all services have each method, as shown in the table: ■ <Configuration>Read. Extracts configuration data matching the input criteria. ■ <Configuration>ReadAll. Extracts all configuration data of a particular type for a company. ■ <Configuration>Upsert. Updates existing configuration data or inserts it, if it does not exist. ■ <Configuration>Create. Creates configuration data. ■ <Configuration>Delete. Deletes configuration data. Table 48. Administrative Services Service Method Usage Access Profile AccessProfileRead Administering access profile configuration data. AccessProfileReadAll AccessProfileUpsert Action Bar Layout ActionBarLayoutReadAll Administering action bar layout configuration data. ActionBarLayoutUpsert Cascading Picklist CascadingPicklistRead Administering cascading picklist configuration data. CascadingPicklistReadAll Custom Record Type CustomRecordTypeRead Administering custom record type configuration data. CustomRecordTypeReadAll CustomRecordTypeUpsert Custom Web Link CustomWebLinkRead Administering Web link configuration data. CustomWebLinkReadAll CustomWebLinkUpsert Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 119 Release 18)
- 120. Web Services On Demand API Calls ■ Administrative Services API Calls Service Method Usage Custom Web Tab CustomWebTabDelete Administering custom Web tab configuration data. CustomWebTabRead CustomWebTabReadAll CustomWebTabUpsert Field Management FieldManagementCreate Administering field management configuration data. FieldManagementRead FieldManagementReadAll FieldManagementUpsert Homepage Layout HomepageLayoutReadAll Administering homepage layout configuration data. Page Layout Field PageLayoutFieldRead Administering field information for page layout configuration data. PageLayoutFieldReadAll PageLayoutFieldUpsert Page Layout Related PageLayoutRelatedInformationReadAll Administering related information Information for page layout configuration data. PageLayoutRelatedInformationUpsert Picklist PicklistRead Administering picklist configuration data. PicklistReadAll PicklistUpsert Role Management RoleReadAll Administering role management configuration data. RoleUpsert You can download the WSDL file for each service from the Web Services Administration page in the Oracle CRM On Demand application. All Web Service operations for the Administrative Services are audited automatically. The audits include all successful operations as well as processing errors such as Request Size exceeded, Invalid SOAP request, Rate limit error, and so on. You can find the audit records in the Web Services Utilization page in Oracle CRM On Demand (click Admin, and then Web Services Utilization). You can view logs for the Oracle Migration Tool On Demand client in the <Installation directory>log directory, for example, C:Oracle Migration Tool On Demandlog. Any requests by the client are also captured in the Web Services Utilization page in Oracle CRM On Demand. The following topics describe each of the methods. 120 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 121. Web Services On Demand API Calls ■ Administrative Services API Calls AccessProfileRead Extracts access profile configuration data. Usage Use the AccessProfileRead method to extract access profile configuration data matching the input criteria. The access profile is specified with the <Name> child element of apQuery:AccessProfile. Refer to “AccessProfileUpsert” on page 122 for information about the access profile data specified in apData:AccessProfile. Arguments Table 49 describes the arguments taken by the AccessProfileRead method. Table 49. Arguments Taken by the AccessProfileRead Method Name Description Required Default I/O apQuery:AccessProfile The access profile query Yes Not Input criteria. applicable apData:AccessProfile The extracted access profile Not Not Output data. applicable applicable Return Value of the Call The access profile is returned. AccessProfileReadAll Extracts all of the access profile configuration data for a company. Usage Use the AccessProfileReadAll method to read all of the access profiles. There is no input argument; the method simply returns all of the access profile data. Refer to “AccessProfileUpsert” on page 122 for information about the access profile data specified in apData:AccessProfile. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 121 Release 18)
- 122. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 50 describes the arguments taken by the AccessProfileReadAll method. Table 50. Arguments Taken by the AccessProfileReadAll Method Name Description Required Default I/O apData:ListOfAccessProfile The extracted data for all access Not Not Output profiles. applicable applicable Return Value of the Call The access profiles are returned. AccessProfileUpsert Updates an existing access profile or inserts a new access profile. Usage Use the AccessProfileUpsert method to insert a profile or update an existing access profile. The apdata:AccessProfile argument contains the following elements containing access profile data: ■ Name. The name of the access profile. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <AccessProfileTranslation> element. ■ Description. A description of the access profile. ■ AvailableForTeam. Whether the profile can be assigned to team members. ■ AvailableForBook. Whether the profile can be assigned to book users. ■ Disabled. Whether the profile cannot be assigned, but existing assignments continue to work. ■ ListOfAccessProfileTranslation. The text fields in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ Title. The display name of the access profile in the language identified by the language code. ■ Description. The description of the access profile in the language identified by the language code. ■ ListOfAccessProfileEntry. The access rights defined on the access profile for each object and child object: ■ AccessObjectName. The names of objects as used in access profiles. ■ PermissionCode. The permission codes corresponding to the various access levels for objects. See the Oracle Migration Tool On Demand Guide for reference tables about the following: 122 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 123. Web Services On Demand API Calls ■ Administrative Services API Calls ■ Mappings of three-letter language codes to languages. ■ Mappings of access profile object names to the display names for the objects in the Oracle CRM On Demand user interface. ■ The permission codes for the various access levels in Oracle CRM On Demand. Arguments Table 51 describes the arguments taken by the AccessProfileUpsert method. Table 51. Arguments Taken by the AccessProfileUpsert Method Name Description Required Default I/O apData:AccessProfile The access profile data to be Yes Not Input inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. ActionBarLayoutReadAll Extracts all of the action bar layout configuration data for a company. Usage Use the ActionBarLayoutReadAll method to read all of the action bar layouts. There is no input argument; the method simply returns all of the action bar layout data. Refer to “ActionBarLayoutUpsert” on page 124 for information about the action bar layout data specified in ablData:ActionBarLayout. Arguments Table 52 describes the arguments taken by the ActionBarLayoutReadAll method. Table 52. Arguments Taken by the ActionBarLayoutReadAll Method Name Description Required Default I/O ablData:ListOfActionBarLayout The extracted data for all Not Not Output action bar layouts. applicable applicable Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 123 Release 18)
- 124. Web Services On Demand API Calls ■ Administrative Services API Calls Return Value of the Call The action bar layouts are returned. ActionBarLayoutUpsert Updates an existing action bar layout or inserts a new action bar layout. Usage Use the ActionBarLayoutUpsert method to insert or update an existing action bar layout. The abldata:ActionBarLayout argument contains the following elements containing action bar layout data: ■ LayoutName. The name of the action bar layout. ■ Description. A description of the action bar layout. ■ ListOfSections. Contains all of the available sections for the action bar layout. The data for a particular section is contained in the following elements: ■ Name. The name of the section, which can be one of the following: ❏ Calendar Action Applet ❏ Global Search Multi Field ❏ Quick Create ❏ Quick Favorite Lists ❏ Quick Favorite Records ❏ Quick History ❏ Quick Message Center ■ Displayed. Whether the section is displayed in the action bar. ■ Sequence. The position of the section within the action bar layout. This corresponds to step 2 in the Action Bar Layout wizard in the UI. The integer value can be one of the following: ❏ -2. The section is in the Not Available Sections list. ❏ -1. The section is in the Available Sections list. ❏ Positive integers. The section is in the Displayed Sections list. The integer value indicates the location of the section within the lists, with 0 (zero) meaning the section is located at the top of the list. See the Oracle Migration Tool On Demand Guide for information about the following: ■ Mappings of action bar section names to the display names for the sections in the Oracle CRM On Demand user interface. 124 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 125. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 53 describes the arguments taken by the ActionBarLayoutUpsert method. Table 53. Arguments Taken by the ActionBarLayoutUpsert Method Name Description Required Default I/O ablData:ActionBarLayout The action bar layout data to be Yes Not Input inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. CascadingPicklistRead Extracts cascading picklist configuration data for an object. Usage Use the CascadingPicklistRead method to extract the set of cascading picklist data matching the input criteria. The object is specified with the <ObjectName> child element of apQuery:CascadingPicklistSet. You can also specify a particular parent picklist or related picklist in the query. The apData:ListOfCascadingPicklistSet output argument can contain any number of CascadingPicklist elements, each of which contains the following data: ■ ParentPicklist. The parent picklist. ■ RelatedPicklist. The related picklist. ■ Description. The description of the cascading picklist. ■ ListOfPicklistValueAssociations. Contains all the associations for a cascading picklist. The associations for a particular picklist are contained in the following elements: ■ ParentPicklistValue. A parent picklist value for the cascading picklist. ■ RelatedPicklistValue. The related values for the parent picklist. There is one these elements for each related picklist value. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 125 Release 18)
- 126. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 54 describes the arguments taken by the CascadingPicklistRead method. Table 54. Arguments Taken by the CascadingPicklistRead Method Name Description Required Default I/O apQuery:CascadingPicklistSet The cascading picklist Yes Not Input query criteria. applicable apData:ListOfCascadingPicklistSet The extracted cascading Not Not Output picklist data. applicable applicable Return Value of the Call The cascading picklist data for the object is returned. CascadingPicklistReadAll Extracts all of the cascading picklist configuration data for a company. Usage Use the CascadingPicklistReadAll method to read all of the cascading picklists. There is no input argument; the method simply returns all of the cascading picklist data for each object. Refer to “CascadingPicklistRead” on page 125 for information about the cascading picklist data returned in apData:ListOfCascadingPicklistSet. Arguments Table 55 describes the arguments taken by the CascadingPicklistReadAll method. Table 55. Arguments Taken by the CascadingPicklistReadAll Method Name Description Required Default I/O apData:ListOfCascadingPick The extracted data for all Not Not Output listSet cascading picklists. applicable applicable Return Value of the Call The cascading picklists are returned. 126 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 127. Web Services On Demand API Calls ■ Administrative Services API Calls CustomRecordTypeRead Extracts custom record type configuration data. Usage Use the CustomRecordTypeRead method to extract custom record type configuration data matching the input criteria. The custom record type is specified with the <Name> child element of apQuery:CustomRecordType. Refer to “CustomRecordTypeUpsert” on page 128 for information about the custom record type data specified in apData:ListOfCustomRecordType. Arguments Table 56 describes the arguments taken by the CustomRecordTypeRead method. Table 56. Arguments Taken by the CustomRecordTypeRead Method Name Description Required Default I/O apQuery:CustomRecordType The custom record type Yes Not Input query criteria. applicable apData:ListOfCustomRecord The extracted custom record Not Not Output Type type data. applicable applicable Return Value of the Call The custom record type data is returned. CustomRecordTypeReadAll Extracts all of the custom record type configuration data for a company. Usage Use the CustomRecordTypeReadAll method to read all of the custom record types. There is no input argument; the method simply returns all of the custom record type data. Refer to “CustomRecordTypeUpsert” on page 128 for information about the custom record type data specified in apData:ListOfCustomRecordType. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 127 Release 18)
- 128. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 57 describes the arguments taken by the CustomRecordTypeReadAll method. Table 57. Arguments Taken by the CustomRecordTypeReadAll Method Name Description Required Default I/O apData:ListOfCustomRecordType The extracted data for all Not Not Output custom record types. applicable applicable Return Value of the Call The custom record types are returned. CustomRecordTypeUpsert Updates an existing custom record type or inserts a new custom record type. Usage Use the CustomRecordTypeUpsert method to insert or update custom record type data. The apdata:CustomRecordType argument contains the following elements containing custom record type data: ■ Name. The object name of the custom record type. ■ SingularName. The singular display name used in the UI. ■ PluralName. The plural display name used in the UI. ■ ShortName. The short display name used in the UI. NOTE: SingularName, PluralName and ShortName are language independent names. If these names are present in the input, the behavior is similar to Mark for Translation being selected in the UI. These elements are not required for customizing language dependent singular/plural/ short names for an object, as they are handled by ListOfCustomRecordTypeTranslation. ■ IconName. The filename of the icon for the custom object. ■ ListOfCustomRecordTypeTranslation. The object display names in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ SingularName. The singular name of the custom record type in the language identified by the language code. ■ PluralName. The plural name of the custom record type in the language identified by the language code. 128 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 129. Web Services On Demand API Calls ■ Administrative Services API Calls ■ ShortName. The short name of the custom record type in the language identified by the language code. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. ■ Mappings of icon filenames to icons for custom objects in the Oracle CRM On Demand user interface. Arguments Table 58 describes the arguments taken by the CustomRecordTypeUpsert method. Table 58. Arguments Taken by the CustomRecordTypeUpsert Method Name Description Required Default I/O apData:CustomRecordType The custom record type data to Yes Not Input be inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. CustomWebLinkRead Extracts custom Web link configuration data. Usage Use the CustomWebLinkRead method to extract custom Web link configuration data for an object. The object is specified with the <ObjectName> child element of apQuery:WebLink. Refer to “CustomWebLinkUpsert” on page 131 for information about the custom Web link data specified in apData:WebLinkSet. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 129 Release 18)
- 130. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 59 describes the arguments taken by the CustomWebLinkRead method. . Table 59. Arguments Taken by the CustomWebLinkRead Method Name Description Required Default I/O apQuery:WebLinkSet The custom Web link query Yes Not Input criteria. applicable apData:ListOfWebLinkSet The extracted custom Web link Not Not Output data. applicable applicable Return Value of the Call The custom Web link is returned. CustomWebLinkReadAll Extracts all of the custom Web link configuration data for a company. Usage Use the CustomWebLinkReadAll method to read all of the custom Web links. There is no input argument; the method simply returns all of the custom Web link data. Refer to “CustomWebLinkUpsert” on page 131 for information about the custom Web link data specified in apData:WebLinkSet. Arguments Table 60 describes the arguments taken by the CustomWebLinkReadAll method. Table 60. Arguments Taken by the CustomWebLinkReadAll Method Name Description Required Default I/O apData:ListOfWebLinkSet The extracted data for all Not Not Output custom Web links. applicable applicable Return Value of the Call The custom Web links are returned. 130 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 131. Web Services On Demand API Calls ■ Administrative Services API Calls CustomWebLinkUpsert Updates custom Web link data or inserts new custom Web link data for an object Usage Use the CustomWebLinkUpsert method to insert custom Web link or update existing custom Web link data for an object. The object is specified with the <ObjectName> child element of apData:WebLinkSet. The apdata:WebLinkSet argument contains the following elements containing custom Web link data: ■ Name. The name of the custom Web link field. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <WebLinkTranslation> element. ■ IntegrationTag. The field’s integration tag name. ■ DisplayText. The label for the hyperlink of the custom Web link. ■ WebLinkTarget. The behavior when a user clicks the hyperlink. Open in Current window, Open in Custom Tab, or Open in New window. ■ TargetCustomWebTab. The required custom Web tab, if Open in Custom Tab is specified for WebLinkTarget. ■ RefreshParentWindow. Whether the parent window is refreshed after a new window is opened. Only applicable if Open in New window is specified for WebLinkTarget. ■ DisplayOptions. A character indicating the pages where the custom Web link is displayed: D for Detail Page, E for Edit Page, or B for Both. ■ ActiveLinkCondition. The condition that controls whether the custom Web link is active on the Detail and Edit pages. ■ DisplayLinkCondition. The condition that controls whether the custom Web link is visible on the Detail and Edit pages. ■ URL. The URL that is invoked when the user clicks the custom Web link. ■ ListOfWebLinkTranslations. The display names in the languages activated for your company: ■ DisplayName. The display name of the custom Web link in the language identified by the language code. ■ DisplayText. The label for the hyperlink, in the language identified by the language code. ■ LangCode. The three-letter language code for the language. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. For more information about custom Web links, see the Oracle CRM On Demand online help. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 131 Release 18)
- 132. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 61 describes the arguments taken by the CustomWebLinkUpsert method. Table 61. Arguments Taken by the CustomWebLinkUpsert Method Name Description Required Default I/O apData:WebLinkSet The custom Web link data to be Yes Not Input inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. CustomWebTabDelete Deletes a custom Web tab. Usage Use the CustomWebTabDelete method to delete a custom Web tab matching the input criteria. The custom Web tab is specified with the <DisplayName> child element of apQuery:CustomWebTab. Refer to “CustomWebTabUpsert” on page 134 for information about the custom Web tab data specified in apData:CustomWebTab. Arguments Table 62 describes the arguments taken by the CustomWebTabDelete method. Table 62. Arguments Taken by the CustomWebTabDelete Method Name Description Required Default I/O apQuery:CustomWebTab The custom Web tab query Yes Not Input criteria. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status of the call is returned. 132 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 133. Web Services On Demand API Calls ■ Administrative Services API Calls CustomWebTabRead Extracts custom Web tab configuration data. Usage Use the CustomWebTabRead method to extract custom Web tab configuration data matching the input criteria. The custom Web tab is specified with the <DisplayName> child element of apQuery:CustomWebTab. Refer to “CustomWebTabUpsert” on page 134 for information about the custom Web tab data specified in apData:CustomWebTab. Arguments Table 63 describes the arguments taken by the CustomWebTabRead method. Table 63. Arguments Taken by the CustomWebTabRead Method Name Description Required Default I/O apQuery:CustomWebTab The custom Web tab query Yes Not Input criteria. applicable apData:CustomWebTab The extracted custom Web tab Not Not Output data. applicable applicable Return Value of the Call The custom Web tab is returned. CustomWebTabReadAll Extracts all of the custom Web tab configuration data for a company. Usage Use the CustomWebTabReadAll method to read all of the custom Web tabs. There is no input argument; the method simply returns all of the custom Web tab data. Refer to “CustomRecordTypeUpsert” on page 128 for information about the custom Web tab data specified in apData:CustomWebTab. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 133 Release 18)
- 134. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 64 describes the arguments taken by the CustomWebTabReadAll method. Table 64. Arguments Taken by the CustomWebTabReadAll Method Name Description Required Default I/O apData:ListOfCustomWebTab The extracted data for all Not Not Output custom Web tabs. applicable applicable Return Value of the Call The custom Web tabs are returned. CustomWebTabUpsert Updates an existing custom Web tab or inserts a new custom Web tab. Usage Use the CustomWebTabUpsert method to insert a custom Web tab or update an existing custom Web tab. The apdata:CustomWebTab argument contains the following elements containing custom Web tab data: ■ DisplayName. The name of the custom Web tab. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <CustomWebTabTranslation> element. ■ Description. A description of the custom Web tab. ■ Url. The URL for the Custom web tab. ■ FrameHeight. The frame height defined for the custom Web tab. ■ FrameWidth. The frame width defined for the custom Web tab. ■ IconName. The filename of the icon used for the custom Web tab. ■ ListOfCustomWebTabTranslation. The display names in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ DisplayName. The display name of the custom Web tab in the language identified by the language code. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. 134 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 135. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 65 describes the arguments taken by the CustomWebTabUpsert method. Table 65. Arguments Taken by the CustomWebTabUpsert Method Name Description Required Default I/O apData:CustomWebTab The custom Web tab data to be Yes Not Input inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. FieldManagementCreate Creates field management configuration data. Usage Use the FieldManagementCreate method to create field management configuration data. The object is specified with the <ObjectName> child element of apData:CustomField. The field management data for the object is contained in elements similar to those of the apData:FieldManagement argument used by the FieldManagementUpsert method, see “FieldManagementUpsert” on page 137. Arguments Table 66 describes the arguments taken by the FieldManagementCreate method. Table 66. Arguments Taken by the FieldManagementCreate Method Name Description Required Default I/O apData:CustomField The field management query Yes Not Input criteria. applicable Status The status of the call. Not Not Output applicable applicable Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 135 Release 18)
- 136. Web Services On Demand API Calls ■ Administrative Services API Calls Return Value of the Call The status of the call is returned. FieldManagementRead Extracts field management configuration data. Usage Use the FieldManagementRead method to extract field management configuration data for an object. The object is specified with the <ObjectName> child element of apQuery:FieldSet. Refer to “FieldManagementUpsert” on page 137 for information about the field management data specified in apData:FieldSet. FieldManagementRead only extracts field definitions for fields that have been created by the user, or out-of-the-box fields that have been modified. Unmodified out-of-the-box fields are bypassed because they exist on all company instances by default. Arguments Table 67 describes the arguments taken by the FieldManagementRead method. Table 67. Arguments Taken by the FieldManagementRead Method Name Description Required Default I/O apQuery:FieldSet The field management query Yes Not Input criteria. applicable apData:ListOfFieldSet The extracted field management Not Not Output data. applicable applicable Return Value of the Call The field management data is returned. FieldManagementReadAll Extracts all of the field management configuration data for a company. Usage Use the FieldManagementReadAll method to read all of the field management data. There is no input argument; the method simply returns all of the field management data. 136 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 137. Web Services On Demand API Calls ■ Administrative Services API Calls Refer to “FieldManagementUpsert” on page 137 for information about the field management data specified in apData:FieldSet. Arguments Table 68 describes the arguments taken by the FieldManagementReadAll method. Table 68. Arguments Taken by the FieldManagementReadAll Method Name Description Required Default I/O apData:ListOfFieldSet The extracted field management Not Not Output data. applicable applicable Return Value of the Call The field management data is returned. FieldManagementUpsert Updates existing field management data or inserts field management data for an object. Usage Use the FieldManagementUpsert method to insert field management data or update existing field management data for an object. The object is specified with the <ObjectName> child element of apData:FieldSet. The apdata:FieldSet argument contains the following elements containing field management data: ■ Name. The system name of the field. ■ DisplayName. The name of the field used in the UI. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <FieldManagementTranslation> element. ■ FieldType. The type of field. ■ IntegrationTag. The field's integration tag name. ■ Required. Whether the field is a required field (true), or is not a required field (false). ■ ReadOnly. Whether the field is a read-only field (true), or is not a read-only field (false). ■ DefaultValue. The default value of the field. ■ FieldValidation. The expression for the field validation rules for the field. ■ PostDefault. Whether the field is prepopulated with the default value when a user creates a new record and the record is saved. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 137 Release 18)
- 138. Web Services On Demand API Calls ■ Administrative Services API Calls ■ ValidationErrorMsg. The custom error message displayed if the field fails field validation. ■ ListOfFieldTranslations. The field management data in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ DisplayName. The display name of the field in the language identified by the language code. ■ ValidationErrorMsg. The custom validation error message in the language identified by the language code. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. For more information about field management, including field validation, see the Oracle CRM On Demand online help. Arguments Table 69 describes the arguments taken by the FieldManagementUpsert method. Table 69. Arguments Taken by the FieldManagementUpsert Method Name Description Required Default I/O apData:FieldSet The field management data to Yes Not Input be inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. HomepageLayoutReadAll Extracts all of the homepage layout configuration data for a company. Usage Use the HomepageLayoutReadAll method to read all of the homepage layouts. There is no input argument; the method simply returns all of the homepage layout data. The apdata:HomepageLayout element contains the following elements containing homepage layout data: 138 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 139. Web Services On Demand API Calls ■ Administrative Services API Calls ■ ObjectName. The name of the object. ■ LayoutName. The name of the homepage layout. ■ Description. A description of the homepage layout. ■ ListOfAvailableSection. Contains all of the available sections for the homepage layout. The data for a particular section is contained in the following elements: ■ SectionName. The name of the section. This is an applet name, such as AccountRecentlyApplet, rather than the display name of the section. ■ SectionLayoutName. The name of the section layout, such as MyRecentlyModifiedAccounts. ■ ListOfSelectedSection. Contains all of the selected sections for the homepage layout. The data for a particular section is contained in the following elements: ■ SectionName. The name of the section. This is an applet name, such as AccountRecently Applet, rather than the display name of the section. ■ SectionLayoutName. The name of the section layout, such as MyRecentlyModifiedAccounts. ■ Sequence. The sequence of the section within the lists of sections: ❏ A sequence value of -2 displays the section in the Available column. ❏ All positive even numbers, including 0 (zero) display the specified section in the Left Side column, where 0 (zero) represents the first section, and so on. ❏ All positive odd numbers display the section in the Right Side column, where a value of 1 represents the first section, and so on. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of section applet names to section names used in the Oracle CRM On Demand user interface. ■ Mappings of section layout names to section names used in the Oracle CRM On Demand user interface. ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. Arguments Table 70 describes the arguments taken by the HomepageLayoutReadAll method. Table 70. Arguments Taken by the HomepageLayoutReadAll Method Name Description Required Default I/O apData:ListOfHomepageLayout The extracted data for all Not Not Output homepage layouts. applicable applicable Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 139 Release 18)
- 140. Web Services On Demand API Calls ■ Administrative Services API Calls Return Value of the Call The homepage layouts are returned. PageLayoutFieldRead Extracts all of the field configuration data for a detail page of an object. Usage Use the PageLayoutFieldRead method to read the field data for an object’s detail page. The object is specified with the <ObjectName> child element of apQuery:PageLayout. Refer to “PageLayoutFieldUpsert” on page 141 for information about the page layout field data specified in apData:PageLayout. Arguments Table 71 describes the arguments taken by the PageLayoutFieldRead method. Table 71. Arguments Taken by the PageLayoutFieldRead Method Name Description Required Default I/O apQuery:PageLayout The page layout query Yes Not Input criteria. applicable apData:ListOfPageLayout The extracted page layout Not Not Output field data. applicable applicable Return Value of the Call The page layout fields are returned. PageLayoutFieldReadAll Extracts all of the field configuration data for detail pages for a company. Usage Use the PageLayoutFieldReadAll method to read all of the field data for detail pages. There is no input argument; the method simply returns all of the page layout field data. Refer to “PageLayoutFieldUpsert” on page 141 for information about the page layout field data specified in apData:PageLayout. 140 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 141. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 72 describes the arguments taken by the PageLayoutFieldReadAll method. Table 72. Arguments Taken by the PageLayoutFieldReadAll Method Name Description Required Default I/O apData:ListOfPageLayout The extracted page layout Not Not Output field data. applicable applicable Return Value of the Call The page layout fields are returned. PageLayoutFieldUpsert Updates existing page layout field data or inserts new page layout field data. Usage Use the PageLayoutFieldUpsert method to insert or update field data for a detail page layout. The apdata:PageLayout argument contains the following elements containing page layout field data: ■ ObjectName. The name of the object. ■ LayoutName. The name of the page layout. ■ Description. A description of the page layout. ■ ListOfPageLayoutField. Contains all of the fields for the page layout. The data for a particular field is contained in the following child elements of <PageLayoutField>: ■ FieldName. The name of the field. ■ ReadOnly. Whether the field is read-only. ■ Required. Whether the field is required. ■ Section. An integer identifying the section in which the field appears. The value 0 represents the first section, 1 the next section, and so on. ■ Column. The column within the section in which the field appears. The value 0 represents the left-most column. ■ Row. The row within the section in which the field appears. The value 0 represents the first row within a section and column, 1 the next row, and so on. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 141 Release 18)
- 142. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 73 describes the arguments taken by the PageLayoutFieldUpsert method. Table 73. Arguments Taken by the PageLayoutFieldUpsert Method Name Description Required Default I/O apData:PageLayout The page layout field data to be Yes Not Input inserted or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. PageLayoutRelatedInformationReadAll Extracts all of the related information for detail page layouts for a company. Usage Use the PageLayoutRelatedInformationReadAll method to read all of the related information data for detail page layouts. There is no input argument; the method simply returns all of the related information. Refer to “PageLayoutRelatedInformationUpsert” on page 143 for information about the page layout related information specified in apData:PageLayoutRelatedInformation. Arguments Table 74 describes the arguments taken by the PageLayoutRelatedInformationReadAll method. Table 74. Arguments Taken by the PageLayoutRelatedInformationReadAll Method Name Description Required Default I/O apData:ListOfPageLayoutRelate The extracted page layout Not Not Output dInformation related information. applicable applicable Return Value of the Call The page layout related information is returned. 142 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 143. Web Services On Demand API Calls ■ Administrative Services API Calls PageLayoutRelatedInformationUpsert Updates existing page layout related information or inserts new page layout related information. Usage Use the PageLayoutRelatedInformationUpsert method to insert or update related information for a detail page layout. The apdata:PageLayoutRelatedInformation argument contains the following elements containing related information for a page layout: ■ ObjectName. The name of the object. ■ LayoutName. The name of the page layout. ■ ListOfPageRelatedInformation. Contains all of the related information for the page layout. The data for a particular related information section is contained in the following child elements of <PageRelatedInformation>: ■ Name. A child object ID, equivalent to the name of a related information section. See the Oracle Migration Tool On Demand Guide for reference tables about the mapping of child object IDs to UI display names for the child objects. ■ Availability. An integer with the range of values -1 through 1, specifying in which list the related information appears in the page layout: Not Available, Available, or Displayed respectively. For values of 1 (Displayed), the order of the <PageRelatedInformation> elements determines the order in which the related information sections are listed in the layout in the UI. ■ RelatedInformationLayout. The name of the corresponding related information layout. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. Arguments Table 75 describes the arguments taken by the PageLayoutRelatedInformationUpsert method. Table 75. Arguments Taken by the PageLayoutRelatedInformationUpsert Method Name Description Required Default I/O apData:PageLayoutRelat The page layout related Yes Not Input edInformation information to be inserted or applicable updated. Status The status of the call. Not Not Output applicable applicable Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 143 Release 18)
- 144. Web Services On Demand API Calls ■ Administrative Services API Calls Return Value of the Call The status is returned. PicklistRead Extracts picklist configuration data. Usage Use the PicklistRead method to extract picklist configuration data for an object. The object is specified with the <ObjectName> child element of apQuery:PicklistSet. Refer to “PicklistUpsert” on page 145 for information about the picklist data specified in apData:PicklistSet. Arguments Table 76 describes the arguments taken by the PicklistRead method. Table 76. Arguments Taken by the PicklistRead Method Name Description Required Default I/O apQuery:PicklistSet The picklist query criteria. Yes Not Input applicable apData:ListOfPicklistSet The extracted picklist data. Not Not Output applicable applicable Return Value of the Call The picklists for the object are returned. PicklistReadAll Extracts all of the picklist configuration data for a company. Usage Use the PicklistReadAll method to read all of the picklists. There is no input argument; the method simply returns all of the picklist data. Refer to “PicklistUpsert” on page 145 for information about the picklist data specified in apData:PicklistSet. 144 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 145. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 77 describes the arguments taken by the PicklistReadAll method. Table 77. Arguments Taken by the PicklistReadAll Method Name Description Required Default I/O apData:ListOfPicklistSet The extracted data for all Not Not Output picklists for all objects. applicable applicable Return Value of the Call The picklists are returned. PicklistUpsert Updates an existing set of picklists or inserts a new set of picklists. Usage Use the PicklistUpsert method to insert a set of picklists or update an existing set of picklists for an object. The object is specified with the <ObjectName> element of apdata:PicklistSet. The apdata:PicklistSet argument contains the following elements containing picklist data: ■ Name. The name of the picklist. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <PicklistTranslation> element. ■ PickListValue. The picklist value. ■ ValueId. The number that determines the position of the value in the picklist. ■ Disabled. Whether the picklist value is disabled. ■ ListOfPicklistTranslation. The picklist value in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ Value. The picklist value in the language identified by the language code. ■ Order. The order number of the picklist value according to language identified by the language code. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. ■ Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 145 Release 18)
- 146. Web Services On Demand API Calls ■ Administrative Services API Calls Arguments Table 78 describes the arguments taken by the PicklistUpsert method. Table 78. Arguments Taken by the PicklistUpsert Method Name Description Required Default I/O apData:PicklistSet The picklist data to be inserted Yes Not Input or updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. RoleReadAll Extracts all of the role configuration data for a company. Usage Use the RoleReadAll method to read all of the roles. There is no input argument; the method simply returns all of the role data. Refer to “RoleUpsert” on page 147 for information about the role data specified in apData:Role. Arguments Table 79 describes the arguments taken by the RoleReadAll method. Table 79. Arguments Taken by the RoleReadAll Method Name Description Required Default I/O apData:ListOfRole The extracted data for all roles Not Not Output for all objects. applicable applicable Return Value of the Call The roles are returned. 146 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 147. Web Services On Demand API Calls ■ Administrative Services API Calls RoleUpsert Updates an existing roles or inserts a new role. Usage Use the RoleUpsert method to insert a role or update an existing role. The role is specified with the <RoleName> element of apdata:Role. The apdata:Role argument contains the following elements containing role data: ■ RoleName. The name of the role. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <RoleTranslation> element. ■ Description. The role description. ■ DefaultSalesProcess. The default sales process for new opportunities created by users who are assigned this role. ■ ThemeName. The default theme for the role. ■ LeadConversionLayout. The lead conversion layout for the users assigned this role. ■ ActionBarLayout. The action bar layout for the users assigned this role. ■ ListOfRoleTranslation. The role name in the languages activated for your company: ■ LanguageCode. The three-letter language code for the language. ■ RoleName. The role name in the language identified by the language code. ■ ListOfRecordTypeAcess. The record type access data: ■ RecordName. The record type. ■ HasAccess. Whether users assigned this role have access to records of this type. ■ CanCreate. Whether users assigned this role can create records of this type. ■ CanReadAll. Whether users assigned this role can see all records of this type. ■ AccessProfile. The access profiles associated with the role: ■ DefaultAccessProfile. The default access profile. ■ OwnerAccessProfile. The owner access profile. ■ ListOfPrivilege. The privileges associated with the role: ■ PrivilegeName. A privilege ID, equivalent to the name of a privilege in the Oracle CRM On Demand application. See the Oracle Migration Tool On Demand Guide for reference tables about the mapping of privilege IDs to UI display names for the privileges. ■ Enabled. Whether the privilege is assigned to the role. ■ TabAccessandOrder. The tabs available and selected for the role: ■ ListOfAvailableTab. The available tabs: ❏ AvailableTab. The name of the tab. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 147 Release 18)
- 148. Web Services On Demand API Calls ■ Administrative Services API Calls ■ ListOfSelectedTab. The selected tabs: ❏ TabName. The name of the tab. ❏ Order. The position in which the tab name appears in the Selected Tabs list. A value of 0 (zero) corresponds to the first tab in the Selected Tabs list. ■ ListOfPageLayoutAssignment. The page layout assignment for each record type: ■ RecordType. The record type. ■ LayoutName. The name of the page layout. If no name is specified, the default layout is applied. ■ ListOfSearchLayoutAssignment. The search layout assignment for each record type: ■ RecordType. The record type. ■ LayoutName. The name of the search layout. ■ ListOfHomepageLayoutAssignment. The homepage layout assignment for each record type: ■ RecordType. The record type. ■ LayoutName. The name of the homepage layout. See the Oracle Migration Tool On Demand Guide for reference tables about the following: ■ Mappings of three-letter language codes to languages. ■ Information on privilege IDs, and their corresponding names, and descriptions. Arguments Table 80 describes the arguments taken by the RoleUpsert method. Table 80. Arguments Taken by the RoleUpsert Method Name Description Required Default I/O apData:Role The role data to be inserted or Yes Not Input updated. applicable Status The status of the call. Not Not Output applicable applicable Return Value of the Call The status is returned. 148 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 149. Web Services On Demand API Calls ■ Data Loader API Calls Data Loader API Calls In Oracle CRM On Demand you can use the Oracle Data Loader On Demand tool to perform bulk data import operations. Client applications can also take advantage of the API used by the tool to make Web services calls to submit bulk import requests. Users with the Admin Import privilege can download the Oracle Data Loader On Demand tool from the application. When you download the tool, a WSDL file is provided as part of the .zip file: OracleDataLoaderOnDemandImportServices.wsdl. Table 81 lists the calls available with the Data Loader API. Table 81. Calls Available in the Data Loader API Name Description BulkOpImportCreateRequest Creates a bulk import request. BulkOpImportSendData Imports the data. The BulkOpImportCreateRequest call must be made before BulkOpImportSendData. Subsequently, BulkOpImportSendData calls can be made repeatedly to send data for importing. BulkOpImportGetRequestDetail Gets the details of a bulk import request. BulkOpImportCreateRequest Creates a bulk import request. Usage Use the BulkOpImportCreateRequest method to create a bulk import request. The arguments taken by the method correspond to elements in the WSDL file, as described in Table 82. The xsdLocal1:ImportOptions argument specifies the import options, which are similar to the options available in the Import Wizard in the Oracle CRM On Demand application: ■ CSVDelimiter. The type of CSV delimiter used in the file: comma (,) or semi-colon (;). ■ DateTimeFormat. The date and time format used in the CSV file: usa, can, eur, uk, other. ■ DuplicateCheckOption. Whether the Row Id (rowid) or external ID (externalid) are used for duplicate checking. ■ ErrorLogLevel. The level of error logging: ■ all. All messages ■ errors. Error messages only. ■ errorswarnings. Error messages and warning messages only. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 149 Release 18)
- 150. Web Services On Demand API Calls ■ Data Loader API Calls Typical customer import data is contained in a CSV file with the following format: ColumnName1, ColumnName2, ... Data1, Data2, ... Data1, Data2, ... ... The xsdLocal1:ListOfFieldMappings element specifies the mapping of CSV column names to field names in Oracle CRM On Demand. For example: <ns1:ListOfFieldMappings> <ns1:FieldMapping> <ns1:CSVColumnName> Web Site </ns1:CSVColumnName> <ns1:FieldName> Home Page </ns1:FieldName> </ns1:FieldMapping> </ns1:ListOfFieldMappings> CSVColumnHeaders specifies the list of CSV column names, for example: <ns0:CSVColumnHeaders> "Account Name","External Unique Id","Web Site","Account Location" </ns0:CSVColumnHeaders> The mappings are validated and if everything is correct, the import request is created. 150 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 151. Web Services On Demand API Calls ■ Data Loader API Calls Arguments Table 82 describes the arguments taken by the BulkOpImportCreateRequest method. Table 82. Arguments Taken by the BulkOpImportCreateRequest Method Name Description Required Default I/O DataFileName The name of the data file to be Yes Not Input imported, for example, applicable account1.csv RecordType The record type to be imported. Yes Not Input applicable xsdLocal1:ImportOptions The list of import options. No Not Input applicable xsdLocal1:ListOfFieldMap The mapping of CSV file column Yes Not Input pings names and their corresponding applicable fields. CSVColumnHeaders The list of column names from Yes Not Input the CSV file. applicable Operation The operation for the current Yes Not Input request, such as insert, update. applicable ClientVersion The current Data Loader client No Not Input version number. applicable RequestId The ID of the request created. Not Not Output applicable applicable Status The status of this Web service Not Not Output request. applicable applicable ErrorMessage Any error message from this Not Not Output Web service request, or a applicable applicable message indicating success. Return Value of the Call The request ID, status, and any error message are returned. BulkOpImportSendData Imports the data for a bulk import request. Usage Use the BulkOpImportSendData method to import the data for a bulk import request. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 151 Release 18)
- 152. Web Services On Demand API Calls ■ Data Loader API Calls The BulkOpImportCreateRequest call must be invoked before BulkOpImportSendData by the client. ... The ListOfCSVData element specifies the row data from the CSV file. For example: <ns1:ListOfCSVData> <ns1:CSVData> <ns1:Row> "High Quality Moving Company","HQMC","www.highmoving.net","San Jose" </ns1:Row> </ns1:CSVData> </ns1:ListOfCSVData> The CSV data is processed and the actual import performed. Arguments Table 83 describes the arguments taken by the BulkOpImportSendData method. Table 83. Arguments Taken by the BulkOpImportSendData Method Name Description Required Default I/O RequestId The request ID that was Yes Not Input/ created. applicable Output TotalNumberOfCSVDataLists The total number of Yes Not Input BulkOpImportSendData applicable calls needed to send all CSV file data. xsdLocal1:ListOfCSVData The actual list of CSV data Yes Not Input contained in the CSV file. applicable StartRecordNumber The starting line number of Yes Not Input the CSV data. applicable ClientVersion The current data loader No Not Input client version number. applicable Status The status of this Web Not Not Output service call. applicable applicable ErrorMessage Any error message from this Not Not Output Web service call, or a applicable applicable message indicating success. 152 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 153. Web Services On Demand API Calls ■ Data Loader API Calls Return Value of the Call The request ID, status, and any error message are returned. BulkOpImportGetRequestDetail Gets the details of a bulk import request. Usage Use the BulkOpImportGetRequestDetail method to get the details of a bulk import request, which is identified by the RequestId argument. Arguments Table 84 describes the arguments taken by the BulkOpImportGetRequestDetail method. Table 84. Arguments Taken by the BulkOpImportGetRequestDetail Method Name Description Required Default I/O RequestId The request ID. Yes Not Input/ applicable Output ClientVersion The current data loader client No Not Input version number. applicable RequestStatus The status of the request. Not Not Output applicable applicable RecordType The record type of the request. Not Not Output applicable applicable RequestedBy The requestor of the request. Not Not Output applicable applicable CompletionTime The time and date the request Not Not Output completed. applicable applicable RequestTime The time and date the request Not Not Output was submitted to be processed. applicable applicable NumberSubmitted The number of records to be Not Not Output imported by the request. applicable applicable NumberProcessed The number of records Not Not Output processed by the request. applicable applicable NumberPartialImported The number of records partially Not Not Output imported by the request. applicable applicable Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 153 Release 18)
- 154. Web Services On Demand API Calls ■ Data Loader API Calls Table 84. Arguments Taken by the BulkOpImportGetRequestDetail Method Name Description Required Default I/O NumberNotImported The number of records not Not Not Output imported by the request. applicable applicable NumberSuccessImported The number of records Not Not Output successfully imported by the applicable applicable request. Status The status of this Web service Not Not Output call. applicable applicable ErrorMessage Any error message from this Not Not Output Web service call. applicable applicable Return Value of the Call The output arguments. 154 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 155. 7 Oracle CRM On Demand Objects Exposed Through Web Services This chapter contains reference information about the objects exposed through the Web Services On Demand API. These objects correspond to record types and enable access to data stored within an instance of Oracle CRM On Demand. This chapter contains the following topics: ■ “Reference Information About the Parent Objects” on page 155 ■ “Parent Objects (Web Services v1.0)” on page 158 ■ “Child Objects (Web Services v1.0)” on page 290 ■ “Core Parent Objects (Web Services v2.0)” on page 297 ■ “Partner Relationship Management Edition Objects (Web Services v2.0)” on page 338 ■ “Life Sciences Edition Parent Objects (Web Services v2.0)” on page 376 ■ “Financial Services Edition Parent Objects (Web Services v2.0)” on page 424 ■ “Automotive Edition Parent Objects (Web Services v2.0)” on page 456 ■ “Child Objects (Web Services v2.0)” on page 461 Reference Information About the Parent Objects The reference information about the parent objects (starting with “Account” on page 159) includes: ■ A description of each object, as well as information on usage of the object. ■ Information about the relationships between objects; for each object, the associated parent and child objects are listed ■ The methods that can be invoked to insert, update, delete, and find data. For more information on these methods, see Chapter 6, “Web Services On Demand API Calls.” ■ The fields that are exposed for the objects: ■ The required and read-only fields ■ The user keys, see “Oracle CRM On Demand User Keys” on page 156 ■ The audit fields, see “Audit Fields” on page 156 ■ The status key, see “Oracle CRM On Demand Status Keys” on page 157 ■ The pick map fields, see “Oracle CRM On Demand Pick Maps” on page 157 ■ For Web Services v1.0 only, the filterable fields, see “Filterable Fields” on page 158 ■ The picklist fields Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 15 5 Release 18)
- 156. Oracle CRM On Demand Objects Exposed Through Web Services ■ Reference Information About the Parent Objects Oracle CRM On Demand User Keys A user key is a field or group of fields that uniquely identifies a record. Generally, a subset of the record’s fields are used as a user key. However, one field on its own can act as a user key, depending on whether the field can identify the record as unique. Each user key can be used independently to identify a record. The most basic user key is the single field ObjectId; for example, for the user object the UserId field is a user key. Every record in the database has at least the following independent user keys: ■ ObjectId ■ ExternalSystemId. In addition, there are various field combinations for different objects that can also be used to define uniqueness. It is only possible to query for or update a particular record in a table if the values of all the fields in any user key are known. In some instances, the ObjectId or ExternalSystemId of a record might not be known, but the values for some other user key might be known, in which case the record can be successfully queried or updated using that user key. For example, for a Note child object, the Subject and Description fields form a user key, because they can be used in conjunction with each other to determine whether the record is unique or not. Such a combination is not guaranteed to provide complete uniqueness, but it can be used to query for uniqueness. The user keys for each object are detailed for each object in “Parent Objects (Web Services v1.0)” on page 158, and “Core Parent Objects (Web Services v2.0)” on page 297. Audit Fields The audit fields for an object provide information about who created an instance of the object, when it was created, who has last updated an instance of the object, and when it was last updated. All objects, both parent and child level, exposed by the Web services API contain the read-only audit fields contained in Table 85. Table 85. Audit Fields for the Oracle CRM On Demand Objects Field Name Description CreatedBy This field is a combination of the full name of the person who created this instance of the object, and the date on which the instance was created. This information is contained within the field in the following format: “Creator Full Name, CreatedDate” CreatedById The Row ID of the user who created the record. CreatedDate The DateTime stamp of when the record was created. 156 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 157. Oracle CRM On Demand Objects Exposed Through Web Services ■ Reference Information About the Parent Objects Table 85. Audit Fields for the Oracle CRM On Demand Objects Field Name Description ModifiedBy This field is a combination of the full name of the person who modified this instance of the object, and the date on which the instance was modified. This information is contained within the field in the following format: “Modified By Full Name, ModifiedDate” ModifiedById The Row ID of the user who last modified the record. ModifiedDate The DateTime stamp of when the record was last modified. Oracle CRM On Demand Status Keys An Oracle CRM On Demand status key is a field or a number of fields that is returned following an operation on an Oracle CRM On Demand object. The status key of objects contained through the Web services API contains all user key and audit fields in addition to some other fields that are identified as status keys for the object. For Web Services v2.0, the Id, CreatedBy, CreatedById, CreatedDate, ModifiedBy, ModifiedById, ModifiedDate and ModId fields are status keys. The ModId field is the modification key, which can be used with all Web Services v2.0 API methods apart from QueryPage. If this key is specified in the request, it helps check and protect against concurrent updates. The status keys for the Oracle CRM On Demand objects are outlined in “Parent Objects (Web Services v1.0)” on page 158 and “Core Parent Objects (Web Services v2.0)” on page 297. Oracle CRM On Demand Pick Maps An Oracle CRM On Demand pick map allows you to set a foreign key for an object using a different field from the foreign key field. For example, when updating an account, you might want to set the owner of the account to a specific user. If the UserId of the user is known it can be set in the OwnerId field, which is the foreign key. However, if the UserId is not known, and only the alias of the user is known, that alias can be entered in the Owner field, which is a pick map field. When Oracle CRM On Demand recognizes that the Owner field has been set, it automatically sets the OwnerId field to the UserId for the user. Pick maps can be used by a number of Oracle CRM On Demand objects to update foreign key references in this way. For each object, a list of pick map fields, and the foreign key fields that they map to, are detailed in “Parent Objects (Web Services v1.0)” on page 158 and “Core Parent Objects (Web Services v2.0)” on page 297. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 157 Release 18)
- 158. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Filterable Fields A filterable field is a field in which you can apply a search query. For the Web Services V1.0 API, all fields in parent objects are filterable and some fields on child objects are filterable; these fields are shown in the tables of filterable fields for each object in “Parent Objects (Web Services v1.0)” on page 158. For the Web Services V2.0 API, all fields in parent objects are filterable. Parent Objects (Web Services v1.0) The following Oracle CRM On Demand objects are detailed in this topic: ■ “Account” on page 159 ■ “Activity” on page 178 ■ “Asset” on page 187 ■ “Book” on page 189 ■ “Campaign” on page 192 ■ “Contact” on page 201 ■ “Current User” on page 220 ■ “CustomObject1 - CustomObject3” on page 222 ■ “Dealer” on page 231 ■ “Household” on page 235 ■ “Lead” on page 239 ■ “MedEd” on page 246 ■ “Note” on page 249 ■ “Opportunity” on page 251 ■ “Portfolio” on page 263 ■ “Product” on page 268 ■ “Product Category” on page 270 ■ “Service Request” on page 272 ■ “Solution” on page 277 ■ “Territory” on page 280 ■ “User” on page 282 ■ “User Group” on page 285 ■ “Vehicle” on page 287 158 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 159. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Account The account object stores information about the companies that you do business with and is also used to track partners and competitors. The methods called on the account object require a list (array) of account objects as an input argument. This list of accounts identifies the records on which the operation is to be carried out. Usage It is important to understand the purpose of the following interfaces in the Account Web Service for accessing contact data related to accounts: ■ ListofAccountContact. Use this interface if you need to access or update a unique account- contact relationship, where there is only one record for each related {Account, Contact} pair. ■ ListOfContactRole. Use this interface if you need to access or update a unique account-contact- role relationship, where there is only one record for each {Account, Contact, Role} triple. There can be multiple rows for each {Account, Contact} pair (one for each role). ■ ListofContact. Use this interface for regular account-contact relationships. Parent Objects Account, CustomObject1 - CustomObject3 Child Components Activity, Address, Asset, Attachment, Book, Competitor, Contact, CustomObject3, Lead, Multiple Contact Roles, Note, Opportunity, PortfolioTeam, Related Account, Revenue, Service Request, and Team. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Methods Called Table 86 details the methods called by the Account service. Table 86. Methods Called by Account Service Method Name as Defined in Service “Delete” on page 63 AccountDelete “DeleteChild” on page 66 AccountDeleteChild “Insert” on page 67 AccountInsert “InsertChild” on page 68 AccountInsertChild “InsertOrUpdate” on page 68 AccountInsertOrUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 159 Release 18)
- 160. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 86. Methods Called by Account Service Method Name as Defined in Service “QueryPage” on page 69 AccountQueryPage “Update” on page 78 AccountUpdate “UpdateChild” on page 79 AccountUpdateChild Fields Table 87 details the required and read-only fields for the account object. Table 87. Required and Read-Only Fields for the Account Object Child Component Field Name Type Account (parent) AccountName Required AccountConcatField Read-only Audit Fields Read-only Activity AccountLocation Read-only CreatedDetail Read-only MEEventName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only DescriptionShadow Read-only DealerName Read-only Audit Fields Read-only 160 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 161. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 87. Required and Read-Only Fields for the Account Object Child Component Field Name Type Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only AccountId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Contact Age Read-only OwnerFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only LastActivityDate Read-only FirstNameShadow Read-only LastNameShadow Read-only CustomObject3 AccountCustomObject3CreatedById Read-only AccountCustomObject3CreatedDate Read-only AccountCustomObject3ModifiedById Read-only AccountCustomObject3ModifiedDate Read-only CustomObject3Id Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 161 Release 18)
- 162. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 87. Required and Read-Only Fields for the Account Object Child Component Field Name Type Lead OwnerFullName Read-only SalesRepFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only ReferredByFullName Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only FirstNameShadow Read-only LastNameShadow Read-only CompanyNameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Multiple Contact Roles ContactRole Required ContactId Required Audit Fields Read-only Opportunity OwnerFullName Read-only PrimaryRevenueExpectedValue Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only FuriganaAccountName Read-only NameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only RelatedAccount AccountRelationshipId Read-only RelatedAccountId Read-only 162 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 163. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 87. Required and Read-Only Fields for the Account Object Child Component Field Name Type Revenue RevenueId Required PartNumber Required Revenue Required ContactFullName Required Audit Fields Read-only ServiceRequest Name Read-only OwnerFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only LastAssessmentDate Read-only AssignmentStatus Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only SRNumberShadow Read-only AbstractShadow Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Table 88 details the status key for the account object, and the child component on which this key resides. Table 88. Status Key for the Account Object Child Component Field Name Account (parent) Audit Fields ExternalSystemId AccountId IntegrationId LastUpdated Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 163 Release 18)
- 164. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 88. Status Key for the Account Object Child Component Field Name AccountNote Audit Fields ExternalSystemId AccountNoteId IntegrationId AccountTeam Audit Fields AccountTeamId Activity Audit Fields ExternalSystemId ActivityId IntegrationId Asset Audit Fields ExternalSystemId AssetId IntegrationId Attachment Audit Fields Id AccountId ModId Book Audit Fields BookId ModId Competitor Audit Fields AccountCompetitorId CompetitorExternalId CompetitorId CompetitorIntegrationId Contact Audit Fields AccountId ContactId ExternalSystemId IntegrationId 164 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 165. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 88. Status Key for the Account Object Child Component Field Name CustomObject3 AccountCustomObject3CreatedById AccountCustomObject3CreatedDate AccountCustomObject3ModifiedById AccountCustomObject3ModifiedDate Lead Audit Fields AccountId ContactId ExternalSystemId IntegrationId LeadId OpportunityId Opportunity Audit Fields AccountId ExternalSystemId IntegrationId OpportunityId RelatedAccount Audit Fields AccountRelationshipId Revenue Audit Fields ExternalId IntegrationId RevenueId ServiceRequest Audit Fields AccountId ContactId ExternalSystemId IntegrationId ServiceRequestId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 165 Release 18)
- 166. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 88. Status Key for the Account Object Child Component Field Name Partner Audit Fields AccountPartnerId PartnerExternalId PartnerId PartnerIntegrationId Updated Table 89 details the pick map fields for the account object and the child objects on which they reside. Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To Account (parent) Owner OwnerId ParentAccount, ParentAccountLocation ParentAccountId ParentAccountIntegrationId ParentAccountId ParentAccountExternalSystemId ParentAccountId 166 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 167. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To Activity AccountIntegrationId AccountId AccountExternalId AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId DelegatedBy DelegatedById FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Asset AccountIntegrationId AccountId Manufacturer ManufacturerId PreferredServiceDealer PreferredServiceDeale rID Book BookName BookId Competitor RelatedAccountExternalId RelatedAccountId RelatedAccountSystemId RelatedAccountId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 167 Release 18)
- 168. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To Contact AccountExternalId AccountId AccountIntegrationId AccountId AccountName AccountId ManagerExternalId ManagerId ManagerIntegrationId ManagerId OwnerEmailAddress OwnerId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SourceCampaignName SourceCampaignId SourceCampaignExternalId SourceCampaignId TimeZoneName TimeZoneId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id CustomObject3 Owner OwnerId 168 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 169. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To Lead AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId AccountName AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId ContactExternalId ContactId ContactIntegrationId ContactId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SalesRepAlias SalesRepId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Multiple Contact ContactIntegrationId ContactId Roles ContactExternalId ContactId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 169 Release 18)
- 170. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To Opportunity AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId SourceCampaignExternalId CampaignId SourceCampaign CampaignId KeyContactExternalId KeyContactId KeyContactLastName KeyContactId DealerExternalId DealerId OwnerAlias OwnerId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Partner RelatedAccountExternalId RelatedAccountId RelatedAccountIntegrationId RelatedAccountId Related Account RelatedAccountExternalId RelatedAccountId RelatedAccountIntegrationId RelatedAccountId Revenue Product ProductId ProductExternalId ProductId ProductIntegrationId ProductId ProductCategory ProductCategoryId ProductCategoryExternalId ProductCategoryId ProductCategoryIntegrationId ProductCategoryId Service Request AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId AssetExternalId AssetId Dealer DealerId ContactExternalId ContactId ContactIntegrationId ContactId 170 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 171. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 89. Pick Map Fields for the Account Object Child Component Pick Map Field Maps To DealerExternalId DealerId OwnerExternalId OwnerId OwnerIntegrationId OwnerId OwnerAlias OwnerId Product ProductId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Table 90 provides a list of the filterable fields for the child components of the account objects, and a list of the user key combinations for each child component. Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Account (parent) All AccountId IntegrationId ExternalSystemId AccountName and Location Account Note Subject Subject and Description Account Team FirstName FirstName and Last Name LastName UserID UserID UserRole AccountAccess OpportunityAccess ContactAccess ModifiedDate ModifiedByID Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 171 Release 18)
- 172. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Activity CallType IntegrationId ActivityId ExternalSystemId Address AddressId AddressId ExternalId ExternalId IntegrationId IntegrationId City Country ModifiedDate Province StateProvince ZipCode Asset AssetId AssetId Contract Date ModifiedDate PartNumber ProductCategory Product ProjectManager PurchaseDate Price Quantity SalesRep SerialNumber ShipDate Status Type Warranty 172 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 173. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Contact AccountContactModifiedById ContactId AccountContactModifiedDate Id ContactType ContactFirstName ContactId ContactLastName Id JobTitle Owner RelationshipType RelationshipModifiedDate RelationshipModifiedById Competitor ModifiedDate CompetitorId CustomObject3 AccountCustomObject3ModifiedById CustomObject3Id AccountCustomObject3ModifiedDate ExternalSystemId CustomObject3Id SystemId CustomObject3Name ExternalSystemId IntegrationId Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 173 Release 18)
- 174. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Lead Campaign Id EstimatedCloseDate LeadId Rating Source Status LeadOwner PotentialRevenue ProductInterest SalesPerson LeadId Id Multiple Contact ContactId ContactId Roles ContactExternalId ContactIntegrationId ContactIntegrationId ContactExternalId ContactRole ModifiedDate Opportunity Owner OpportunityId Revenue Id CloseDate Forecast ExpectedRevenue Probability Priority ReasonWonLost Status OpportunityId Id 174 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 175. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Related Account AccountRelationshipId AccountRelationshipId Comments RelatedAccountId EndDate RelatedAccountExternalId ModifiedDate RelatedAccountIntegrationId RelatedAccountExternalId RelatedAccountId RelatedAccountIntegrationId RelationshipRole RelationshipStatus RelationshipType ReverseRelationshipRole StartDate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 175 Release 18)
- 176. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Revenue ContactFullName RevenueId Description ProductId ExternalId ProductExternalId IntegrationId ProductIntegrationId Forecast Frequency ModifiedDate NumberOfPeriods Product ProductCategoryId ProductCategoryExternalId ProductCategoryIntegrationId ProductExternalId ProductId ProductIntegrationId PurchasePrice Quantity Revenue RevenueId StartCloseDate Status Type 176 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 177. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 90. Filterable Fields and User Key Fields on the Account Object’s Child Components Child Components Filterable Fields User Key Field Combinations Service Request Subject Id Area ServiceRequestId Owner Priority Type Cause Source Status Id ServiceRequestId Table 91 details the picklists available for the account object. Table 91. Picklists Available for the Account Object Child Component Field Name Account (parent) AccountType Priority Region CallFrequency InfluenceType Route Status MarketPotential MarketingSegment Account Team TeamRole Competitor Role Multiple Contact Roles ContactRole Partner Role RelatedAccount Relationship Status Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 177 Release 18)
- 178. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 91. Picklists Available for the Account Object Child Component Field Name Revenue Type Status Frequency For more information on the fields exposed through the Account Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the account object. Related Topic Contact Activity The activity object stores information on an activity that a user must carry out, for example, a call- back activity for an account. When an activity is created, the user must set the Activity field explicitly to Task or Appointment. Usage Oracle On Demand Web Services uses activities to organize, track, and resolve a variety of tasks, from finding and pursuing opportunities to closing service requests. If a task requires multiple steps that one or more people can carry out, activities greatly simplify the job. Activities can help to: ■ Define and assign the task ■ Provide information to complete the task ■ Track the progress of the task ■ Track costs and bill for the task Parent Objects Account, Campaign, Contact, Lead, Opportunity, and Service Request Child Components Attachment, Book, Contact, ProductsDetailed, SampleDropped, Solution, and User. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. 178 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 179. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 92 details the methods called by the Activity service. Table 92. Methods Called by Activity Service Method Name as Defined in Service “Delete” on page 63 ActivityDelete “DeleteChild” on page 66 ActivityDeleteChild “Insert” on page 67 ActivityInsert “InsertChild” on page 68 ActivityInsertChild “InsertOrUpdate” on page 68 ActivityInsertOrUpdate “QueryPage” on page 69 ActivityQueryPage “Update” on page 78 ActivityUpdate “UpdateChild” on page 79 ActivityUpdateChild Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 179 Release 18)
- 180. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 93 details the required and read-only fields for the activity object. Table 93. Required and Read-Only Fields for the Activity Object Child Component Field Name Type Activity (parent) Subject Required Activity Required ActivityId Read-only AddressId Read-only CallType Read-only ContactFirstName Read-only ContactLastName Read-only LeadFirstName Read-only LeadLastName Read-only MedEdEventName Read-only OpportunityName Read-only FundRequest Read-only SmartCall Read-only AssignedQueue Read-only QueueHoldTime Read-only QueueStartTime Read-only TotalHoldTime Read-only ResolutionCode Read-only Audit Fields Read-only Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only ActivityId Read-only Id Read-only ModId Read-only Audit Fields Read-only 180 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 181. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 93. Required and Read-Only Fields for the Activity Object Child Component Field Name Type Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Contact ContactId Read-only ContactFirstName Read-only ContactLastName Read-only ContactAccountId Read-only ContactAccountName Read-only ContactAccountLocation Read-only ContactAccountIntegrationId Read-only ContactAccountExternalSystemId Read-only Audit Fields Read-only ProductDetailed ProductId Required Indication Required ProductDetailedId Read-only SampleDropped ProductId Required Quantity Required SampleDroppedId Read-only Audit Fields Read-only User UserId Read-only UserEmail Read-only UserFirstName Read-only UserLastName Read-only UserRole Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 181 Release 18)
- 182. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 94 details the status key for the activity object. Table 94. Status Key for the Activity Object Child Component Field Name Activity (parent) Audit Fields ActivityId ExternalSystemId IntegrationId Attachment Audit Fields Id ActivityId Book Audit Fields BookId ModId Contact Audit Fields ActivityContactId ContactIntegrationId ContactExternalSystemId ContactId User Audit Fields Id UserExternalId UserIntegrationId ProductDetailed Audit Fields ProductDetailedId ExternalId SampleDropped Audit Fields SampleDroppedId ExternalId Solution Audit Fields SolutionId ExternalId 182 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 183. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 95 details the pick map fields for the activity object and the child objects on which they reside. Table 95. Pick Map Fields for the Activity Object Child Component Pick Map Field Maps To Activity (parent) AccountName AccountId AccountLocation AccountId AccountExternalSystemId AccountId AccountIntegration AccountId Owner OwnerId CampaignExternalSystemId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId LeadExternalSystemId LeadId LeadIntegrationId LeadId MedEdEventExternalSystemId MedEdEventId MedEdEventIntegrationId MedEdEventId OpportunityExternalSystemId OpportunityId OpportunityIntegrationId OpportunityId PortfolioExternalSystemId PortfolioId PortfolioIntegrationId PortfolioId ServiceRequestNumber ServiceRequestId ServiceRequestExternalSystemId ServiceRequestId ServiceRequestIntegrationId ServiceRequestId FundRequestExternalSystemId FundRequestId FundRequestIntegrationId FundRequestId Book BookName BookId Contact ContactExternalId ContactId ContactIntegrationId ContactId User UserExternalId UserId UserIntegrationId UserId SampleDropped ProductIntegrationId ProductId ProductExternalSystemId ProductId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 183 Release 18)
- 184. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 95. Pick Map Fields for the Activity Object Child Component Pick Map Field Maps To ProductDetailed ProductIntegrationId ProductId ProductExternalSystemId ProductId Solution ProductIntegrationId ProductId ProductExternalSystemId ProductId Table 96 provides a list of the filterable fields for the child components of the activity objects, and a list of the user key combinations for each child component. Table 96. Filterable Fields and User Key Fields on the Activity Object’s Child Components Child Components Filterable Fields User Key Field Combinations Activity (parent) All ActivityId IntegrationId ExternalSystemId Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Contact ContactId ContactId ContactExternalId ContactExternalId ContactIntegrationId ContactIntegrationId ContactFirstName ContactLastName ContactAccountId ContactAccountName ContactAccountLocation ContactAccountIntegrationId ContactAccountExternalSystemId ModifiedDate 184 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 185. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 96. Filterable Fields and User Key Fields on the Activity Object’s Child Components Child Components Filterable Fields User Key Field Combinations User ModifiedDate UserId UserId UserExternalId UserExternalId UserIntegrationId UserIntegrationId UserEmail UserFirstName UserLastName UserRole ProductDetailed ProductDetailedId ProductDetailedId ProductDetailedExternalSystemId ProductDetailedExternalSystemId ProductId ProductId ProductExternalSystemId ProductExternalSystemId ModifiedDate Name Indication SampleDropped SampleDroppedId SampleDroppedId SampleDroppedExternalSystemId SampleDroppedExternalSystemId ProductId ProductId ProductExternalSystemId ProductExternalSystemId ModifiedDate Quantity ProductName Solution SolutionId SolutionId SolutionExternalSystemId SolutionExternalSystemId ModifiedDate ProductLine PrimaryProductName Name ProductId ProductIntegrationId ProductExternalId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 185 Release 18)
- 186. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 97 details the picklists available for the activity object. Table 97. Picklists Available for the Activity Object Field Name AccountName AccountLocation AccountIntegrationId AccountExternalSystemId OpportunityName ServiceRequestNumber ServiceRequestIntegrationId ServiceRequestExternalSystemId DelegatedByExternalSystemId PrimaryContactIntegrationId PrimaryContactExternalSystemId MedEdEventIntegrationId MedEdEventExternalSystemId FundRequestExternalId LeadIntegrationId LeadExternalSystemId CampaignIntegrationId CampaignExternalSystemId ActivitySubtype ResolutionCode PublishInternal Status Issue Indication For more information on the fields exposed through the Activity Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object. 186 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 187. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Asset The asset object stores information on the assets held by your accounts, for example, the products that an account has purchased. The asset object has no child components. Usage Oracle On Demand Web Services uses assets to manage products through their life cycle. It is also used by your accounts to register products, receive product news and literature, track warranty agreements, and receive recommendations on scheduled services. Parent Objects Account and Contact. Methods Called Table 98 details the methods called by the Asset service. Table 98. Methods Called by Asset Service Method Name as Defined in Service “Delete” on page 63 AssetDelete “Insert” on page 67 AssetInsert “InsertOrUpdate” on page 68 AssetInsertOrUpdate “QueryPage” on page 69 AssetQueryPage “Update” on page 78 AssetUpdate Fields Table 99 details the required and read-only fields for the asset object. Table 99. Required and Read-Only Fields for the Asset Object Child Component Field Name Type Asset (parent) ProductId Required ProductCategory Read-only PartNumber Read-only Type Read-only Status Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 187 Release 18)
- 188. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 100 details the status key for the asset object. Table 100. Status Key for the Asset Object Child Component Field Name Asset (parent) Audit Fields AssetId IntegrationId ExternalSystemId Table 101 details the pick map fields for the asset object. Table 101. Pick Map Fields for the Asset Object Child Component Pick Map Field Maps To Asset (parent) AccountIntegrationId AccountId AccountExternalSystemId AccountId Account, AccountLocation AccountId ProductIntegrationId ProductId ProductExternalSystemId ProductId Product ProductId Table 102 provides a list of the filterable fields and a list of user key combinations for the asset object. Table 102. Filterable Fields and User Key Fields on the Asset Object’s Child Components Child Components Filterable Fields User Key Field Combinations Asset (parent) All AssetId IntegrationId ExternalSystemId 188 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 189. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 103 details the picklists available for the asset object. Table 103. Picklists Available for the Asset Object Field Name Warranty Contract For more information on the fields exposed through the Asset Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the asset object. Book The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books. NOTE: To download the Book WSDL, you must be given access to the Book object. If you do not have access to the Book object, it is not available to download from the Web Services Administration pages. For assistance in gaining access to the Book object, contact your Oracle CRM On Demand service provider. Parent Objects Account, Activity, Contact, Custom Object 1 - 3, Dealer, Household, Lead, Opportunity, Portfolio, Service Request. Child Components BookUser, SubBook. Methods Called Table 104 details the methods called by the Book service. Table 104. Methods Called by Book Service Method Name as Defined in Service “Delete” on page 63 BookDelete “DeleteChild” on page 66 BookDeleteChild Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 189 Release 18)
- 190. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 104. Methods Called by Book Service Method Name as Defined in Service “Insert” on page 67 BookInsert “InsertChild” on page 68 BookInsertChild “InsertOrUpdate” on page 68 BookInsertOrUpdate “QueryPage” on page 69 BookQueryPage “Update” on page 78 BookUpdate “UpdateChild” on page 79 BookUpdateChild Fields Table 105 details the required and read-only fields for the book object. Table 105. Required and Read-Only Fields for the Book Object Child Component Field Name Type Book (parent) BookName Required BookId Read-only Audit Fields Read-only BookUser UserId Required Audit Fields Read-only SubBook UserAlias Required AccessProfileName Required Table 106 details the status key for the book object. Table 106. Status Key for the Book Object Child Component Field Name Book (parent) Audit Fields BookId BookName BookUser Audit Fields BookId SubBook BookId UserId 190 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 191. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 107 details the pick map fields for the book object. Table 107. Pick Map Fields for the Book Object Child Component Pick Map Field Maps To Book BookName BookId BookUser BookName BookId SubBook BookName BookId Table 108 provides a list of the filterable fields for the child components of the book object, and a list of user key combinations for each child component. Table 108. Filterable Fields and User Key Fields on the Book Object’s Child Components Child Components Filterable Fields User Key Field Combinations Book (parent) All BookId BookName BookUser None BookId UserId SubBook None BookId BookName Table 109 details the picklists available for the book object. Table 109. Picklists Available for the Book Object Child Component Field Name Book (parent) BookType ParentBookName BookUser UserAlias BookRole AccessProfileName Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 191 Release 18)
- 192. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) For more information on the fields exposed through the Book Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the book object. Campaign The campaign object provides a mechanism for marketing products and services to customers and prospects. The campaign object is the primary way in which new products and services are marketed to customers and prospects. Parent Objects Contact, Lead Child Components Activity, Attachment, Contact/Recipient, Lead, Note, and Opportunity. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Methods Called Table 110 details the methods called by the Campaign service. Table 110. Methods Called by Campaign Service Method Name as Defined in Service “Delete” on page 63 CampaignDelete “DeleteChild” on page 66 CampaignDeleteChild “Insert” on page 67 CampaignInsert “InsertChild” on page 68 CampaignInsertChild “InsertOrUpdate” on page 68 CampaignInsertOrUpdate “QueryPage” on page 69 CampaignQueryPage “Update” on page 78 CampaignUpdate “UpdateChild” on page 79 CampaignUpdateChild 192 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 193. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 111 details the required and read-only fields for the campaign object. Table 111. Required and Read-Only Fields for the Campaign Object Child Object Field Name Type Campaign CampaignName Required SourceCode Required Audit Fields Read-only CreatedByFullName Read-only LastUpdated Read-only Activity AccountLocation Read-only CreatedDetail Read-only MEEventName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only DescriptionShadow Read-only Duration Read-only Audit Fields Read-only Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only CampaignId Read-only Id Read-only ModId Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 193 Release 18)
- 194. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 111. Required and Read-Only Fields for the Campaign Object Child Object Field Name Type Lead ContactFirstName Read-only ContactlastName Read-only LeadFullName Read-only OwnerFullName Read-only SalesRepFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only ReferredByFullName Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only FirstNameShadow Read-only LastNameShadow Read-only CompanyNameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Note Subject Required Audit Fields Read-only Opportunity OwnerFullName Read-only PrimaryRevenueExpectedValue Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only FuriganaAccountName Read-only ReassignOwnerFlag Read-only NameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Recipient ContactID Required ModifiedDate Read-only 194 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 195. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 112 details the status key for the campaign object. Table 112. Status Key for the Campaign Object Child Component Field Name Campaign (parent) Audit Fields ExternalSystemId Id IntegrationId Activity Audit Fields CampaignId ExternalSystemId Id IntegrationId Attachment Audit Fields Id CampaignId CampaignNote Audit Fields CampaignId ExternalSystemId Id IntegrationId LastUpdated Lead Audit Fields ExternalSystemId Id IntegrationId LastUpdated Opportunity Audit Fields ExternalSystemId Id IntegrationId LastUpdated Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 195 Release 18)
- 196. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 112. Status Key for the Campaign Object Child Component Field Name Recipient Audit Fields CampaignContactId ContactExtrernalId ContactIntegrationId ContactId Table 113 details the pick map field for the campaign object. Table 113. Pick Map Field for the Campaign Object Child Component Pick Map Field Maps To Campaign (parent) Owner OwnerId 196 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 197. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 113. Pick Map Field for the Campaign Object Child Component Pick Map Field Maps To Activity AccountIntegrationId AccountId AccountExternalId AccountId Address AddressId AssignedTo AssignedToId Campaign CampaignId CampaignExternalId CampaignId CampaignIntegrationId CampaignId Dealer DealerId DelegatedBy DelegatedById FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Lead AccountIntegrationId AccountId AccountLocation AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 197 Release 18)
- 198. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 113. Pick Map Field for the Campaign Object Child Component Pick Map Field Maps To CampaignName CampaignId ContactExternalId ContactId ContactIntegrationId ContactId OpportunityIntegrationId OpportunityId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SalesRepAlias SalesRepId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Opportunity AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId SourceCampaignExternalId CampaignId SourceCampaign CampaignId KeyContactExternalId KeyContactId KeyContactLastName KeyContactId DealerExternalId DealerId OwnerAlias OwnerId Territory TerritoryId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id 198 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 199. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 114 provides a list of the filterable fields for the child components of the campaign objects, and a list of user key combinations for each child component. Table 114. Filterable Fields and User Key Fields on the Campaign Object’s Child Components Child Components Filterable Fields User Key Field Combinations Campaign (parent) All CampaignId IntegrationId ExternalSystemID Activity Type Type and Description Owner Subject DueDate Priority Status Attachment None Id ExternalSystemId FileNameOrURL and FileExtension CampaignNote Subject Subject and Description Lead Campaign FirstName EstimatedCloseDate Description Rating Source Status LeadOwner PotentialRevenue ProductInterest SalesPerson Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 199 Release 18)
- 200. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 114. Filterable Fields and User Key Fields on the Campaign Object’s Child Components Child Components Filterable Fields User Key Field Combinations Opportunity Account OpportunityName Owner Revenue CloseDate Forecast ExpectedRevenue Probability Priority ReasonWonLost SalesStage Status Recipient ContactId None ModifiedDate Table 115 details the picklists available for the campaign object. Table 115. Picklists Available for the Campaign Object Child Component Field Name Campaign (parent) CampaignType Status Contact DeliveryStatus ResponseStatus For more information on the fields exposed through the Campaign Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the campaign object. Related Topic Current User and Opportunity 200 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 201. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Contact The contact object stores information on individuals with whom your organization has a relationship. It allows the user to store information on individuals who are external to your company, but who are associated with the business process. Contacts stored in the Oracle CRM On Demand database can also be associated with an account. Parent Objects Account, Activity, Campaign, CustomObject1 - CustomObject3, Opportunity, Portfolio, and Vehicle Child Components Account, Activity, Address, Asset, Attachment, Book, Campaign, CustomObject3, Interests, Lead, Note, Opportunity, Related Contact, Revenue, Service Request and Team. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Methods Called Table 116 details the methods called by the Contact service. Table 116. Methods Called by Contact Service Method Name as Defined in Service “Delete” on page 63 ContactDelete “DeleteChild” on page 66 ContactDeleteChild “Insert” on page 67 ContactInsert “InsertChild” on page 68 ContactInsertChild “InsertOrUpdate” on page 68 ContactInsertOrUpdate “QueryPage” on page 69 ContactQueryPage “Update” on page 78 ContactUpdate “UpdateChild” on page 79 ContactUpdateChild Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 201 Release 18)
- 202. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 117 details the required and read-only fields for the contact object. Table 117. Required and Read-Only Fields for the Contact Object Child Component Field Name Type Contact (parent) FirstName Required LastName Required AlternateAddressId Read-only ContactConcatField Read-only ContactFullName Read-only Audit Fields Read-only Manager Read-only PrimaryAddressId Read-only Account AccountId Read-only Activity AccountLocation Read-only Contact Read-only CreatedDetail Read-only MEEventName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only DescriptionShadow Read-only Audit Fields Read-only Address AddressId Read-only 202 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 203. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 117. Required and Read-Only Fields for the Contact Object Child Component Field Name Type Asset AssetId Required ContactAssetId Read-only ExternalSystemId Read-only Product Read-only ProductId Read-only ProductPartNumber Read-only ProductType Read-only ProductStatus Read-only CreatedByandDate Read-only ModifiedByandDate Read-only SerialNumber Read-only Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only ContactId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Campaign CampaignContactId Read-only Audit Fields Read-only Contact Team ContactTeamId Read-only UserFirstName Read-only UserLastName Read-only UserRole Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 203 Release 18)
- 204. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 117. Required and Read-Only Fields for the Contact Object Child Component Field Name Type CustomObject3 ContactCustomObject3CreatedById Read-only ContactCustomObject3CreatedDate Read-only ContactCustomObject3ModifiedById Read-only ContactCustomObject3ModifiedDate Read-only CustomObject3Id Read-only Interests Category Required Interests Required InterestId Read-only Lead ContactIntegrationId Read-only ContactExternalId Read-only OwnerFullName Read-only SalesRepFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only ReferredByFullName Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only FirstNameShadow Read-only LastNameShadow Read-only CompanyNameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only 204 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 205. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 117. Required and Read-Only Fields for the Contact Object Child Component Field Name Type Opportunity OwnerFullName Read-only PrimaryRevenueExpectedValue Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only FuriganaAccountName Read-only ReassignOwnerFlag Read-only NameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Related Contact ContactRelationshipId Read-only ContactId Read-only RelatedContactFirstName Read-only RelatedContactLastName Read-only Revenue RevenueId Required PartNumber Required Revenue Required ContactFullName Required Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 205 Release 18)
- 206. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 117. Required and Read-Only Fields for the Contact Object Child Component Field Name Type ServiceRequest Name Read-only OwnerFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only LastAssessmentDate Read-only AssignmentStatus Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only SRNumberShadow Read-only AbstractShadow Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Table 118 details the status key for the contact object. Table 118. Status Key for the Contact Object Child Component Field Name Contact (parent) Audit Fields AccountId ExternalSystemId Id IntegrationId LastUpdated Account Audit Fields Name and Location ExternalSystemId Activity Audit Fields ActivityExternalId ActivityId ActivityIntegrationId 206 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 207. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 118. Status Key for the Contact Object Child Component Field Name Asset Audit Fields Attachment Audit Fields Id ContactId Book Audit Fields BookId ModId Campaign Audit Fields CampaignContactId CampaignExternalSystemId CampaignId ModId ContactNote Audit Fields ContactId ExternalSystemId Id IntegrationId CustomObject3 CustomObject3Id ContactCustomObject3CreatedById ContactCustomObject3CreatedDate ContactCustomObject3ModifiedById ContactCustomObject3ModifiedDate Interests Audit Fields InterestId ExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 207 Release 18)
- 208. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 118. Status Key for the Contact Object Child Component Field Name Lead Audit Fields AccountId CampaignId ContactId ExternalSystemId IntegrationId LeadId OpportunityId Opportunity Audit Fields AccountId ExternalSystemId IntegrationId LeadId OpportunityId RelatedContact Audit Fields ContactRelationshipId RelatedContactId Revenue Audit Fields ExternalId IntegrationId RevenueId ServiceRequest Audit Fields AccountId ContactID ExternalSystemId IntegrationId ServiceRequestId 208 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 209. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 118. Status Key for the Contact Object Child Component Field Name Team Audit Fields ContactTeamId UserExternalSystemId UserId UserIntegrationId Table 119 details the pick map fields for the contact object. Table 119. Pick Map Fields for the Contact Object Child Component Pick Map Field Maps To Contact (parent) AccountName AccountId Owner AssignedToAlias SourceCampaignName SourceCampaignId ManagerExternalSystemId ManagerId Account ExternalSystemId AccountId Activity AccountIntegrationId AccountId AccountExternalId AccountId AssignedTo AssignedToId CampaignExternalId CampaignId CampaignIntegrationId CampaignId DelegatedBy DelegatedById Dealer DealerId FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 209 Release 18)
- 210. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 119. Pick Map Fields for the Contact Object Child Component Pick Map Field Maps To SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Asset ExternalSystemId AssetId IntegrationId AssetId AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId AccountName AccountId CustomerContactExternalSystemId ContactId Manufacturer ManufacturerId ProductExternalSystemId ProductId ProductPrimaryProductLine ProductPrimaryProductLi neId PreferredServiceDealer PreferredServiceDealerId Book BookName BookId Campaign CampaignExternalSystemId CampaignId CampaignName CampaignId Contact Team UserExternalSystemId UserId UserIntegrationId UserId CustomObject3 Owner OwnerId Interests InterestExternalSystemId InterestId 210 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 211. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 119. Pick Map Fields for the Contact Object Child Component Pick Map Field Maps To Lead AccountIntegrationId AccountId AccountLocation AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SalesRepAliasId SalesRepId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Opportunity AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId SourceCampaignExternalId CampaignId SourceCampaign CampaignId KeyContactExternalId KeyContactId KeyContactLastName KeyContactId DealerExternalId DealerId OwnerAlias OwnerId SalesStage SalesStageId Territory TerritoryId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Related Contact RelatedContactExternalId RelatedContactId RelatedContactIntegrationId RelatedContactId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 211 Release 18)
- 212. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 119. Pick Map Fields for the Contact Object Child Component Pick Map Field Maps To Revenue Product ProductId ProductExternalId ProductId ProductIntegrationId ProductId ProductCategory ProductCategoryId ProductCategoryExternalId ProductCategoryId ProductCategoryIntegrationId ProductCategory Service Request AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId AssetExternalId AssetId Dealer DealerId ContactExternalId ContactId ContactIntegrationId ContactId OwnerExternalId OwnerId OwnerIntegrationId OwnerId OwnerAlias OwnerId Product ProductId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Table 120 provides a list of the filterable fields for the child components of the contact objects, and a list of user key combinations for each child component. Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Contact (parent) All ContactId IntegrationId ExternalSystemId 212 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 213. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Account AccountId AccountId ExternalSystemId ExternalSystemId Location Name and Location Name Activity CallType ActivityIntegrationId ActivityID ActivityExternaId Address AddressID AddressID ExternalId ExternalId IntegrationId IntegrationId City Country ZipCode StateProvince Province Asset AssetId AssetId ExternalSystemId ExternalSystemId IntegrationId IntegrationId ProductId SerialNumber Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 213 Release 18)
- 214. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Campaign CampaignContactId CampaignContactId CampaignId CampaignId CampaignExternalSystemId CampaignExternalSystemId CampaignName CampaignName DeliveryStatus ResponseStatus ModifiedDate Contact Note Subject Subject and Description Contact Team ContactTeamId None UserId UserExternalSystemId UserIntegrationId UserFirstName UserLastName ContactAccess UserRole CustomObject3 ContactCustomObject3Modifie CustomObject3Id dById ContactCustomObject3Modifie ExternalSystemId dDate CustomObject3Id SystemId CustomObject3Name ExternalSystemId IntegrationId Type Interests InterestId InterestId Category ExternalSystemId Subject 214 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 215. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Lead Campaign None EstimatedCloseDate Rating Source Status LeadOwner PotentialRevenue ProductInterest SalesPerson LeadId OpportunityId Opportunity Opportunity None OpportunityId Owner Revenue CloseDate Forecast ExpectedRevenue Probability Priority ReasonWonLost SalesStage Status Account Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 215 Release 18)
- 216. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Personal Address PersonalAddressIntegrationId None PersonalAddressName AlternateCity AlternateCountry AlternateZipCode AlternateStateProvince AlternateAddress AlternateAddress2 AlternateAddress3 Id IntegrationId AddressName City Country ZipCode StateProvince Address ShippingAddress2 Related Contact ContactRelationshipId None RelatedContactId RelatedContactExternalId RelatedContactIntegrationId RelationshipStatus RelationshipType StartDate EndDate Description RelationshipRole ReverseRelationshipRole 216 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 217. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Revenue ContactFullName RevenueId Description ExternalId ExternalId IntegrationId Forecast Frequency IntegrationId ModifiedDate NumberOfPeriods Product ProductId ProductCategoryId ProductCategory ProductCategoryExternalId ProductCategoryIntegrationId ProductExternalId ProductIntegrationId PurchasePrice Quantity Revenue RevenueId Status StartCloseDate Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 217 Release 18)
- 218. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 120. Filterable Fields and User Key Fields on the Contact Object’s Child Components Child Components Filterable Fields User Key Field Combinations Service Request Subject SRNumber Area Owner Priority Type Cause Source Status ServiceRequestId 218 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 219. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 121 details the picklists available for the contact object. Table 121. Picklists Available for the Contact Object Child Component Field Name Contact (parent) ContactType LeadSource MrMrs BestTimeToCall CallFrequency CurrentInvestmentMix Degree ExperienceLevel Gender InvestmentHorizon LifeEvent MaritalStatus MarketPotential Objective OwnOrRent PrimaryGoal RiskProfile Route Segment Tier Account Call Frequency Route Status Type Contact Team TeamRole Interests Category Subjects Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 219 Release 18)
- 220. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 121. Picklists Available for the Contact Object Child Component Field Name Related Contact Relationship Status Revenue Type Status Frequency Table 122 details a number of contact object fields that you must not use for customer integrations. Table 122. Contact Object Fields That You Must Not Use Field Name PartyTypeCode PartyUId PersonUId For more information on the fields exposed through the Contact Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the contact object. Current User The current user object stores information on the currently logged-in user. Child Components Login History and Quota Methods Called Table 123 details the method called by the Current user service, and its name as defined on the service. Table 123. Methods Called by Current User Service Method Name as Defined in Service “QueryPage” on page 69 CurrentUserQueryPage 220 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 221. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 124 details the required and read-only fields for the current user object. Table 124. Required and Read-Only Fields for the Current User Object Child Component Field Name Type Current User FirstName Required (parent) LastName Required CreatedBy Read-only ModifiedBy Read-only Login History LastLoggedIn Read-only Table 125 provides a list of the filterable fields for the child components of the current user objects, and a list of user key combinations for each child component. Table 125. Filterable Fields on the Current User Object’s Child Components Child Component Filterable Fields User Key Field Combinations Current User All CurrentUserId (parent) IntegrationId ExternalSystemId FirstName and LastName and Middlename Login History Alias None SourceIPAddress SignInStatus SignInTime For more information on the fields exposed through the Current user Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the current user object. Related Topic User Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 221 Release 18)
- 222. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) CustomObject1 - CustomObject3 The CustomObject1, CustomObject2, and CustomObject3 services expose the functionality of the CustomObject1 - CustomObject3 objects to external applications. TIP: The reference information for each of CustomObject1, CustomObject2, and CustomObject3 follows the same pattern. In this topic, the information for CustomerObject1 is given as an example. NOTE: To download the CustomObject1 - CustomObject3 WSDL file, you must be given access to the relevant CustomObject object. If you do not have access to the CustomObject object, it is not available to download from the Web Services Administration page or available to use Web service calls. For assistance in gaining access to the CustomObject1 - CustomObject3 objects, contact your Oracle CRM On Demand service provider. Parent Objects Account, Contact Child Components Account, Attachment, Book, Contact, Opportunity, Portfolio, and Team. CustomObject1, CustomObject2, and CustomObject3 also have child components for the other CustomObjects as follow: ■ CustomObject1. CustomObject2 and CustomObject3 child components. ■ CustomObject2. CustomObject1 and CustomObject3 child components. ■ CustomObject3. CustomObject1 and CustomObject2 child components. For information about using attachments with these objects, see Appendix A, “Using Attachments With Web Services On Demand”. NOTE: For CustomObject3 only, the following fields are exposed: CustomObject5Id, CustomObject5Name, CustomObject5ExternalSystemId. Methods Called Table 126 details the methods called by the CustomObject1 service. The methods for CustomObject2 and CustomObject3 follow the same pattern. Table 126. Methods Called by CustomObJect1 Service Method Name as Defined in Service “Delete” on page 63 CustomObject1Delete “DeleteChild” on page 66 CustomObject1DeleteChild “Insert” on page 67 CustomObject1Insert “InsertChild” on page 68 CustomObject1InsertChild 222 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 223. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 126. Methods Called by CustomObJect1 Service Method Name as Defined in Service “InsertOrUpdate” on page 68 CustomObject1OrUpdate “QueryPage” on page 69 CustomObject1Page “Update” on page 78 CustomObject1Update “UpdateChild” on page 79 CustomObject1UpdateChild Fields Table 127 details the required and read-only fields for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern. Table 127. Required and Read-Only Fields for the CustomObject1 Object Child Component Field Name Type CustomObject1 ParentId Required (parent) ParentExternalSystemID Required ParentIntegrationId Required ParentObject1Id Read-only Account CObj1AccountCreatedById Read-only CObj1AccountCreatedDate Read-only CObj1AccountModifiedById Read-only CObj1AccountModifiedDate Read-only Region Read-only AccountType Read-only Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only CustomObjectId Read-only Id Read-only ModId Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 223 Release 18)
- 224. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 127. Required and Read-Only Fields for the CustomObject1 Object Child Component Field Name Type Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Contact CObj1ContactCreatedById Read-only CObj1ContactCreatedDate Read-only CObj1ContactModifiedById Read-only CObj1ContactModifiedDate Read-only ContactFirstName Read-only ContactLastName Read-only ContactType Read-only CustomObject2 CObj1CustomObject2CreatedById Read-only CObj1CustomObject2CreatedDate Read-only CObj1CustomObject2ModifiedById Read-only CObj1CustomObject2ModifiedDate Read-only CustomObject2Id Read-only CustomObject3 CObj1CustomObject3CreatedById Read-only CObj1CustomObject3CreatedDate Read-only CObj1CustomObject3ModifiedById Read-only CObj1CustomObject3ModifiedDate Read-only CustomObject3Id Read-only Opportunity AccountName Read-only CObj1OpportunityCreatedById Read-only CObj1OpportunityCreatedDate Read-only CObj1OpportunityModifiedById Read-only CObj1OpportunityModifiedDate Read-only OpportunityName Read-only Revenue Read-only SalesStage Read-only 224 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 225. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 127. Required and Read-Only Fields for the CustomObject1 Object Child Component Field Name Type Portfolio AccountNumber Read-only CObj1PortfolioCreatedById Read-only CObj1PortfolioCreatedDate Read-only CObj1PortfolioModifiedById Read-only CObj1PortfolioModifiedDate Read-only Revenue Read-only Team CustomObject1TeamId Read-only UserFirstName Read-only UserLastName Read-only Table 128 details the status key for the CustomObject1 object. The status keys for CustomObject2 and CustomObject3 follow a similar pattern. Table 128. Status Key for the CustomObject1 Object Child Component Field Name CustomObject1 (parent) Audit Fields CustomObject1Id ExternalSystemId IntegrationId Account CustomObject1AccountId CObj1AccountCreatedById CObj1AccountCreatedDate CObj1AccountModifiedById CObj1AccountModifiedDate Attachment Audit Fields Id CustomObjectId Book Audit Fields BookId ModId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 225 Release 18)
- 226. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 128. Status Key for the CustomObject1 Object Child Component Field Name Contact CustomObject1ContactId CObj1ContactCreatedById CObj1ContactCreatedDate CObj1ContactModifiedById CObj1ContactModifiedDate CustomObject2 CustomObject2Id CObj1CustomObject2CreatedById CObj1CustomObject2CreatedDate CObj1CustomObject2ModifiedById CObj1CustomObject2ModifiedDate CustomObject3 CustomObject3Id CObj1CustomObject3CreatedById CObj1CustomObject3CreatedDate CObj1CustomObject3ModifiedById CObj1CustomObject3ModifiedDate Opportunity OpportunityId CObj1OpportunityCreatedById CObj1OpportunityCreatedDate CObj1OpportunityModifiedById CObj1OpportunityCreatedDate Portfolio PortfolioId CObj1PortfolioCreatedById CObj1PortfolioCreatedDate CObj1PortfolioModifedById CObj1PortfolioModifiedDate Team Audit Fields CustomObject1TeamId 226 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 227. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 129 details the pick map fields for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern. Table 129. Pick Map Fields for the CustomObject1 Object Child Component Pick Map Field Maps To CustomObject1 AccountExternalId AccountId (parent) AccountIntegrationId AccountId AccountName AccountId ActivityExternalId ActivityId ActivityIntegrationId ActivityId ActivityName ActivityId CampaignExternalId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId ContactExternalId ContactId ContactFirstName ContactId ContactFullName ContactId ContactIntegrationId ContactId ContactLastName ContactId CustomObject2ExternalId CustomObject2Id CustomObject2IntegrationId CustomObject2Id CustomObject2Name CustomObject2Id CustomObject3ExternalId CustomObject3Id CustomObject3IntegrationId CustomObject3Id CustomObject3Name CustomObject3Id DealerName DealerId HouseholdExternalId HouseholdId HouseholdIntegrationId HouseholdId HouseholdName HouseholdId LeadExternalId LeadId LeadFirstName LeadId LeadFullName LeadId LeadIntegrationId LeadId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 227 Release 18)
- 228. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 129. Pick Map Fields for the CustomObject1 Object Child Component Pick Map Field Maps To CustomObject1 LeadLastName LeadId (cont.) Owner OwnerId OpportunityExternalId OpportunityId OpportunityIntegrationId OpportunityId OpportunityName OpportunityId ParentExternalSystemId ParentId ParentIntegrationId ParentId PortfolioAccountNumber PortfolioId ProductExternalId ProductId ProductIntegrationId ProductId ProductName ProductId SolutionExternalId SolutionId SolutionIntegrationId SolutionId SolutionTitle SolutionId ServiceRequestExternalId ServiceRequestId ServiceRequestIntegrationId ServiceRequestId ServiceRequestName ServiceRequestId VIN VehicleId Account ExternalSystemId AccountId IntegrationId AccountId Location AccountId Name AccountId Book BookName BookId Contact ExternalSystemId ContactId IntegrationId ContactId CustomObject2 Owner OwnerId CustomObject3 Owner OwnerId Opportunity ExternalSystemId OpportunityId IntegrationId OpportunityId Portfolio ExternalSystemId PortfolioId IntegrationId PortfolioId 228 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 229. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 129. Pick Map Fields for the CustomObject1 Object Child Component Pick Map Field Maps To Team UserExternalSystemId UserId UserIntegrationId UserId UserEmail UserId Table 130 provides a list of the filterable fields for the child components of the CustomObject1 object, and a list of user key combinations for each child component. The fields for CustomObject2 and CustomObject3 follow a similar pattern. Table 130. Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components Child Components Filterable Fields User Key Field Combinations CustomObject1 All CustomObject1Id (parent) ExternalSystemId IntegrationId Account AccountId CustomObject1AccountId AccountType ExternalSystemId CObj1AccountModifiedById IntegrationId CObj1AccountModifiedDate ExternalSystemId IntegrationId Location Name Region Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 229 Release 18)
- 230. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 130. Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components Child Components Filterable Fields User Key Field Combinations Contact ContactId CustomObject1ContactId CObj1ContactModifiedById ExternalSystemId CObj1ContactModifiedDate IntegrationId ContactType ExternalSystemId IntegrationId CustomObject2 CustomObject2Id CustomObject2Id CObj1CustomObject2ModifiedById ExternalSystemId CObj1CustomObject2ModifiedDate IntegrationId ExternalSystemId IntegrationId Name Type CustomObject3 CustomObject3Id CustomObject3Id CObj1CustomObject3ModifiedById ExternalSystemId CObj1CustomObject3ModifiedDate IntegrationId ExternalSystemId IntegrationId Name Type Opportunity CObj1OpportunityModifiedById OpportunityId CObj1OpportunityModifiedDate ExternalSystemId ExternalSystemId IntegrationId IntegrationId OpportunityId Portfolio CObj1PortfolioModifiedById PortfolioId CObj1PortfolioModfiedDate ExternalSystemId ExternalSystemId IntegrationId IntegrationId PortfolioId 230 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 231. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 130. Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components Child Components Filterable Fields User Key Field Combinations Team CustomObject1TeamId CustomObject1TeamId UserEmail UserExternalSystemId UserExternalSystemId UserIntegrationId UserId UserIntegrationId Table 131 details the picklists available for the CustomObject1 object. The fields for CustomObject2 and CustomObject3 follow a similar pattern. Table 131. Picklists Available for the CustomObject1 Object Child Component Field Name Dealer Type Household Type Portfolio Type Vehicle Type Dealer The dealer object stores information about dealerships in the automotive industry, for example, the name of the dealership, the identity of the parent dealership, the site on which the dealership is based, and so on. The dealer object does not have any parent objects. NOTE: To download the Dealer WSDL file, you must be given access to the Dealer object. If you do not have access to the Dealer object, it is not available to download from the Web Services Administration page or available to use the vertical Web service calls. For assistance in gaining access to the Dealer object, contact your Oracle CRM On Demand service provider. Child Objects Attachment and Book. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 231 Release 18)
- 232. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 132 details the methods called by the Dealer service. Table 132. Methods Called by Dealer Service Method Name as Defined in Service “Delete” on page 63 DealerDelete “DeleteChild” on page 66 DealerDeleteChild “Insert” on page 67 DealerInsert “InsertChild” on page 68 DealerInsertChild “InsertOrUpdate” on page 68 DealerInsertOrUpdate “QueryPage” on page 69 DealerQueryPage “Update” on page 78 DealerUpdate “UpdateChild” on page 79 DealerUpdateChild Fields All fields on the dealer object are filterable. Table 133 details the required and read-only fields for the dealer object. Table 133. Required and Read-Only Fields for the Dealer Object Child Component Field Name Type Dealer DealerId Required DealerIntegrationId Required DealerExternalSystemID Required DealerId Read-only DealerType Read-only Audit Fields Read-only 232 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 233. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 133. Required and Read-Only Fields for the Dealer Object Child Component Field Name Type Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only DealerId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Table 134 details the status key for the dealer object. Table 134. Status Key for the Dealer Object Child Component Field Name Dealer (parent) Audit Fields DealerId DealerIntegrationID DealerExternalSystemId Attachment Audit Fields Id DealerId Book Audit Fields BookId ModId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 233 Release 18)
- 234. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 135 details the pick map fields for the dealer object. Table 135. Pick Map Fields for the Dealer Object Child Components Pick Map Field Maps To Dealer (parent) Owner OwnerId ParentDealerExternalSystemId ParentDealerId ParentDealerIntegrationId ParentDealerId ParentDealerName ParentDealerId ParentDealerSite ParentDealerId Book BookName BookId Table 136 provides a list of the filterable fields for the child components of the dealer object, and a list of user key combinations for each child component. Table 136. Filterable Fields and User Key Fields on the Dealer Object’s Child Components Child Components Filterable Fields User Key Field Combinations Dealer (parent) All DealerId IntegrationID ExternalSystemID Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Table 137 details the picklists available for the dealer object. Table 137. Picklists Available for the Dealer Object Field Name ParentDealerName ParentDealerSite For more information on the fields exposed through the Dealer Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the dealer object. 234 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 235. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Household The household object allows you to define and record financial details about a group of contacts that live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details include the assets of the household, the liabilities of the household, the net income of the household, and so on. NOTE: To download the Household WSDL, you must be given access to the Household object. If you do not have access to the Household object, it is not available to download from the Web Services Administration page or available to use the vertical Web service calls. For assistance in gaining access to the Household object, contact your Oracle CRM On Demand service provider. Child Component Book, HouseholdTeam Methods Called Table 138 details the methods called by the Household service. Table 138. Methods Called by Household Service Method Name as Defined in Service “Delete” on page 63 HouseholdDelete “DeleteChild” on page 66 HouseholdDeleteChild “Insert” on page 67 HouseholdInsert “InsertChild” on page 68 HouseholdInsertChild “InsertOrUpdate” on page 68 HouseholdInsertOrUpdate “QueryPage” on page 69 HouseholdQueryPage “Update” on page 78 HouseholdUpdate “UpdateChild” on page 79 HouseholdInsertChild Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 235 Release 18)
- 236. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 139 details the required and read-only fields for the household object. Table 139. Required and Read-Only Fields for the Household Object Child Component Field Name Type Household (parent) HouseholdName Required IntegrationID Required ExternalSystemID Required HouseholdId Read-only PrimaryContactId Read-only PrimaryContactExternalId Read-only PrimaryContactIntegrationId Read-only PrimaryContactFirstName Read-only PrimaryContactLastName Read-only Timezone Read-only HouseholdCurrency Read-only LastActivity Read-only HeadDOB Read-only TotalIncome Read-only TotalAssets Read-only TotalExpenses Read-only TotalLiabilities Read-only TotalNetWorth Read-only RiskProfile Read-only ExperienceLevel Read-only InvestmentHorizon Read-only CurrentInvestmentMix Read-only Objective Read-only PrimaryGoal Read-only Audit Fields Read-only 236 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 237. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 139. Required and Read-Only Fields for the Household Object Child Component Field Name Type Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Contact ContactId Required ContactExternalId Required ContactIntegrationId Required ContactFirstName Read-only ContactLastName Read-only ContactId Read-only ContactMrMrs Read-only Audit Fields Read-only HouseholdTeam HouseholdAccess Required UserId Read-only UserAlias Read-only UserEmail Read-only Table 140 details the status key for the household object. Table 140. Status Key for the Household Object Child Component Field Name Household (parent) Audit Fields ExternalSystemId HouseholdId IntegrationID Book Audit Fields BookId ModId Contact Audit Fields ContactId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 237 Release 18)
- 238. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 140. Status Key for the Household Object Child Component Field Name HouseholdTeam Audit Fields UserExternalId HouseholdId UserAlias UserEmail Table 141 details the pick map fields for the household object. Table 141. Pick Map Field for the Household Object Child Component Pick Map Field Maps To Contact ContactExternalId ContactId ContactIntegrationId Book BookName BookId HouseholdTeam UserEmail UserId UserAlias UserId UserExternalSystemId UserId LastName UserId FirstName UserId Table 142 provides a list of the filterable fields for the child components of the household object, and a list of user key combinations for each child component. Table 142. Filterable Fields and User Key Fields on the Household Object’s Child Components Child Components Filterable Fields User Key Field Combinations Household (parent) All HouseholdId IntegrationID ExternalSystemID Book None BookId BookName 238 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 239. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 142. Filterable Fields and User Key Fields on the Household Object’s Child Components Child Components Filterable Fields User Key Field Combinations Contact ContactID ContactID ContactExternalId ContactExternalId ContactIntegrationId ContactIntegrationId ModifiedDate RelationshipRole HouseholdTeam UserId HouseholdId UserExternalSystemId ExternalSystemId LastName UserAlias FirstName UserEmail TeamRole HouseholdAccess HouseholdTeamId Table 143 details the picklists available for the household object. Table 143. Picklists Available for the Household Object Child Component Field Name Household (parent) Segment Type Contact RelationshipRole HouseholdTeam TeamRole HouseholdAccess For more information on the fields exposed through the Household Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the household object. Lead The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 239 Release 18)
- 240. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Parent Objects Account, Campaign, Contact, and Opportunity Child Components Activity, Attachment, Book, and Campaign. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Methods Called Table 144 details the methods called by the Lead service. Table 144. Methods Called by Lead Service Method Name as Defined in Service “Delete” on page 63 LeadDelete “DeleteChild” on page 66 LeadDeleteChild “Insert” on page 67 LeadInsert “InsertChild” on page 68 LeadInsertChild “InsertOrUpdate” on page 68 LeadInsertOrUpdate “QueryPage” on page 69 LeadQueryPage “Update” on page 78 LeadUpdate “UpdateChild” on page 79 LeadUpdateChild 240 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 241. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 145 details the required and read-only fields for the lead object. Table 145. Required and Read-Only Fields for the Lead Object Child Component Field Name Type Lead (parent) FirstName Required LastName Required LeadOwner Required ContactFullName Read-only Audit Fields Read-only LastUpdated Read-only LeadConcatField Read-only LeadFullName Read-only ReferredById Read-only Activity AccountLocation Read-only CreatedDetail Read-only Lead Read-only LeadExternalId Read-only MEEventName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only DescriptionShadow Read-only Duration Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 241 Release 18)
- 242. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 145. Required and Read-Only Fields for the Lead Object Child Component Field Name Type Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only LeadId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Table 146 details the status key for the lead object. Table 146. Status Key for the Lead Object Child Component Field Name Lead (parent) Audit Fields AccountId CampaignId ContactId ExternalSystemId Id IntegrationId LastUpdated OpportunityId 242 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 243. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 146. Status Key for the Lead Object Child Component Field Name Activity Audit Fields ExternalSystemId Id IntegrationId LeadId Attachment Audit Fields Id LeadId Book Audit Fields BookId ModId Table 147 details the pick map fields for the lead object. Table 147. Pick Map Fields for the Lead Object Child Component Pick Map Field Maps To Lead (parent) Campaign CampaignId OpportunityName OpportunityId Owner OwnerId AccountExternalSystemId AccountId OpportunityExternalSystemId OpportunityId ContactExternalSystemId ContactId CampaignExternalSystemId CampaignId ReferredByExternalSystemId ReferredById Activity AccountIntegrationId AccountId AccountExternalId AccountId Address AddressId AssignedTo AssignedToId CampaignExternalId CampaignId CampaignIntegrationId CampaignId DelegatedBy DelegatedById Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 243 Release 18)
- 244. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 147. Pick Map Fields for the Lead Object Child Component Pick Map Field Maps To Dealer DealerId FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Book BookName BookId Table 148 provides a list of the filterable fields for the child components of the lead object, and a list of user key combinations for each child component. Table 148. Filterable Fields and User Key Fields on the Lead Object’s Child Components Child Components Filterable Fields User Key Field Combinations Lead (parent) All LeadId IntegrationId ExternalSystemId LeadFirstName and LeadLastName Description 244 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 245. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 148. Filterable Fields and User Key Fields on the Lead Object’s Child Components Child Components Filterable Fields User Key Field Combinations Activity Type Type and Description Owner Subject DueDate Priority Status Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Table 149 details the picklists available for the lead object. Table 149. Picklists Available for the Lead Object Field Name Country MrMrs Rating Source StateProvince Status For more information on the fields exposed through the Lead Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the lead object. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 245 Release 18)
- 246. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) MedEd The MedEd object allows you to plan and track medical education events. A medical education event can be as simple as a lunch-and-learn session in a physician's office or as complex as a seminar series or national sales meeting. NOTE: To download the MedEd WSDL file, you must be given access to the MedEd object. If you do not have access to the MedEd object, it is not available to download from the Web Services Administration page or available to use the vertical Web service calls. For assistance in gaining access to the MedEd object, contact your Oracle CRM On Demand service provider. Child Component Invitee Methods Called Table 150 details the methods called by the MedEd service. Table 150. Methods Called by MedEd Service Method Name as Defined in Service “Delete” on page 63 MedEdDelete “DeleteChild” on page 66 MedEdDeleteChild “Insert” on page 67 MedEdInsert “InsertChild” on page 68 MedEdInsertChild “InsertOrUpdate” on page 68 MedEdInsertOrUpdate “QueryPage” on page 69 MedEdQueryPage “Update” on page 78 MedEdUpdate “UpdateChild” on page 79 MedEdUpdateChild 246 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 247. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 151 details the read-only fields for the MedEd object and its child component. Table 151. Read-Only Fields on the MedEd Object Child Component Field Name Type MedEd (parent) EndDate Required Name Required Objective Required StartDate Required Audit Fields Read-only Invitee InviteeStatus Required InviteeId Read-only Audit Fields Read-only Table 152 details the status key for the MedEd object. Table 152. Status Key for the MedEd Object Child Component Field Name MedEd (parent) Audit Fields ExternalId MedEdId Invitee Audit Fields ContactIdExternalId MedEdInviteeId Table 153 details the pickmap fields for the MedEd object and its child objects. Table 153. Pick Map Fields for the MedEd Object Child Component Pick Map Field Maps To MedEd (parent) ProductExternalId ProductId ProductIntegrationId ProductId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 247 Release 18)
- 248. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 154 provides a list of the filterable fields and user key combinations for the child components of the MedEd object. Table 154. Filterable Fields and User Key Fields on the MedEd Object’s Child Components Child Components Filterable Fields User Key Field Combinations MedEd (parent) ExternalSystemId MedEdId ProductIntegrationId ExternalSystemId ProductId ProductId ProductExternalId PrimaryOwnerId Invitee ContactId MedEdInviteeId ContactExternalId ContactExternalId InviteeStatus Type ModifiedDate Table 155 details the picklists available for the MedEd object. Table 155. Picklists Available for the MedEd Object Child Component Field Name MedEd (parent) EventStatusCode EventTypeCode Invitee InviteeStatus For more information on the fields exposed through the MedEd Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the MedEd object. Related Topic Invitee 248 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 249. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Note The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application. The notes can be sent from users or can store extra information (as a note) on a parent object. This allows employees who are working on a particular record to add extra information as they see fit. For example, when talking to a contact, an employee might notice that the contact is not happy with a service provided. The employee can record this information in a note so that any other employees who talk to the contact are aware of the contact’s dissatisfaction. The note object has no child components. Parent Objects Account, Campaign, Contact, Opportunity, and Service Request Methods Called Table 156 details the methods called by the Note service. Table 156. Methods Called by Note Service Method Name as Defined in Service “Delete” on page 63 NoteDelete “Insert” on page 67 NoteInsert “InsertOrUpdate” on page 68 NoteInsertOrUpdate “QueryPage” on page 69 NoteQueryPage “Update” on page 78 NoteUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 249 Release 18)
- 250. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 157 details the required and read-only fields for the note object. Table 157. Required and Read-Only Fields for the Note Object Child Component Field Name Type Note (parent) Subject Required NoteId Read-only OwnerId Read-only OwnerAlias Read-only ParentNoteId Read-only SourceId Read-only SourceName Read-only Audit Fields Read-only Table 158 details the status key for the note object. Table 158. Status Key for the Note Object Child Component Field Name Note (parent) Audit Fields NoteId Table 159 provides a list of the filterable fields and a list of user key combinations for the note object. Table 159. Filterable Fields and User Key Fields on the Note Object’s Child Components Child Components Filterable Fields User Key Field Combinations Note (parent) All NoteId For more information on the fields exposed through the Note Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the note object. 250 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 251. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Opportunity The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered. Parent Objects Account, Campaign, Contact, CustomObject1 - CustomObject3 Child Components Activity, Attachment, Book, Competitor, Contact, Lead, Note, and OpportunityTeam. NOTE: The Revenue child object for Opportunity is actually called Product. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Methods Called Table 160 details the methods called by the Opportunity service. Table 160. Methods Called by Opportunity Service Method Name as Defined in Service “Delete” on page 63 OpportunityDelete “DeleteChild” on page 66 OpportunityDeleteChild “Insert” on page 67 OpportunityInsert “InsertChild” on page 68 OpportunityInsertChild “InsertOrUpdate” on page 68 OpportunityInsertOrUpdate “QueryPage” on page 69 OpportunityQueryPage “Update” on page 78 OpportunityUpdate “UpdateChild” on page 79 OpportunityUpdateChild Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 251 Release 18)
- 252. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Fields Table 161 details the required and read-only fields for the opportunity object. Table 161. Required and Read-Only Fields for the Opportunity Object Child Component Field Name Type Opportunity (parent) AccountId Required CloseDate Required OpportunityName Required SalesStage Required Audit Fields Read-only LastUpdated Read-only OpportunityConcatField Read-only Activity AccountLocation Read-only CreatedDetail Read-only MEEventName Read-only Opportunity Read-only OpportunityIntegrationId Read-only OpportunityExternalId Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only DescriptionShadow Read-only Duration Read-only Audit Fields Read-only 252 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 253. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 161. Required and Read-Only Fields for the Opportunity Object Child Component Field Name Type Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only OpportunityId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Competitor CompetitorId Required CompetitorExternalSystemId Required ReverseRelationshipRole Required RelationshipRole Required StartDate Required OpportunityCompetitorId Read-only Contact Age Read-only OwnerFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only LastActivityDate Read-only FirstNameShadow Read-only LastNameShadow Read-only OpportunityTeam OpportunityAccess Required UserId Required Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 253 Release 18)
- 254. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 161. Required and Read-Only Fields for the Opportunity Object Child Component Field Name Type Partner OpportunityPartnerId Read-only PartnerExternalSystemId Required ReverseRelationshipRole Required RelationshipRole Required StartDate Required Product ProductRevenueId Read-only ProductCategoryId Read-only ProductCategory Read-only ProductPartNumber Read-only ProductStatus Read-only ProductType Read-only OpportunityId Read-only OpportunityName Read-only OpportunityIntegrationID Read-only OpportunityExternalSystemId Read-only OpportunitySalesStage Read-only OpportunityAccountId Read-only OpportunityAccountName Read-only OpportunityAccountLocation Read-only OpportunityAccountExternalSystemId Read-only OpportunityAccountIntegrationId Read-only ContactFirstName Read-only ContactLastName Read-only 254 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 255. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 162 details the status key for the opportunity object. Table 162. Status Key for the Opportunity Object Child Component Field Name Opportunity (parent) Audit Fields AccountId ExternalSystemId Id IntegrationId Activity Audit Fields ExternalSystemId Id IntegrationId OpportunityId Attachment Audit Fields Id OpportunityId Book Audit Fields BookId ModId Competitor Audit Fields OpportunityCompetitorId CompetitorId CompetitorExternalSystemId Contact Audit Fields AccountId ContactId ExternalSystemId IntegrationId OpportunityId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 255 Release 18)
- 256. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 162. Status Key for the Opportunity Object Child Component Field Name Lead Audit Fields AccountId ContactId ExternalSystemId IntegrationId LastUpdated LeadId OpportunityId OpportunityNote Audit Fields ExternalSystemId Id IntegrationId OpportunityId Partner Audit Fields OpportunityPartnerId PartnerId PartnerExternalSystemId Product Audit Fields ExternalId ProductRevenueId IntegrationID Table 163 details the pick map fields for the opportunity object. Table 163. Pick Map Fields for the Opportunity Object Child Component Pick Map Field Maps To Opportunity (parent) Owner OwnerId AccountExternalSystemId AccountId Territory TerritoryId KeyContactIntegrationId KeyContactId KeyContactExternalSystemId KeyContactId 256 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 257. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 163. Pick Map Fields for the Opportunity Object Child Component Pick Map Field Maps To Activity AccountIntegrationId AccountId AccountExternalId AccountId Address AddressId AssignedTo AssignedToId CampaignExternalId CampaignId CampaignIntegrationId CampaignId Dealer DealerId DelegatedBy DelegatedById FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Book BookName BookId Contact AccountExternaSystemlId AccountId AccountIntegrationId AccountId ManagerExternalSystemId ManagerId ManagerIntegrationId ManagerId OwnerEmailAddress OwnerId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SourceCampaignName SourceCampaignId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 257 Release 18)
- 258. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 163. Pick Map Fields for the Opportunity Object Child Component Pick Map Field Maps To SourceCampaignExternalId SourceCampaignId TimeZoneName TimeZoneId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Competitor PrimaryContactName ContactId PartnerExternalSystemId PartnerId PartnerName PartnerId Partner PrimaryContactName ContactId CompetitorExternalSystemId CompetitorId CompetitorName CompetitorId Product ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId ContactExternalSystemId ContactId ContactIntegrationId ContactId Owner OwnerId CustomObject5Name CustomObject5Id CustomObject5ExternalSyste CustomObject5Id mId CustomObject6Name CustomObject6Id CustomObject6ExternalSyste CustomObject6Id mId Table 164 provides a list of the filterable fields for the child components of the opportunity objects, and a list of user key combinations for each child component. Table 164. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components Child Components Filterable Fields User Key Field Combinations Opportunity (parent) All OpportunityId IntegrationId ExternalSystemId 258 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 259. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 164. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components Child Components Filterable Fields User Key Field Combinations Activity Type Type and Description Owner Subject DueDate Priority Status Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Book None BookId BookName Competitor OpportunityCompetitorId OpportunityCompetitorId PrimaryContactId ExternalSystemId EndDate CompetitorId CompetitorId CompetitorExternalSystemId ReverseRelationshipRole RelationshipRole StartDate ModifiedDate Contact ContactType AccountName and Private ContactFirstName ContactFirstName and ContactLastName and Private JobTitle ContactLastName Owner Id Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 259 Release 18)
- 260. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 164. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components Child Components Filterable Fields User Key Field Combinations Lead Campaign None EstimatedCloseDate Rating Source Status LeadOwner PotentialRevenue ProductInterest SalesPerson LeadId Note Subject Subject and Description Partner OpportunityPartnerId OpportunityPartnerId PrimaryContactId ExternalSystemId EndDate PartnerId PartnerId PartnerExternalSystemId ReverseRelationshipRole RelationshipRole StartDate ModifiedDate 260 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 261. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 164. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components Child Components Filterable Fields User Key Field Combinations Product OpportunityIntegrationId OpportunityExternalSystemId OpportunityExternalSystemId OpportunityIntegrationId OpportunitySalesStage ProductRevenueId OpportunityAccountId ExternalId OpportunityAccountName IntegrationId OpportunityAccountLocation OpportunityAccountExternalSystemId OpportunityAccountIntegrationId ModifiedDate ContactId ContactExternalSystemId ContactIntegrationId Contract OwnerId Owner SerialNumber Revenue ExpectedRevenue Quantity PurchasePrice PurchaseDate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 261 Release 18)
- 262. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 164. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components Child Components Filterable Fields User Key Field Combinations StartCloseDate NumberOfPeriods Frequency Probability Forecast AssetValue Premium ShipDate Status Type Warranty ProductRevenueId ExternalId IntegrationId ProductId ProductName ProductExternalSystemID ProductionIntegrationId ProductCategoryId ProductCategory ProductPartNumber ProductStatus ProductType OpportunityId OpportunityName 262 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 263. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 165 details the picklists available for the opportunity object. Table 165. Picklists Available for the Opportunity Object Child Component Field Name Opportunity (parent) LeadSource Priority Probability ReasonWonLost Status Type Year Make Model OpportunityTeam TeamRole Product Frequency Probability Status Type Warranty Contract For more information on the fields exposed through the Opportunity Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the opportunity object. Portfolio The portfolio object allows you to define and record details about the collection of financial services that you can provide to an account. Financial services include loans, credit cards, insurance, general banking, and so on. NOTE: To download the Portfolio WSDL file, you must be given access to the Portfolio object. If you do not have access to the Portfolio object, it is not available to download from the Web Services Administration page or available to use the vertical Web service calls. For assistance in gaining access to the Portfolio object, contact your Oracle CRM On Demand service provider. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 263 Release 18)
- 264. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Child Component Book, Contact, PortfolioTeam Methods Called Table 166 details the methods called by the Portfolio service. Table 166. Methods Called by Portfolio Service Method Name as Defined in Service “Delete” on page 63 PortfolioDelete “DeleteChild” on page 66 PortfolioDeleteChild “Insert” on page 67 PortfolioInsert “InsertChild” on page 68 PortfolioInsertChild “InsertOrUpdate” on page 68 PortfolioInsertOrUpdate “QueryPage” on page 69 PortfolioQueryPage “Update” on page 78 PortfolioUpdate “UpdateChild” on page 79 PortfolioUpdateChild Fields Table 167 details the read-only fields for the portfolio object and its child component. Table 167. Read-Only Fields on the Portfolio Object Child Component Field Name Type Portfolio (parent) PortfolioId Read-only Owner Read-only OwnerId Read-only PrimaryContact Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only 264 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 265. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 167. Read-Only Fields on the Portfolio Object Child Component Field Name Type Contact ContactId Read-only ContactFirstName Read-only ContactLastName Read-only ContactHomePhone Read-only ContactEmail Read-only Audit Fields Read-only PortfolioTeam PortfolioAccess Required UserId Read-only UserAlias Read-only UserEmail Read-only Table 168 details the status key for the portfolio object. Table 168. Status Key for the Portfolio Object Child Component Field Name Portfolio (parent) Audit Fields ExternalSystemId PortfolioId IntegrationId Book Audit Fields BookId ModId Contact Audit Fields ContactId Id PortfolioTeam Audit Fields UserId UserAlias UserEmail UserExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 265 Release 18)
- 266. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 169 details the pickmap fields for the portfolio object and its child objects. Table 169. Pick Map Fields for the Portfolio Object Child Component Pick Map Field Maps To Portfolio (parent) InstitutionExternalId InstitutionId InstitutionIntegrationId InstitutionId InstitutionName InstitutionId InstitutionLocation InstitutionId Product ProductId ProductExternalId ProductId ProductIntegrationId ProductId Book BookName BookId Contact ContactExternalId ContactId ContactIntegrationId ContactId PortfolioTeam UserEmail UserId UserAlias UserId UserExternalSystemId UserId LastName UserId FirstName UserId FullName UserId Table 170 provides a list of the filterable fields and user key combinations for the child components of the portfolio object. Table 170. Filterable Fields and User Key Fields on the Portfolio Object’s Child Components Child Components Filterable Fields User Key Field Combinations Portfolio (parent) All PortfolioId IntegrationId ExternalSystemId Book None BookId BookName 266 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 267. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 170. Filterable Fields and User Key Fields on the Portfolio Object’s Child Components Child Components Filterable Fields User Key Field Combinations Contact ContactId ContactId ContactExternalId ContactExternalId ContactIntegrationId ContactIntegrationId ContactFirstName ContactLastName ContactHomePhone ContactEmail PrimaryInsured NamedInsured PolicyOwner Relationship PortfolioTeam UserId UserId UserExternalSystemId UserExternalSystemId LastName UserAlias FirstName UserEmail TeamRole PortfolioAccess Table 171 details the picklists available for the portfolio object. Table 171. Picklists Available for the Portfolio Object Child Component Field Name Portfolio (parent) AccountType Status TermUnit Contact Relationship PortfolioTeam TeamRole PortfolioAccess For more information on the fields exposed through the Portfolio Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the portfolio object. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 267 Release 18)
- 268. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Related Topic Fields Product The product object allows you to define and record details about a product or service that your company sells to its customers, including information on product price, category, and so on. The product object does not have any child objects. Parent Objects Account, Campaign and Contact Methods Called Table 172 details the methods called by the Product service. Table 172. Methods Called by Product Service Method Name as Defined in Service “Insert” on page 67 ProductInsert “InsertOrUpdate” on page 68 ProductInsertOrUpdate “QueryPage” on page 69 ProductQueryPage “Update” on page 78 ProductUpdate Fields All fields on the product object are filterable. Table 173 details the required and read-only fields for the product object. Table 173. Required and Read-Only Fields for the Product Object Child Component Field Name Type Product (parent) ProductName Required Audit Fields Read-only 268 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 269. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 174 details the status key for the product object. Table 174. Status Key for the Product Object Child Component Field Name Product (parent) Audit Fields Id IntegrationId Table 175 details the pick map field for the product object. Table 175. Pick Map Field for the Product Object Pick Map Field Maps To ParentCategory ParentCategoryId Table 176 details the user keys for the product object. Table 176. User Keys for the Product Object Child Component Field Name Product (parent) ProductId IntegrationId ExternalSystemId Table 177 details the picklists available for the product object. Table 177. Picklists Available for the Product Object Field Name BodyStyle Category Class CurrencyCode DoorStyle Engine Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 269 Release 18)
- 270. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 177. Picklists Available for the Product Object Field Name Make Model PriceType ProductType Revision Status SubType TherapeuticClass Transmission Trim For more information on the fields exposed through the Product Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the product object. Related Topic Product Category Product Category The product category object allows you to logically sort products into groups, where each product is in some way related to the other products in the category. The product category object does not have any child objects. Parent Objects None 270 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 271. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 178 details the methods called by the Product category service. Table 178. Methods Called by Product Category Service Method Name as Defined in Service “Delete” on page 63 ProductCategoryDelete “Insert” on page 67 ProductCategoryInsert “InsertOrUpdate” on page 68 ProductCategoryInsertOrUpdate “QueryPage” on page 69 ProductCategoryQueryPage “Update” on page 78 ProductCategoryUpdate Fields All fields on the product category object are filterable. Table 179 details the required and read-only fields for the product category object. Table 179. Required and Read-Only Fields for the Product Category Object Child Component Field Name Type ProductCategory CategoryName Required Audit Fields Read-only ModifiedByFullName Read-only Table 180 details the status key for the product category object. Table 180. Status Key for the Product Category Object Child Component Field Name ProductCategory Audit Fields ExternalSystemId Id IntegrationId Name Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 271 Release 18)
- 272. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 181 details the pick map field for the product category object. Table 181. Pick Map Field for the Product Category Object Pick Map Field Maps To ParentCategory ParentCategoryId Table 182 details the user keys for the product category object. Table 182. User Keys for the Product Category Object Child Component Field Name ProductCategory ProductCategoryId IntegrationId ExternaSystemId Name For more information on the fields exposed through the Product category Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the product category object. Related Topic Product Service Request The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly. Parent Objects Account, Contact, and Solution Child Components Activity, Attachment, Audit Trail, Book, Note, and Solution. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. 272 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 273. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 183 details the methods called by the Service request service. Table 183. Methods Called by Service Request Service Method Name as Defined in Service “Delete” on page 63 ServiceRequestDelete “DeleteChild” on page 66 ServiceRequestDeleteChild “Insert” on page 67 ServiceRequestInsert “InsertChild” on page 68 ServiceRequestInsertChild “InsertOrUpdate” on page 68 ServiceRequestInsertOrUpdate “QueryPage” on page 69 ServiceRequestQueryPage “Update” on page 78 ServiceRequestUpdate “UpdateChild” on page 79 ServiceRequestUpdateChild Fields Table 184 details the required and read-only fields for the service request object. Table 184. Required and Read-Only Fields for the Service Request Object Child Component Field Name Type ServiceRequest (parent) ContactEmail Read-only ContactFirstName Read-only ContactFullName Read-only ContactLastName Read-only Audit Fields Read-only LastUpdated Read-only ServiceRequestConcatId Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 273 Release 18)
- 274. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 184. Required and Read-Only Fields for the Service Request Object Child Component Field Name Type Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only SRId Read-only Id Read-only ModId Read-only Audit Fields Read-only Book BookName Required BookId Read-only SystemAssociateFlag Read-only ModId Read-only Audit Fields Read-only Table 185 details the status key for the service request object. Table 185. Status Key for the Service Request Object Child Component Field Name ServiceRequest (parent) Audit Fields AccountId ContactId ExternalSystemId Id IntegrationId LastUpdated Activity Audit Fields ExternalSystemId Id IntegrationId 274 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 275. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 185. Status Key for the Service Request Object Child Component Field Name Attachment Audit Fields Id SRId Book Audit Fields BookId ModId ServiceRequestNote Audit Fields ExternalSystemId Id LastUpdated ServiceRequestId Solution Audit Fields ExternalSystemId Id IntegrationId LastUpdated Table 186 details the pick map fields for the service request object. Table 186. Pick Map Fields for the Service Request Object Child Component Pick Map Field Maps To Service Request (parent) Owner OwnerId AccountExternalSystemId AccountId AssetIntegrationId AssetId AssetExternalSystemId AssetId ProductExternalSystemId ProductId Book BookName BookId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 275 Release 18)
- 276. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 187 provides a list of the filterable fields for the child components of the service request object, and a list of user key combinations for each child component. Table 187. Filterable Fields and User Key Fields on the Service Request Object’s Child Components Child Component Filterable Fields User Key Field Combinations Service Request All ServiceRequestId (parent) IntegrationId ExternalSystemId SRNumber Activity Type Type and Description Owner Subject DueDate Priority Status Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Audit Trail Date None User FieldModified Book None BookId BookName Service Request Note Subject Subject and Description Solution Title Title Published SolutionId Status Id 276 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 277. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 188 details the picklists available for the service request object. Table 188. Picklists Available for the Service Request Object Field Name Area Cause Priority Source Status Type For more information on the fields exposed through the Service request Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the service request object. Solution The solution object stores information on solutions to customer problems or service requests. Solutions can be reused if the same problem is identified with a product or service. This prevents the duplication of work for customer service representatives. Parent Object Activity and Service Request Child Component Attachment and Service Request. For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 277 Release 18)
- 278. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 189 details the methods called by the Solution service. Table 189. Methods Called by Solution Service Method Name as Defined in Service “Delete” on page 63 SolutionDelete “DeleteChild” on page 66 SolutionDeleteChild “Insert” on page 67 SolutionInsert “InsertChild” on page 68 SolutionInsertChild “InsertOrUpdate” on page 68 SolutionInsertOrUpdate “QueryPage” on page 69 SolutionQueryPage “Update” on page 78 SolutionUpdate “UpdateChild” on page 79 SolutionUpdateChild Fields Table 190 details the required and read-only fields for the solution object. Table 190. Required and Read-Only Fields for the Solution Object Child Component Field Name Type Solution (parent) Title Required Audit Fields Read-only CreatorId Read-only LastUpdated Read-only Attachment DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only SolutionId Read-only Id Read-only ModId Read-only Audit Fields Read-only 278 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 279. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 191 details the status key for the solution object. Table 191. Status Key for the Solution Object Child Component Field Name Solution (parent) Audit Fields ExternalSystemId Id IntegrationId LastUpdated Attachment Audit Fields Id SolutionId ServiceRequest Audit Fields ExternalSystemId Id IntegrationId LastUpdated Table 192 provides a list of the filterable fields for the child components of the solution objects, and a list of user key combinations for each child component. Table 192. Filterable Fields and User Key Fields on the Solution Object’s Child Components Child Components Filterable Fields User Key Field Combinations Solution (parent) All SolutionId IntegrationId ExternalSystemId Attachment None Id ExternalSystemId FileNameOrURL and FileExtension Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 279 Release 18)
- 280. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 192. Filterable Fields and User Key Fields on the Solution Object’s Child Components Child Components Filterable Fields User Key Field Combinations Service Request Subject SRNumber Area Owner Priority Type Cause Source Status Table 193 details the picklists available for the solution object. Table 193. Picklists Available for the Solution Object Field Name Area Cause Priority Source Status Type For more information on the fields exposed through the Solution Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the solution object. Related Topic Service Request Territory The territory object allows you to store information about the sales territory that is assigned to a user. This information includes the territory name, a description, the currency code, and the sales quota for the territory. The territory object does not have any associated child objects or parent objects. 280 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 281. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Parent Objects None Methods Called Table 194 details the methods called by the Territory service. Table 194. Methods Called by Territory Service Method Name as Defined in Service “Delete” on page 63 TerritoryDelete “Insert” on page 67 TerritoryInsert “InsertOrUpdate” on page 68 TerritoryInsertOrUpdate “QueryPage” on page 69 TerritoryQueryPage “Update” on page 78 TerritoryUpdate Fields All fields on the territory object are filterable. The TerritoryName field is a user key for the territory object. Table 195 details the required and read-only fields for the territory object. Table 195. Required and Read-Only Fields for the Territory Object Child Component Field Name Type Territory (parent) TerritoryName Required Territory Read-only Audit Fields Read-only Table 196 details the status key for the territory object. Table 196. Status Key for the Territory Object Child Component Field Name Territory (parent) Audit Fields ExternalSystemId IntegrationId TerritoryId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 281 Release 18)
- 282. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 197 details the pick map field for the territory object. Table 197. Pick Map Field for the Territory Object Pick Map Field Maps To ParentTerritoryIntegrationId ParentTerritoryId ParentTerritoryExternalSystemId ParentTerritoryId ParentTerritoryId ParentTerritoryId Table 198 details the picklists available for the territory object. Table 198. Picklists Available for the Territory Object Field Name ParentTerritoryExternalSystemId ParentTerritoryIntegrationId For more information on the fields exposed through the Territory Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the territory object. User The user object allows you to define and record details of all users in the application, for example, name, position, contact details, manager, and so on. It is different from the Current User object in that it is not restricted only to the currently logged in user. It enables queries to be run on all users, and enables an administrator to insert and update a user’s profile. The user object does not have any child components. Usage The UserLoginId and UserSignInId fields must be used as follows: ■ UserLoginId. Used for creating user records through the User Web service. ■ UserSignInId. Used as the user name for logging in and authenticating using Web services. Also, used for queries, as using UserLoginId is not allowed for queries. Parent Object User Group 282 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 283. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Child Object DelegatedUser Methods Called Table 199 details the methods called by the User service. Table 199. Methods Called by User Service Method Name as Defined in Service “DeleteChild” on page 66 UserDeleteChild “Insert” on page 67 UserInsert “InsertChild” on page 68 UserInsertChild “InsertOrUpdate” on page 68 UserInsertOrUpdate “QueryPage” on page 69 UserQueryPage “Update” on page 78 UserUpdate “UpdateChild” on page 79 UserUpdateChild Fields All fields on the user object are filterable. Table 200 details the required and read-only fields for the user object. Table 200. Required and Read-Only Fields for the User Object Child Component Field Name Type User FirstName Required LastName Required UserLoginId Required UserSignInId Required Alias Required EmailAddr Required Role Required Status Required Audit Fields Read-only LastSignInDateTime Read-only ManagerFullName Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 283 Release 18)
- 284. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 201 details the status key for the user object. Table 201. Status Key for the User Object Child Component Field Name User ModifiedById ModifiedDate EMailAddr UserId IntegrationId Table 202 details the pick map field for the user object. Table 202. Pick Map Field for the User Object Pick Map Field Maps To Role RoleId Table 203 provides a list of user key combinations for the user object. Table 203. User Key Fields on the User Object Child Components User Key Field Combinations User UserId ExternalSystemId IntegrationId EmailAddr For more information on the fields exposed through the User Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user object. Related Topic Current User 284 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 285. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) User Group The User Group object allows you to create groups to which users can be added. Users can only be a member of one group, and groups can contain many users. Parent Objects None Child Component User Methods Called Table 204 details the methods called by the User group service. Table 204. Methods Called by User Group Service Method Name as Defined in Service “Delete” on page 63 UserGroupDelete “DeleteChild” on page 66 UserGroupDeleteChild “Insert” on page 67 UserGroupInsert “InsertChild” on page 68 UserGroupInsertChild “InsertOrUpdate” on page 68 UserGroupInsertOrUpdate “QueryPage” on page 69 UserGroupQueryPage “Update” on page 78 UserGroupUpdate “UpdateChild” on page 79 UserGroupUpdateChild Fields Table 205 details the required and read-only fields for the user group object. Table 205. Required and Read-Only Fields for the User Group Object Child Component Field Name Type User Group (parent) Name Required UserGroupId Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 285 Release 18)
- 286. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 205. Required and Read-Only Fields for the User Group Object Child Component Field Name Type User UserGroupUserId Read-only UserId Read-only Alias Read-only Email Read-only Role Read-only UserFirstName Read-only UserLastName Read-only “Audit Fields” Read-only Table 206 details the status key for the user group object. Table 206. Status Key for the User Group Object Child Component Field Name UserGroup (parent) Audit Fields UserGroupId UserGroupIntegrationId UserGroupExternalSystemId User Audit Fields Members_UserId UserExternalSystemId UserIntegrationId Table 207 details the pick map field for the user group object. Table 207. Pick Map Field for the User Group Object Child Component Pick Map Field Maps To User UserIntegrationId UserId UserExternalSystemId UserId 286 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 287. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 208 provides a list of the filterable fields for the child components of the user group object, and a list of user key combinations for each child component. Table 208. Filterable Fields and User Key Fields on the User Group Object’s Child Components Child Component Filterable Fields User Key Field Combinations User Group (parent) All Name User UserGroupId None UserId UserIntegrationId UserExternalSystemId Alias Email Role UserFirstName UserLastName For more information on the fields exposed through the User group Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user group object. Vehicle The vehicle object allows you to create and store information about a vehicle, for example, a car, a truck, a van, and so on, that your company would like to sell to a contact or account. This information includes the vehicle’s current mileage, the invoice price, the dealership, the make, and so on. NOTE: To download the Vehicle WSDL file, you must be given access to the Vehicle object. If you do not have access to the Vehicle object, it is not available to download from the Web Services Administration page or available to use the vertical Web service calls. For assistance in gaining access to the Vehicle object, contact your Oracle CRM On Demand service provider. Parent Objects None Child Component Contact Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 287 Release 18)
- 288. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Methods Called Table 209 details the methods called by the Vehicle service. Table 209. Methods Called by Vehicle Service Method Name as Defined in Service “Delete” on page 63 VehicleDelete “DeleteChild” on page 66 VehicleDeleteChild “Insert” on page 67 VehicleInsert “InsertChild” on page 68 VehicleInsertChild “InsertOrUpdate” on page 68 VehicleInsertOrUpdate “QueryPage” on page 69 VehicleQueryPage “Update” on page 78 VehicleUpdate “UpdateChild” on page 79 VehicleUpdateChild Fields Table 210 details the required and read-only fields for the vehicle object. Table 210. Required and Read-Only Fields for the Vehicle Object Child Component Field Name Type Vehicle (parent) VehicleId Read-only Contact Read-only ProductType Read-only SellingDealer Read-only ServicingDealer Read-only Audit Fields Read-only Contact ContactId Required ContactExternalSystemId Required ContactIntegrationId Required Audit Fields Read-only 288 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 289. Oracle CRM On Demand Objects Exposed Through Web Services ■ Parent Objects (Web Services v1.0) Table 211 details the status key for the vehicle object. Table 211. Status Key for the Vehicle Object Child Component Field Name Vehicle (parent) Audit Fields ExternalSystemId IntegrationId VehicleId Contact Audit Fields ContactId Table 212 details the pick map fields for the vehicle object. Table 212. Pick Map Fields for the Vehicle Object Child Component Pick Map Field Maps To Vehicle (parent) AccountName AccountId AccountSite AccountId AccountIntegrationId AccountId AccountExternalID AccountId SellingDealerExternalId SellingDealerId SellingDealerIntegrationId SellingDealerId ServicingDealerExternalId ServicingDealerId ServicingDealerIntegrationId ServicingDealerId Contact ContactExternalSystemId ContactId ContactIntegrationId ContactId Table 213 provides a list of the filterable fields for the child components of the vehicle object, and a list of user key combinations for each child component. Table 213. Filterable Fields and User Key Fields on the Vehicle Object’s Child Components Child Component Filterable Fields User Key Field Combinations Vehicle (parent) All VehicleId ExternalSystemId IntegrationId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 289 Release 18)
- 290. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) Table 213. Filterable Fields and User Key Fields on the Vehicle Object’s Child Components Child Component Filterable Fields User Key Field Combinations Contact ContactId ContactId ContactExternalSystemId ContactExternalSystemId ContactIntegrationId ContactIntegrationId ContactFirstName Table 214 details the picklists available for the vehicle object. Table 214. Picklists Available for the Vehicle Object Field Name Body Door Engine ExteriorColor InteriorColor Location Make Model VehicleOwnedBy Status Transmission Trim UsedNew WarrantyType Year For more information on the fields exposed through the Vehicle Web service, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the vehicle object. Child Objects (Web Services v1.0) The following is a list of child objects that are used in Oracle On Demand Web Services. These are objects that are child objects only and are not themselves parent objects: 290 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 291. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) ■ “Address” on page 291 ■ “Attachment” on page 292 ■ “Audit Trail” on page 292 ■ “BookUser” on page 292 ■ “Competitor” on page 292 ■ “DelegatedUser” on page 293 ■ “HouseholdTeam” on page 293 ■ “Interests” on page 294 ■ “Invitee” on page 294 ■ “Login History” on page 294 ■ “Multiple Contact Roles” on page 294 ■ “OpportunityTeam” on page 294 ■ “PortfolioTeam” on page 295 ■ “ProductsDetailed” on page 295 ■ “Quota” on page 295 ■ “Recipient” on page 296 ■ “Related Account” on page 296 ■ “Related Contact” on page 296 ■ “Revenue” on page 296 ■ “SampleDropped” on page 297 ■ “SubBook” on page 297 ■ “Team” on page 297 Address The address object stores information on the different addresses that are associated with accounts and contacts. It is used to store billing and shipping addresses for accounts. It is also used to store the personal addresses for contacts. Parent Objects Account, Contact Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 291 Release 18)
- 292. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) Attachment The attachment object stores information about a file or URL that is attached to a record in the application. Parent Objects Account, Activity, Campaign, Contact, CustomObject1 - CustomObject3, Dealer, Lead, Opportunity, Service Request, and Solution. Audit Trail The audit trail object stores information about how a service request object is modified from the moment that it is created until a solution for the service request has been found. The audit trail object stores information, such as the created and modified dates for the service request, and also the users who created and updated the service request. Parent Object Service Request BookUser The BookUser object stores information about a book user. For more information on the BookUser fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the book object. Parent Object Book Competitor The competitor object stores the information on competitors for your accounts. 292 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 293. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) Fields Table 215 details the picklists available for the competitor object. Table 215. Picklists Available for the Competitor Object Field Name RelationshipRole ReverseRelationshipRole For more information on the competitor fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the account object. Parent Objects Account, Opportunity DelegatedUser The DelegatedUser object stores information about a user that can impersonate another user. The delegated user is added so that they can access a user’s data, for example, when a person is on vacation or leaves the company. For more information on the DelegatedUser fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the user object. Parent Object User HouseholdTeam The HouseholdTeam object stores the information on a team that shares household records. For more information on the household team fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the household object. Parent Object Household Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 293 Release 18)
- 294. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) Interests The Interests object stores information about things in which a contact is interested, such as products, services, or hobbies. Parent Object Contact Invitee The Invitee object stores information about invitees to medical education events, including feedback about the invitation. Parent Object MedEd Login History The login history object stores information about the currently logged in user, such as the amount of times that the user has logged in, and the dates and times at which the current user logged in. Parent Object Current User Multiple Contact Roles The multiple contact roles object stores information on the different roles that a contact can hold within an account. It stores information on the different types of jobs that one contact can hold within your organization. For example, the customer relations manager can also have a role within the sales team to provide valuable feedback to the sales representatives. Parent Object Account OpportunityTeam The OpportunityTeam object stores information about a team that shares opportunity records. 294 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 295. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) For more information on the opportunity team fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the opportunity object. Parent Object Opportunity PortfolioTeam The PortfolioTeam object stores information about a team that shares portfolio records For more information on the portfolio team fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the portfolio object. Parent Objects Account, Portfolio ProductsDetailed The ProductsDetailed object stores the information on product details for an activity. This is used, for example, to record information about products discussed on sales calls to customers. For more information on the product detail fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object. Parent Objects Activity Quota The quota object stores information about the sales targets of and sales made by the current user. Parent Object Current User Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 295 Release 18)
- 296. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v1.0) Recipient The recipient object stores information about a recipient associated with a campaign. Parent Object Campaign Related Account The related account object stores information on an account that has a relationship with the parent account in question. The details of the related account child object are inherited from a particular account parent object. Parent Object Account Related Contact The related contact object stores information about a contact that has a relationship with the parent contact in question. The details of the related contact child object are inherited from a particular contact parent object. Parent Object Contact Revenue The revenue object stores monetary information about accounts, contacts, and their associated opportunities. This includes information on the revenue available, expected revenue, and also information about the products associated with the accounts, contacts, opportunities, and so on. NOTE: The Revenue child object of Opportunity is actually called Product. Parent Objects Account, Contact and Opportunity 296 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 297. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) SampleDropped The SampleDropped object stores the information on samples for an activity. This is used, for example, to record information about samples left with the customer on sales calls to customers. For more information on the SampleDropped fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the activity object. Parent Object Activity SubBook The Subbook object stores information about a subbook. For more information on the SubBook fields exposed, go to the Web Services Administration page within the Oracle CRM On Demand application, and generate the WSDL file for the book object. Parent Object Book Team The team object stores information on the team that is assigned to a particular account or contact. In this way, a team of employees can be dedicated to an account or contact, ensuring that the activities, service requests, leads, and opportunities surrounding that account or contact are always kept up-to-date and are attended to regularly. Parent Objects Account, Contact, and CustomObject1 - CustomObject3. Core Parent Objects (Web Services v2.0) This topic include the standard objects of Oracle CRM On Demand. Objects that are only available with industry-specific editions of the application are covered in the following topics: ■ “Partner Relationship Management Edition Objects (Web Services v2.0)” on page 338 ■ “Life Sciences Edition Parent Objects (Web Services v2.0)” on page 376 ■ “Financial Services Edition Parent Objects (Web Services v2.0)” on page 424 ■ “Automotive Edition Parent Objects (Web Services v2.0)” on page 456 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 297 Release 18)
- 298. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) The following Oracle CRM On Demand objects are detailed in this topic: ■ “Account” on page 298 ■ “Activity” on page 301 ■ “Asset” on page 305 ■ “Book” on page 308 ■ “Campaign” on page 309 ■ “Category” on page 312 ■ “Contact” on page 313 ■ “CustomObject” on page 317 ■ “Group” on page 320 ■ “Lead” on page 322 ■ “Note” on page 324 ■ “Opportunity” on page 325 ■ “Product” on page 328 ■ “Service Request” on page 330 ■ “Solution” on page 332 ■ “Territory” on page 334 ■ “User” on page 336 Objects exposed through the Web Services v2.0 API can reference other objects through a number of reference fields, which are foreign key fields for those other objects. You can determine the objects that are referenced by examining the WSDL file for the referencing object. Account The account object stores information about the companies that you do business with and is also used to track partners and competitors. The methods called on the account object require a list (array) of account objects as an input argument. This list of accounts identifies the records on which the operation is to be carried out. Adding and Updating Account Addresses The account object has three types of address: 1 Billing address 2 Shipping address 3 Simple address 298 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 299. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) The billing and shipping address correspond to fields in the account object. The address child object can correspond to a simple address, but may also correspond to a billing address or a shipping address. You can use either AccountInsert, AccountUpdate or AccountExecute calls to insert or update billing and shipping addresses for an account. With AccountInsert or AccountUpdate calls, the account parent node with billing and shipping address fields must be present and there should not be any child node. If an address child is present, only a simple address can be added, and not billing and shipping addresses. If the address child or any other child node is not present, only billing and shipping addresses can be added, and not simple addresses. With the AccountExecute call, both the account parent node and address child node can be present along with billing and shipping address fields at the parent level. To distinguish whether the address in an address child node is a billing or shipping address: ■ If the PrimaryBillToAddressId and AddressId fields have the same value, then the address is a billing address. ■ If the PrimaryShipToAddressId and AddressId have the same values, the address is a shipping address. Child Objects Activity, Address, Asset, Attachment, Business Plan, Claim, Deal Registration, Financial Account, Financial Account Holder, Financial Plan, Lead, Message Response, Note, Objective, Opportunity, Policy, Policy Holder, Revenue, Service Request, Special Pricing Request. Methods Called Table 216 details the methods called by the Account service. Table 216. Methods Called by Account Service Method Name as Defined in Service “Delete” on page 82 AccountDelete “Execute” on page 83 AccountExecute “Insert” on page 84 AccountInsert “QueryPage” on page 85 AccountQueryPage “Update” on page 93 AccountUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 299 Release 18)
- 300. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Fields Table 217 details the required and read-only fields for the account object. Table 217. Required and Read-Only Fields for the Account Object Field Name Type AccountName Required AccountConcatField Read-only Audit Fields Read-only Table 218 details the status key for the account object. Table 218. Status Key for the Account Object Field Name Audit Fields ExternalSystemId AccountId IntegrationId LastUpdated Table 219 details the pick map fields for the account object. Table 219. Pick Map Fields for the Account Object Pick Map Field Maps To Owner OwnerId ParentAccount, ParentAccountLocation ParentAccountId ParentAccountIntegrationId ParentAccountId ParentAccountExternalSystemId ParentAccountId 300 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 301. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 220 provides a list of the a list of the user key combinations for the account object. Table 220. User Key Fields on the Account Object User Key Field Combinations Id ExternalSystemId AccountName and Location Table 221 details the picklists available for the account object. Table 221. Picklists Available for the Account Object Field Name AccountType Priority Region CallFrequency InfluenceType Route Status MarketPotential MarketSegment Activity The activity object stores information on an activity that a user must carry out, for example, a call- back activity for an account. When an activity is created, the user must set the Activity field explicitly to Task or Appointment. Usage Oracle On Demand Web Services uses activities to organize, track, and resolve a variety of tasks, from finding and pursuing opportunities to closing service requests. If a task requires multiple steps that one or more people can carry out, activities greatly simplify the job. Activities can help to: ■ Define and assign the task ■ Provide information to complete the task ■ Track the progress of the task Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 301 Release 18)
- 302. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) ■ Track costs and bill for the task NOTE: The Owner field is not exposed for the activity object in Web Services v2.0. Child Objects Attachment, Contact, Message Response, Products Detailed, Promotional Items Dropped, Sample Dropped, Sample Transaction, Signature, User. Methods Called Table 222 details the methods called by the Activity service. Table 222. Methods Called by Activity Service Method Name as Defined in Service “Delete” on page 82 ActivityDelete “Execute” on page 83 ActivityExecute “Insert” on page 84 ActivityInsert “QueryPage” on page 85 ActivityQueryPage “Update” on page 93 ActivityUpdate Fields Table 223 details the required and read-only fields for the activity object. Table 223. Required and Read-Only Fields for the Activity Object Field Name Type Subject Required Activity Required ActivityId Read-only AddressId Read-only CallType Read-only ContactFirstName Read-only ContactLastName Read-only LeadFirstName Read-only LeadLastName Read-only MedEdEventName Read-only OpportunityName Read-only 302 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 303. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 223. Required and Read-Only Fields for the Activity Object Field Name Type FundRequest Read-only SmartCall Read-only AssignedQueue Read-only QueueHoldTime Read-only QueueStartTime Read-only TotalHoldTime Read-only ResolutionCode Read-only Audit Fields Read-only Table 224 details the status key for the activity object. Table 224. Status Key for the Activity Object Field Name Audit Fields ActivityId ExternalSystemId IntegrationId Table 225 details the pick map fields for the activity object. Table 225. Pick Map Fields for the Activity Object Pick Map Field Maps To OwnerAlias OwnerId AccountName AccountId AccountLocation AccountId AccountExternalSystemId AccountId AccountIntegrationId AccountId CampaignExternalSystemId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId LeadExternalSystemId LeadId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 303 Release 18)
- 304. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 225. Pick Map Fields for the Activity Object Pick Map Field Maps To LeadIntegrationId LeadId MedEdEventExternalSystemId MedEdEventId MedEdEventIntegrationId MedEdEventId OpportunityExternalSystemId OpportunityId OpportunityIntegrationId OpportunityId PortfolioExternalSystemId PortfolioId PortfolioIntegrationId PortfolioId ServiceRequestNumber ServiceRequestId ServiceRequestExternalSystemId ServiceRequestId ServiceRequestIntegrationId ServiceRequestId FundRequestExternalSystemId FundRequestId FundRequestIntegrationId FundRequestId Table 226 provides a list of the user key combinations for the activity object. Table 226. User Key Fields on the Activity Object User Key Field Combinations Description Id ExternalSystemId Table 227 details the picklists available for the activity object. Table 227. Picklists Available for the Activity Object Field Name AccountName AccountLocation AccountIntegrationId AccountExternalSystemId OpportunityName 304 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 305. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 227. Picklists Available for the Activity Object Field Name ServiceRequestNumber ServiceRequestIntegrationId ServiceRequestExternalSystemId DelegatedByExternalSystemId PrimaryContactIntegrationId PrimaryContactExternalSystemId MedEdEventIntegrationId MedEdEventExternalSystemId FundRequestExternalId LeadIntegrationId LeadExternalSystemId CampaignIntegrationId CampaignExternalSystemId ActivitySubtype ResolutionCode PublishInternal Status Issue Indication Asset The asset object stores information on the assets held by your accounts, for example, the products that an account has purchased. Child Objects None Usage Oracle On Demand Web Services uses assets to manage products through their life cycle. It is also used by your accounts to register products, receive product news and literature, track warranty agreements, and receive recommendations on scheduled services. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 305 Release 18)
- 306. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Methods Called Table 228 details the methods called by the Asset service. Table 228. Methods Called by Asset Service Method Name as Defined in Service “Delete” on page 82 AssetDelete “Execute” on page 83 AssetExecute “Insert” on page 84 AssetInsert “QueryPage” on page 85 AssetQueryPage “Update” on page 93 AssetUpdate Fields Table 229 details the required and read-only fields for the asset object. Table 229. Required and Read-Only Fields for the Asset Object Field Name Type ProductId Required ProductCategory Read-only PartNumber Read-only Type Read-only Status Read-only Audit Fields Read-only Table 230 details the status key for the asset object. Table 230. Status Key for the Asset Object Field Name Audit Fields AssetId IntegrationId ExternalSystemId 306 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 307. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 231 details the pick map fields for the asset object. Table 231. Pick Map Fields for the Asset Object Pick Map Field Maps To AccountIntegrationId AccountId AccountExternalSystemId AccountId Account, AccountLocation AccountId ProductIntegrationId ProductId ProductExternalSystemId ProductId Product ProductId Table 232 provides a list of the user key combinations for the asset object. Table 232. User Key Fields on the Asset Object User Key Field Combinations Id ExternalSystemId ProductId ProductName ProductExternalId Table 233 details the picklists available for the asset object. Table 233. Picklists Available for the Asset Object Field Name Warranty Contract Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 307 Release 18)
- 308. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Book The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books. NOTE: To download the Book WSDL, you must be given access to the Book object. If you do not have access to the Book object, it is not available to download from the Web Services Administration pages. For assistance in gaining access to the Book object, contact your Oracle CRM On Demand service provider. Methods Called Table 234 details the methods called by the Book service. Table 234. Methods Called by Book Service Method Name as Defined in Service “Delete” on page 82 BookDelete “Execute” on page 83 BookExecute “Insert” on page 84 BookInsert “QueryPage” on page 85 BookQueryPage “Update” on page 93 BookUpdate Fields Table 235 details the required and read-only fields for the book object. Table 235. Required and Read-Only Fields for the Book Object Field Name Type BookName Required BookId Read-only Audit Fields Read-only 308 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 309. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 236 details the status key for the book object. Table 236. Status Key for the Book Object Field Name Audit Fields BookId BookName Table 237 details the pick map fields for the book object. Table 237. Pick Map Fields for the Book Object Pick Map Field Maps To BookName BookId Table 238 provides a list of the user key combinations for the book object. Table 238. User Key Fields on the Book Object User Key Field Combinations Id BookName Table 239 details the picklists available for the book object. Table 239. Picklists Available for the Book Object Field Name BookType ParentBookName Campaign The campaign object provides a mechanism for marketing products and services to customers and prospects. The campaign object is the primary way in which new products and services are marketed to customers and prospects. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 309 Release 18)
- 310. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Child Objects Activity, Application, Attachment, Book, Financial Account, Financial Plan, Lead, MDF Request, Note, Policy Methods Called Table 240 details the methods called by the Campaign service. Table 240. Methods Called by Campaign Service Method Name as Defined in Service “Delete” on page 82 CampaignDelete “Execute” on page 83 CampaignExecute “Insert” on page 84 CampaignInsert “QueryPage” on page 85 CampaignQueryPage “Update” on page 93 CampaignUpdate Fields Table 241 details the required and read-only fields for the campaign object. Table 241. Required and Read-Only Fields for the Campaign Object Field Name Type CampaignName Required SourceCode Required Audit Fields Read-only CreatedByFullName Read-only LastUpdated Read-only Table 242 details the status key for the campaign object. Table 242. Status Key for the Campaign Object Field Name Audit Fields ExternalSystemId 310 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 311. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 242. Status Key for the Campaign Object Field Name Id IntegrationId Table 243 details the pick map field for the campaign object. Table 243. Pick Map Field for the Campaign Object Pick Map Field Maps To Owner OwnerId Table 244 provides a list of the user key combinations for the campaign object. Table 244. User Key Fields on the Campaign Object User Key Field Combinations Id ExternalSystemId SourceCode CampaignName Table 245 details the picklists available for the campaign object. Table 245. Picklists Available for the Campaign Object Field Name CampaignType Status Related Topic Current User and Opportunity Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 311 Release 18)
- 312. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Category The category object allows you to logically sort products into groups, where each product is in some way related to the other products in the category. The category object is equivalent to the Web Services V1.0 product category object. Methods Called Table 246 details the methods called by the Category service. Table 246. Methods Called by Category Service Method Name as Defined in Service “Delete” on page 82 CategoryDelete “Execute” on page 83 CategoryExecute “Insert” on page 84 CategoryInsert “QueryPage” on page 85 CategoryQueryPage “Update” on page 93 CategoryUpdate Fields Table 247 details the required and read-only fields for the category object. Table 247. Required and Read-Only Fields for the Category Object Field Name Type CategoryName Required Audit Fields Read-only ModifiedByFullName Read-only Table 248 details the status key for the category object. Table 248. Status Key for the Category Object Field Name Audit Fields ExternalSystemId Id 312 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 313. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 248. Status Key for the Category Object Field Name IntegrationId Name Table 249 details the pick map field for the category object. Table 249. Pick Map Field for the Category Object Pick Map Field Maps To ParentCategory ParentCategoryId Table 250 details the user keys for the category object. Table 250. User Keys for the Category Object Field Name Id ExternaSystemId Name Contact The contact object stores information on individuals with whom your organization has a relationship. It allows the user to store information on individuals who are external to your company, but who are associated with the business process. Contacts stored in the Oracle CRM On Demand database can also be associated with an account. Adding and Updating Contact Addresses The contact object has three types of address: 1 Primary address 2 Alternate address 3 Simple address If the contact is associated with an account, the account’s billing address becomes the contact’s primary address, that is, the account’s billing address fields populate the contact’s primary address fields. The primary address fields are read-only in the contact record. The primary address may also be called the account address. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 313 Release 18)
- 314. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) The alternate address is simply the contact’s address. Alternate address fields at the parent level are editable and this address is added to address children with the Primary checkbox in the UI selected. The alternate address may also be called the contact address. You can use either ContactInsert, ContactUpdate or ContactExecute calls to insert or update primary or alternate addresses for a contact. With ContactInsert or ContactUpdate calls, the contact parent node with primary and alternate address fields must be present, and there should not be any child node. If an address child is present, only a simple address can be added, and not primary and alternate addresses. If the address child or any other child node is not present, only primary and alternate addresses can be added, and not simple addresses. With the ContactExecute call, both the contact parent node and address child node can be present along with primary and alternate address fields at the parent level. Child Objects Account, Activity, Address, Attachment, Business Plan, Claim, Contact Best Time, Contact State License, Coverage, Deal Registration, Financial Account, Financial Account Holder, Financial Plan, Interests, Involved Party, Lead, Message Response, Note, Objective, Opportunity, Plan Contact, Policy, Policy Holder, Related Contact, Revenue, Service Request, Signature, Special Pricing Request, Contact Team. Methods Called Table 251 details the methods called by the Contact service. Table 251. Methods Called by Contact Service Method Name as Defined in Service “Delete” on page 82 ContactDelete “Execute” on page 83 ContactExecute “Insert” on page 84 ContactInsert “QueryPage” on page 85 ContactQueryPage “Update” on page 93 ContactUpdate Fields Table 252 details the required and read-only fields for the contact object. Table 252. Required and Read-Only Fields for the Contact Object Field Name Type FirstName Required LastName Required AlternateAddressId Read-only 314 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 315. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 252. Required and Read-Only Fields for the Contact Object Field Name Type ContactConcatField Read-only ContactFullName Read-only Audit Fields Read-only Manager Read-only PrimaryAddressId Read-only Table 253 details the status key for the contact object. Table 253. Status Key for the Contact Object Field Name Audit Fields AccountId ExternalSystemId Id IntegrationId LastUpdated Table 254 details the pick map fields for the contact object. Table 254. Pick Map Fields for the Contact Object Pick Map Field Maps To AccountName AccountId Owner AssignedToAlias SourceCampaignName SourceCampaignId ManagerExternalSystemId ManagerId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 315 Release 18)
- 316. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 255 provides a list of the user key combinations for the contact object. Table 255. User Key Fields on the Contact Object User Key Field Combinations FirstName and LastName Id ExternalSystemId Table 256 details the picklists available for the contact object. Table 256. Picklists Available for the Contact Object Field Name ContactType LeadSource MrMrs BestTimeToCall CallFrequency CurrentInvestmentMix Degree ExperienceLevel Gender InvestmentHorizon LifeEvent MaritalStatus MarketPotential Objective OwnOrRent PrimaryGoal RiskProfile Route Segment Tier 316 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 317. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 257 details a number of contact object fields that you must not use for customer integrations. Table 257. Contact Object Fields That You Must Not Use Field Name PartyTypeCode PartyUId PersonUId CustomObject The CustomObject services expose the functionality of the CustomObject objects to external applications. TIP: The reference information for each of Custom Objects follows the same pattern. In this topic, the information for CustomerObject1 is given as an example. The name of some CustomObject fields in the WSDL files for Web Services v2.0 differ from the names used in the WSDL files for Web Services v1.0. For example, the Web Services v1.1 fields ParentExternalSystemId and ParentName correspond to CustomObject1ExternalSystemId and CustomObject1Name for Web Services v2.0. NOTE: To download the CustomObject WSDL file, you must be given access to the relevant CustomObject object. If you do not have access to the CustomObject object, it is not available to download from the Web Services Administration page or available to use Web service calls. For assistance in gaining access to the CustomObject objects, contact your Oracle CRM On Demand service provider. Child Objects Attachment. Methods Called Table 258 details the methods called by the CustomObject1 service. The methods for the other Custom Objects follow the same pattern. Table 258. Methods Called by CustomObJect1 Service Method Name as Defined in Service “Delete” on page 82 CustomObject1Delete “Execute” on page 83 CustomObject1Execute “Insert” on page 84 CustomObject1Insert Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 317 Release 18)
- 318. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 258. Methods Called by CustomObJect1 Service Method Name as Defined in Service “QueryPage” on page 85 CustomObject1QueryPage “Update” on page 93 CustomObject1Update Fields Table 259 details the required and read-only fields for the CustomObject1 object. Table 259. Required and Read-Only Fields for the CustomObject1 Object Field Name Type CustomObject1Id Required CustomObject1ExternalSystemID Required CustomObject1IntegrationId Required CustomObject1Id Read-only Table 260 details the status key for the CustomObject1 object. Table 260. Status Key for the CustomObject1 Object Field Name Audit Fields CustomObject1Id ExternalSystemId IntegrationId Table 261 details the pick map fields for the CustomObject1 object. Table 261. Pick Map Fields for the CustomObject1 Object Pick Map Field Maps To AccountExternalId AccountId AccountIntegrationId AccountId AccountName AccountId ActivityExternalId ActivityId ActivityIntegrationId ActivityId 318 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 319. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 261. Pick Map Fields for the CustomObject1 Object Pick Map Field Maps To ActivityName ActivityId CampaignExternalId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId ContactExternalId ContactId ContactFirstName ContactId ContactFullName ContactId ContactIntegrationId ContactId ContactLastName ContactId CustomObjectnExternalId CustomObjectnId CustomObjectnIntegrationId CustomObjectnId CustomObjectnName CustomObjectnId DealerName DealerId HouseholdExternalId HouseholdId HouseholdIntegrationId HouseholdId HouseholdName HouseholdId LeadExternalId LeadId LeadFirstName LeadId LeadFullName LeadId LeadIntegrationId LeadId LeadLastName LeadId Owner OwnerId OpportunityExternalId OpportunityId OpportunityIntegrationId OpportunityId OpportunityName OpportunityId ParentExternalSystemId ParentId ParentIntegrationId ParentId PortfolioAccountNumber PortfolioId ProductExternalId ProductId ProductIntegrationId ProductId ProductName ProductId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 319 Release 18)
- 320. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 261. Pick Map Fields for the CustomObject1 Object Pick Map Field Maps To SolutionExternalId SolutionId SolutionIntegrationId SolutionId SolutionTitle SolutionId ServiceRequestExternalId ServiceRequestId ServiceRequestIntegrationId ServiceRequestId ServiceRequestName ServiceRequestId VIN VehicleId Table 262 provides a list of the user key combinations for the CustomObject1 object. Table 262. User Key Fields on the CustomObject1 Object User Key Field Combinations CustomObject1Id ExternalSystemId IntegrationId Group The Group object allows you to create groups to which users can be added. Users can only be a member of one group, and groups can contain many users. The group object is equivalent to the Web Services V1.0 user group object. Methods Called Table 263 details the methods called by the Group service. Table 263. Methods Called by Group Service Method Name as Defined in Service “Delete” on page 82 GroupDelete “Execute” on page 83 GroupExecute “Insert” on page 84 GroupInsert “QueryPage” on page 85 GroupQueryPage “Update” on page 93 GroupUpdate 320 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 321. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Fields Table 264 details the required and read-only fields for the group object. Table 264. Required and Read-Only Fields for the Group Object Field Name Type Name Required UserGroupId Read-only Audit Fields Read-only Table 265 details the status key for the group object. Table 265. Status Key for the Group Object Field Name Audit Fields UserGroupId UserGroupIntegrationId UserGroupExternalSystemId Table 266 details the pick map field for the group object. Table 266. Pick Map Field for the Group Object Pick Map Field Maps To UserIntegrationId UserId UserExternalSystemId UserId Table 267 provides a list of the user key combinations for the group object. Table 267. User Key Fields on the Group Object User Key Field Combinations Id ExternalSystemId Name Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 321 Release 18)
- 322. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Lead The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign. Child Objects Activity, Attachment. Methods Called Table 268 details the methods called by the Lead service. Table 268. Methods Called by Lead Service Method Name as Defined in Service “Delete” on page 82 LeadDelete “Execute” on page 83 LeadExecute “Insert” on page 84 LeadInsert “QueryPage” on page 85 LeadQueryPage “Update” on page 93 LeadUpdate Fields Table 269 details the required and read-only fields for the lead object. Table 269. Required and Read-Only Fields for the Lead Object Field Name Type FirstName Required LastName Required LeadOwner Required ContactFullName Read-only Audit Fields Read-only LastUpdated Read-only LeadConcatField Read-only LeadFullName Read-only ReferredById Read-only 322 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 323. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 270 details the status key for the lead object. Table 270. Status Key for the Lead Object Field Name Audit Fields AccountId CampaignId ContactId ExternalSystemId Id IntegrationId LastUpdated OpportunityId Table 271 details the pick map fields for the lead object. Table 271. Pick Map Fields for the Lead Object Pick Map Field Maps To Campaign CampaignId OpportunityName OpportunityId Owner OwnerId AccountExternalSystemId AccountId OpportunityExternalSystemId OpportunityId ContactExternalSystemId ContactId CampaignExternalSystemId CampaignId ReferredByExternalSystemId ReferredById Table 272 provides a list of the user key combinations of the lead object. Table 272. User Key Fields on the Lead Object User Key Field Combinations Id Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 323 Release 18)
- 324. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 272. User Key Fields on the Lead Object User Key Field Combinations ExternalSystemId LeadFirstName and LeadLastName Table 273 details the picklists available for the lead object. Table 273. Picklists Available for the Lead Object Field Name Country MrMrs Rating Source StateProvince Status Note The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application. The notes can be sent from users or can store extra information (as a note) on a parent object. This allows employees who are working on a particular record to add extra information as they see fit. For example, when talking to a contact, an employee might notice that the contact is not happy with a service provided. The employee can record this information in a note so that any other employees who talk to the contact are aware of the contact’s dissatisfaction. Methods Called Table 274 details the methods called by the Note service. Table 274. Methods Called by Note Service Method Name as Defined in Service “Delete” on page 82 NoteDelete “Execute” on page 83 NoteExecute “Insert” on page 84 NoteInsert “QueryPage” on page 85 NoteQueryPage “Update” on page 93 NoteUpdate 324 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 325. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Fields Table 275 details the required and read-only fields for the note object. Table 275. Required and Read-Only Fields for the Note Object Field Name Type Subject Required NoteId Read-only OwnerId Read-only OwnerAlias Read-only ParentNoteId Read-only SourceId Read-only SourceName Read-only Audit Fields Read-only Table 276 details the status key for the note object. Table 276. Status Key for the Note Object Field Name Audit Fields NoteId Table 277 provides a list of the user key combinations for the note object. Table 277. User Key Fields on the Note Object User Key Field Combinations NoteId Opportunity The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 325 Release 18)
- 326. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Child Objects Activity, Attachment, Deal Registration, Lead, Note, Plan Opportunity, Revenue, Special Pricing Request. Methods Called Table 278 details the methods called by the Opportunity service. Table 278. Methods Called by Opportunity Service Method Name as Defined in Service “Delete” on page 82 OpportunityDelete “Execute” on page 83 OpportunityExecute “Insert” on page 84 OpportunityInsert “QueryPage” on page 85 OpportunityQueryPage “Update” on page 93 OpportunityUpdate Fields Table 279 details the required and read-only fields for the opportunity object. Table 279. Required and Read-Only Fields for the Opportunity Object Field Name Type AccountId Required CloseDate Required OpportunityName Required SalesStage Required Audit Fields Read-only LastUpdated Read-only OpportunityConcatField Read-only Table 280 details the status key for the opportunity object. Table 280. Status Key for the Opportunity Object Field Name Audit Fields AccountId 326 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 327. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 280. Status Key for the Opportunity Object Field Name ExternalSystemId Id IntegrationId Table 281 details the pick map fields for the opportunity object. Table 281. Pick Map Fields for the Opportunity Object Pick Map Field Maps To Owner OwnerId AccountExternalSystemId AccountId Territory TerritoryId KeyContactIntegrationId KeyContactId KeyContactExternalSystemId KeyContactId Table 282 provides a list of the user key combinations for the opportunity object. Table 282. User Key Fields on the Opportunity Object User Key Field Combinations Id ExternalSystemId Name Table 283 details the picklists available for the opportunity object. Table 283. Picklists Available for the Opportunity Object Field Name LeadSource Priority Probability ReasonWonLost Status Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 327 Release 18)
- 328. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 283. Picklists Available for the Opportunity Object Field Name Type Year Make Model Product The product object allows you to define and record details about a product or service that your company sells to its customers, including information on product price, category, and so on. Child Objects Price List Line Item Methods Called Table 284 details the methods called by the Product service. Table 284. Methods Called by Product Service Method Name as Defined in Service “Execute” on page 83 ProductExecute “Insert” on page 84 ProductInsert “QueryPage” on page 85 ProductQueryPage “Update” on page 93 ProductUpdate Fields Table 285 details the required and read-only fields for the product object. Table 285. Required and Read-Only Fields for the Product Object Field Name Type ProductName Required Audit Fields Read-only 328 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 329. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 286 details the status key for the product object. Table 286. Status Key for the Product Object Field Name Audit Fields Id IntegrationId Table 287 details the pick map field for the product object. Table 287. Pick Map Field for the Product Object Pick Map Field Maps To ParentCategory ParentCategoryId Table 288 details the user keys for the product object. Table 288. User Keys for the Product Object Field Name ProductName Id ExternalSystemId Table 289 details the picklists available for the product object. Table 289. Picklists Available for the Product Object Field Name BodyStyle Category Class CurrencyCode DoorStyle Engine Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 329 Release 18)
- 330. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 289. Picklists Available for the Product Object Field Name Make Model PriceType ProductType Revision Status SubType TherapeuticClass Transmission Trim Service Request The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly. Child Objects Attachment, Note. Methods Called Table 290 details the methods called by the Service request service. Table 290. Methods Called by Service Request Service Method Name as Defined in Service “Delete” on page 82 ServiceRequestDelete “Execute” on page 83 ServiceRequestExecute “Insert” on page 84 ServiceRequestInsert “QueryPage” on page 85 ServiceRequestQueryPage “Update” on page 93 ServiceRequestUpdate 330 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 331. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Fields Table 291 details the required and read-only fields for the service request object. Table 291. Required and Read-Only Fields for the Service Request Object Field Name Type ContactEmail Read-only ContactFirstName Read-only ContactFullName Read-only ContactLastName Read-only Audit Fields Read-only LastUpdated Read-only ServiceRequestConcatId Read-only Table 292 details the status key for the service request object. Table 292. Status Key for the Service Request Object Field Name Audit Fields AccountId ContactId ExternalSystemId Id IntegrationId LastUpdated Table 293 details the pick map fields for the service request object. Table 293. Pick Map Fields for the Service Request Object Pick Map Field Maps To Owner OwnerId AccountExternalSystemId AccountId AssetIntegrationId AssetId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 331 Release 18)
- 332. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 293. Pick Map Fields for the Service Request Object Pick Map Field Maps To AssetExternalSystemId AssetId ProductExternalSystemId ProductId Table 294 provides a list of the user key combinations for the service request object. Table 294. User Key Fields on the Service Request Object User Key Field Combinations Id ExternalSystemId SRNumber Table 295 details the picklists available for the service request object. Table 295. Picklists Available for the Service Request Object Field Name Area Cause Priority Source Status Type Solution The solution object stores information on solutions to customer problems or service requests. Solutions can be reused if the same problem is identified with a product or service. This prevents the duplication of work for customer service representatives. Child Object Attachment, Book, Message Response, Messaging Plan, Messaging Plan Item, Messaging Plan Item Relation. 332 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 333. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Methods Called Table 296 details the methods called by the Solution service. Table 296. Methods Called by Solution Service Method Name as Defined in Service “Delete” on page 82 SolutionDelete “Execute” on page 83 SolutionExecute “Insert” on page 84 SolutionInsert “QueryPage” on page 85 SolutionQueryPage “Update” on page 93 SolutionUpdate Fields Table 297 details the required and read-only fields for the solution object. Table 297. Required and Read-Only Fields for the Solution Object Field Name Type Title Required Audit Fields Read-only CreatorId Read-only LastUpdated Read-only Table 298 details the status key for the solution object. Table 298. Status Key for the Solution Object Field Name Audit Fields ExternalSystemId Id IntegrationId LastUpdated Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 333 Release 18)
- 334. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 299 provides a list of the user key combinations for the solution object. Table 299. User Key Fields on the Solution Object User Key Field Combinations Name Id ExternalSystemId Table 300 details the picklists available for the solution object. Table 300. Picklists Available for the Solution Object Field Name Area Cause Priority Source Status Type Territory The territory object allows you to store information about the sales territory that is assigned to a user. This information includes the territory name, a description, the currency code, and the sales quota for the territory. Methods Called Table 301 details the methods called by the Territory service. Table 301. Methods Called by Territory Service Method Name as Defined in Service “Delete” on page 82 TerritoryDelete “Execute” on page 83 TerritoryExecute “Insert” on page 84 TerritoryInsert 334 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 335. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 301. Methods Called by Territory Service Method Name as Defined in Service “QueryPage” on page 85 TerritoryQueryPage “Update” on page 93 TerritoryUpdate Fields Table 302 details the required and read-only fields for the territory object. Table 302. Required and Read-Only Fields for the Territory Object Field Name Type TerritoryName Required Territory Read-only Audit Fields Read-only Table 303 details the status key for the territory object. Table 303. Status Key for the Territory Object Field Name Audit Fields ExternalSystemId IntegrationId TerritoryId Table 304 details the pick map field for the territory object. Table 304. Pick Map Field for the Territory Object Pick Map Field Maps To ParentTerritoryIntegrationId ParentTerritoryId ParentTerritoryExternalSystemId ParentTerritoryId ParentTerritoryId ParentTerritoryId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 335 Release 18)
- 336. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Table 305 details the user key for the territory object. Table 305. User Key for the Territory Object Field Name Id ExternalSystemId TerritoryName Table 306 details the picklist fields available for the territory object. Table 306. Picklists Available for the Territory Object Field Name ParentTerritoryExternalSystemId ParentTerritoryIntegrationId User The user object allows you to define and record details of all users in the application, for example, name, position, contact details, manager, and so on. It enables queries to be run on all users, and enables an administrator to insert and update a user’s profile. Usage The UserLoginId and UserSignInId fields must be used as follows: ■ UserLoginId. Used for creating user records through the User Web service. ■ UserSignInId. Used as the user name for logging in and authenticating using Web services. Also, used for queries, as using UserLoginId is not allowed for queries. Child Object Delegated User 336 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 337. Oracle CRM On Demand Objects Exposed Through Web Services ■ Core Parent Objects (Web Services v2.0) Methods Called Table 307 details the methods called by the User service. Table 307. Methods Called by User Service Method Name as Defined in Service “Execute” on page 83 UserExecute “Insert” on page 84 UserInsert “QueryPage” on page 85 UserQueryPage “Update” on page 93 UserUpdate Fields Table 308 details the required and read-only fields for the user object. Table 308. Required and Read-Only Fields for the User Object Field Name Type FirstName Required LastName Required UserLoginId Required UserSignInId Required Alias Required EmailAddr Required Role Required Status Required Audit Fields Read-only LastSignInDateTime Read-only ManagerFullName Read-only Table 309 details the status key for the user object. Table 309. Status Key for the User Object Field Name ModifiedById ModifiedDate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 337 Release 18)
- 338. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 309. Status Key for the User Object Field Name EMailAddr UserId IntegrationId Table 310 details the pick map field for the user object. Table 310. Pick Map Field for the User Object Pick Map Field Maps To Role RoleId Table 311 provides a list of user key combinations for the user object. Table 311. User Key Fields on the User Object User Key Field Combinations Id ExternalSystemId Alias Partner Relationship Management Edition Objects (Web Services v2.0) This topic includes the parent objects available with Oracle CRM On Demand Partner Relationship Management Edition. For these parent objects, all child objects are also exposed. NOTE: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider. The following objects are detailed in this topic: ■ “Accreditation” on page 339 ■ “Accreditation Request” on page 341 ■ “Application” on page 343 ■ “Certification” on page 346 338 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 339. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) ■ “Certification Request” on page 348 ■ “Course” on page 350 ■ “Course Enrollment” on page 352 ■ “Deal Registration” on page 355 ■ “Exam” on page 357 ■ “Exam Registration” on page 359 ■ “Fund” on page 362 ■ “MDF Request” on page 364 ■ “Partner” on page 366 ■ “Price List” on page 368 ■ “Price List Line Item” on page 370 ■ “Special Pricing Request” on page 372 ■ “Special Pricing Request Line Item” on page 374 Accreditation The accreditation object stores information about a partner company's accreditation for selling products, providing services, or both. Accreditations are an acknowledgement of a partner company's skill, competence, and training in selling a particular line of products or offering services such as design, installation, upgrade, and so on. A partner company is awarded an accreditation upon satisfying several requirements; one of which is usually a minimum number (or percentage) of employees with specific certifications. In Oracle CRM On Demand, an accreditation can be held only by a partner company. Individuals cannot hold accreditations; instead, they hold certifications. Child Objects Accreditation, Accreditation Request, Attachment, Book, Category, Certification, Custom Object 01-03, Custom Object 4 and higher, Product, Solution. Methods Called Table 312 details the methods called by the Accreditation service. Table 312. Methods Called by Accreditation Service Method Name as Defined in Service “Delete” on page 82 AccreditationDelete “Execute” on page 83 AccreditationExecute “Insert” on page 84 AccreditationInsert Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 339 Release 18)
- 340. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 312. Methods Called by Accreditation Service Method Name as Defined in Service “QueryPage” on page 85 AccreditationQueryPage “Update” on page 93 AccreditationUpdate Fields Table 313 details the required and read-only fields for the accreditation object. Table 313. Required and Read-Only Fields for the Accreditation Object Field Name Type Name Required Status Required OwnerId Required Audit Fields Read-only Table 314 details the status key for the accreditation object. Table 314. Status Key for the Accreditation Object Field Name Audit Fields Id ModId Table 315 details the pick map fields for the accreditation object. Table 315. Pick Map Fields for the Accreditation Object Pick Map Field Maps To PrimaryProductProductCategory, PrimaryProductId PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType PrimaryProductCategoryName PrimaryProductCategoryId 340 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 341. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 315. Pick Map Fields for the Accreditation Object Pick Map Field Maps To ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId Table 316 provides a list of the user key combinations for the accreditation object. Table 316. User Key Fields on the Accreditation Object User Key Field Combinations Id Name Table 317 details the picklists available for the accreditation object. Table 317. Picklists Available for the Accreditation Object Field Name PaymentOption Status Type Accreditation Request The accreditation request object stores information about a partner company's request for accreditation. Child Objects None Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 341 Release 18)
- 342. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Methods Called Table 318 details the methods called by the Accreditation Request service. Table 318. Methods Called by Accreditation Request Service Method Name as Defined in Service “Delete” on page 82 AccreditationRequestDelete “Execute” on page 83 AccreditationRequestExecute “Insert” on page 84 AccreditationRequestInsert “QueryPage” on page 85 AccreditationRequestQueryPage “Update” on page 93 AccreditationRequestUpdate Fields Table 319 details the required and read-only fields for the accreditation request object. Table 319. Required and Read-Only Fields for the Accreditation Request Object Field Name Type AccreditationId Required PartnerId Required OwnerId Required Audit Fields Read-only Table 320 details the status key for the accreditation request object. Table 320. Status Key for the Accreditation Request Object Field Name Audit Fields Id ModId 342 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 343. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 321 details the pick map fields for the accreditation request object. Table 321. Pick Map Fields for the Accreditation Request Object Pick Map Field Maps To AccreditationName, AccreditationNum, AccreditationId AccreditationStatus, AccreditationType, AccreditationExternalSystemId PartnerChannelAccountManagerAlias, PartnerId PartnerIntegrationId, PartnerExternalSystemId, PartnerLocation, PartnerMainPhone, PartnerName ObjectiveName, ObjectiveExternalSystemId ObjectiveId PlanName, PlanType, PlanStatus, PlanId PlanDescription, PlanExternalSystemId Table 322 provides a list of the user key combinations for the accreditation request object. Table 322. User Key Fields on the Accreditation Request Object User Key Field Combinations Id AccreditationId, PartnerId and RequestDate Table 323 details the picklists available for the accreditation request object. Table 323. Picklists Available for the Accreditation Request Object Field Name Status Application The application object is the means by which a new or existing partner applies for a partnership with the brand owner. The brand owner then reviews, approves, or rejects the application. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 343 Release 18)
- 344. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Child Objects Activity, Book. Methods Called Table 324 details the methods called by the Application service. Table 324. Methods Called by Application Service Method Name as Defined in Service “Delete” on page 82 ApplicationDelete “Execute” on page 83 ApplicationExecute “Insert” on page 84 ApplicationInsert “QueryPage” on page 85 ApplicationQueryPage “Update” on page 93 ApplicationUpdate Fields Table 325 details the required and read-only fields for the application object. Table 325. Required and Read-Only Fields for the Application Object Field Name Type ContactFirstName Required ContactLastName Required SubmissionStatus Required CompanyName Required CurrencyCode Read-only Audit Fields Read-only Table 326 details the status key for the application object. Table 326. Status Key for the Application Object Field Name Audit Fields Id ModId 344 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 345. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 327 details the pick map fields for the application object. Table 327. Pick Map Fields for the Application Object Pick Map Field Maps To CurrentApproverAlias CurrentApproverId AssociatedPartnerName PartnerId PartnerProgramProgramName PartnerProgramId CampaignName CampaignId OwnerAlias OwnerId ProcessedByAlias ProcessedById Table 328 provides a list of the user key combinations for the application object. Table 328. User Key Fields on the Application Object User Key Field Combinations Id ExternalSystemId CompanyName Table 329 details the picklists available for the application object. Table 329. Picklists Available for the Application Object Field Name ApprovalStatus PartnerType ProgramLevel RejectReason Source SubmissionStatus Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 345 Release 18)
- 346. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Certification The certification object stores information about an individual's competency in a specific set of skills. In Oracle CRM On Demand, certifications are always associated with an individual, in contrast to accreditations, which are always associated with a partner company. A certification is proof of an individual's competency in a specific set of skills. Child Objects Accreditation, Attachment, Book, Category, Certification, Certification Request, Course, Custom Object 01-03, Custom Object 4 and higher, Exam, Product, Solution. Methods Called Table 330 details the methods called by the Certification service. Table 330. Methods Called by Certification Service Method Name as Defined in Service “Delete” on page 82 CertificationDelete “Execute” on page 83 CertificationExecute “Insert” on page 84 CertificationInsert “QueryPage” on page 85 CertificationQueryPage “Update” on page 93 CertificationUpdate Fields Table 331 details the required and read-only fields for the certification object. Table 331. Required and Read-Only Fields for the Certification Object Field Name Type Name Required Status Required OwnerId Required Audit Fields Read-only 346 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 347. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 332 details the status key for the certification object. Table 332. Status Key for the Certification Object Field Name Audit Fields Id ModId Table 333 details the pick map fields for the certification object. Table 333. Pick Map Fields for the Certification Object Pick Map Field Maps To PrimaryProductProductCategory, PrimaryProductId PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType PrimaryProductCategoryName PrimaryProductCategoryId ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId Table 334 provides a list of the user key combinations for the certification object. Table 334. User Key Fields on the Certification Object User Key Field Combinations Id Name Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 347 Release 18)
- 348. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 335 details the picklists available for the certification object. Table 335. Picklists Available for the Certification Object Field Name PaymentOption Status Type Certification Request The certification request object stores information about an individual’s request for certification. Child Objects None. Methods Called Table 336 details the methods called by the Certification Request service. Table 336. Methods Called by Certification Request Service Method Name as Defined in Service “Delete” on page 82 CertificationRequestDelete “Execute” on page 83 CertificationRequestExecute “Insert” on page 84 CertificationRequestInsert “QueryPage” on page 85 CertificationRequestQueryPage “Update” on page 93 CertificationRequestUpdate Fields Table 337 details the required and read-only fields for the certification request object. Table 337. Required and Read-Only Fields for the Certification Request Object Field Name Type CertificationId Required ContactId Required 348 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 349. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 337. Required and Read-Only Fields for the Certification Request Object Field Name Type OwnerId Required Audit Fields Read-only Table 338 details the status key for the certification request object. Table 338. Status Key for the Certification Request Object Field Name Audit Fields Id ModId Table 339 details the pick map fields for the certification request object. Table 339. Pick Map Fields for the Certification Request Object Pick Map Field Maps To CertificationName, CertificationNum, CertificationId CertificationStatus, CertificationType, CertificationExternalSystemId ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId PlanName, PlanType, PlanStatus, PlanId PlanDescription, PlanExternalSystemId Table 340 provides a list of the user key combinations for the certification request object. Table 340. User Key Fields on the Certification Request Object User Key Field Combinations Id CertificationId, ContactId, and RequestDate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 349 Release 18)
- 350. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 341 details the picklists available for the certification request object. Table 341. Picklists Available for the Certification Request Object Field Name Status Course The course object stores information about a training course. A course is a structured educational programme offered with the primary aim of imparting a specific set of skills to an individual. Many companies, especially those that deal with complex products or services, require their partners and resellers to be adequately trained in and familiar with what they sell. Typically, courses focus on a specific product or product family; however, at times, they might also deal with generic concepts or principles. Courses may either be theoretical or practical, or a blend of both. Child Objects Attachment, Book, Category, Certification, Course, Course Enrollment, Custom Object 01-03, Custom Object 4 and higher, Exam, Partner, Product, Solution. Methods Called Table 342 details the methods called by the Course service. Table 342. Methods Called by Course Service Method Name as Defined in Service “Delete” on page 82 CourseDelete “Execute” on page 83 CourseExecute “Insert” on page 84 CourseInsert “QueryPage” on page 85 CourseQueryPage “Update” on page 93 CourseUpdate 350 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 351. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Fields Table 343 details the required and read-only fields for the course object. Table 343. Required and Read-Only Fields for the Course Object Field Name Type Name Required Status Required OwnerId Required Audit Fields Read-only Table 344 details the status key for the course object. Table 344. Status Key for the Course Object Field Name Audit Fields Id ModId Table 345 details the pick map fields for the course object. Table 345. Pick Map Fields for the Course Object Pick Map Field Maps To PrimaryProductProductCategory, PrimaryProductId PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType ProductCategoryName ProductCategoryId ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 351 Release 18)
- 352. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 345. Pick Map Fields for the Course Object Pick Map Field Maps To ExamType, ExamStatus, ExamName, ExamId ExamID, ExamExternalSystemId OwnerFirstName, OwnerLastName, OwnerId OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr Table 346 provides a list of the user key combinations for the course object. Table 346. User Key Fields on the Course Object User Key Field Combinations Id CourseId, CandidateId, and EnrollDate Table 347 details the picklists available for the course object. Table 347. Picklists Available for the Course Object Field Name Type Status Format Medium PaymentOption Course Enrollment The course enrollment object stores information about an individual’s enrollment for a course. Child Objects None 352 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 353. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Methods Called Table 348 details the methods called by the Course Enrollment service. Table 348. Methods Called by Course Enrollment Service Method Name as Defined in Service “Delete” on page 82 CourseEnrollmentDelete “Execute” on page 83 CourseEnrollmentExecute “Insert” on page 84 CourseEnrollmentInsert “QueryPage” on page 85 CourseEnrollmentQueryPage “Update” on page 93 CourseEnrollmentUpdate Fields Table 349 details the required and read-only fields for the course enrollment object. Table 349. Required and Read-Only Fields for the Course Enrollment Object Field Name Type CourseId Required CandidateId Required OwnerId Required Audit Fields Read-only Table 350 details the status key for the course enrollment object. Table 350. Status Key for the Course Enrollment Object Field Name Audit Fields Id ModId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 353 Release 18)
- 354. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 351 details the pick map fields for the course enrollment object. Table 351. Pick Map Fields for the Course Enrollment Object Pick Map Field Maps To CourseName, CourseStatus, CourseType, CourseId CourseID, CourseExternalSystemId CandidateContactEmail, CandidateId CandidateContactFirstName, CandidateContactLastName, CandidateContactFullName, CandidateIntegrationId, CandidateAccountName, CandidateExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId OfferingPartnerChannelAccountManagerAlias, OfferingPartnerId OfferingPartnerIntegrationId, OfferingPartnerExternalSystemId, OfferingPartnerLocation, OfferingPartnerMainPhone, OfferingPartnerPartnerName OwnerFirstName, OwnerLastName, OwnerId OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr Table 352 provides a list of the user key combinations for the course enrollment object. Table 352. User Key Fields on the Course Enrollment Object User Key Field Combinations CourseId CandidateId EnrollDate 354 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 355. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 353 details the picklists available for the course enrollment object. Table 353. Picklists Available for the Course Enrollment Object Field Name Status Deal Registration The deal registration object stores information about the process by which a partner company requests exclusive rights to an opportunity from the brand owner. Child Objects Activity, Book, Custom Object 01 -03, Custom Object 4 and higher, Special Pricing Request. Methods Called Table 354 details the methods called by the Deal Registration service. Table 354. Methods Called by Deal Registration Service Method Name as Defined in Service “Delete” on page 82 DealRegistrationDelete “Execute” on page 83 DealRegistrationExecute “Insert” on page 84 DealRegistrationInsert “QueryPage” on page 85 DealRegistrationQueryPage “Update” on page 93 DealRegistrationUpdate Fields Table 355 details the required and read-only fields for the deal registration object. Table 355. Required and Read-Only Fields for the Deal Registration Object Field Name Type DealRegistrationName Required Type Required PartnerId Required SubmissionStatus Required Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 355 Release 18)
- 356. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 355. Required and Read-Only Fields for the Deal Registration Object Field Name Type DealRegistrationId Read-only ConvertedtoOpportunity Read-only Audit Fields Read-only Table 356 details the status key for the deal registration object. Table 356. Status Key for the Deal Registration Object Field Name Audit Fields Id ModId Table 357 details the pick map fields for the deal registration object. Table 357. Pick Map Fields for the Deal Registration Object Pick Map Field Maps To PartnerExternalSystemId PartnerId PartnerName PartnerId Table 358 provides a list of the user key combinations for the deal registration object. Table 358. User Key Fields on the Deal Registration Object User Key Field Combinations ExternalSystemId DealRegistrationName and PartnerId Id 356 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 357. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 359 details the picklists available for the deal registration object. Table 359. Picklists Available for the Deal Registration Object Field Name Type Status State Country Salutation ApprovalStatus RejectReason Exam The exam object stores information about a training examination. Exams measure the competency of an individual in a specific set of skills. They are usually the next logical step for an individual after completing a course. Typically, a course culminates in an exam (or exams) and an individual is expected to register and appear for the exams upon completing the course. In fact, many companies consider that a course has been successfully completed only if the exams are passed with at least the minimum passing score. Child Objects Attachment, Book, Category, Certification, Course, Custom Object 01-03, Custom Object 4 and higher, Exam, Exam Registration, Partner, Product, Solution. Methods Called Table 360 details the methods called by the Exam service. Table 360. Methods Called by Exam Service Method Name as Defined in Service “Delete” on page 82 ExamDelete “Execute” on page 83 ExamExecute “Insert” on page 84 ExamInsert “QueryPage” on page 85 ExamQueryPage “Update” on page 93 ExamUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 357 Release 18)
- 358. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Fields Table 361 details the required and read-only fields for the exam object. Table 361. Required and Read-Only Fields for the Exam Object Field Name Type Name Required Status Required OwnerId Required Audit Fields Read-only Table 362 details the status key for the exam object. Table 362. Status Key for the Exam Object Field Name Audit Fields Id ModId Table 363 details the pick map fields for the exam object. Table 363. Pick Map Fields for the Exam Object Pick Map Field Maps To PrimaryProductProductCategory, PrimaryProductId PrimaryProductExternalSystemId, PrimaryProductDescription, PrimaryProductName, PrimaryProductPartNumber, PrimaryProductStatus, PrimaryProductIntegrationId, PrimaryProductType ProductCategoryName ProductCategoryId ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId 358 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 359. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 363. Pick Map Fields for the Exam Object Pick Map Field Maps To ObjectiveName, ObjectiveExternalSystemId ObjectiveId OwnerFirstName, OwnerLastName, OwnerId OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr Table 364 provides a list of the user key combinations for the exam object. Table 364. User Key Fields on the Exam Object User Key Field Combinations Id Name Table 365 details the picklists available for the exam object. Table 365. Picklists Available for the Exam Object Field Name Type Status Format Medium PaymentOption Grade Exam Registration The exam registration object stores information about an individual’s registration for an examination. Child Objects None. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 359 Release 18)
- 360. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Methods Called Table 366 details the methods called by the Exam Registration service. Table 366. Methods Called by Exam Registration Service Method Name as Defined in Service “Delete” on page 82 ExamRegistrationDelete “Execute” on page 83 ExamRegistrationExecute “Insert” on page 84 ExamRegistrationInsert “QueryPage” on page 85 ExamRegistrationQueryPage “Update” on page 93 ExamRegistrationUpdate Fields Table 367 details the required and read-only fields for the exam registration object. Table 367. Required and Read-Only Fields for the Exam Registration Object Field Name Type ExamId Required CandidateId Required ExamDate Required OwnerId Required Audit Fields Read-only Table 368 details the status key for the exam registration object. Table 368. Status Key for the Exam Registration Object Field Name Audit Fields Id ModId 360 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 361. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 369 details the pick map fields for the exam registration object. Table 369. Pick Map Fields for the Exam Registration Object Pick Map Field Maps To ExamName, ExamStatus, ExamType, ExamID, ExamId ExamExternalSystemId ContactEmail, ContactFirstName, ContactId ContactLastName, ContactFullName, ContactIntegrationId, ContactAccountName, ContactExternalSystemId ObjectiveName, ObjectiveExternalSystemId ObjectiveId PartnerChannelAccountManagerAlias, PartnerId PartnerIntegrationId, PartnerExternalSystemId, PartnerLocation, PartnerMainPhone, PartnerName, OwnerFirstName, OwnerLastName, OwnerId OwnerUserSignInId, OwnerAlias, OwnerFullName, OwnerIntegrationId, OwnerExternalSystemId, OwnerEMailAddr. Table 370 provides a list of the user key combinations for the exam registration object. Table 370. User Key Fields on the Exam Registration Object User Key Field Combinations Id CourseId, CandidateId, OwnerId, and ExamDate Table 371 details the picklists available for the exam registration object. Table 371. Picklists Available for the Exam Registration Object Field Name Status Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 361 Release 18)
- 362. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Fund The fund object stores information about a sum of money or a set of other resources that are set aside for a specific purpose. Child Objects Activity, Custom Object 01-03, Custom Object 4 and higher, MDF Request, Special Pricing Request. Methods Called Table 372 details the methods called by the Fund service. Table 372. Methods Called by Fund Service Method Name as Defined in Service “Delete” on page 82 FundDelete “Execute” on page 83 FundExecute “Insert” on page 84 FundInsert “QueryPage” on page 85 FundQueryPage “Update” on page 93 FundUpdate Fields Table 373 details the required and read-only fields for the fund object. Table 373. Required and Read-Only Fields for the Fund Object Field Name Type FundName Required FundId Required TargetAmount Required Audit Fields Read-only 362 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 363. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 374 details the status key for the fund object. Table 374. Status Key for the Fund Object Field Name Audit Fields Id ModId Table 375 details the pick map field for the fund object. Table 375. Pick Map Field for the Fund Object Pick Map Field Maps To Partner PartnerId Table 376 provides a list of the user key combinations for the fund object. Table 376. User Key Fields on the Fund Object User Key Field Combinations FundId Id Table 377 details the picklists available for the fund object. Table 377. Picklists Available for the Fund Object Field Name FundCode Status Type CurrencyCode Partner Period Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 363 Release 18)
- 364. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) MDF Request The MDF request object stores information about market development funds (MDF) requests. Child Objects Activity, Book, Custom Object 01-03, Custom Object 4 and higher. Methods Called Table 378 details the methods called by the MDF Request service. Table 378. Methods Called by MDF Request Service Method Name as Defined in Service “Delete” on page 82 MDFRequestDelete “Execute” on page 83 MDFRequestExecute “Insert” on page 84 MDFRequestInsert “QueryPage” on page 85 MDFRequestQueryPage “Update” on page 93 MDFRequestUpdate Fields Table 379 details the required and read-only fields for the MDF request object. Table 379. Read-Only Fields on the MDF Request Object Field Name Type RequestName Required PrincipalPartnerAccountId Required FundName Required DueDate Required SubmissionStatus Required MDFRequestId Read-only Audit Fields Read-only 364 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 365. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 380 details the status key for the MDF request object. Table 380. Status Key for the MDF Request Object Field Name Audit Fields Id ModId Table 381 details the pickmap fields for the MDF request object. Table 381. Pick Map Fields for the MDF Request Object Pick Map Field Maps To PrincipalPartnerAccountExternalSystemId PrincipalPartnerAccountId PrincipalPartnerAccountIntegrationId PrincipalPartnerAccountId PrincipalPartnerAccountPartnerName, PrincipalPartnerAccountId PrincipalPartnerAccountLocation PrincipalPartnerAccountChannelAccountManagerAlias PrincipalPartnerAccountId Table 382 provides a list of the user key combinations for the MDF request object. Table 382. User Key Fields on the MDF Request Object User Key Field Combinations RequestName Id ExternalSystemId Table 383 details the picklists available for the MDF request object. Table 383. Picklists Available for the MDF Request Object Field Name Status Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 365 Release 18)
- 366. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 383. Picklists Available for the MDF Request Object Field Name SubmissionStatus ApprovalStatus MarketingPurpose Region Category ReasonCode ClaimStatus Partner The partner object allows you to define and record details about partner accounts. Child Objects Application, Book, Business Plan, Custom Object 4 and higher, Deal Registration, MDF Request, Partner, Policy, Special Pricing Request. Methods Called Table 384 details the methods called by the Partner service. Table 384. Methods Called by Partner Service Method Name as Defined in Service “Insert” on page 84 PartnerInsert “QueryPage” on page 85 PartnerQueryPage “Update” on page 93 PartnerUpdate Fields Table 385 details the read-only fields for the partner object. Table 385. Read-Only Fields on the Partner Object Field Name Type PartnerName Required 366 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 367. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 385. Read-Only Fields on the Partner Object Field Name Type CurrencyCode Read-only Audit Fields Read-only Table 386 details the status key for the partner object. Table 386. Status Key for the Partner Object Field Name Audit Fields Id ModId Table 387 details the pickmap fields for the partner object. Table 387. Pick Map Fields for the Partner Object Pick Map Field Maps To Owner OwnerId ParentAccountName, ParentAccountId ParentAccountLocation ChannelAccountManager ChannelAccountManagerId SourceCampaignName SourceCampaignId OwnerPartnerAccountPartnerName OwnerPartnerId PrincipalPartnerPartnerName PrincipalPartnerId OriginatingPartnerAccountPartnerName OriginatingPartnerId Territory TerritoryId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 367 Release 18)
- 368. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 388 provides a list of the user key combinations for the partner object. Table 388. User Key Fields on the Partner Object User Key Field Combinations Id ExternalSystemId Location PartnerName Table 389 details the picklists available for the partner object. Table 389. Picklists Available for the Partner Object Field Name CallFrequency ComplianceStatus Expertise InfluenceType MarketPotential MarketSegment PartnerOrgStatus PartnerLevel Priority Region Route Status Price List The price list object store information about a price list for products. Child Objects Account, Partner, Price List Line Item, Special Pricing Request. 368 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 369. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Methods Called Table 390 details the methods called by the Price List service. Table 390. Methods Called by Price List Service Method Name as Defined in Service “Delete” on page 82 PriceListDelete “Execute” on page 83 PriceListExecute “Insert” on page 84 PriceListInsert “QueryPage” on page 85 PriceListQueryPage “Update” on page 93 PriceListUpdate Fields Table 391 details the required and read-only fields for the price list object. Table 391. Required and Read-Only Fields for the Price List Object Field Name Type PriceListName Required EffectiveFrom Required Type Required Status Required CurrencyCode Required Audit Fields Read-only Table 392 details the status key for the price list object. Table 392. Status Key for the Price List Object Field Name Audit Fields Id ModId There are no pick map fields for the price list object. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 369 Release 18)
- 370. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 393 details the user keys for the price list object. Table 393. User Keys for the Price List Object Field Name PriceListName and Type Id ExternalSystemId Table 394 details the picklists available for the price list object. Table 394. Picklists Available for the Price List Object Field Name Type Status Price List Line Item The price list line item object store information about a product in a price list. Child Objects None Methods Called Table 395 details the methods called by the Price List Line Item service. Table 395. Methods Called by Price List Line Item Service Method Name as Defined in Service “Delete” on page 82 PriceListLineItemDelete “Execute” on page 83 PriceListLineItemExecute “Insert” on page 84 PriceListLineItemInsert “QueryPage” on page 85 PriceListLineItemQueryPage “Update” on page 93 PriceListLineItemUpdate 370 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 371. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Fields Table 396 details the required and read-only fields for the price list line item object. Table 396. Required and Read-Only Fields for the Price List Line Item Object Field Name Type PriceListId Required ProductId Required Type Required Audit Fields Read-only Table 397 details the status key for the price list line item object. Table 397. Status Key for the Price List Line Item Object Field Name Audit Fields Id ModId Table 398 details the pick map field for the price list line item object. Table 398. Pick Map Field for the Price List Line Item Object Pick Map Field Maps To ProductExternalSystemId ProductId ProductIntegrationId ProductId ProductName, ProductId ProductCategory PriceListPriceListName PriceListId PriceListIntegrationId PriceListId PriceListExternalSystemId PriceListId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 371 Release 18)
- 372. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 399 details the user keys for the price list line item object. Table 399. User Keys for the Price List Line Item Object Field Name Id ExternalSystemId ProductId and PriceListId and PriceType Table 400 details the picklists available for the price list line item object. Table 400. Picklists Available for the Price List Line Item Object Field Name PriceType Special Pricing Request The Special Pricing (SP) request object stores information about a special pricing request, which is a set of business processes where a partner asks the brand owner for a discount on a product. Child Objects Activity, Book, Custom Object 01 - 03, Custom Object 4 and higher, Special Pricing Request Line Item. Methods Called Table 401 details the methods called by the SP Request service. Table 401. Methods Called by SP Request Service Method Name as Defined in Service “Delete” on page 82 SPRequestDelete “Execute” on page 83 SPRequestExecute “Insert” on page 84 SPRequestInsert “QueryPage” on page 85 SPRequestQueryPage “Update” on page 93 SPRequestUpdate 372 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 373. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Fields Table 402 details the required and read-only fields for the SP request object. Table 402. Read-Only Fields on the SP Request Object Field Name Type SPRequestName Required PrincipalPartnerAccountId Required SubmissionStatus Required SPRequestId Read-only Audit Fields Read-only Table 403 details the status key for the SP request object. Table 403. Status Key for the SP Request Object Field Name Audit Fields Id ModId Table 404 details the pickmap fields for the SP request object. Table 404. Pick Map Fields for the SP Request Object Pick Map Field Maps To PrincipalPartnerAccountExternalSystemId PrincipalPartnerAccountId PrincipalPartnerAccountIntegrationId PrincipalPartnerAccountId PrincipalPartnerAccountPartnerName, PrincipalPartnerAccountId PrincipalPartnerAccountLocation PrincipalPartnerAccountChannelAccountManagerAlias PrincipalPartnerAccountId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 373 Release 18)
- 374. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Table 405 provides a list of the user key combinations for the SP request object. Table 405. User Key Fields on the SP Request Object User Key Field Combinations Id ExternalSystemId SPRequestName FundId and RequestDate Table 406 details the picklists available for the SP request object. Table 406. Picklists Available for the SP Request Object Field Name SubmissionStatus ApprovalStatus RejectReason Type ClaimStatus Special Pricing Request Line Item The Special Pricing (SP) request line item object stores information about a product associated with a special pricing request. Child Objects None. 374 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 375. Oracle CRM On Demand Objects Exposed Through Web Services ■ Partner Relationship Management Edition Objects (Web Services v2.0) Methods Called Table 407 details the methods called by the SP Request Line Item service. Table 407. Methods Called by SP Request Line Item Service Method Name as Defined in Service “Delete” on page 82 SPRequestLineItemDelete “Execute” on page 83 SPRequestLineItemExecute “Insert” on page 84 SPRequestLineItemInsert “QueryPage” on page 85 SPRequestLineItemQueryPage “Update” on page 93 SPRequestLineItemUpdate Fields Table 408 details the required and read-only fields for the SP request line item object. Table 408. Read-Only Fields on the SP Request Line Item Object Field Name Type ProductId Required SPRequestId Read-only Audit Fields Read-only Table 409 details the status key for the SP request line item object. Table 409. Status Key for the SP Request Line Item Object Field Name Audit Fields Id ModId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 375 Release 18)
- 376. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 410 details the pickmap fields for the SP request line item object. Table 410. Pick Map Fields for the SP Request Line Item Object Pick Map Field Maps To ProductExternalSystemId ProductId ProductIntegrationId ProductId ProductName, ProductCategory ProductId Table 411 provides a list of the user key combinations for the SP request line item object. Table 411. User Key Fields on the SP Request Line Item Object User Key Field Combinations Id ExternalSystemId ItemNumber There are no picklists available for the SP request line item object. Life Sciences Edition Parent Objects (Web Services v2.0) This topic includes the parent objects available with Oracle CRM On Demand Life Sciences Edition. For these parent objects, all child objects are also exposed. NOTE: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider. The following objects are detailed in this topic: ■ “Allocation” on page 377 ■ “Business Plan” on page 379 ■ “Contact Best Time” on page 382 ■ “Contact State License” on page 384 ■ “Inventory Audit Report” on page 386 ■ “Inventory Period” on page 388 376 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 377. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) ■ “MedEd” on page 390 ■ “Message Response” on page 392 ■ “Messaging Plan” on page 394 ■ “Messaging Plan Item” on page 397 ■ “Messaging Plan Item Relation” on page 399 ■ “Modification Tracking” on page 401 ■ “Objective” on page 403 ■ “Plan Account” on page 405 ■ “Plan Contact” on page 407 ■ “Plan Opportunity” on page 409 ■ “Sample Disclaimer” on page 411 ■ “Sample Inventory” on page 413 ■ “Sample Lot” on page 415 ■ “Sample Transaction” on page 417 ■ “Signature” on page 420 ■ “Transaction Item” on page 421 NOTE: While the Business Plan, Objective, Plan Account, Plan Contact, and Plan Opportunity functionality was developed in the context of Oracle CRM On Demand Life Sciences Edition, all Oracle CRM On Demand customers can access and leverage this functionality. Your administrator or customer advocate can enable the Business Plan, Objective, Plan Account, Plan Contact, and Plan Opportunity objects and make these pages available for your use. Allocation The allocation object determines the period of time in which sample products are provided for a sales representative to distribute to clinics, hospitals, or physician contacts during a sample drop call execution. Child Objects None. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 377 Release 18)
- 378. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 412 details the methods called by the Allocation service. Table 412. Methods Called by Allocation Service Method Name as Defined in Service “Delete” on page 82 AllocationDelete “Execute” on page 83 AllocationExecute “Insert” on page 84 AllocationInsert “QueryPage” on page 85 AllocationQueryPage “Update” on page 93 AllocationUpdate Fields Table 413 details the required and read-only fields for the allocation object. Table 413. Required and Read-Only Fields for the Allocation Object Field Name Type AllocationType Required OwnerId Required ProductName Required StopSampleFlag Required ActivePeriod Read-only Audit Fields Read-only Table 414 details the status key for the allocation object. Table 414. Status Key for the Allocation Object Field Name Audit Fields Id ModId 378 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 379. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 415 details the pick map fields for the allocation object. Table 415. Pick Map Fields for the Allocation Object Pick Map Field Maps To ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 416 provides a list of the user key combinations for the allocation object. Table 416. User Key Fields on the Allocation Object User Key Field Combinations Id ExternalSystemId OwnerId and ProductId and StartDate and EndDate and AllocationType Table 417 details the picklists available for the allocation object. Table 417. Picklists Available for the Allocation Object Field Name AllocationType Business Plan The business plan object allows sales organizations to explicitly establish strategic goals (for example, revenue targets) and action plans to achieve those goals, in the form of objectives, activities, and opportunities. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 379 Release 18)
- 380. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Child Objects Activity, Business Plan, Objective, Plan Account, Plan Contact, Plan Opportunity. Methods Called Table 418 details the methods called by the Business Plan service. Table 418. Methods Called by BusinessPlan Service Method Name as Defined in Service “Delete” on page 82 BusinessPlanDelete “Execute” on page 83 BusinessPlanExecute “Insert” on page 84 BusinessPlanInsert “QueryPage” on page 85 BusinessPlanQueryPage “Update” on page 93 BusinessPlanUpdate Fields Table 419 details the required and read-only fields for the business plan object. Table 419. Required and Read-Only Fields for the Business plan Object Field Name Type PlanName Required PeriodName Required Type Required Status Required Audit Fields Read-only Table 420 details the status key for the business plan object. Table 420. Status Key for the Business plan Object Field Name Audit Fields Id ModId 380 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 381. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 421 details the pick map fields for the business plan object. Table 421. Pick Map Fields for the Business plan Object Pick Map Field Maps To ParentPlanNamePlanName ParentPlanId ParentPlanNameExternalSystemId ParentPlanId ParentPlanNameIntegrationId ParentPlanId ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId PeriodName PeriodId PeriodExternalSystemId PeriodId PeriodIntegrationId PeriodId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 422 provides a list of the user key combinations for the business plan object. Table 422. User Key Fields on the Business plan Object User Key Field Combinations Id ExternalSystemId PeriodId and PlanName Table 423 details the picklists available for the business plan object. Table 423. Picklists Available for the Business plan Object Field Name Type Status Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 381 Release 18)
- 382. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Contact Best Time The contact best time object records and tracks the best time and day of week to call on a contact (by typically, a physician or another health care provider). Child Objects None. Methods Called Table 424 details the methods called by the Contact Best Time service. Table 424. Methods Called by Contact Best Time Service Method Name as Defined in Service “Delete” on page 82 ContactBestTimeDelete “Execute” on page 83 ContactBestTimeExecute “Insert” on page 84 ContactBestTimeInsert “QueryPage” on page 85 ContactBestTimeQueryPage “Update” on page 93 ContactBestTimePlanUpdate Fields Table 425 details the required and read-only fields for the contact best time object. Table 425. Required and Read-Only Fields for the Contact Best Time Object Field Name Type StartDay Required StartTime Required EndTime Required FullAddress Required ContactFullName Required Audit Fields Read-only 382 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 383. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 426 details the status key for the contact best time object. Table 426. Status Key for the Contact Best Time Object Field Name Audit Fields Id ModId Table 427 details the pick map fields for the contact best time object. Table 427. Pick Map Fields for the Contact Best Time Object Pick Map Field Maps To AddressExternalSystemId AddressId AddressIntegrationId AddressId ContactFullName ContactId ContactExternalSystemId ContactId ContactIntegrationId ContactId Table 428 provides a list of the user key combinations for the contact best time object. Table 428. User Key Fields on the Contact Best Time Object User Key Field Combinations ContactId AddressId ExternalSystemId Table 429 details the picklists available for the contact best time object. Table 429. Picklists Available for the Contact Best Time Object Field Name StartDay Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 383 Release 18)
- 384. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Contact State License The contact state license object stores the medical license information for a contact, typically a physician. Child Objects None. Methods Called Table 430 details the methods called by the contact state license service. Table 430. Methods Called by Contact State License Service Method Name as Defined in Service “Delete” on page 82 ContactLicenseDelete “Execute” on page 83 ContactLicenseExecute “Insert” on page 84 ContactLicenseInsert “QueryPage” on page 85 ContactLicenseQueryPage “Update” on page 93 ContactLicenseUpdate Fields Table 431 details the required and read-only fields for the contact state license object. Table 431. Required and Read-Only Fields for the Contact State LicenseObject Field Name Type ContactFullName Required LicenseNumber Required Audit Fields Read-only Table 432 details the status key for the contact state license object. Table 432. Status Key for the Contact State License Object Field Name Audit Fields 384 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 385. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 432. Status Key for the Contact State License Object Field Name Id ModId Table 433 details the pick map fields for the contact state license object. Table 433. Pick Map Fields for the Contact State License Object Pick Map Field Maps To ContactFullName ContactId ContactExternalSystemId ContactId ContactIntegrationId ContactId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 434 provides a list of the user key combinations for the contact state license object. Table 434. User Key Fields on the Contact State License Object User Key Field Combinations Id ExternalSystemId ContactId and State LicenseNumber Table 435 details the picklists available for the contact state license object. Table 435. Picklists Available for the Contact State License Object Field Name State Status Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 385 Release 18)
- 386. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Inventory Audit Report The inventory audit report object stores information about the reports generated by Oracle CRM On Demand when a sales representative chooses to create a new interim or final audit count for an inventory period. Child Objects Sample Inventory Methods Called Table 436 details the methods called by the Inventory Audit Report service. Table 436. Methods Called by Inventory Audit Report Service Method Name as Defined in Service “Delete” on page 82 InventoryAuditReportDelete “Execute” on page 83 InventoryAuditReportExecute “Insert” on page 84 InventoryAuditReportInsert “QueryPage” on page 85 InventoryPeriodQueryPage “Update” on page 93 InventoryPeriodUpdate Fields Table 437 details the required and read-only fields for the inventory audit report object. Table 437. Required and Read-Only Fields for the Inventory Audit Report Object Field Name Type Type Required Status Required Reason Required CountCompletedOn Required InventoryPeriodStartDate Required OwnerUserSignId Required Audit Fields Read-only 386 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 387. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 438 details the status key for the inventory audit report object. Table 438. Status Key for the Inventory Audit Report Object Field Name Audit Fields Id ModId Table 439 details the pick map fields for the inventory audit report object. Table 439. Pick Map Field for the Inventory Audit Report Object Pick Map Field Maps To InventoryPeriodExternalSystemId InventoryPeriodId InventoryPeriodIdIntegrationId InventoryPeriodId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 440 provides a list of the user key combinations for the inventory audit report object. Table 440. User Key Fields on the Inventory Audit Report Object User Key Field Combinations Id ExternalSystemId InventoryPeriodId and OwnerId and CountCompletedOn Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 387 Release 18)
- 388. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 441 details the picklists available for the inventory audit report object. Table 441. Picklists Available for the Inventory Audit Report Object Field Name Type Status Reason Inventory Period The inventory period object represents a time frame within which all movement of samples or promotional items (sample drops, receipts, disbursements, and inventory adjustments) can be tracked. Child Objects Inventory Audit Report, Sample Inventory, Sample Transaction, Sample Transaction. Methods Called Table 442 details the methods called by the Inventory Period service. Table 442. Methods Called by Inventory Period Service Method Name as Defined in Service “Delete” on page 82 InventoryPeriodDelete “Execute” on page 83 InventoryPeriodExecute “Insert” on page 84 InventoryPeriodInsert “QueryPage” on page 85 InventoryPeriodQueryPage “Update” on page 93 InventoryPeriodUpdate 388 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 389. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Fields Table 443 details the required and read-only fields for the inventory period object. Table 443. Required and Read-Only Fields for the Inventory Period Object Field Name Type StartDate Required OwnerId Required ActiveFlg Required ReconciledFlg Required Audit Fields Read-only Table 444 details the status key for the inventory period object. Table 444. Status Key for the Inventory Period Object Field Name Audit Fields Id ModId Table 445 details the pick map fields for the inventory period object. Table 445. Pick Map Field for the Inventory Period Object Pick Map Field Maps To OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 446 provides a list of the user key combinations for the inventory period object. Table 446. User Key Fields on the Inventory Period Object User Key Field Combinations Id Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 389 Release 18)
- 390. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 446. User Key Fields on the Inventory Period Object User Key Field Combinations ExternalSystemId OwnerId and StartDate MedEd The MedEd object allows you to plan and track medical education events. A medical education event can be as simple as a lunch-and-learn session in a physician's office or as complex as a seminar series or national sales meeting. Child Objects Book, Invitee Methods Called Table 447 details the methods called by the MedEd service. Table 447. Methods Called by MedEd Service Method Name as Defined in Service “Delete” on page 82 MedEdDelete “Execute” on page 83 MedEdExecute “Insert” on page 84 MedEdInsert “QueryPage” on page 85 MedEdQueryPage “Update” on page 93 MedEdUpdate Fields Table 448 details the required and read-only fields for the MedEd object. Table 448. Read-Only Fields on the MedEd Object Field Name Type EndDate Required Name Required Objective Required 390 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 391. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 448. Read-Only Fields on the MedEd Object Field Name Type StartDate Required Audit Fields Read-only Table 449 details the status key for the MedEd object. Table 449. Status Key for the MedEd Object Field Name Audit Fields ExternalId MedEdId Table 450 details the pickmap fields for the MedEd object. Table 450. Pick Map Fields for the MedEd Object Pick Map Field Maps To ProductExternalId ProductId ProductIntegrationId ProductId Table 451 provides a list of the user key combinations for the MedEd object. Table 451. User Key Fields on the MedEd Object User Key Field Combinations MedEdId ExternalSystemId Name Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 391 Release 18)
- 392. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 452 details the picklists available for the MedEd object. Table 452. Picklists Available for the MedEd Object Field Name EventStatusCode EventTypeCode Message Response The message response object stores feedback received from the audience during the presentation of a message plan during a particular period. Child Objects None Methods Called Table 453 details the methods called by the Message Response service. Table 453. Methods Called by Message Response Service Method Name as Defined in Service “Delete” on page 82 MessageResponseDelete “Execute” on page 83 MessageResponseExecute “Insert” on page 84 MessageResponseInsert “QueryPage” on page 85 MessageResponseQueryPage “Update” on page 93 MessageResponseUpdate Fields Table 454 details the required and read-only fields for the message response object. Table 454. Read-Only Fields on the Message Response Object Field Name Type EndTime Required FollowUp Required 392 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 393. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 454. Read-Only Fields on the Message Response Object Field Name Type Response Required SequenceNumber Required SolutionId Required StartTime Required Message Read-only Duration Read-only Audit Fields Read-only Table 455 details the status key for the message response object. Table 455. Status Key for the Message Response Object Field Name Audit Fields Id ModId Table 456 details the pickmap fields for the message response object. Table 456. Pick Map Fields for the Message Response Object Pick Map Field Maps To ContactFullName ContactId ContactExternalSystemId ContactId ContactIntegrationId ContactId AccountName AccountId AccountExternalSystemId AccountId AccountIntegrationId AccountId SolutionTitle SolutionId SolutionExternalSystemId SolutionId SolutionIntegrationId SolutionId PlanName PlanId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 393 Release 18)
- 394. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 456. Pick Map Fields for the Message Response Object Pick Map Field Maps To PlanExternalSystemId PlanId PlanIntegrationId Planid PlanItemName PlanItemId PlanItemExternalSystemId PlanItemId PlanItemIntegrationId PlanItemId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 457 provides a list of the user key combinations for the message response object. Table 457. User Key Fields on the Message Response Object User Key Field Combinations Id ExternalSystemId PlanName and SolutionName Table 458 details the picklists available for the message response object. Table 458. Picklists Available for the Message Response Object Field Name Response Messaging Plan The messaging plan object stores information about a presentation delivered using a personal computer or tablet computer for sales users to detail products and track customer feedback. Child Objects Book, Message Response, Messaging Plan Item. 394 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 395. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 459 details the methods called by the Messaging Plan service. Table 459. Methods Called by Messaging Plan Service Method Name as Defined in Service “Delete” on page 82 MessagePlanDelete “Execute” on page 83 MessagePlanExecute “Insert” on page 84 MessagePlanInsert “QueryPage” on page 85 MessagePlanQueryPage “Update” on page 93 MessagePlanUpdate Fields Table 460 details the required and read-only fields for the messaging plan object. Table 460. Read-Only Fields on the Messaging Plan Object Field Name Type Name Required OwnerId Required Type Required ProductName Required Status Required LockSequence Required DisclosureMandatory Required EnableFollowUp Required VerificationStatus Read-only Audit Fields Read-only Table 461 details the status key for the messaging plan object. Table 461. Status Key for the Messaging Plan Object Field Name Audit Fields Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 395 Release 18)
- 396. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 461. Status Key for the Messaging Plan Object Field Name Id ModId Table 462 details the pickmap fields for the messaging plan object. Table 462. Pick Map Fields for the Messaging Plan Object Pick Map Field Maps To SolutionTitle SolutionId SolutionExternalSystemId SolutionId SolutionIntegrationId SolutionId EffectivePeriodName EffectivePeriodId EffectivePeriodExternalSystemId EffectivePeriodId EffectivePeriodIntegrationId EffectivePeriodId ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 463 provides a list of the user key combinations for the messaging plan object. Table 463. User Key Fields on the Messaging Plan Object User Key Field Combinations Id ExternalSystemId Name and OwnerId 396 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 397. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 464 details the picklists available for the messaging plan object. Table 464. Picklists Available for the Messaging Plan Object Field Name Type Status Skin Messaging Plan Item The messaging plan item object stores information about the items that make up a message plan. Child Objects Messaging Plan Item Relation, Message Response. Methods Called Table 465 details the methods called by the Messaging Plan Item service. Table 465. Methods Called by Messaging Plan Item Service Method Name as Defined in Service “Delete” on page 82 MsgPlanItemDelete “Execute” on page 83 MsgPlanItemExecute “Insert” on page 84 MsgPlanItemInsert “QueryPage” on page 85 MsgPlanItemQueryPage “Update” on page 93 MsgPlanItemUpdate Fields Table 466 details the required and read-only fields for the messaging plan item object. Table 466. Read-Only Fields on the Messaging Plan Item Object Field Name Type SequenceNumber Required DisclosureMessage Required Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 397 Release 18)
- 398. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 466. Read-Only Fields on the Messaging Plan Item Object Field Name Type Type Required SolutionNameTitle Required ParentMessagePlanName Required Audit Fields Read-only Table 467 details the status key for the messaging plan item object. Table 467. Status Key for the Messaging Plan Item Object Field Name Audit Fields Id ModId Table 468 details the pickmap fields for the messaging plan item object. Table 468. Pick Map Fields for the Messaging Plan Item Object Pick Map Field Maps To ParentMessagePlanName ParentMessagePlanId ParentMessagePlanExternalSystemId ParentMessagePlanId ParentMessagePlanIntegrationId ParentMessagePlanId SolutionNameTitle SolutionId SolutionExternalSystemId SolutionId SolutionIntegrationId SolutionId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId 398 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 399. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 469 provides a list of the user key combinations for the messaging plan item object. Table 469. User Key Fields on the Messaging Plan Item Object User Key Field Combinations Id ExternalSystemId ParentMessagePlanId and SolutionNameId and SequenceNumber and Type Table 470 details the picklists available for the messaging plan item object. Table 470. Picklists Available for the Messaging Plan Item Object Field Name Type Status Rating Messaging Plan Item Relation The messaging plan item relation object stores information about a presentation item that provides optional information to support the primary message plan item. Child Objects None Methods Called Table 471 details the methods called by the Messaging Plan Item Relation service. Table 471. Methods Called by Messaging Plan Item Service Method Name as Defined in Service “Delete” on page 82 MsgPlanItemRelationDelete “Execute” on page 83 MsgPlanItemRelationExecute “Insert” on page 84 MsgPlanItemRelationInsert Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 399 Release 18)
- 400. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 471. Methods Called by Messaging Plan Item Service Method Name as Defined in Service “QueryPage” on page 85 MsgPlanItemRelationQueryPage “Update” on page 93 MsgPlanItemRelationUpdate Fields Table 472 details the required and read-only fields for the messaging plan item relation object. Table 472. Read-Only Fields on the Messaging Plan Item Relation Object Field Name Type Type Required ParentMPItemName Required SolutionNameTitle Required Audit Fields Read-only Table 473 details the status key for the messaging plan item relation object. Table 473. Status Key for the Messaging Plan Item Relation Object Field Name Audit Fields Id ModId Table 474 details the pickmap fields for the messaging plan item relation object. Table 474. Pick Map Fields for the Messaging Plan Item Relation Object Pick Map Field Maps To ParentMPItemName ParentMPItemId ParentMPItemExternalSystemId ParentMPItemId ParentMPItemIntegrationId ParentMPItemid SolutionNameTitle SolutionId SolutionExternalSystemId SolutionId 400 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 401. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 474. Pick Map Fields for the Messaging Plan Item Relation Object Pick Map Field Maps To SolutionIntegrationId SolutionId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 475 provides a list of the user key combinations for the messaging plan item relation object. Table 475. User Key Fields on the Messaging Plan Item Relation Object User Key Field Combinations Id ExternalSystemId ParentMPId and SolutionNameId and Type Table 476 details the picklists available for the messaging plan item relation object. Table 476. Picklists Available for the Messaging Plan Item Relation Object Field Name Type Status Rating Modification Tracking The modification tracking object stores information about change events for a given set of Oracle CRM On Demand objects. When the modification tracking feature is enabled, for each event a modification record is written to the modification tracking log, which is used for synchronization of external mobile applications. For information about the list of objects for which change events are tracked, and the modification tracking feature generally, see the Oracle CRM On Demand online help. Child Objects None. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 401 Release 18)
- 402. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 477 details the methods called by the Modification Tracking service. Table 477. Methods Called by Modification Tracking Service Method Name as Defined in Service “Delete” on page 82 ModificationTrackingDelete “Execute” on page 83 ModificationTrackingExecute “Insert” on page 84 ModificationTrackingInsert “QueryPage” on page 85 ModificationTrackingQueryPage “Update” on page 93 ModificationTrackingUpdate Fields Table 478 details the required and read-only fields for the modification tracking object. Table 478. Required and Read-Only Fields for the Modification Tracking Object Field Name Type ObjectId Required EventName Required ObjectName Required ModificationNumber Required Audit Fields Read-only Table 479 details the status key for the modification tracking object. Table 479. Status Key for the Modification Tracking Object Field Name Audit Fields Id ModId 402 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 403. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 480 provides a list of the user key combinations for the modification tracking object. Table 480. User Key Fields on the Modification Tracking Object User Key Field Combinations Id ObjectName Objective The objective object stores information about a tactical goal you want to achieve to attain a higher level strategic goal in a business plan. Child Objects Activity, Objective, Opportunity. Methods Called Table 481 details the methods called by the objective service. Table 481. Methods Called by Objective Service Method Name as Defined in Service “Delete” on page 82 ObjectiveDelete “Execute” on page 83 ObjectiveExecute “Insert” on page 84 ObjectiveInsert “QueryPage” on page 85 ObjectiveQueryPage “Update” on page 93 ObjectiveUpdate Fields Table 482 details the required and read-only fields for the objective object. Table 482. Required and Read-Only Fields for the Objective Object Field Name Type ObjectiveName Required Type Required Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 403 Release 18)
- 404. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 482. Required and Read-Only Fields for the Objective Object Field Name Type Status Required PeriodName Required Audit Fields Read-only Table 483 details the status key for the objective object. Table 483. Status Key for the Objective Object Field Name Audit Fields Id ModId Table 484 details the pick map fields for the objective object. Table 484. Pick Map Fields for the Objective Object Pick Map Field Maps To ParentObjectiveObjectiveName ParentObjectiveId ParentObjectiveExternalSystemId ParentObjectiveId ParentObjectiveIntegrationId ParentObjectiveId PlanNamePlanName PlanNameId PlanNameExternalSystemId PlanNameId PlanNameIntegrationId PlanNameId AccountNameAccountName AccountId AccountExternalSystemId AccountId AccountIntegrationId AccountId ContactNameContactFullName ContactId ContactExternalSystemId ContactId ContactIntegrationId ContactId ProductNameName ProductId ProductdExternalSystemId ProductId ProductIntegrationId ProductId 404 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 405. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 484. Pick Map Fields for the Objective Object Pick Map Field Maps To PeriodName PeriodId PeriodExternalSystemId PeriodId PeriodIntegrationId PeriodId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 485 provides a list of the user key combinations for the objective object. Table 485. User Key Fields on the Objective Object User Key Field Combinations Id ExternalSystemId AccountNameId and ContactNameId and ProductNameId and PeriodId ObjectiveName Table 486 details the picklists available for the objective object. Table 486. Picklists Available for the Objective Object Field Name Status Type ObjectiveUnits Plan Account The plan account object is a mapping of accounts and business plans. Child Objects None. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 405 Release 18)
- 406. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 487 details the methods called by the plan account service. Table 487. Methods Called by Plan Account Service Method Name as Defined in Service “Delete” on page 82 AccountBusinessPlanDelete “Execute” on page 83 AccountBusinessPlanExecute “Insert” on page 84 AccountBusinessPlanInsert “QueryPage” on page 85 AccountBusinessPlanQueryPage “Update” on page 93 AccountBusinessPlanUpdate Fields Table 488 details the required and read-only fields for the plan account object. Table 488. Required and Read-Only Fields for the Plan Account Object Field Name Type AccountIDAccountName Required BusinessPlanPlanName Required ContactId Required RelationshipCode Read-only Audit Fields Read-only Table 489 details the status key for the plan account object. Table 489. Status Key for the Plan Account Object Field Name Audit Fields Id ModId 406 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 407. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 490 details the pick map fields for the plan account object. Table 490. Pick Map Fields for the Plan Account Object Pick Map Field Maps To AccountIDAccountName AccountId AccountExternalSystemId AccountId AccountIntegrationId AccountId BusinessPlanPlanName BusinessPlanId BusinessPlanExternalSystemId BusinessPlanId BusinessPlanIntegrationId BusinessPlanId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 491 provides a list of the user key combinations for the plan account object. Table 491. User Key Fields on the Plan Account Object User Key Field Combinations Id ExternalSystemId BusinessPlanId and AccountIDId BusinessPlanPlanName Plan Contact The plan contact object is a mapping of contacts and business plans. Child Objects None Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 407 Release 18)
- 408. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 492 details the methods called by the plan contact service. Table 492. Methods Called by Plan Contact Service Method Name as Defined in Service “Delete” on page 82 ContactBusinessPlanDelete “Execute” on page 83 ContactBusinessPlanExecute “Insert” on page 84 ContactBusinessPlanInsert “QueryPage” on page 85 ContactBusinessPlanQueryPage “Update” on page 93 ContactBusinessPlanUpdate Fields Table 493 details the required and read-only fields for the plan contact object. Table 493. Required and Read-Only Fields for the Plan Contact Object Field Name Type ContactId Required BusinessPlanPlanName Required Audit Fields Read-only Table 494 details the status key for the plan contact object. Table 494. Status Key for the Plan Contact Object Field Name Audit Fields Id ModId Table 495 details the pick map fields for the plan contact object. Table 495. Pick Map Fields for the Plan Contact Object Pick Map Field Maps To ContactFullName ContactId ContactExternalSystemId ContactId 408 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 409. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 495. Pick Map Fields for the Plan Contact Object Pick Map Field Maps To ContactIntegrationId ContactId BusinessPlanPlanName BusinessPlanId BusinessPlanExternalSystemId BusinessPlanId BusinessPlanIntegrationId BusinessPlanId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 496 provides a list of the user key combinations for the plan contact object. Table 496. User Key Fields on the Plan Contact Object User Key Field Combinations Id ExternalSystemId BusinessPlanId and ContactId ContactFullName Plan Opportunity The plan opportunity object is a mapping of opportunities and business plans. Child Objects None. Methods Called Table 497 details the methods called by the Plan Opportunity service. Table 497. Methods Called by Plan Opportunity Service Method Name as Defined in Service “Delete” on page 82 PlanOpportunityDelete “Execute” on page 83 PlanOpportunityExecute Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 409 Release 18)
- 410. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 497. Methods Called by Plan Opportunity Service Method Name as Defined in Service “Insert” on page 84 PlanOpportunityInsert “QueryPage” on page 85 PlanOpportunityQueryPage “Update” on page 93 PlanOpportunityUpdate Fields Table 498 details the required and read-only fields for the plan opportunity object. Table 498. Required and Read-Only Fields for the Plan Opportunity Object Field Name Type OpportunityName Required PlanName Required Audit Fields Read-only Table 499 details the status key for the plan opportunity object. Table 499. Status Key for the Plan Opportunity Object Field Name Audit Fields Id ModId Table 500 details the pick map fields for the plan opportunity object. Table 500. Pick Map Fields for the Plan Opportunity Object Pick Map Field Maps To OpportunityName OpportunityId OpportunityExternalSystemId OpportunityId OpportunityIntegrationId OpportunityId PlanName PlanId PlanExternalSystemId PlanId PlanIntegrationId PlanId OwnerUserSignId OwnerId 410 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 411. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 500. Pick Map Fields for the Plan Opportunity Object Pick Map Field Maps To OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 501 provides a list of the user key combinations for the plan opportunity object. Table 501. User Key Fields on the Plan Opportunity Object User Key Field Combinations Id ExternalSystemId PlanId and OpportunityId OpportunityName Sample Disclaimer The sample disclaimer object stores the text that is displayed to deny responsibility for certain adverse effects and reduce liability for a product sample that is dropped off to a physician or other health care professional. Child Objects None Methods Called Table 502 details the methods called by the Sample Disclaimer service. Table 502. Methods Called by Sample Disclaimer Service Method Name as Defined in Service “Delete” on page 82 SignatureDisclaimerDelete “Execute” on page 83 SignatureDisclaimerExecute “Insert” on page 84 SignatureDisclaimerInsert “QueryPage” on page 85 SignatureDisclaimerQueryPage “Update” on page 93 SignatureDisclaimerUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 411 Release 18)
- 412. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Fields Table 503 details the required and read-only fields for the sample disclaimer object. Table 503. Required and Read-Only Fields for the Sample Disclaimer Object Field Name Type DisclaimerText Required Status Required Audit Fields Read-only Table 504 details the status key for the sample disclaimer object. Table 504. Status Key for the Sample Disclaimer Object Field Name Audit Fields Id ModId Table 505 details the pick map field for the sample disclaimer object. Table 505. Pick Map Field for the Sample Disclaimer Object Pick Map Field Maps To OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 506 details the user keys for the sample disclaimer object. Table 506. User Keys for the Sample Disclaimer Object Field Name Id ExternalSystemId 412 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 413. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 506. User Keys for the Sample Disclaimer Object Field Name DisclaimerNumber Status and Created Table 507 details the picklists available for the sample disclaimer object. Table 507. Picklists Available for the Sample Disclaimer Object Field Name Status Sample Inventory The sample inventory object stores information about a product that has been categorized as qualifying for dropping a sample. Child Objects None Methods Called Table 508 details the methods called by the Sample Inventory service. Table 508. Methods Called by Sample Inventory Service Method Name as Defined in Service “Delete” on page 82 SampleInventoryDelete “Execute” on page 83 SampleInventoryExecute “Insert” on page 84 SampleInventoryInsert “QueryPage” on page 85 SampleInventoryQueryPage “Update” on page 93 SampleInventoryUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 413 Release 18)
- 414. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Fields Table 509 details the required and read-only fields for the sample inventory object. Table 509. Required and Read-Only Fields for the Sample Inventory Object Field Name Type InventoryPeriodStartDate Required ProductName Required OpeningBalance Required SystemCount Read-only Difference Read-only InventoryLot Read-only Audit Fields Read-only Table 510 details the status key for the sample inventory object. Table 510. Status Key for the Sample Inventory Object Field Name Audit Fields Id ModId Table 511 details the pick map field for the sample inventory object. Table 511. Pick Map Fields for the Sample Inventory Object Pick Map Field Maps To LotNumLotId LotNumId LotNumExternalSystemId LotNumId LotNumIntegrationId LotNumId InventoryPeriodExternalSystemId InventoryPeriodId InventoryPeriodIntegrationId InventoryPeriodId AuditReportExternalSystemId AuditReportId AuditReportIntegrationId AuditReportId 414 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 415. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 511. Pick Map Fields for the Sample Inventory Object Pick Map Field Maps To ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 512 details the user keys for the sample inventory object. Table 512. User Keys for the Sample Inventory Object Field Name SampleInventoryId IntegrationId ExternalSystemId OwnerId and ProductId and InventoryPeriodId and LotNumId and AuditReportId ProductName Sample Lot The sample lot object records information about lot numbers for sample products. Child Objects Sample Inventory, Transaction Item. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 415 Release 18)
- 416. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 513 details the methods called by the Sample Lot service. Table 513. Methods Called by Sample Lot Service Method Name as Defined in Service “Delete” on page 82 SampleLotDelete “Execute” on page 83 SampleLotExecute “Insert” on page 84 SampleLotInsert “QueryPage” on page 85 SampleLotQueryPage “Update” on page 93 SampleLotUpdate Fields Table 514 details the required and read-only fields for the sample lot object. Table 514. Required and Read-Only Fields for the Sample Lot Object Field Name Type LotId Required SampleName Required ExpirationDate Required Orderable Required ParentSampleNameName Required Status Read-only CutoffDate Read-only Audit Fields Read-only Table 515 details the status key for the sample lot object. Table 515. Status Key for the Sample Lot Object Field Name Audit Fields Id ModId 416 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 417. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 516 details the pick map field for the sample lot object. Table 516. Pick Map Field for the Sample Lot Object Pick Map Field Maps To ParentSampleNameName ParentSampleNameId ParentSampleNameExternalSystemId ParentSampleNameId ParentSampleNameIntegrationId ParentSampleNameId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 517 details the user keys for the sample lot object. Table 517. User Keys for the Sample Lot Object Field Name Id ExternalSystemId LotId Sample Transaction The sample transaction object is a record for a sample transfer, receipt, disbursement, or inventory adjustment. A sample transaction is created so that all movement of samples and promotional items can be reported and reconciled at the end of an inventory period, and a running count of inventory products can be maintained during the life of an inventory period. Child Objects Transaction Item Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 417 Release 18)
- 418. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 518 details the methods called by the Sample Transaction service. Table 518. Methods Called by Sample Transaction Service Method Name as Defined in Service “Delete” on page 82 TransactionDelete “Execute” on page 83 TransactionExecute “Insert” on page 84 TransactionInsert “QueryPage” on page 85 TransactionQueryPage “Update” on page 93 TransactionUpdate Fields Table 519 details the required and read-only fields for the sample transaction object. Table 519. Required and Read-Only Fields for the Sample Transaction Object Field Name Type Name Required TransactionDate Required TransactionType Required InvoiceNumber Required Audit Fields Read-only Table 520 details the status key for the sample transaction object. Table 520. Status Key for the Sample Transaction Object Field Name Audit Fields Id ModId 418 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 419. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 521 details the pick map field for the sample transaction object. Table 521. Pick Map Field for the Sample Transaction Object Pick Map Field Maps To SalesPersonIDId SalesPersonIDId SalesPersonIDExternalSystemId SalesPersonIDId SalesPersonIDIntegrationId SalesPersonIDId TransferToUserSignId TransferToId TransferToExternalSystemId TransferToId TransferToIntegrationId TransferToId InventoryPeriodExternalSystemId InventoryPeriodId InventoryPeriodIntegrationId InventoryPeriodId ProductIntegrationId ProductId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 522 details the user keys for the sample transaction object. Table 522. User Keys for the Sample Transaction Object Field Name Id ExternalSystemId Name Table 523 details the picklists available for the sample transaction object. Table 523. Picklists Available for the Sample Transaction Object Field Name TransactionType TransactionStatus Reason Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 419 Release 18)
- 420. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Signature The signature object stores information about a signature associated with a call activity for samples that are dropped. Child Objects None Methods Called Table 524 details the methods called by the Signature service. Table 524. Methods Called by Signature Service Method Name as Defined in Service “Delete” on page 82 SignatureDelete “Execute” on page 83 SignatureExecute “Insert” on page 84 SignatureItemInsert “QueryPage” on page 85 SignatureQueryPage “Update” on page 93 SignatureUpdate Fields Table 525 details the required and read-only fields for the signature object. Table 525. Required and Read-Only Fields for the Signature Object Field Name Type ActivityId Required SignatureCtrl Required Audit Fields Read-only Table 526 details the status key for the signature object. Table 526. Status Key for the Signature Object Field Name Audit Fields 420 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 421. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 526. Status Key for the Signature Object Field Name Id ModId Table 527 details the pick map field for the signature object. Table 527. Pick Map Field for the Signature Object Pick Map Field Maps To ContactFullName ContactId ContactExternalSystemId ContactId ContactIntegrationId ContactId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 528 details the user keys for the signature object. Table 528. User Keys for the Signature Object Field Name Id ExternalSystemId ActivityId Transaction Item The transaction item object stores the details of the sample or promotional items associated with a sample transaction. Child Objects None Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 421 Release 18)
- 422. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Methods Called Table 529 details the methods called by the Transaction Item service. Table 529. Methods Called by Transaction Item Service Method Name as Defined in Service “Delete” on page 82 TransactionItemDelete “Execute” on page 83 TransactionItemExecute “Insert” on page 84 TransactionItemInsert “QueryPage” on page 85 TransactionItemQueryPage “Update” on page 93 TransactionItemUpdate Fields Table 530 details the required and read-only fields for the transaction item object. Table 530. Required and Read-Only Fields for the Transaction Item Object Field Name Type LineNumber Required SampleTransactionName Required ProductName Required Quantity Required Audit Fields Read-only Table 531 details the status key for the transaction item object. Table 531. Status Key for the Transaction Item Object Field Name Audit Fields Id ModId 422 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 423. Oracle CRM On Demand Objects Exposed Through Web Services ■ Life Sciences Edition Parent Objects (Web Services v2.0) Table 532 details the pick map field for the transaction item object. Table 532. Pick Map Field for the Transaction Item Object Pick Map Field Maps To SampleTransactionName SampleTransactionId SampleTransactionExternalSystemId SampleTransactionId SampleTransactionIntegrationId SampleTransactionId LotNumLotId LotNumId LotNumExternalSystemId LotNumId LotNumIntegrationId LotNumId InventoryPeriodExternalSystemId InventoryPeriodId InventoryPeriodIntegrationId InventoryPeriodId ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId OwnerUserSignId OwnerId OwnerExternalSystemId OwnerId OwnerIntegrationId OwnerId Table 533 details the user keys for the transaction item object. Table 533. User Keys for the Transaction Item Object Field Name Id ExternalSystemId SampleTransactionId and LineNumber ProductName Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 423 Release 18)
- 424. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Financial Services Edition Parent Objects (Web Services v2.0) This topic includes the parent objects available with Oracle CRM On Demand Financial Services Edition. For these parent objects, all child objects are also exposed. NOTE: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider. The following objects are detailed in this topic: ■ “Claim” on page 424 ■ “Coverage” on page 427 ■ “Damage” on page 429 ■ “Financial Account” on page 431 ■ “Financial Account Holder” on page 433 ■ “Financial Account Holding” on page 435 ■ “Financial Plan” on page 437 ■ “Financial Product” on page 439 ■ “Financial Transaction” on page 441 ■ “Household” on page 443 ■ “Insurance Property” on page 446 ■ “Involved Party” on page 448 ■ “Policy” on page 450 ■ “Policy Holder” on page 452 ■ “Portfolio” on page 454 Claim The claim object allows you to define and record details about an insurance policy claim. Claims are typically the claims of a contact or business that an insurance company manages. Child Objects Activity, Damage, Involved Party, Service Request. 424 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 425. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Methods Called Table 534 details the methods called by the Claim service. Table 534. Methods Called by Claim Service Method Name as Defined in Service “Delete” on page 82 ClaimDelete “Execute” on page 83 ClaimExecute “Insert” on page 84 ClaimInsert “QueryPage” on page 85 ClaimQueryPage “Update” on page 93 ClaimUpdate Fields Table 535 details the required and read-only fields for the claim object. Table 535. Read-Only Fields on the Claim Object Field Name Type ClaimNumber Required ReportDate Required LossDateandTime Required PolicyName Required CurrencyCode Read-only Audit Fields Read-only Table 536 details the status key for the claim object. Table 536. Status Key for the Claim Object Field Name Audit Fields ExternalSystemId ClaimNumber IntegrationId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 425 Release 18)
- 426. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 537 details the pickmap fields for the claim object. Table 537. Pick Map Fields for the Claim Object Pick Map Field Maps To PolicyExternalSystemId PolicyId PolicyIntegrationId PolicyId Table 538 provides a list of the user key combinations for the claim object. Table 538. User Key Fields on the Claim Object User Key Field Combinations Id ExternalSystemId ClaimNumber Table 539 details the picklists available for the claim object. Table 539. Picklists Available for the Claim Object Field Name AbilitytoWork AtFault CategoryofLoss ClassofEmployee InjuredDuringWorkingHours KindofLoss LiabilitySource LineofBusiness LocationofLoss LossCode LossType MedicalInjuryCode PartofBodyInjured PlaceofInjury 426 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 427. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 539. Picklists Available for the Claim Object Field Name RelationshiptoInsured ReportedBy State Status TypeofInjury Coverage The coverage object allows you to define and record details about an insurance policy coverage. Coverage is a term used to describe the monetary limits and risks covered as set out in an insurance policy. Child Objects None Methods Called Table 540 details the methods called by the Coverage service. Table 540. Methods Called by Coverage Service Method Name as Defined in Service “Delete” on page 82 CoverageDelete “Execute” on page 83 CoverageExecute “Insert” on page 84 CoverageInsert “QueryPage” on page 85 CoverageQueryPage “Update” on page 93 CoverageUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 427 Release 18)
- 428. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 541 details the required and read-only fields for the coverage object. Table 541. Read-Only Fields on the Coverage Object Field Name Type CoverageName Required PolicyName Required CurrencyCode Read-only Owner Read-only OwnerId Read-only Audit Fields Read-only Table 542 details the status key for the coverage object. Table 542. Status Key for the Coverage Object Field Name Audit Fields ExternalSystemId CoverageName IntegrationId Table 543 details the pickmap fields for the coverage object. Table 543. Pick Map Fields for the Coverage Object Pick Map Field Maps To PolicyExternalSystemId PolicyId PolicyIntegrationId PolicyId Table 544 provides a list of the user key combinations for the coverage object. Table 544. User Key Fields on the Coverage Object User Key Field Combinations CoverageName 428 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 429. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 544. User Key Fields on the Coverage Object User Key Field Combinations IntegrationId ExternalSystemId Table 545 details the picklists available for the coverage object. Table 545. Picklists Available for the Coverage Object Field Name Coverage Status Damage The damage object allows you to define and record details about the damages to properties covered in an insurance policy. Child Objects None Methods Called Table 546 details the methods called by the Damage service. Table 546. Methods Called by Damage Service Method Name as Defined in Service “Delete” on page 82 DamageDelete “Execute” on page 83 DamageExecute “Insert” on page 84 DamageInsert “QueryPage” on page 85 DamageQueryPage “Update” on page 93 DamageUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 429 Release 18)
- 430. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 547 details the required and read-only fields for the damage object. Table 547. Read-Only Fields on the Damage Object Field Name Type ClaimNumber Required DamageName Required CurrencyCode Read-only Owner Read-only OwnerId Read-only PrimaryContact Read-only Audit Fields Read-only Table 548 details the status key for the damage object. Table 548. Status Key for the Damage Object Field Name Audit Fields ExternalSystemId DamageId IntegrationId Table 549 details the pickmap fields for the damage object. Table 549. Pick Map Fields for the Damage Object Pick Map Field Maps To ClaimExternalId ClaimId ClaimIntegrationId ClaimId 430 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 431. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 550 provides a list of the user key combinations for the damage object. Table 550. User Key Fields on the Damage Object User Key Field Combinations Id ExternalSystemId DamageName Financial Account The financial account object stores information about the financial accounts of a contact or business that a financial institution manages, but can also track held away financial accounts. Child Objects Activity, Financial Account, Financial Account Holder, Financial Account Holding, Financial Plan, Financial Transaction, Lead, Opportunity, Policy, Service Request. Methods Called Table 551 details the methods called by the Financial Account service. Table 551. Methods Called by Financial Account Service Method Name as Defined in Service “Delete” on page 82 FinancialAccountDelete “Execute” on page 83 FinancialAccountExecute “Insert” on page 84 FinancialAccountInsert “QueryPage” on page 85 FinancialAccountQueryPage “Update” on page 93 FinancialAccountUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 431 Release 18)
- 432. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 552 details the required and read-only fields for the financial account object. Table 552. Required and Read-Only Fields for the Financial Account Object Field Name Type FinancialAccount Required FinancialAccountNumber Required Type Required CurrencyCode Read-only Audit Fields Read-only Table 553 details the status key for the financial account object.t Table 553. Status Key for the Financial Account Object Field Name Audit Fields ExternalSystemId FinancialAccount IntegrationId Table 554 details the pick map fields for the financial account object. Table 554. Pick Map Fields for the Financial Account Object Pick Map Field Maps To ParentFinancialAccountIntegrationId ParentFinancialAccountId ParentFinancialAccountExternalSystemId ParentFinancialAccountId 432 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 433. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 555 provides a list of the a list of the user key combinations for the financial account object. Table 555. User Key Fields on the Financial Account Object User Key Field Combinations FinancialAccount Id ExternalSystemId Table 556 details the picklists available for the financial account object. Table 556. Picklists Available for the Financial Account Object Field Name Type HomeBranch Financial Account Holder The financial account holder object stores information about the a financial account holder, which is any contact that has a relationship with the financial account, most commonly the legal owner of the financial account. Child Objects None Methods Called Table 557 details the methods called by the Financial Account Holder service. Table 557. Methods Called by Financial Account Holder Service Method Name as Defined in Service “Delete” on page 82 FinancialAccountHolderDelete “Execute” on page 83 FinancialAccountHolderExecute “Insert” on page 84 FinancialAccountHolderInsert “QueryPage” on page 85 FinancialAccountHolderQueryPage “Update” on page 93 FinancialAccountHolderUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 433 Release 18)
- 434. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 558 details the required and read-only fields for the financial account holder object. Table 558. Required and Read-Only Fields for the Financial Account Holder Object Field Name Type FinancialAccountHolderName Required FinancialAccount Required Role Required CurrrencyCode Read-only Audit Fields Read-only Table 559 details the status key for the financial account holder object. Table 559. Status Key for the Financial Account Holder Object Field Name Audit Fields ExternalSystemId FinancialAccountHolderName IntegrationId Table 560 details the pick map fields for the financial account holder object. Table 560. Pick Map Fields for the Financial Account Holder Object Pick Map Field Maps To FinancialAccounIntegrationId FinancialAccountId FinancialAccounExternalSystemId FinancialAccountId 434 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 435. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 561 provides a list of the a list of the user key combinations for the financial account holder object. Table 561. User Key Fields on the Financial Account Holder Object User Key Field Combinations FinancialAccountHolderName Id ExternalSystemId Table 562 details the picklists available for the financial account holder object. Table 562. Picklists Available for the Financial Account Holder Object Field Name Role Financial Account Holding The financial account holding object stores information about the financial account holdings, which are typically the total of all financial account transactions of a single financial product for a financial account. Child Objects None Methods Called Table 563 details the methods called by the Financial Account Holding service. Table 563. Methods Called by Financial Account Holding Service Method Name as Defined in Service “Delete” on page 82 FinancialAccountHoldingDelete “Execute” on page 83 FinancialAccountHoldingExecute “Insert” on page 84 FinancialAccountHoldingInsert “QueryPage” on page 85 FinancialAccountHoldingQueryPage “Update” on page 93 FinancialAccountHoldingUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 435 Release 18)
- 436. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 564 details the required and read-only fields for the financial account holding object. Table 564. Required and Read-Only Fields for the Financial Account Holding Object Field Name Type FinancialAccountHoldingsName Required FinancialAccount Required FinancialProductFinancialProductName Required CurrencyCode Read-only Audit Fields Read-only Table 565 details the status key for the financial account holding object. Table 565. Status Key for the Financial Account Holding Object Field Name Audit Fields ExternalSystemId FinancialAccountHoldingsName IntegrationId Table 566 details the pick map fields for the financial account holding object. Table 566. Pick Map Fields for the Financial Account Holding Object Pick Map Field Maps To FinancialAccounIntegrationId FinancialAccountId FinancialAccounExternalSystemId FinancialAccountId 436 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 437. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 567 provides a list of the a list of the user key combinations for the financial account holding object. Table 567. User Key Fields on the Financial Account Holding Object User Key Field Combinations FinancialAccountHoldingsName Id ExternalSystemId Financial Plan The financial plan object stores information about the plans of a contact or business for one or more specific financial accounts that a financial institution manages. Child Objects Activity, Lead, Opportunity, Service Request. Methods Called Table 568 details the methods called by the Financial Plan service. Table 568. Methods Called by Financial Plan Service Method Name as Defined in Service “Delete” on page 82 FinancialPlanDelete “Execute” on page 83 FinancialPlanExecute “Insert” on page 84 FinancialPlanInsert “QueryPage” on page 85 FinancialPlanQueryPage “Update” on page 93 FinancialPlanUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 437 Release 18)
- 438. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 569 details the required and read-only fields for the financial plan object. Table 569. Required and Read-Only Fields for the Financial Plan Object Field Name Type FinancialPlan Required Status Required Type Required CurrencyCode Read-only Audit Fields Read-only Table 570 details the status key for the financial plan object. Table 570. Status Key for the Financial Plan Object Field Name Audit Fields ExternalSystemId FinancialPlan IntegrationId Table 571 details the pick map fields for the financial plan object. Table 571. Pick Map Fields for the Financial Plan Object Pick Map Field Maps To FinancialAccounIntegrationId FinancialAccountId FinancialAccounExternalSystemId FinancialAccountId 438 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 439. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 572 provides a list of the a list of the user key combinations for the financial plan object. Table 572. User Key Fields on the Financial Plan Object User Key Field Combinations FinancialPlan Id ExternalSystemId Table 573 details the picklists available for the financial plan object. Table 573. Picklists Available for the Financial Plan Object Field Name Type Status Financial Product The financial product object stores information about the products and services that a financial institution offers to its customers. Child Objects Coverage, Financial Account Holding, Financial Product, Financial Transaction. Methods Called Table 574 details the methods called by the Financial Product service. Table 574. Methods Called by Financial Product Service Method Name as Defined in Service “Delete” on page 82 FinancialProductDelete “Execute” on page 83 FinancialProductExecute “Insert” on page 84 FinancialProductInsert “QueryPage” on page 85 FinancialProductQueryPage “Update” on page 93 FinancialProductUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 439 Release 18)
- 440. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 575 details the required and read-only fields for the financial product object. Table 575. Required and Read-Only Fields for the Financial Product Object Field Name Type FinancialProductName Required CurrencyCode Read-only Audit Fields Read-only Table 576 details the status key for the financial product object. Table 576. Status Key for the Financial Product Object Field Name Audit Fields ExternalSystemId FinancialProductName IntegrationId Table 577 details the pick map fields for the financial product object. Table 577. Pick Map Fields for the Financial Product Object Pick Map Field Maps To ParentFinancialProductIntegrationId ParentFinancialProductId ParentFinancialProductExternalSystemId ParentFinancialProductId Table 578 provides a list of the a list of the user key combinations for the financial product object. Table 578. User Key Fields on the Financial Product Object User Key Field Combinations FinancialProductName Id ExternalSystemId 440 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 441. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 579 details the picklists available for the financial product object. Table 579. Picklists Available for the Financial Product Object Field Name Category Type Class Sub-Class Financial Transaction The financial transaction object stores information about financial account transactions, which are typically the individual transactions of a financial account for all financial products. Child Objects Financial Transaction, Service Request. Methods Called Table 580 details the methods called by the Financial Transaction service. Table 580. Methods Called by Financial Transaction Service Method Name as Defined in Service “Delete” on page 82 FinancialTransactionDelete “Execute” on page 83 FinancialTransactionExecute “Insert” on page 84 FinancialTransactionInsert “QueryPage” on page 85 FinancialTransactionQueryPage “Update” on page 93 FinancialTransactionUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 441 Release 18)
- 442. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 581 details the required and read-only fields for the financial transaction object. Table 581. Required and Read-Only Fields for the Financial Transaction Object Field Name Type FinancialAccount Required FinancialProductFinancialProductName Required TransactionType Required TransactionID Required Audit Fields Read-only Table 582 details the status key for the financial transaction object. Table 582. Status Key for the Financial Transaction Object Field Name Audit Fields ExternalSystemId TransactionID IntegrationId Table 583 details the pick map fields for the financial transaction object. Table 583. Pick Map Fields for the Financial Transaction Object Pick Map Field Maps To FinancialTransactionParentIntegrationId FinancialTransactionParentId FinancialTransactionParentExternalSystemId FinancialTransactionParentId 442 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 443. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 584 provides a list of the a list of the user key combinations for the financial transaction object. Table 584. User Key Fields on the Financial Transaction Object User Key Field Combinations TransactionID Id ExternalSystemId Table 585 details the picklists available for the financial transaction object. Table 585. Picklists Available for the Financial Transaction Object Field Name TransactionType Household The household object allows you to define and record financial details about a group of contacts that live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details include the assets of the household, the liabilities of the household, the net income of the household, and so on. Child Objects Claim, Financial Account, Financial Account Holder, Financial Plan, Policy, Policy Holder. Methods Called Table 586 details the methods called by the Household service. Table 586. Methods Called by Household Service Method Name as Defined in Service “Delete” on page 82 HouseholdDelete “Execute” on page 83 HouseholdExecute “Insert” on page 84 HouseholdInsert “QueryPage” on page 85 HouseholdQueryPage “Update” on page 93 HouseholdUpdate Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 443 Release 18)
- 444. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Fields Table 587 details the required and read-only fields for the household object. Table 587. Required and Read-Only Fields for the Household Object Field Name Type HouseholdName Required IntegrationID Required ExternalSystemID Required HouseholdId Read-only PrimaryContactId Read-only PrimaryContactExternalId Read-only PrimaryContactIntegrationId Read-only PrimaryContactFirstName Read-only PrimaryContactLastName Read-only Timezone Read-only HouseholdCurrency Read-only LastActivity Read-only HeadDOB Read-only TotalIncome Read-only TotalAssets Read-only TotalExpenses Read-only TotalLiabilities Read-only TotalNetWorth Read-only RiskProfile Read-only ExperienceLevel Read-only InvestmentHorizon Read-only CurrentInvestmentMix Read-only Objective Read-only PrimaryGoal Read-only Audit Fields Read-only 444 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 445. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 588 details the status key for the household object. Table 588. Status Key for the Household Object Field Name Audit Fields ExternalSystemId HouseholdId IntegrationID Table 589 details the pick map fields for the household object. Table 589. Pick Map Field for the Household Object Pick Map Field Maps To ContactExternalId ContactId ContactIntegrationId Table 590 provides a list of the user key combinations for the household object. Table 590. User Key Fields on the Household Object User Key Field Combinations HouseholdName Id ExternalSystemId Table 591 details the picklists available for the household object. Table 591. Picklists Available for the Household Object Field Name Segment Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 445 Release 18)
- 446. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Insurance Property The insurance property object allows you to define and record details about an insurance property. Insurance properties are typically the properties of a contact that are included in an insurance policy or a claim. Child Objects Coverage, Damage. Methods Called Table 592 details the methods called by the Insurance Property service. Table 592. Methods Called by Insurance Property Service Method Name as Defined in Service “Delete” on page 82 InsurancePropertyDelete “Execute” on page 83 InsurancePropertyExecute “Insert” on page 84 InsurancePropertyInsert “QueryPage” on page 85 InsurancePropertyQueryPage “Update” on page 93 InsurancePropertyUpdate Fields Table 593 details the required and read-only fields for the insurance property object. Table 593. Read-Only Fields on the Insurance Property Object Field Name Type PolicyName Required Type Required CurrencyCode Read-only Owner Read-only OwnerId Read-only Audit Fields Read-only 446 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 447. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 594 details the status key for the insurance property object. Table 594. Status Key for the Insurance Property Object Field Name Audit Fields ExternalSystemId PolicyId IntegrationId Table 595 details the pickmap fields for the insurance property object. Table 595. Pick Map Fields for the Insurance Property Object Pick Map Field Maps To PolicyExternalSystemId PolicyId PolicyIntegrationId PolicyId Table 596 provides a list of the user key combinations for the insurance property object. Table 596. User Key Fields on the Insurance Property Object User Key Field Combinations Type Id ExternalSystemId Table 597 details the picklists available for the insurance property object. Table 597. Picklists Available for the Insurance Property Object Field Name Type Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 447 Release 18)
- 448. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Involved Party The involved party object allows you to define and record details about an involved party, which is typically a contact involved in an insurance claim. Child Objects None Methods Called Table 598 details the methods called by the Involved Party service. Table 598. Methods Called by Involved Party Service Method Name as Defined in Service “Delete” on page 82 InvolvedPartyDelete “Execute” on page 83 InvolvedPartyExecute “Insert” on page 84 InvolvedPartyInsert “QueryPage” on page 85 InvolvedPartyQueryPage “Update” on page 93 InvolvedPartyUpdate Fields Table 599 details the required and read-only fields for the involved party object. Table 599. Read-Only Fields on the Involved Party Object Field Name Type ClaimNumber Required Role Required InvolvedPartyName Required Contact Required CurrencyCode Read-only Owner Read-only OwnerId Read-only Audit Fields Read-only 448 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 449. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 600 details the status key for the involved party object. Table 600. Status Key for the Involved Party Object Field Name Audit Fields ExternalSystemId InvolvedPartyName IntegrationId Table 601 details the pickmap fields for the involved party object. Table 601. Pick Map Fields for the Involved Party Object Pick Map Field Maps To ClaimExternalSystemId ClaimId ClaimIntegrationId ClaimId Table 602 provides a list of the user key combinations for the involved party object. Table 602. User Key Fields on the Involved Party Object User Key Field Combinations InvolvedPartyName Id ExternalSystemId Table 603 details the picklists available for the involved party object. Table 603. Picklists Available for the Involved Party Object Field Name Role RoleinAccident Location Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 449 Release 18)
- 450. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Policy The policy object allows you to define and record details about an insurance policy. Child Objects Activity, Claim, Coverage, Insurance Property, Lead, Opportunity, Policy, Policy Holder, Service Request. Methods Called Table 604 details the methods called by the Policy service. Table 604. Methods Called by Policy Service Method Name as Defined in Service “Delete” on page 82 PolicyDelete “Execute” on page 83 PolicyExecute “Insert” on page 84 PolicyInsert “QueryPage” on page 85 PolicyQueryPage “Update” on page 93 PolicyUpdate Fields Table 605 details the required and read-only fields for the policy object. Table 605. Read-Only Fields on the Policy Object Field Name Type PolicyNumber Required PolicyType Required CurrencyCode Read-only Owner Read-only OwnerId Read-only Audit Fields Read-only 450 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 451. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 606 details the status key for the policy object. Table 606. Status Key for the Policy Object Field Name Audit Fields ExternalSystemId PolicyNumber IntegrationId Table 607 details the pickmap fields for the policy object. Table 607. Pick Map Fields for the Policy Object Pick Map Field Maps To ClaimExternalSystemId ClaimId ClaimIntegrationId ClaimId Table 608 provides a list of the user key combinations for the policy object. Table 608. User Key Fields on the Policy Object User Key Field Combinations PolicyNumber Id ExternalSystemId Table 609 details the picklists available for the policy object. Table 609. Picklists Available for the Policy Object Field Name PolicyType Status SubStatus BillingStatus Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 451 Release 18)
- 452. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 609. Picklists Available for the Policy Object Field Name RateState RatePlan ReferralSource PolicyPayMethod Policy Holder The policy holder object allows you to define and record details about an insurance policy holder. A policy holder is typically the contact that owns the policy that the insurance company manages. Child Objects None Methods Called Table 610 details the methods called by the Policy Holder service. Table 610. Methods Called by Policy Holder Service Method Name as Defined in Service “Delete” on page 82 PolicyHolderDelete “Execute” on page 83 PolicyHolderExecute “Insert” on page 84 PolicyHolderInsert “QueryPage” on page 85 PolicyHolderQueryPage “Update” on page 93 PolicyHolderUpdate Fields Table 611 details the required and read-only fields for the policy holder object. Table 611. Read-Only Fields on the Policy Holder Object Field Name Type PolicyName Required Role Required PolicyHolderName Required 452 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 453. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 611. Read-Only Fields on the Policy Holder Object Field Name Type CurrencyCode Read-only Owner Read-only OwnerId Read-only Audit Fields Read-only Table 612 details the status key for the policy holder object. Table 612. Status Key for the Policy Holder Object Field Name Audit Fields ExternalSystemId PolicyHolderName IntegrationId Table 613 details the pickmap fields for the policy holder object. Table 613. Pick Map Fields for the Policy Holder Object Pick Map Field Maps To PolicyExternalSystemId PolicyId PolicyIntegrationId PolicyId Table 614 provides a list of the user key combinations for the policy holder object. Table 614. User Key Fields on the Policy Holder Object User Key Field Combinations PolicyHolderName Id ExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 453 Release 18)
- 454. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 615 details the picklists available for the policy holder object. Table 615. Picklists Available for the Policy Holder Object Field Name InsuredType Role Portfolio The portfolio object allows you to define and record details about the collection of financial services that you can provide to an account. Financial services include loans, credit cards, insurance, general banking, and so on. Child Objects Financial Account, Financial Plan. Methods Called Table 616 details the methods called by the Portfolio service. Table 616. Methods Called by Portfolio Service Method Name as Defined in Service “Delete” on page 82 PortfolioDelete “Execute” on page 83 PortfolioExecute “Insert” on page 84 PortfolioInsert “QueryPage” on page 85 PortfolioQueryPage “Update” on page 93 PortfolioUpdate Fields Table 617 details the read-only fields for the portfolio object. Table 617. Read-Only Fields on the Portfolio Object Field Name Type PortfolioId Read-only Owner Read-only 454 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 455. Oracle CRM On Demand Objects Exposed Through Web Services ■ Financial Services Edition Parent Objects (Web Services v2.0) Table 617. Read-Only Fields on the Portfolio Object Field Name Type OwnerId Read-only PrimaryContact Read-only Audit Fields Read-only Table 618 details the status key for the portfolio object. Table 618. Status Key for the Portfolio Object Field Name Audit Fields Id ModId Table 619 details the pickmap fields for the portfolio object. Table 619. Pick Map Fields for the Portfolio Object Pick Map Field Maps To InstitutionExternalId InstitutionId InstitutionIntegrationId InstitutionId InstitutionName InstitutionId InstitutionLocation InstitutionId Product ProductId ProductExternalId ProductId ProductIntegrationId ProductId Table 620 provides a list of the user key combinations for the portfolio object. Table 620. User Key Fields on the Portfolio Object User Key Field Combinations AccountNumber and ProductId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 455 Release 18)
- 456. Oracle CRM On Demand Objects Exposed Through Web Services ■ Automotive Edition Parent Objects (Web Services v2.0) Table 620. User Key Fields on the Portfolio Object User Key Field Combinations Id ExternalSystemId Table 621 details the picklists available for the portfolio object. Table 621. Picklists Available for the Portfolio Object Field Name AccountType Status TermUnit Automotive Edition Parent Objects (Web Services v2.0) This topic includes the parent objects available with Oracle CRM On Demand Automotive Edition. NOTE: To download WSDL files for these objects, you must be given access to the object. If you do not have access to the object, it is not available to download from the Web Services Administration page or available to use the Web service calls. For assistance in gaining access to the objects, contact your Oracle CRM On Demand service provider. The following objects are detailed in this topic: ■ “Dealer” on page 456 ■ “Vehicle” on page 458 Dealer The dealer object stores information about dealerships in the automotive industry, for example, the name of the dealership, the identity of the parent dealership, the site on which the dealership is based, and so on. The dealer object does not have any parent objects. Child Objects Attachment For information about using attachments with this object, see Appendix A, “Using Attachments With Web Services On Demand”. 456 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 457. Oracle CRM On Demand Objects Exposed Through Web Services ■ Automotive Edition Parent Objects (Web Services v2.0) Methods Called Table 622 details the methods called by the Dealer service. Table 622. Methods Called by Dealer Service Method Name as Defined in Service “Delete” on page 82 DealerDelete “Execute” on page 83 DealerExecute “Insert” on page 84 DealerInsert “QueryPage” on page 85 DealerQueryPage “Update” on page 93 DealerUpdate Fields Table 623 details the required and read-only fields for the dealer object. Table 623. Required and Read-Only Fields for the Dealer Object Field Name Type DealerId Required DealerIntegrationId Required DealerExternalSystemID Required DealerId Read-only DealerType Read-only Audit Fields Read-only Table 624 details the status key for the dealer object. Table 624. Status Key for the Dealer Object Field Name Audit Fields DealerId DealerIntegrationID DealerExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 457 Release 18)
- 458. Oracle CRM On Demand Objects Exposed Through Web Services ■ Automotive Edition Parent Objects (Web Services v2.0) Table 625 details the pick map fields for the dealer object. Table 625. Pick Map Fields for the Dealer Object Pick Map Field Maps To Owner OwnerId ParentDealerExternalSystemId ParentDealerId ParentDealerIntegrationId ParentDealerId ParentDealerName ParentDealerId ParentDealerSite ParentDealerId Table 626 provides a list of the user key combinations for the dealer object. Table 626. User Key Fields on the Dealer Object User Key Field Combinations DealerId IntegrationID ExternalSystemID Table 627 details the picklists available for the dealer object. Table 627. Picklists Available for the Dealer Object Field Name ParentDealerName ParentDealerSite Vehicle The vehicle object allows you to create and store information about a vehicle, for example, a car, a truck, a van, and so on, that your company would like to sell to a contact or account. This information includes the vehicle’s current mileage, the invoice price, the dealership, the make, and so on. Child Objects None 458 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 459. Oracle CRM On Demand Objects Exposed Through Web Services ■ Automotive Edition Parent Objects (Web Services v2.0) Methods Called Table 628 details the methods called by the Vehicle service. Table 628. Methods Called by Vehicle Service Method Name as Defined in Service “Delete” on page 82 VehicleDelete “Execute” on page 83 VehicleExecute “Insert” on page 84 VehicleInsert “QueryPage” on page 85 VehicleQueryPage “Update” on page 93 VehicleUpdate Fields Table 629 details the required and read-only fields for the vehicle object. Table 629. Required and Read-Only Fields for the Vehicle Object Field Name Type VehicleId Read-only Contact Read-only ProductType Read-only SellingDealer Read-only ServicingDealer Read-only Audit Fields Read-only Table 630 details the status key for the vehicle object. Table 630. Status Key for the Vehicle Object Field Name Audit Fields ExternalSystemId IntegrationId VehicleId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 459 Release 18)
- 460. Oracle CRM On Demand Objects Exposed Through Web Services ■ Automotive Edition Parent Objects (Web Services v2.0) Table 631 details the pick map fields for the vehicle object. Table 631. Pick Map Fields for the Vehicle Object Pick Map Field Maps To AccountName AccountId AccountSite AccountId AccountIntegrationId AccountId AccountExternalID AccountId SellingDealerExternalId SellingDealerId SellingDealerIntegrationId SellingDealerId ServicingDealerExternalId ServicingDealerId ServicingDealerIntegrationId ServicingDealerId Table 632 provides a list of the user key combinations for the vehicle object. Table 632. User Key Fields on the Vehicle Object User Key Field Combinations Id ExternalSystemId ProductId SerialNumber ProductExternalId Table 633 details the picklists available for the vehicle object. Table 633. Picklists Available for the Vehicle Object Field Name Body Door Engine ExteriorColor InteriorColor 460 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 461. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 633. Picklists Available for the Vehicle Object Field Name Location Make Model VehicleOwnedBy Status Transmission Trim UsedNew WarrantyType Year Child Objects (Web Services v2.0) This topic includes a list of child objects that are used in Oracle On Demand Web Services. The list includes: ■ Objects that are child objects only and are not themselves parent objects. ■ Objects that are also parent objects. Various parent objects are also child objects of other objects. This includes a number of industry- specific objects added in Release 16 and Release 17 of Oracle CRM On Demand. Refer to the topics about the parent objects for information about the parent-child relationships. For these objects, the field information given for parent objects is the same for the objects when they are child objects, and is therefore not repeated in this topic. For each child object, the methods that can be called are as shown in Table 634. The methods that you can use on a child object are the same as for its parent object. Table 634. Methods Called On Child Objects Method Name as Defined in Service “Delete” on page 82 <object>Delete “Execute” on page 83 <object>Execute “Insert” on page 84 <object>Insert “QueryPage” on page 85 <object>QueryPage “Update” on page 93 <object>Update Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 461 Release 18)
- 462. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) The following child objects are listed: ■ “Account” on page 462 ■ “Activity” on page 464 ■ “Address” on page 466 ■ “Asset” on page 467 ■ “Attachment” on page 469 ■ “Book” on page 470 ■ “Contact” on page 471 ■ “Contact Team” on page 473 ■ “Custom Object 4 and Higher” on page 474 ■ “Delegated User” on page 476 ■ “Interests” on page 477 ■ “Invitee” on page 478 ■ “Lead” on page 480 ■ “Note” on page 482 ■ “Opportunity” on page 483 ■ “Products Detailed” on page 485 ■ “Promotional Items Dropped” on page 486 ■ “Recipient” on page 487 ■ “Related Contact” on page 488 ■ “Revenue” on page 490 ■ “Sample Dropped” on page 492 ■ “Service Request” on page 493 ■ “User” on page 495 NOTE: For the Quote and Order child objects, access is included for use by the Oracle CRM On Demand to EBS integration and are not available for non-Oracle use. Account The account object stores information about the companies that you do business with and is also used to track partners and competitors. Parent Object Contact 462 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 463. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 635 details the required and read-only fields for the account child object. Table 635. Required and Read-Only Fields for the Account Child Object Field Name Type AccountId Read-only Table 636 details the status key for the account child object. Table 636. Status Key for the Account Child Object Field Name Audit Fields Name and Location ExternalSystemId Table 637 details the pick map fields for the account child object. Table 637. Pick Map Fields for the Account Child Object Pick Map Field Maps To ExternalSystemId AccountId Table 638 provides a list of the user key combinations for the account child object. Table 638. User Key Fields on the Account Child Object User Key Field Combinations AccountId ExternalSystemId Name and Location Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 463 Release 18)
- 464. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 639 details the picklists available for the account child object. Table 639. Picklists Available for the Account Child Object Field Name Call Frequency Route Status Type Activity The activity object stores information on an activity that a user must carry out, for example, a callback activity for an account. Parent Objects Account, Campaign, Contact, Lead, Opportunity. Fields Table 640 details the required and read-only fields for the activity child object. Table 640. Required and Read-Only Fields for the Activity Child Object Field Name Type AccountLocation Read-only CreatedDetail Read-only MEEventName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only CODInteractionTime Read-only CODWrapUpTime Read-only CODHandleTime Read-only CODIVRTime Read-only CODQueueHoldTime Read-only CODTotalHoldTime Read-only 464 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 465. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 640. Required and Read-Only Fields for the Activity Child Object Field Name Type DescriptionShadow Read-only DealerName Read-only Audit Fields Read-only Table 641 details the status key for the activity child object. Table 641. Status Key for the Activity Child Object Field Name Audit Fields ExternalSystemId ActivityId IntegrationId Table 642 details the pick map fields for the activity child object. Table 642. Pick Map Fields for the Activity Child Object Pick Map Field Maps To AccountIntegrationId AccountId AccountExternalId AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId DelegatedBy DelegatedById FundRequest FundRequestId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId PrimaryContactIntegrationId PrimaryContactId PrimaryContactExternalId PrimaryContactId LeadIntegrationId LeadId LeadExternalId LeadId OwnerExternalId OwnerId OwnerIntegrationId OwnerId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 465 Release 18)
- 466. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 642. Pick Map Fields for the Activity Child Object Pick Map Field Maps To SRIntegrationId SRId SRExternalId SRId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Table 643 provides a list of the user key combinations for the activity child object. Table 643. User Key Fields on the Activity Child Object User Key Field Combinations Id ExternalSystemId Description Address The address object stores information on the different addresses that are associated with accounts and contacts. For more information about addresses, see “Adding and Updating Account Addresses” on page 298, and “Adding and Updating Contact Addresses” on page 313. Parent Objects Account, Contact Fields Table 644 details the required and read-only fields for the address child object. Table 644. Required and Read-Only Fields for the Address Child Object Field Name Type AddressId Read-only 466 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 467. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 645 details the status key for the address child object. Table 645. Status Key for the Address Child Object Field Name Audit Fields AddressId ExternalId IntegrationId Table 646 details the pick map fields for the address child object. Table 646. Pick Map Fields for the Address Child Object Pick Map Field Maps To None Table 647 provides a list of the user key combinations for the address child object. Table 647. User Key Fields on the Address Child Object User Key Field Combinations AddressId ExternalId IntegrationId Asset The asset object stores information on the assets held by your accounts, for example, the products that an account has purchased. Parent Object Account Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 467 Release 18)
- 468. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 648 details the required and read-only fields for the asset child object. Table 648. Required and Read-Only Fields for the Asset Child Object Field Name Type AssetId Required ContactAssetId Read-only ExternalSystemId Read-only Product Read-only ProductId Read-only ProductPartNumber Read-only ProductType Read-only ProductStatus Read-only CreatedByandDate Read-only ModifiedByandDate Read-only SerialNumber Read-only Table 649 details the status key for the asset child object. Table 649. Status Key for the Asset Child Object Field Name Audit Fields AssetId ExternalSystemId IntegrationId Table 650 details the pick map fields for the asset child object. Table 650. Pick Map Fields for the Asset Child Object Pick Map Field Maps To AccountIntegrationId AccountId Manufacturer ManufacturerId PreferredServiceDealer PreferredServiceDealerID 468 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 469. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 651 provides a list of the user key combinations for the asset child object. Table 651. User Key Fields on the Asset Child Object User Key Field Combinations AssetId ExternalSystemId IntegrationId Attachment The attachment object stores information about a file or URL that is attached to a record in the application. Parent Objects Account, Accreditation, Activity, Campaign, Certification, Contact, Course, CustomObject, Dealer, Exam, Lead, Opportunity, Service Request, and Solution. Fields Table 652 details the required and read-only fields for the attachment object. Table 652. Required and Read-Only Fields for the Attachment Child Object Field Name Type DisplayFileName Required FileNameOrURL Required FileDate Read-only FileSize Read-only <parent_object>Id Read-only Id Read-only ModId Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 469 Release 18)
- 470. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 653 details the status key for the attachment child object. Table 653. Status Key for the Attachment Child Object Field Name Audit Fields Id <parent_object>Id Table 654 provides a list of the user key combinations for the attachment child object. Table 654. User Key Fields on the Attachment Child Object User Key Field Combinations Id ExternalSystemId FileNameOrURL and FileExtension Book The book object provides a way of segmenting data according to the organizational units of your business, such as territories or products. Administrators can create book hierarchies based on how they want to organize your information, and then set up users to have the appropriate level of access to books. Parent Object Accreditation, Application, Certification, Course, CustomObject, Deal Registration, Exam, MedEd, Messaging Plan, Partner, Solution, Special Pricing Request. Fields Table 655 details the required and read-only fields for the book child object. Table 655. Required and Read-Only Fields for the Book Child Object Field Name Type BookName Required BookId Read-only SystemAssociateFlag Read-only 470 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 471. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 655. Required and Read-Only Fields for the Book Child Object Field Name Type ModId Read-only Audit Fields Read-only Table 656 details the status key for the book child object. Table 656. Status Key for the Book Child Object Field Name Audit Fields BookId ModId Table 657 details the pick map fields for the book child object. Table 657. Pick Map Fields for the Book Child Object Pick Map Field Maps To BookName BookId Table 658 provides a list of the user key combinations for the book child object. Table 658. User Key Fields on the Book Child Object User Key Field Combinations BookId BookName Contact The contact object stores information on individuals with whom your organization has a relationship. It allows the user to store information on individuals who are external to your company, but who are associated with the business process. Contacts stored in the Oracle CRM On Demand database can also be associated with an account. Parent Object Activity Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 471 Release 18)
- 472. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 659 details the required and read-only fields for the contact child object. Table 659. Required and Read-Only Fields for the Contact Child Object Field Name Type ContactId Read-only ContactFirstName Read-only ContactLastName Read-only ContactAccountId Read-only ContactAccountName Read-only ContactAccountLocation Read-only ContactAccountIntegrationId Read-only ContactAccountExternalSystemId Read-only Audit Fields Read-only Table 660 details the status key for the contact child object. Table 660. Status Key for the Contact Child Object Field Name Audit Fields ActivityContactId ContactExternalId ContactIntegrationId ContactId Table 661 details the pick map fields for the contact child object. Table 661. Pick Map Fields for the Contact Child Object Pick Map Field Maps To ContactExternalId ContactId ContactIntegrationId ContactId 472 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 473. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 662 provides a list of the user key combinations for the contact child object. Table 662. User Key Fields on the Contact Child Object User Key Field Combinations ActivityContactId ContactExternalId ContactIntegrationId Contact Team The team object stores information on the team that is assigned to a particular account or contact. In this way, a team of employees can be dedicated to an account or contact, ensuring that the activities, service requests, leads, and opportunities surrounding that account or contact are always kept up-to-date and are attended to regularly. Parent Object Contact Fields Table 663 details the required and read-only fields for the contact team child object. Table 663. Required and Read-Only Fields for the Contact Team Child Object Field Name Type ContactTeamId Read-only UserFirstName Read-only UserLastName Read-only UserRole Read-only Table 664 details the status key for the contact team child object. Table 664. Status Key for the Contact Team Child Object Field Name Audit Fields ContactTeamId UserExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 473 Release 18)
- 474. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 664. Status Key for the Contact Team Child Object Field Name UserId UserIntegrationId Table 665 details the pick map fields for the contact team child object. Table 665. Pick Map Fields for the Contact Team Child Object Pick Map Field Maps To UserExternalSystemId UserId UserIntegrationId UserId Table 666 provides a list of the user key combinations for the contact team child object. Table 666. User Key Fields on the Contact Team Child Object User Key Field Combinations None Table 667 details the picklists available for the contact team child object. Table 667. Picklists Available for the Contact Team Child Object Field Name TeamRole Custom Object 4 and Higher The custom objects 4 and higher. Parent Objects All top-level objects. 474 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 475. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 668 details the required and read-only fields for the custom object child object. Table 668. Required and Read-Only Fields for the Custom Object Child Object Field Name Type Name Required Currency Read-only Audit Fields Read-only Table 669 details the status key for the custom object child object. Table 669. Status Key for the Custom Object Child Object Field Name Audit Fields Id ExternalSystemId Table 670 details the pick map fields for the custom object child object. Table 670. Pick Map Fields for the Custom Object Child Object Pick Map Field Maps To Owner OwnerId Table 671 provides a list of the user key combinations for the custom object child object. Table 671. User Key Fields on the Custom Object Child Object User Key Field Combinations Id ExternalSystemId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 475 Release 18)
- 476. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 672 details the picklists available for the custom object child object. Table 672. Picklists Available for the Custom Object Child Object Field Name Type Delegated User The delegated user object stores information about a user that can impersonate another user. The delegated user is added so that they can access a user’s data, for example, when a person is on vacation or leaves the company. Parent Object User Fields Table 673 details the required and read-only fields for the delegated user child object. Table 673. Required and Read-Only Fields for the Delegated User Child Object Field Name Type UserId Required UserRole Required Audit Fields Read-only Table 674 details the status key for the delegated user child object. Table 674. Status Key for the Delegated User Child Object Field Name Audit Fields Id ExternalSystemId 476 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 477. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 675 provides a list of the user key combinations for the delegated user child object. Table 675. User Key Fields on the Delegated User Child Object User Key Field Combinations Id ExternalSystemId Table 676 details the picklists available for the delegated user child object. Table 676. Picklists Available for the Delegated User Child Object Field Name UserRole Interests The interests object stores information about things in which a contact is interested, such as products, services, or hobbies. Parent Object Contact Fields Table 677 details the required and read-only fields for the interests child object. Table 677. Required and Read-Only Fields for the Interests Child Object Field Name Type Category Required Interests Required InterestId Read-only Audit Fields Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 477 Release 18)
- 478. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 678 details the status key for the interests child object. Table 678. Status Key for the Interests Child Object Field Name Audit Fields InterestId ExternalSystemId Table 679 details the pick map fields for the interests child object. Table 679. Pick Map Fields for the Interests Child Object Pick Map Field Maps To InterestExternalSystemId InterestId Table 680 provides a list of the user key combinations for the interests child object. Table 680. User Key Fields on the Interests Child Object User Key Field Combinations InterestId ExternalSystemId Table 681 details the picklists available for the interests child object. Table 681. Picklists Available for the Interests Child Object Field Name Category Subjects Invitee The invitee object stores information about invitees to medical education events, including feedback about the invitation. 478 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 479. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Parent Object MedEd Fields Table 682 details the required and read-only fields for the invitee child object. Table 682. Required and Read-Only Fields for the Invitee Child Object Field Name Type Required InviteeStatus InviteeId Read-only Audit Fields Read-only Table 683 details the status key for the invitee child object. Table 683. Status Key for the Invitee Child Object Field Name Audit Fields ContactIdExternalId MedEdInviteeId Table 684 details the pick map fields for the invitee child object. Table 684. Pick Map Fields for the Invitee Child Object Pick Map Field Maps To InviteeExternalSystemId InviteeId Table 685 provides a list of the user key combinations for the invitee child object. Table 685. User Key Fields on the Invitee Child Object User Key Field Combinations ContactIdExternalId MedEdInviteeId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 479 Release 18)
- 480. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 686 details the picklists available for the invitee child object. Table 686. Picklists Available for the Invitee Child Object Field Name InviteeStatus Lead The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign. Parent Objects Account, Campaign, Contact, Opportunity Fields Table 687 details the required and read-only fields for the lead child object. Table 687. Required and Read-Only Fields for the Lead Child Object Field Name Type OwnerFullName Read-only SalesRepFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only ReferredByFullName Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only FirstNameShadow Read-only LastNameShadow Read-only CompanyNameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only 480 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 481. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 688 details the status key for the lead child object. Table 688. Status Key for the Lead Child Object Field Name Audit Fields AccountId ContactId ExternalSystemId IntegrationId LeadId OpportunityId Table 689 details the pick map fields for the lead child object. Table 689. Pick Map Fields for the Lead Child Object Pick Map Field Maps To AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId AccountName AccountId CampaignExternalId CampaignId CampaignIntegrationId CampaignId CampaignName CampaignId ContactExternalId ContactId ContactIntegrationId ContactId OpportunityIntegrationId OpportunityId OpportunityExternalId OpportunityId OwnerExternalId OwnerId OwnerIntegrationId OwnerId SalesRepAlias SalesRepId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 481 Release 18)
- 482. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 690 provides a list of the user key combinations for the lead child object. Table 690. User Key Fields on the Lead Child Object User Key Field Combinations LeadId Id Note The note object stores information about the notes available in the Message Center in the Oracle CRM On Demand application. Parent Objects Account, Campaign, Contact, Opportunity, Service Request Fields Table 691 details the required and read-only fields for the note child object. Table 691. Required and Read-Only Fields for the Note Child Object Field Name Type Subject Required NoteId Read-only Audit Fields Read-only Table 692 details the status key for the note child object. Table 692. Status Key for the Note Child Object Field Name Audit Fields NoteId 482 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 483. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 693 provides a list of the user key combinations for the note child object. Table 693. User Key Fields on the Note Child Object User Key Field Combinations NoteId Opportunity The opportunity object allows employees to identify and record a potential revenue-generating event that has arisen with an account or contact. Opportunities can be generated from marketing campaigns when leads indicate that they are interested in a product or service that has been offered. Parent Object Account Fields Table 694 details the required and read-only fields for the opportunity child object. Table 694. Required and Read-Only Fields for the Opportunity Child Object Field Name Type OwnerFullName Read-only PrimaryRevenueExpectedValue Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only FuriganaAccountName Read-only NameShadow Read-only AssignmentStatus Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 483 Release 18)
- 484. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 695 details the status key for the opportunity child object. Table 695. Status Key for the Opportunity Child Object Field Name Audit Fields AccountId ExternalSystemId IntegrationId OpportunityId Table 696 details the pick map fields for the opportunity child object. Table 696. Pick Map Fields for the Opportunity Child Object Pick Map Field Maps To AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId SourceCampaignExternalId CampaignId SourceCampaign CampaignId KeyContactExternalId KeyContactId KeyContactLastName KeyContactId DealerExternalId DealerId OwnerAlias OwnerId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id 484 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 485. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 697 provides a list of the user key combinations for the opportunity child object. Table 697. User Key Fields on the Opportunity Child Object User Key Field Combinations OpportunityId Id Products Detailed The Products Detailed object stores the information on product details for an activity. This is used, for example, to record information about products discussed on sales calls to customers. Parent Object Activity Fields Table 698 details the required and read-only fields for the products detailed child object. Table 698. Required and Read-Only Fields for the Products Detailed Child Object Field Name Type ProductId Required Indication Required ProductDetailedId Read-only Audit Fields Read-only Table 699 details the status key for the products detailed child object. Table 699. Status Key for the Products Detailed Child Object Field Name Audit Fields ProductDetailedId ExternalId Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 485 Release 18)
- 486. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 700 details the pick map fields for the products detailed child object. Table 700. Pick Map Fields for the Products Detailed Child Object Pick Map Field Maps To ProductExternalSystemId ProductId ProductIntegrationId ProductId Table 701 provides a list of the user key combinations for the products detailed child object. Table 701. User Key Fields on the Products Detailed Child Object User Key Field Combinations ProductDetailedId ProductDetailedExternalSytemId ProductExternalSytemId ProductId ProductExternalSytemId Name Indication Promotional Items Dropped The Promotional Items Dropped object stores the information on promotional items dropped for an activity. Parent Object Activity Fields Table 702 details the required and read-only fields for the promotional items dropped child object. Table 702. Required and Read-Only Fields for the Promotional Items Dropped Child Object Field Name Type ProductName Required Quantity Required 486 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 487. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 702. Required and Read-Only Fields for the Promotional Items Dropped Child Object Field Name Type ProductAllocationId Required Audit Fields Read-only Table 703 details the status key for the promotional items dropped child object. Table 703. Status Key for the Promotional Items Dropped Child Object Field Name Audit Fields Id ModId Table 704 details the pick map fields for the promotional items dropped child object. Table 704. Pick Map Fields for the Promotional Items Dropped Child Object Pick Map Field Maps To ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId Table 705 provides a list of the user key combinations for the promotional items dropped child object. Table 705. User Key Fields on the Promotional Items Dropped Child Object User Key Field Combinations Id Recipient The recipient object stores information about a recipient associated with a campaign. Parent Object Campaign Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 487 Release 18)
- 488. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 706 details the required and read-only fields for the recipient child object. Table 706. Required and Read-Only Fields for the Recipient Child Object Field Name Type ContactId Required ModifiedDate Read-only Table 707 details the status key for the recipient child object. Table 707. Status Key for the Recipient Child Object Field Name Audit Fields CampaignContactId ContactExtrernalId ContactIntegrationId ContactId Table 708 provides a list of the user key combinations for the recipient child object. Table 708. User Key Fields on the Recipient Child Object User Key Field Combinations None Related Contact The related contact object stores information about a contact that has a relationship with the parent contact in question. The details of the related contact child object are inherited from a particular contact parent object. Parent Object Contact 488 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 489. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Fields Table 709 details the required and read-only fields for the related contact child object. Table 709. Required and Read-Only Fields for the Related Contact Child Object Field Name Type ContactRelationshipId Read-only ContactId Read-only RelatedContactFirstName Read-only RelatedContactLastName Read-only Table 710 details the status key for the related contact child object. Table 710. Status Key for the Related Contact Child Object Field Name Audit Fields ContactRelationshipId RelatedContactId Table 711 details the pick map fields for the related contact child object. Table 711. Pick Map Fields for the Related Contact Child Object Pick Map Field Maps To RelatedContactExternalId RelatedContactId RelatedContactIntegrationId RelatedContactId Table 712 provides a list of the user key combinations for the related contact child object. Table 712. User Key Fields on the Related Contact Child Object User Key Field Combinations None Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 489 Release 18)
- 490. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 713 details the picklists available for the related contact child object. Table 713. Picklists Available for the Related Contact Child Object Field Name Relationship Status Revenue The revenue object stores monetary information about accounts, contacts, and their associated opportunities. This includes information on the revenue available, expected revenue, and also information about the products associated with the accounts, contacts, opportunities, and so on. NOTE: The Revenue child object of Opportunity is actually called Product. Parent Objects Account, Contact, Opportunity Fields Table 714 details the required and read-only fields for the revenue child object. Table 714. Required and Read-Only Fields for the Revenue Child Object Field Name Type RevenueId Required PartNumber Required Revenue Required ContactFullName Required Audit Fields Read-only Table 715 details the status key for the revenue child object. Table 715. Status Key for the Revenue Child Object Field Name Audit Fields ExternalId 490 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 491. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 715. Status Key for the Revenue Child Object Field Name IntegrationId RevenueId Table 716 details the pick map fields for the revenue child object. Table 716. Pick Map Fields for the Revenue Child Object Pick Map Field Maps To Product ProductId ProductExternalId ProductId ProductIntegrationId ProductId ProductCategory ProductCategoryId ProductCategoryExternalId ProductCategoryId ProductCategoryIntegrationId ProductCategoryId Table 717 provides a list of the user key combinations for the revenue child object. Table 717. User Key Fields on the Revenue Child Object User Key Field Combinations RevenueId ProductId ProductExternalId ProductIntegrationId Table 718 details the picklists available for the revenue child object. Table 718. Picklists Available for the Revenue Child Object Field Name Type Status Frequency Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 491 Release 18)
- 492. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Sample Dropped The SampleDropped object stores the information on samples for an activity. This is used, for example, to record information about samples left with the customer on sales calls to customers. Parent Object Activity Fields Table 719 details the required and read-only fields for the sample dropped child object. Table 719. Required and Read-Only Fields for the Sample Dropped Child Object Field Name Type ProductId Required Quantity Required SampleDroppedId Read-only Audit Fields Read-only Table 720 details the status key for the sample dropped child object. Table 720. Status Key for the Sample Dropped Child Object Field Name Audit Fields Id ModlId Table 721 details the pick map fields for the sample dropped child object. Table 721. Pick Map Fields for the Sample Dropped Child Object Pick Map Field Maps To ProductName ProductId ProductExternalSystemId ProductId ProductIntegrationId ProductId 492 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 493. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 722 provides a list of the user key combinations for the sample dropped child object. Table 722. User Key Fields on the Sample Dropped Child Object User Key Field Combinations SampleDroppedId SampleDroppedExternalSystemId ProductId ProductExternalSystemId Quantity ProductName Service Request The service request object allows customers to request information or assistance with a problem related to products or services purchased from your company. Service requests can be ranked for severity and prioritized accordingly. Parent Objects Account, Contact Fields Table 723 details the required and read-only fields for the service request child object. Table 723. Required and Read-Only Fields for the Service Request Child Object Field Name Type Name Read-only OwnerFullName Read-only CreatedbyEmailAddress Read-only ModifiedbyEmailAddress Read-only LastAssessmentDate Read-only AssignmentStatus Read-only FuriganaAccountName Read-only FuriganaContactFirstName Read-only FuriganaContactLastName Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 493 Release 18)
- 494. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 723. Required and Read-Only Fields for the Service Request Child Object Field Name Type SRNumberShadow Read-only AbstractShadow Read-only LastAssignmentCompletionDate Read-only LastAssignmentSubmissionDate Read-only Audit Fields Read-only Table 724 details the status key for the service request child object. Table 724. Status Key for the Service Request Child Object Field Name Audit Fields AccountId ContactId ExternalSystemId IntegrationId ServiceRequestId Table 725 details the pick map fields for the service request child object. Table 725. Pick Map Fields for the Service Request Child Object Pick Map Field Maps To AccountIntegrationId AccountId AccountExternalId AccountId AccountLocation AccountId Account AccountId AssetExternalId AssetId Dealer DealerId ContactExternalId ContactId ContactIntegrationId ContactId DealerExternalId DealerId OwnerExternalId OwnerId 494 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 495. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 725. Pick Map Fields for the Service Request Child Object Pick Map Field Maps To OwnerIntegrationId OwnerId OwnerAlias OwnerId Product ProductId CustomObject1Name CustomObject1Id CustomObject2Name CustomObject2Id CustomObject3Name CustomObject3Id Table 726 provides a list of the user key combinations for the service request child object. Table 726. User Key Fields on the Service Request Child Object User Key Field Combinations ServiceRequestId Id User The user object allows you to define and record details of all users in the application, for example, name, position, contact details, manager, and so on. Parent Object Activity Fields Table 727 details the required and read-only fields for the user child object. Table 727. Required and Read-Only Fields for the User Child Object Field Name Type UserId Read-only UserEmail Read-only UserFirstName Read-only UserLastName Read-only Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 495 Release 18)
- 496. Oracle CRM On Demand Objects Exposed Through Web Services ■ Child Objects (Web Services v2.0) Table 727. Required and Read-Only Fields for the User Child Object Field Name Type UserRole Read-only Audit Fields Read-only Table 728 details the status key for the user child object. Table 728. Status Key for the User Child Object Field Name Audit Fields Id UserExternald UserIntegrationId Table 729 details the pick map fields for the user child object. Table 729. Pick Map Fields for the User Child Object Pick Map Field Maps To UserExternalId UserId UserIntegrationId UserId Table 730 provides a list of the user key combinations for the user child object. Table 730. User Key Fields on the User Child Object User Key Field Combinations UserId UserExternalId UserIntegrationId 496 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 497. A Using Attachments With Web Services On Demand This appendix describes how to exchange attachments using Web services On Demand. It contains the following topics: ■ “About Attachments” on page 497 ■ “The Attachment Element” on page 497 ■ “Specifying File Attachment Content” on page 499 ■ “Retrieving or Querying File Attachments” on page 503 ■ “Specifying URL Attachments” on page 505 About Attachments Attachments can be exchanged for a number of objects using Web Services On Demand. The parent objects that have Attachment child objects are: Account, Activity, Campaign, Contact, Custom Object 01 - 03, Dealer, Lead, Opportunity, Service Request, and Solution. File Attachments can be exchanged as text or as binary data. In the case of binary data, the data must be encoded as inline Base64 encoded data, which ensures that the binary data is in a printable format. Binary files must therefore be encoded into Base64 format in the content provided in SOAP requests. File attachments added through Web services requests are limited to 9MB in size just as they are for the Oracle CRM On Demand UI. Attachments greater than 9MB in size are therefore rejected. To accommodate Base64 encoding of binary files, the request size limit for SOAP requests with attachment files is 14MB. You can develop client applications that allows attachment files to be added or updated for multiple records. SOAP requests contain multiple records; the first record contains the attachment as well as a Content ID value, however, other records in the SOAP request do not need to contain the same attachment, they need only reference the Content ID value from the first record. The Attachment Element In a Web services call, the content of an attachment must be contained in the <Attachment> element, which has the complex data type SiebelXmlAttachmentType, as shown in the following sample WSDL for an Attachment child object: <xsd:complexType name="ListOfAttachment"> <xsd:sequence> <xsd:element name="Attachment" maxOccurs="unbounded" minOccurs="0" type="xsdLocal1:Attachment" /> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 49 7 Release 18)
- 498. Using Attachments With Web Services On Demand ■ The Attachment Element </xsd:sequence> </xsd:complexType> <xsd:complexType name="Attachment"> <xsd:sequence> <xsd:element name="Id" maxOccurs="1" minOccurs="0" type="xsdLocal1:string30"/> <xsd:element name="DisplayFileName" maxOccurs="1" minOccurs="0" type="xsdLocal1:string200" /> <xsd:element name="FileNameOrURL" maxOccurs="1" minOccurs="0" type="xsdLocal1:string200" /> <xsd:element name="FileExtension" maxOccurs="1" minOccurs="0" type="xsdLocal1:string10" /> <xsd:element name="FileDate" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="FileSize" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="ContactId" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="ExternalSystemId" maxOccurs="1" minOccurs="0" type="xsdLocal1:string30" /> <xsd:element name="Description" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="CreatedDate" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="CreatedById" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="CreatedBy" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="ModId" maxOccurs="1" minOccurs="0" type="xsdLocal1:string30"/> <xsd:element name="ModifiedDate" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="ModifiedById" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="ModifiedBy" maxOccurs="1" minOccurs="0" type="xsd:string" /> <xsd:element name="Attachment" maxOccurs="1" minOccurs="0" type="xsdLocal1:SiebelXmlAttachmentType"/> </xsd:sequence> </xsd:complexType> ... <xsd:complexType name="SiebelXmlAttachmentType"> <xsd:simpleContent> <xsd:extension base="xsd:base64Binary"> 498 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 499. Using Attachments With Web Services On Demand ■ Specifying File Attachment Content <xsd:attribute name="ContentId" type="xsd:string" /> <xsd:attribute name="AttachmentIsTextData" type="xsd:string" /> </xsd:extension> </xsd:simpleContent> </xsd:complexType> As the WSDL sample indicates. the <Attachment> child element can have the following optional attributes: ■ ContentId. Uniquely identifies the attachment content. If the attribute is not specified, the Web Services framework creates one for internal processing and to identify the content. This attribute is also used to achieve content reuse within a SOAP message, as described in “Attaching a File to Multiple Records” on page 501. ■ AttachmentIsTextData. Indicates that the content is plain text and that no Base64 decoding needs to be performed on it. The default value for this attribute is false. This attribute must be specified when text content is being specified. Specifying File Attachment Content The following topics describe the different ways in which you can specify the attachment content and how you can attach the same file to multiple records. Sample SOAP requests are included to illustrate the use of the attributes of the <Attachment> element. Attaching Binary Data The following SOAP sample shows how the Base64 encoded attachment file must be embedded within the SOAP document: <?xml version="1.0" encoding="UTF-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:// www.w3.org/2001/XMLSchema"> <soap:Body> <AccountWS_AccountInsert_Input xmlns="urn:crmondemand/ws/account/10/2004"> <ListOfAccount> <Account> <Description>This is for missing fields test</Description> <Location>Bangalore</Location> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 499 Release 18)
- 500. Using Attachments With Web Services On Demand ■ Specifying File Attachment Content <AccountName>Atach_Test1</AccountName> <NumberEmployees>300</NumberEmployees> <ListOfAttachment> <Attachment> <FileNameOrURL>Attached</FileNameOrURL> <FileExtension>doc</FileExtension> <DisplayFileName>A Doc Attachment</DisplayFileName> <Attachment ContentId="content_doc">0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAA ........ ........ AAAAAAAAAAAAAAAAAAAAAAAAAA=</Attachment> </Attachment> </ListOfAttachment> </Account> </ListOfAccount> </AccountWS_AccountInsert_Input> </soap:Body> </soap:Envelope> The attachment content is specified within the <Attachment> element which has the data type SiebelXmlAttachmentType. NOTE: It is not required to specify the ContentId attribute. Attaching a Text File When attaching a text file (a non-binary file in printable ASCII format), no Base64 encoding is required. The following SOAP request illustrates how a text file can be attached: <?xml version="1.0" encoding="UTF-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:// www.w3.org/2001/XMLSchema"> <soap:Body> 500 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 501. Using Attachments With Web Services On Demand ■ Specifying File Attachment Content <AccountWS_AccountInsert_Input xmlns="urn:crmondemand/ws/account/10/2004"> <ListOfAccount> <Account> <Description>Account with text attachment</Description> <Location>Bangalore</Location> <AccountName>Attach Text</AccountName> <NumberEmployees>300</NumberEmployees> <ListOfAttachment> <Attachment> <FileNameOrURL>Attach Text</FileNameOrURL> <FileExtension>txt</FileExtension> <DisplayFileName>My Rantings</DisplayFileName> <Attachment AttachmentIsTextData="true"> The quick brown fox jumps over the lazy dog.. </Attachment> </Attachment> </ListOfAttachment> </Account> </ListOfAccount> </AccountWS_AccountInsert_Input> </soap:Body> </soap:Envelope> The AttachmentIsTextData attribute of the <Attachment> element has the value true to indicate that the content is plain text and that no Base64 encoding or decoding is required to be performed by the Web Services framework. Attaching a File to Multiple Records The ContentId attribute of the <Attachment> element is used to uniquely identify attachment content. The ContentID argument is optional and the Web services framework generate ones for its internal processing, if it is not provided. The ContentID attribute allows you to reuse the content contained in another <Attachment> element so that you can specify the same attachment content for multiple records. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 501 Release 18)
- 502. Using Attachments With Web Services On Demand ■ Specifying File Attachment Content When reusing the content in this way, you only need to specify the ContentID value, and the attachment content must be empty. Values of the ContentID attribute must be unique. The following SOAP request shows how a file can be attached to two records: <?xml version="1.0" encoding="UTF-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:// www.w3.org/2001/XMLSchema"> <soap:Body> <AccountWS_AccountInsert_Input xmlns="urn:crmondemand/ws/account/10/2004"> <ListOfAccount> <Account> <Description>Account for attachment and resuse test</Description> <Location>Bangalore</Location> <AccountName>Attach Test Reuse</AccountName> <NumberEmployees>300</NumberEmployees> <ListOfAttachment> <Attachment> <FileNameOrURL>Attached</FileNameOrURL> <FileExtension>doc</FileExtension> <DisplayFileName>To be reused</DisplayFileName> <Attachment ContentId="reuse">0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7/ CQAGAAAAAAAAAAAAAAACAAAA+AAAAAAAAAAAEAAA+gAAAAEAAAD+////AAAAAPYAAAD3AAAA////////// ///////////////// .......... The Base64 encoded stream goes here .......... AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=</Attachment> </Attachment> </ListOfAttachment> </Account> <Account> <Description>This copying the attachment</Description> <Location>San Mateo</Location> <AccountName>Attach Test Copy</AccountName> 502 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 503. Using Attachments With Web Services On Demand ■ Retrieving or Querying File Attachments <NumberEmployees>300</NumberEmployees> <ListOfAttachment> <Attachment> <FileNameOrURL>Attach Reuse</FileNameOrURL> <FileExtension>doc</FileExtension> <DisplayFileName>Reused</DisplayFileName> <Attachment ContentId="reuse"></Attachment> </Attachment> </ListOfAttachment> </Account> </ListOfAccount> </AccountWS_AccountInsert_Input> </soap:Body> </soap:Envelope> The SOAP request above shows how you can attach the same file to two different Account records. ■ The ContentId value Content_01 is specified for the attachment child of the first Account. ■ The same ContentId value is specified for the attachment child of the second account, with the result that the same file is attached to both accounts. Only the ContentId attribute needs to be specified for the second account record. Retrieving or Querying File Attachments When performing a query operation to retrieve attachment content, the response must contain Base64 encoded content. This is true even if the attached file is a simple text file. The attachment content must therefore be decoded back from Base64 to the binary or text format in all cases. No content reuse is supported when performing a query. Even though the same file has been attached to multiple records, the response always generates unique ContentId values and the <Attachment> elements contain the attachment content. The following SOAP response illustrates a query response for an attachment child: <?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:// www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 503 Release 18)
- 504. Using Attachments With Web Services On Demand ■ Retrieving or Querying File Attachments <ns:AccountWS_AccountQueryPage_Output mlns:ns="urn:crmondemand/ws/account/10/ 2004"> <ns:LastPage>true</ns:LastPage> <ListOfAccount xmlns="urn:/crmondemand/xml/account"> <Account> <AccountId>1QA2-L9DZG</AccountId> <Description>Account with attachment</Description> <Location>Toronto</Location> <AccountName>Test Account</AccountName> <ListOfAttachment> <Attachment> <DisplayFileName>My sales analysis</DisplayFileName> <FileNameOrURL>Analysis</FileNameOrURL> <FileExtension>xml</FileExtension> <Description></Description> <Attachment AttachmentIsTextData="false" Extension="xml" ContentId="1QA2- RTX3">PD94bWwgdiVVRGLTgiPz48P1NpZWJlbC1Qcm9wZXJ0eS1TZXQgRXNjYXBl <Base 64 encoded attachment data ........> </Attachment> </Attachment> </ListOfAttachment> </Account> </ListOfAccount> </ns:AccountWS_AccountQueryPage_Output> </SOAP-ENV:Body> </SOAP-ENV:Envelope> There are two additional attributes of the <Attachment> element: ■ EndOfData. Indicates that the data is the complete content. Always true. ■ TimedOut. Indicates whether a time-out occurred when obtaining the data. Always false. 504 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 505. Using Attachments With Web Services On Demand ■ Specifying URL Attachments Specifying URL Attachments Web Services also supports the exchange of URL attachments as well as file attachments. The handling of URL attachments differs from file attachments in the following ways: ■ The FileNameOrURL field must specify the actual URL. The URL must begin with one of the following: HTTP, HTTPS, FTP or WWW (case-insensitive). ■ The FileNameOrURL and FileExtension fields form a user key for Attachment child objects, however, FileExtension is not a required field for URL attachments and is ignored. The <Attachment> element is not required to have any content, and any content is ignored if provided. The following example SOAP request shows a URL attachment. <?xml version="1.0" encoding="UTF-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:// www.w3.org/2001/XMLSchema"> <soap:Body> <AccountWS_AccountInsert_Input xmlns="urn:crmondemand/ws/account/10/2004"> <ListOfAccount> <Account> <Description>Account with URL attachment</Description> <Location>Bangalore</Location> <AccountName>Atach URL</AccountName> <NumberEmployees>300</NumberEmployees> <ListOfAttachment> <Attachment> <FileNameOrURL>www.pingpong.com</FileNameOrURL> </Attachment> </ListOfAttachment> </Account> </ListOfAccount> </AccountWS_AccountInsert_Input> </soap:Body> </soap:Envelope> Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 505 Release 18)
- 506. Using Attachments With Web Services On Demand ■ Specifying URL Attachments 506 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 507. B Mapping of Display Names to Service API Object Names A number of the Service API methods, such as GetMapping use elements such as <ObjectName> or <RecordType> to identify the objects on which they operate. However, the object names specified in requests or returned may differ from the name displayed in the UI. For such cases, Table 731 shows the mapping between the default UI display name of objects and their programmatic names as used by Service API methods. For more information about the Service API methods, see “Service API Calls” on page 94. Table 731. Mapping of Display Object Names To Service API Object Names UI Name Service API Name Account Competitor AccountCompetitor Account Relationship AccountRelationship Accreditation Request AccreditationRequest Address CUT Address Application Team ApplicationTeam Allocation CRMOD_LS_Allocation Business Plan CRMODLS_BusinessPlan Call Product Detail Call ProdDetail Call Promotional Item Call PromItemDrop Call Sample Dropped Call SampDrop Campaign Recipient ContactCampaign Certification Request CertificationRequest Contact Best Times ContactBestTimes Contact Interests ContactInterest Contact Relationship ContactRelationship Contact State License CRMOD_LS_ContactLicenses Course Enrollment CourseEnrollment Custom Object 01 Team CustObj1 Team Custom Object 02 Team CustObj2 Team Custom Object 03 Team CustObj3 Team Custom Object n Team CustObjn Team Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 50 7 Release 18)
- 508. Mapping of Display Names to Service API Object Names ■ Table 731. Mapping of Display Object Names To Service API Object Names UI Name Service API Name Dealer Channel Partner Dealer Territory Channel Partner Territory Deal Registration DealRegistration Deal Registration Product Revenue DealRegistrationProductRevenue Deal Registration Team DealRegistrationTeam Exam Registration ExamRegistration Financial Account FinancialAccount Financial Account Holder FinancialAccountHolder Financial Account Holding FinancialAccountHolding Financial Plan FinancialPlan Financial Product FinancialProduct Financial Transaction FinancialTransaction Household Team HouseholdTeam Inventory Audit Report CRMODLS_InventoryAuditReport Inventory Period CRMODLS_InventoryPeriod Insurance Property InsuranceProperty Involved Party InvolvedParty MDF Request MDFRequest MDF Request Team MDFRequestTeam MedEd Event MedEdEvent MedEd Invitee MedEdInvitee Message Response CRMODLS_PCD_MSGRSP Messaging Plan CRMOD_LS_MessagingPlan Messaging Plan Item CRMOD_LS_MsgPlanItem Messaging Plan Item Relation CRMOD_LS_MsgPlnRel Modification Tracking CRMODLS_ModificationLog Objective CRMODLS_OBJECTIVE Opportunity Competitor OpportunityCompetitor Opportunity Partner OpportunityPartner Partner Account PartnerAccount Partner Opportunity PartnerOpportunity 508 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 509. Mapping of Display Names to Service API Object Names ■ Table 731. Mapping of Display Object Names To Service API Object Names UI Name Service API Name Partner Program PartnerProgram Partner Team PartnerTeam Partner Type PartnerType Plan Account CRMODLS_BPL_ACNT Plan Contact CRMODLS_BPL_CNTCT Plan Opportunity CRMODLS_PlanOpportunities Policy Holder Policy Portfolio Team PortfolioTeam Portfolio Owner PortfolioOwners Price List PriceList Price List Line Item PriceListLineItem Program Membership ProgramPartner Sample Disclaimer CRMODLS_SIGNDISC Sample Inventory CRMODLS_SampleInventory Sample Lot CRMODLS_SampleLot Sample Transaction CRMOD_LS_Transactions Signature CRMODLS_Signature Special Pricing Request SPRequest Special Pricing Request Line Item SPRequestLineItem Special Pricing Request Team SPRequestTeam Transaction Item CRMOD_LS_TransactionItems Vehicle Financial Information Vehicle FinInfo Vehicle Sales History Vehicle SalesHist Vehicle Service History Vehicle ServHist Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 509 Release 18)
- 510. Mapping of Display Names to Service API Object Names ■ 510 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 511. C Web Services On Demand Limiters The Oracle CRM On Demand’s Web Services interface resources can be shared by multiple organizations. Oracle CRM On Demand provides a limiting infrastructure to make sure that some users do not consume a disproportionate share of those resources. These limiters constrain customer organizations’ use of server-side resources to equitably share available resources among users and to minimize the possibility of denial-of-service incidents. Table 732 summarizes the limiters, their default values, units, and error messages. For more information, contact Customer Care. Further information about the Web Services Request Rate limiter is provided in “Web Services Request Rate” on page 512. Table 732. Web Services On Demand Limiters Default Limiter Name Description Value Units Error Message Concurrent Maximum number of 10 sessions N/A Session Limit concurrent sessions (Company) for a company Lifetime of Number of days Web 90 days N/A Audit records services utilization records are saved Queued Maximum number of 5 sessions The server is currently busy Request Limit requests that a processing a prior request for (Stateful) stateful Web services you. Please try your request user may have again later. queued waiting for a free OM session Queued Maximum number of 5 sessions The server is currently busy Request Limit requests that a processing a prior request for (Stateless) stateless Web services you. Please try your request user may have again later. queued waiting for a free OM session. Web Service Number of Web 20 requests The maximum rate of requests Request Rate service messages that /second was exceeded. Please try again can be sent in one in {0} ms. second Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 51 1 Release 18)
- 512. Web Services On Demand Limiters ■ Table 732. Web Services On Demand Limiters Default Limiter Name Description Value Units Error Message Web Service Maximum size, in 14400 KB Request exceeded the size limit Request Size kilobytes, of a Web of {0} KB. services request. Web Service How long, in seconds, 600 seconds Internal Error: Session is not Session that a Web services available. Aborting. Inactivity Time session may remain Limit idle before being closed by the system. Maximum For return messages 100 records PageSize method argument Records the maximum number cannot be greater than 100, (fixed Returned of records returned specified by the server maximum for each query. parameter ‘MaximumPageSize’. value) A response never returns more than the specified number of records for a parent object in a request. Maximum The maximum 20 objects Requests containing more than Objects in a number of objects 20 objects are not allowed. (fixed Web Services that can be sent in a maximum Request single SOAP request. value) Web Services Request Rate All integration requests (data exchange requests) in a session are subject to rate limiting. Rate limiting is implemented for the following reasons: ■ A user can perform long-running operations on the server that result in complex and long- running queries on the database. ■ A user can perform constant operations on the server that constantly use resources. Rate limiting can alleviate the previous problems to some extent. Oracle CRM On Demand applies a restriction to each session to limit the number of requests for each second that clients can make. The rate limit is set to twenty requests for each second. This is measured as a minimum of 1/20th second wait time between requests. If the rate limit is exceeded, the following error message is provided to subsequent SOAP requests: The maximum rate of requests was exceeded. Please try again in <waitTime> ms. There are two situations in which this error message is displayed: 512 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 513. Web Services On Demand Limiters ■ 1 Where the client sends more than 20 requests per second 2 Where the client sends requests at a rate faster than one request per 50 ms. For the second situation, a wait statement is recommended. Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 513 Release 18)
- 514. Web Services On Demand Limiters ■ 514 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 515. Index A read-only fields 342 AccessProfileRead method required fields 342 arguments 121 status key 342 call return value 121 user key fields 343 AccessProfileReadAll method ActionBarLayoutReadAll method arguments 122 arguments 123 call return value 122 call return value 124 AccessProfileUpsert method ActionBarLayoutUpsert method arguments 123 arguments 125 call return value 123 call return value 125 account child object activity child object about 462 about 464 fields 463 fields 464 pick map 463 pick map 465 picklists 464 read-only fields 464 read-only fields 463 required fields 464 required fields 463 status key 465 status key 463 user key fields 466 user key fields 463 activity object account object about 178, 301 about 159, 298 child components 178 child components 159 fields 180, 302 fields 160, 300 filterable fields 184 filterable fields 171 list of values 186, 304 methods 159, 299 methods 179, 302 pick map fields 166, 300 parents 178 picklists 177, 301 pick map fields 183, 303 read-only fields 160, 300 read-only fields 180, 302 required fields 160, 300 required fields 180, 302 status key 163, 300 status key 182, 303 user key fields 301 usage 178, 282, 301, 336 accreditation object user key fields 184, 304 about 339 address child object 466 fields 340 fields 466 list of values 341 pick map 467 methods 339 read-only fields 466 pick map fields 340 required fields 466 read-only fields 340 status key 467 required fields 340 user key fields 467 status key 340 Administrative Services API calls user key fields 341 AccessProfileRead 121 accreditation request object AccessProfileReadAll 121 about 341 AccessProfileUpsert 122 fields 342 ActionBarLayoutReadAll 123 list of values 343 ActionBarLayoutUpsert 124 methods 342 CascadingPicklistRead 125 pick map fields 343 CascadingPicklistReadAll 126 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 51 5 Release 18)
- 516. Index ■ A CustomRecordTypeRead 127 CustomWebTabDelete 132 CustomRecordTypeReadAll 127 CustomWebTabRead 133 CustomRecordTypeUpsert 128 CustomWebTabReadAll 133 CustomWebLinkRead 129 CustomWebTabUpsert 134 CustomWebLinkReadAll 130 Delete method (Web Services v1.0) 63 CustomWebLinkUpsert 131 Delete method (Web Services v2.0) 82 CustomWebTabDelete 132 DeleteChild method 66 CustomWebTabRead 133 DeletedItemQueryPage method 95 CustomWebTabReadAll 133 DeleteEvents method 99 CustomWebTabUpsert 134 designing client applications 56 FieldManagementCreate 135 Echo Argument 63, 80 FieldManagementRead 136 Execute method 83 FieldManagementReadAll 136 FieldManagementCreate 135 FieldManagementUpsert 137 FieldManagementRead 136 HomepageLayoutReadAll 138 FieldManagementReadAll 136 overview 119 FieldManagementUpsert 137 PageLayoutFieldRead 140 GetEvents method 100 PageLayoutFieldReadAll 140 GetMapping method 103 PageLayoutFieldUpsert 141 GetPicklistValues method 104 PageLayoutRelatedInformationReadAll 142 GetServerTime method 105 PageLayoutRelatedInformationUpsert 143 HomepageLayoutReadAll 138 PicklistRead 144 Insert method (Web Services v1.0) 67 PicklistReadAll 144 Insert method (Web Services v2.0) 84 PicklistUpsert 145 InsertChild method 68 RoleReadAll 146 InsertOrUpdate method 68 RoleUpsert 147 LoginHistoryQueryPage method 106 allocation object LOVLanguageMode argument 81 about 377 MergeRecords method 107 fields 378 MetadataChangeSummaryQueryPage list of values 379 method 109 methods 378 PageLayoutFieldRead 140 pick map fields 379 PageLayoutFieldReadAll 140 read-only fields 378 PageLayoutFieldUpsert 141 required fields 378 PageLayoutRelatedInformationReadAll 142 status key 378 PageLayoutRelatedInformationUpsert 143 user key fields 379 PicklistRead 144 API calls PicklistReadAll 144 AccessProfileRead 121 PicklistUpsert 145 AccessProfileReadAll 121 QueryPage method (Web Services v1.0) 69 AccessProfileUpsert 122 QueryPage method (Web Services v2.0) 85 ActionBarLayoutReadAll 123 RoleReadAll 146 ActionBarLayoutUpsert 124 RoleUpsert 147 BulkOpImportCreateRequest 149 SalesProcessQueryPage method 110 BulkOpImportGetRequestDetail 153 Service API calls 94 BulkOpImportSendData 151 SetPasswordAPI method 112 CascadingPicklistRead 125 SetSessionTimeZone method 113 CascadingPicklistReadAll 126 Update method (Web Services v1.0) 78 core methods 62 Update method (Web Services v2.0) 93 CustomRecordTypeRead 127 UpdateCascadingPicklists method 115 CustomRecordTypeReadAll 127 UpdateChild method 79 CustomRecordTypeUpsert 128 UpdatePicklist method 114 CustomWebLinkRead 129 UserUsageQueryPage method 117 CustomWebLinkReadAll 130 ViewMode argument 81 CustomWebLinkUpsert 131 application object 516 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 517. Index ■ B about 343 integration design 43 fields 344 integration management 58 list of values 345 integration performance 54 methods 344 login history 57 pick map fields 345 moving customers between pods 58 read-only fields 344 opportunity product revenue records 47 required fields 344 outages 58 status key 344 outages and failures 47 user key fields 345 QueryPage method 57 arguments session management 55 Echo method 63, 80 setting and querying blank values 46 LOVLanguageMode method 81 SSL certificates 59 ViewMode method 81 stateless Web services 45 asset child object 467 telephone numbers in Web services fields 468 requests 52 pick map 468 user usage 57 read-only fields 468 Web services proxy classes 48 required fields 468 Web services requests 44 status key 468 book child object user key fields 469 about 470 asset object fields 470 about 187, 305 pick map 471 fields 187, 306 read-only fields 470 filterable fields 188 required fields 470 list of values 189, 307 status key 471 methods 187, 306 user key fields 471 pick map fields 188, 307 book object read-only fields 187, 306 about 189, 308 required fields 187, 306 child components 189 status key 188, 306 fields 190, 308 usage 187, 305 filterable fields 191 user key fields 188, 307 list of values 191, 309 attachment child object 469 methods 189, 308 fields 469 pick map 191, 309 read-only fields 469 read-only fields 190, 308 required fields 469 required fields 190, 308 status key 470 status key 190, 309 user key fields 470 user key fields 309 attachment object 292 book user object 292 attachments 497 BulkOpImportCreateRequest method audit fields 156 arguments 151 audit records, lifetime 511 call return value 151 audit trail object 292 BulkOpImportGetRequestDetail method arguments 153 B call return value 154 batch processing 54 BulkOpImportSendData method best practices arguments 152 API calls 56 call return value 153 attachments 56 business plan object batch processing 54 about 379 error handling and logging 47 fields 380 flushing of caches 44 list of values 381 indexed custom fields 58 methods 380 pick map fields 381 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 517 Release 18)
- 518. Index ■ C read-only fields 380 account 159 required fields 380 activity 178 status key 380 book 189 user key fields 381 campaign 192 contact 201 C current user 220 campaign object CustomObject1 222 about 192, 309 household 235 child components 192 lead 240 fields 193, 310 MedEd 246 filterable fields 199 opportunity 251 list of values 200, 311 portfolio 264 methods 192, 310 service request 272 pick map field 196, 311 solution 277 read-only fields 193, 310 user group 285 required fields 193, 310 vehicle 287 status key 195, 310 child objects user key fields 311 account 462 CascadingPicklistRead method activity 464 arguments 126 address 466 call return value 126 asset 467 CascadingPicklistReadAll method attachment 292, 469 arguments 126 audit trail 292 call return value 126 book 470 category object book user 292 about 312 competitor 292 methods 312 contact 471 pick map field 313 contact team 473 read-only fields 312 custom object 474 required fields 312 delegated user 293, 476 status key 312 household team 293 user keys 313 interests 294, 477 certification object invitee 294, 478 about 346 lead 480 fields 346 login history 294 list of values 348 multiple contact roles 294 methods 346 note 482 pick map fields 347 opportunity 483 read-only fields 346 opportunity team 294 required fields 346 portfolio team 295 status key 347 product detailed 295 user key fields 347 products detailed 485 certification request object promotional items dropped 486 about 348 quota 295 fields 348 recipient 296, 487 list of values 350 related account 296 methods 348 related contact 296, 488 pick map fields 349 revenue 296, 490 read-only fields 348 sample dropped 297, 492 required fields 348 service request 493 status key 349 sub book 297 user key fields 349 team 297 child components user 495 claim object 518 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 519. Index ■ C about 424 read-only fields 202, 314 fields 425 required fields 202, 314 methods 425 status key 206, 315 pick map fields 426 user key fields 316 picklists 426 contact state license object read-only fields 425 about 384 status key 425 fields 384 user key fields 426 list of values 385 client applications, designing methods 384 API calls 56 pick map 385 batch processing 54 read-only fields 384 error handling 47 required fields 384 error logging 47 status key 384 handling outages 58 user key fields 385 Insert method 56 contact team child object InsertorUpdate method 56 about 473 session management 55 fields 473 session pooling 55 pick map 474 Update method 56 picklists 474 client integrations read-only fields 473 examples 16 required fields 473 client-side session management 37 status key 473 company-specific WSDL 24 user key fields 474 competitor object core methods about 292 Delete method (Web Services v1.0) 63 fields 293 Delete method (Web Services v2.0) 82 concurrent session limit (company) 511 DeleteChild method 66 contact best time object Execute method 83 about 382 Insert method (Web Services v1.0) 67 fields 382 Insert method (Web Services v2.0) 84 list of values 383 InsertChild method 68 methods 382 InsertOrUpdate method 68 pick map fields 383 list of 62 read-only fields 382 MergeRecords 107 required fields 382 QueryPage method (Web Services v1.0) 69 status key 383 QueryPage method (Web Services v2.0) 85 user key fields 383 Update method (Web Services v1.0) 78 contact child object Update method (Web Services v2.0) 93 about 471 UpdateChild method 79 fields 472 core technologies 15 pick map 472 about 15 read-only fields 472 course enrollment object required fields 472 about 352 status key 472 fields 353 user key fields 473 list of values 355 contact object methods 353 about 201, 313 pick map fields 354 child components 201 read-only fields 353 fields 202, 314 required fields 353 filterable fields 212 status key 353 list of values 219, 316 user key fields 354 methods 201, 314 course object objects not to use 220, 317 about 350 pick map 209, 315 fields 351 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 519 Release 18)
- 520. Index ■ D list of values 352 required fields 223, 318 methods 350 status key 225, 318 pick map fields 351 user keys 229, 320 read-only fields 351 CustomRecordTypeRead method required fields 351 arguments 127 status key 351 call return value 127 user key fields 352 CustomRecordTypeReadAll method coverage object arguments 128 about 427 call return value 128 fields 428 CustomRecordTypeUpsert method methods 427 arguments 129 pick map fields 428 call return value 129 picklists 429 CustomWebLinkRead method read-only fields 428 arguments 130 status key 428 call return value 130 user key fields 428 CustomWebLinkReadAll method CRM On Demand arguments 130 custom fields 23 call return value 130 integration tag 23 CustomWebLinkUpsert method CRM On Demand Web Services 16 arguments 132 communication with (figure) 16 call return value 132 filterable fields 158 CustomWebTabDelete method parent and child relationships, about 23 arguments 132 reliability 19 call return value 132 Security 17 CustomWebTabRead method currency and number fields 28 arguments 133 current user object call return value 133 about 220 CustomWebTabReadAll method child components 220 arguments 134 fields 221 call return value 134 filterable fields 221 CustomWebTabUpsert method methods 220 arguments 135 read-only fields 221 call return value 135 required fields 221 custom fields 23 D custom object child object damage object about 474 about 429 fields 475 fields 430 pick map 475 methods 429 picklists 476 pick map fields 430 read-only fields 475 read-only fields 430 required fields 475 status key 430 status key 475 user key fields 431 user key fields 475 Data Loader API calls customization-specific WSDL 24 available calls 149 CustomObject1 object BulkOpImportCreateRequest 149 about 222, 317 BulkOpImportGetRequestDetail 153 child components 222 BulkOpImportSendData 151 fields 223, 318 overview 149 filterable fields 229 date and time fields 27 list of values 231 deal registration object methods 222, 317 about 355 pick map 227, 318 fields 355 read-only fields 223, 318 520 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 521. Index ■ E list of values 357 about 357 methods 355 fields 358 pick map field 356 list of values 359 read-only fields 355 methods 357 required fields 355 pick map fields 358 status key 356 read-only fields 358 user keys 356 required fields 358 dealer object status key 358 about 231, 456 user key fields 359 fields 232, 457 exam registration object filterable fields 234 about 359 list of values 458 fields 360 methods 232, 457 list of values 361 pick map field 234, 458 methods 360 read-only fields 232, 457 pick map fields 361 required fields 232, 457 read-only fields 360 status key 233, 457 required fields 360 user keys 458 status key 360 delegated user child object user key fields 361 about 476 Execute method fields 476 arguments 83 read-only fields 476 call return value 84 required fields 476 usage 83 status key 476 user key fields 477 F delegated user object 293 features, what’s new 13 Delete method field types arguments 65 custom fields 23 Delete method (Web Services v1.0) supported 24 usage 63 FieldManagementCreate method Delete method (Web Services v2.0) arguments 135 arguments 82 call return value 136 usage 82 FieldManagementRead method DeleteChild method arguments 136 arguments 66 call return value 136 usage 66 FieldManagementReadAll method DeletedItemQueryPage method arguments 137 about 95 call return value 137 arguments 98 FieldManagementUpsert method call return value 98 arguments 138 DeleteEvents method call return value 138 about 99 fields call return value 100 audit 156 custom fields 23 E read-only, account child object 463 Echo argument 63, 80 read-only, account object 160, 300 email fields 28 read-only, accreditation object 340 Enable Web Services Access 31 read-only, accreditation request object 342 Enable Web Services Access privilege 31 read-only, activity child object 464 error handling 47 read-only, activity object 180, 302 error logging 47 read-only, address child object 466 establishing a session 35 read-only, allocation object 378 exam object read-only, application object 344 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 521 Release 18)
- 522. Index ■ F read-only, asset child object 468 read-only, modification tracking object 402 read-only, asset object 187, 306 read-only, note child object 482 read-only, attachment child object 469 read-only, note object 250, 325 read-only, book child object 470 read-only, objective object 403 read-only, book object 190, 308 read-only, opportunity child object 483 read-only, business plan object 380 read-only, opportunity object 252, 326 read-only, campaign object 193, 310 read-only, partner object 366 read-only, category object 312 read-only, plan account object 406, 410 read-only, certification object 346 read-only, plan contact object 408 read-only, certification request object 348 read-only, policy holder object 452 read-only, claim object 425 read-only, policy object 450 read-only, contact best time object 382 read-only, portfolio object 264, 454 read-only, contact child object 472 read-only, price list line item object 371 read-only, contact object 202, 314 read-only, price list object 369 read-only, contact state license object 384 read-only, product category object 271 read-only, contact team child object 473 read-only, product object 268, 328 read-only, course enrollment object 353 read-only, products detailed child object 485 read-only, course object 351 read-only, promotional items dropped child read-only, coverage object 428 object 486 read-only, current user object 221 read-only, recipient child object 488 read-only, custom object child object 475 read-only, related contact child object 489 read-only, CustomObject1 object 223, 318 read-only, revenue child object 490 read-only, damage object 430 read-only, sample disclaimer object 412 read-only, deal registration object 355 read-only, sample dropped child object 492 read-only, dealer object 232, 457 read-only, sample inventory object 414 read-only, delegated user child object 476 read-only, sample lot object 416 read-only, exam object 358 read-only, sample transaction object 418 read-only, exam registration object 360 read-only, service request child object 493 read-only, financial account holder read-only, service request object 273, 331 object 434 read-only, signature object 420 read-only, financial account holding read-only, solution object 278, 333 object 436 read-only, SP request line item object 375 read-only, financial account object 432 read-only, SP request object 373 read-only, financial plan object 438 read-only, territory object 281, 335 read-only, financial product object 440 read-only, transaction item object 422 read-only, financial transaction object 442 read-only, user child object 495 read-only, fund object 362 read-only, user group object 285 read-only, group object 321 read-only, user object 283, 337 read-only, household object 236, 444 read-only, vehicle object 288, 459 read-only, insurance property object 446 required, account child object 463 read-only, interests child object 477 required, account object 160, 300 read-only, inventory audit report object 386 required, accreditation object 340 read-only, inventory period object 389 required, accreditation request object 342 read-only, invitee child object 479 required, activity child object 464 read-only, involved party object 448 required, activity object 180, 302 read-only, lead child object 480 required, address child object 466 read-only, lead object 241, 322 required, allocation object 378 read-only, MDF request object 364 required, application object 344 read-only, MedEd object 247, 390 required, asset child object 468 read-only, message response object 392 required, asset object 187, 306 read-only, messaging plan item object 397 required, attachment child object 469 read-only, messaging plan item relation required, book child object 470 object 400 required, book object 190, 308 read-only, messaging plan object 395 required, business plan object 380 522 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 523. Index ■ F required, campaign object 193, 310 required, product object 268, 328 required, category object 312 required, products detailed child object 485 required, certification object 346 required, promotional items dropped child required, certification request object 348 object 486 required, contact best time object 382 required, recipient child object 488 required, contact child object 472 required, related contact child object 489 required, contact object 202, 314 required, revenue child object 490 required, contact state license object 384 required, sample disclaimer object 412 required, contact team child object 473 required, sample dropped child object 492 required, course enrollment object 353 required, sample inventory object 414 required, course object 351 required, sample lot object 416 required, current user object 221 required, sample transaction object 418 required, custom object child object 475 required, service request child object 493 required, CustomObject1 object 223, 318 required, service request object 273, 331 required, deal registration object 355 required, signature object 420 required, dealer object 232, 457 required, solution object 278, 333 required, delegated user child object 476 required, SP request line item object 375 required, exam object 358 required, SP request object 373 required, exam registration object 360 required, territory object 281, 335 required, financial account holder object 434 required, transaction item object 422 required, financial account holding required, user child object 495 object 436 required, user group object 285 required, financial account object 432 required, user object 283, 337 required, financial plan object 438 required, vehicle object 288, 459 required, financial product object 440 filterable fields 158 required, financial transaction object 442 financial account holder object required, fund object 362 about 433 required, group object 321 fields 434 required, household object 236, 444 methods 433 required, interests child object 477 pick map fields 434 required, inventory audit report object 386 picklists 435 required, inventory period object 389 read-only fields 434 required, invitee child object 479 required fields 434 required, lead child object 480 status key 434 required, lead object 241, 322 user key fields 435 required, MDF request object 364 financial account holding object required, MedEd object 390 about 435 required, message response object 392 fields 436 required, messaging plan item object 397 methods 435 required, messaging plan item relation pick map fields 436 object 400 read-only fields 436 required, messaging plan object 395 required fields 436 required, modification tracking object 402 status key 436 required, note child object 482 user key fields 437 required, note object 250, 325 financial account object required, objective object 403 about 431 required, opportunity child object 483 fields 432 required, opportunity object 252, 326 methods 431 required, plan account object 406 pick map fields 432 required, plan contact object 408 picklists 433 required, plan opportunity object 410 read-only fields 432 required, price list line item object 371 required fields 432 required, price list object 369 status key 432 required, product category object 271 user key fields 433 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 523 Release 18)
- 524. Index ■ G financial plan object GetServerTime method about 437 about 105 fields 438 call return value 106 methods 437 group object pick map fields 438 about 320 picklists 439 methods 320 read-only fields 438 pick map field 321 required fields 438 read-only fields 321 status key 438 required fields 321 user key fields 439 status key 321 financial product object user key fields 321 about 439 fields 440 H methods 439 handling outages 58 pick map fields 440 HomepageLayoutReadAll method picklists 441 arguments 139 read-only fields 440 call return value 140 required fields 440 household object status key 440 about 235, 443 user key fields 440 child components 235 financial transaction object fields 236, 444 about 441 filterable fields 238 fields 442 list of values 234, 239, 445 methods 441 methods 235, 443 pick map fields 442 pick map field 238, 445 picklists 443 read-only fields 236, 444 read-only fields 442 required fields 236, 444 required fields 442 status key 237, 445 status key 442 user key fields 445 user key fields 443 household team object 293 fund object about 362 fields 362 I methods 362 indexed custom fields 58 pick map field 363 Insert method picklists 363 arguments 67 read-only fields 362 call return value 67 required fields 362 parent and child objects, effect on 67 status key 363 Insert method (Web Services v1.0) user key fields 363 usage 67 Insert method (Web Services v2.0) arguments 84 G call return value 85 generating customized WSDL 24 usage 84 GetEvents method InsertChild method about 100 arguments 68 call return value 101 usage 68 GetMapping method InsertOrUpdate method about 103 arguments 69 call return value 104 call return value 69 GetPicklistValues method parent and child objects, effect on 69 about 104, 114, 115 usage 68 arguments 105 insurance property object call return value 105 about 446 524 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 525. Index ■ K fields 446 read-only fields 448 methods 446 status key 449 pick map fields 447 user key fields 449 picklists 447 isEncoded parameter 38 read-only fields 446 status key 447 K user key fields 447 keys integration tag, viewing 23 status key, about 157 integrations status key, account child object 463 client integration examples 16 status key, account object 163, 300 Web services session, integration status key, accreditation object 340 requests 40 status key, accreditation request object 342 interests child object 294 status key, activity child object 465 about 477 status key, activity object 182, 303 fields 477 status key, address child object 467 pick map 478 status key, allocation object 378 picklists 477, 478, 480 status key, application object 344 read-only fields 477 status key, asset child object 468 required fields 477 status key, asset object 188, 306 status key 478 status key, attachment child object 470 user key fields 478 status key, book child object 471 inventory audit report object status key, book object 190, 309 about 386 status key, business plan object 380 fields 386 status key, campaign object 195, 310 list of values 388 status key, category object 312 methods 386 status key, certification object 347 pick map field 387 status key, certification request object 349 read-only fields 386 status key, claim object 425 required fields 386 status key, contact best time object 383 status key 387 status key, contact child object 472 user key fields 387 status key, contact object 206, 315 inventory period object status key, contact state license object 384 about 388 status key, contact team child object 473 fields 389 status key, course enrollment object 353 methods 388 status key, course object 351 pick map field 389 status key, coverage object 428 read-only fields 389 status key, CustomObject1 object 225, 318 required fields 389 status key, damage object 430 status key 389 status key, deal registration object 356 user key fields 389 status key, dealer object 233, 457 invitee child object 294 status key, delegated user child object 476 about 478 status key, exam object 358 fields 479 status key, exam registration object 360 pick map 479 status key, financial account holder read-only fields 479 object 434 required fields 479 status key, financial account holding status key 479 object 436 user key fields 479 status key, financial account object 432 involved party object status key, financial plan object 438 about 448 status key, financial product object 440 fields 448 status key, financial transaction object 442 methods 448 status key, fund object 363 pick map fields 449 status key, group object 321 picklists 449 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 525 Release 18)
- 526. Index ■ L status key, household object 237, 445 status key, user group object 286 status key, insurance property object 447 status key, user object 284, 337 status key, interests child object 478 status key, vehicle object 289, 459 status key, inventory audit report object 387 status key,custom object child object 475 status key, inventory period object 389 user key, about 156 status key, invitee child object 479 user key, category object 313 status key, involved party object 449 user key, price list line item object 372 status key, lead child object 481 user key, price list object 370 status key, lead object 242, 323 user key, product category object 272 status key, MDF request object 365 user key, product object 269, 329 status key, MedEd object 247, 391 user key, sample disclaimer object 412 status key, message response object 393 user key, sample inventory object 415 status key, messaging plan item object 398 user key, sample lot object 417 status key, messaging plan item relation user key, sample transaction object 419 object 400 user key, signature object 421 status key, messaging plan object 395 user key, territory object 336 status key, modification tracking object 402 user key, transaction item object 423 status key, note child object 482 user key, user object 284, 338 status key, note object 250, 325 status key, objective object 404 L status key, opportunity child object 484 lead child object status key, opportunity object 255, 326 about 480 status key, partner object 367 fields 480 status key, plan account object 406 pick map 481 status key, plan contact object 408 read-only fields 480 status key, plan opportunity object 410 required fields 480 status key, policy holder object 453 status key 481 status key, policy object 451 user key fields 482 status key, portfolio object 265, 455 lead object status key, price list line item object 371 about 239, 322 status key, price list object 369 child components 240 status key, product category object 271 fields 241, 322 status key, product object 269, 329 methods 240, 322 status key, products detailed child pick map fields 243, 323 object 485 picklists 245, 324 status key, promotional items dropped child read-only fields 241, 322 object 487 required fields 241, 322 status key, recipient child object 488 status key 242, 323 status key, related contact child object 489 user key fields 323 status key, revenue child object 490 lifetime of audit records 511 status key, sample disclaimer object 412 locale-dependent access 27 status key, sample dropped child object 492 logging in status key, sample inventory object 414 isEncoded parameter 38 status key, sample lot object 416 Single Sign-On 39 status key, sample transaction object 418 URL encoding 36, 38 status key, service request child object 494 Web services session 38 status key, service request object 274, 331 login history child object 294 status key, signature object 420 LoginHistoryQueryPage method status key, solution object 279, 333 about 106 status key, SP request line item object 375 arguments 106 status key, SP request object 373 call return value 107 status key, territory object 281, 335 LOVLanguageMode argument 81 status key, transaction item object 422 status key, user child object 496 526 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 527. Index ■ M M list of values 401 Manage Access to Web Services privilege 31 methods 399 maximum number of records returned 512 pick map fields 400 maximum objects in a Web services read-only fields 400 request 512 required fields 400 maximum records returned 512 status key 400 MDF request object user key fields 401 about 364 messaging plan object fields 364 about 394 list of values 365 fields 395 methods 364 list of values 397 pick map fields 365 methods 395 read-only fields 364 pick map fields 396 required fields 364 read-only fields 395 status key 365 required fields 395 user key fields 365 status key 395 MedEd object user key fields 396 about 246, 390 MetaDataChangeSummaryQueryPage child components 246 method fields 247, 390 call return value 110 filterable fields 248 MetadataChangeSummaryQueryPage list of values 248, 392 method methods 246, 390 about 109 pick map fields 247, 391 arguments 109 read-only fields 247, 390 methods called by required fields 390 account 159, 299 status key 247, 391 accreditation 339 user key fields 248, 391 accreditation request 342 MergeRecords method activity 179, 302 call return value 109 allocation 378 message response object application 344 about 392 asset 187, 306 fields 392 book 189, 308 list of values 394 business plan 380 methods 392 campaign 192, 310 pick map fields 393 category 312 read-only fields 392 certification 346 required fields 392 certification request 348 status key 393 claim 425 user key fields 394 contact 201, 314 messaging plan item object contact best time 382 about 397 contact state license 384 fields 397 course 350 list of values 399 course enrollment 353 methods 397 coverage 427 pick map fields 398 current user 220 read-only fields 397 CustomObject1 222, 317 required fields 397 damage 429 status key 398 deal registration 355 user key fields 399 dealer 232, 457 messaging plan item relation object exam 357 about 399 exam registration 360 fields 400 financial account 431 financial account holder 433 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 527 Release 18)
- 528. Index ■ N financial account holding 435 required fields 402 financial plan 437 status key 402 financial product 439 user key fields 403 financial transaction 441 multiple contact roles child object 294 fund 362 multi-select picklists 27 group 320 household 235, 443 N insurance property 446 namespace, WSSE 18 inventory audit report 386 new features 13 inventory period 388 note child object involved party 448 about 482 lead 240, 322 fields 482 MDF request 364 read-only fields 482 MedEd 246, 390 required fields 482 message response 392 status key 482 messaging plan 395 user key fields 483 messaging plan item 397 note object messaging plan item relation 399 about 249, 324 modification tracking 402 fields 250, 325 note 249, 324 filterable fields 250 objective 403 methods 249, 324 opportunity 251, 326 read-only fields 250, 325 partner 366 required fields 250, 325 plan account 406 status key 250, 325 plan contact 408 user key fields 250, 325 plan opportunity 409 number and currency fields 28 policy 450 policy holder 452 portfolio 264, 454 O price list 369 object display names 507 price list line item 370 objective object product 268, 328 about 403 product category 271 fields 403 sample disclaimer 411 list of values 405 sample inventory 413 methods 403 sample lot 416 pick map fields 404 sample transaction 418 read-only fields 403 service request 273, 330 required fields 403 signature 420 status key 404 solution 278, 333 user key fields 405 SP request 372 objects SP request line item 375 filterable fields 158 territory 281, 334 modification key 157 transaction item 422 parent and child relationships, about 23 user 283, 337 pick maps 157 user group 285 status keys 157 vehicle 288, 459 user keys 156 modification key objects, exposed about 157 See parent objects; child objects modification tracking object opportunity child object about 401 about 483 fields 402 fields 483 methods 402 pick map 484 read-only fields 402 read-only fields 483 528 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 529. Index ■ P required fields 483 account 159, 298 status key 484 accreditation 339 user key fields 485 accreditation request 341 opportunity object activity 178, 301 about 251, 325 allocation 377 child components 251 application 343 fields 252, 326 asset 187, 305 list of value fields 263, 327 book 189, 308 methods 251, 326 business plan 379 pick map field 256, 327 campaign 192, 309 read-only fields 252, 326 category 312 required fields 252, 326 certification 346 status key 255, 326 certification request 348 user key fields 327 claim 424 opportunity team child object 294 contact 313 Oracle CRM On Demand Web Services contact best time 382 Oracle CRM On Demand parent and child contact object 201 record types 19 contact state license 384 pick maps 157 course 350 status keys 157 course enrollment 352 user keys 156 coverage 427 Oracle CRM On Demand Web Services Toolkit current user 220 about 16 damage 429 Oracle On Demand Web Services Toolkit deal registration 355 CRM On Demand Web Services 16 dealer 231, 456 outbound SSO 39 exam 357 exam registration 359 P financial account 431 PageLayoutFieldRead method financial account holder 433 arguments 140 financial account holding 435 call return value 140 financial plan 437 PageLayoutFieldReadAll method financial product 439 arguments 141 financial transaction 441 call return value 141 fund 362 PageLayoutFieldUpsert method group 320 arguments 142 household 235, 443 call return value 142 insurance property 446 PageLayoutRelatedInformationReadAll inventory audit report 386 method inventory period 388 arguments 142 involved party 448 call return value 142 lead 239, 322 PageLayoutRelatedInformationUpsert MDF request 364 method MedEd 246, 390 arguments 143 message response 392 call return value 144 messaging plan 394 parent and child objects messaging plan item 397 Insert method, effect on 67 messaging plan item relation 399 InsertOrUpdate method, effect on 69 modification tracking 401 relationships, about 23 note 249, 324 Update method, effect of 78 objective 403 parent and child record types opportunity 251, 325 about and list of 19 partner 366 parent objects plan account 405 plan contact 407 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 529 Release 18)
- 530. Index ■ P plan opportunity 409 contact child object 472 policy 450 contact CustomObject1 227, 318 policy holder 452 contact object 209, 315 portfolio 263, 454 contact state license object 385 price list 368 contact team child object 474 price list line item 370 course enrollment object 354 product 268, 328 course object 351 product category 270 coverage object 428 sample disclaimer 411 custom object child object 475 sample inventory 413 damage object 430 sample lot 415 deal registration object 356 sample transaction 417 dealer object 234, 458 service request 272, 330 exam object 358 signature 420 exam registration object 361 solution 277, 332 financial account holder object 434 SP request 372 financial account holding object 436 SP request line item 374 financial account object 432 territory 280, 334 financial plan object 438 transaction item 421 financial product object 440 user 282, 336 financial transaction object 442 user group 285 fund object 363 vehicle 287 group object 321 parent objects (Web Services v1.0) household object 238, 445 list of 158 insurance property object 447 partner object interests child object 478 about 366 inventory audit report object 387 fields 366 inventory period object 389 list of values 368 invitee child object 479 methods 366 involved party object 449 pick map fields 367 lead child object 481 read-only fields 366 lead object pick map fields 243, 323 status key 367 MDF request object 365 user key fields 368 MedEd object 247, 391 pick map message response object 393 account child object 463 messaging plan item object 398 account object 166, 300 messaging plan item relation object 400 accreditation object 340 messaging plan object 396 accreditation request object 343 objective object 404 activity child object 465 opportunity child object 484 activity object 183, 303 opportunity object 256, 327 address child object 467 Oracle CRM On Demand pick maps, allocation object 379 about 157 application object 345 partner object 367 asset child object 468 plan account object 407 asset object 188, 307 plan contact object 408 book child object 471 plan opportunity object 410 book object 191, 309 policy holder object 453 business plan object 381 policy object 451 campaign object 196, 311 portfolio object 266, 455 category object 313 price list line item object 371 certification object 347 price list object 369 certification request object 349 product category object 272 claim object 426 product object 269, 329 contact best time object 383 products detailed child object 486 530 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 531. Index ■ P promotional items dropped child object 487 about 452 related contact child object 489 fields 452 revenue child object 491 methods 452 sample disclaimer object 412 pick map fields 453 sample dropped child object 492 picklists 454 sample inventory object 414 read-only fields 452 sample lot object 417 status key 453 sample transaction object 419 user key fields 453 service request child object 494 policy object service request object 275, 331 about 450 signature object 421 fields 450 SP request line item object 376 methods 450 SP request object 373 pick map fields 451 transaction item object 423 picklists 451 user child object 496 read-only fields 450 user group object 286 status key 451 user object 282, 284, 335, 338 user key fields 451 vehicle object 289, 460 portfolio object PicklistRead method about 263, 454 arguments 144 child components 264 call return value 144 fields 264, 454 PicklistReadAll method filterable fields 266 arguments 145 list of values 267, 456 call return value 145 methods 264, 454 PicklistUpsert method pick map fields 266, 455 arguments 146 read-only fields 264, 454 call return value 146 status key 265, 455 plan account object user key fields 266, 455 about 405 portfolio team object fields 406 about 295 methods 406 price list line item object pick map fields 407 about 370 read-only fields 406, 410 fields 371 required fields 406 methods 370 status key 406 pick map field 371 user key fields 407 picklists 372 plan contact object read-only fields 371 about 407 required fields 371 fields 408 status key 371 methods 408 user keys 372 pick map fields 408 price list object read-only fields 408 about 368 required fields 408 fields 369 status key 408 methods 369 user key fields 409 pick map field 369 plan opportunity object picklists 370 about 409 read-only fields 369 fields 410 required fields 369 methods 409 status key 369 pick map fields 410 user keys 370 required fields 410 privileges 31 status key 410 privileges, Manage Access to Web user key fields 411 Services. 31 policy holder object product category object Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 531 Release 18)
- 532. Index ■ Q about 270 R fields 271, 312 read-only fields methods 271 account child object 463 pick map field 272 account object 160, 300 read-only fields 271 accreditation object 340 required fields 271 accreditation request object 342 status key 271 activity child object 464 user keys 272 activity object 180, 302 product detailed object 295 address child object 466 product object allocation object 378 about 268, 328 application object 344 fields 268, 328 asset child object 468 methods 268, 328 asset object 187, 306 pick map field 269, 329 attachment child object 469 picklists 269, 329 book child object 470 read-only fields 268, 328 book object 190, 308 required fields 268, 328 business plan object 380 status key 269, 329 campaign object 193, 310 user keys 269, 329 category object 312 products detailed child object certification object 346 about 485 certification request object 348 fields 485 claim object 425 pick map 486 contact best time object 382 read-only fields 485 contact child object 472 required fields 485 contact object 202, 314 status key 485 contact state license object 384 user key fields 486 contact team child object 473 promotional items dropped child object course enrollment object 353 about 486 course object 351 fields 486 coverage object 428 pick map 487 current user object 221 read-only fields 486 custom object child object 475 required fields 486 CustomObject1 object 223, 318 status key 487 damage object 430 user key fields 487 deal registration object 355 dealer object 232, 457 Q delegated user child object 476 QueryPage method exam object 358 arguments 77 exam registration object 360 best practices 57 financial account holder object 434 call return value 77 financial account holding object 436 Oracle CRM On Demand query syntax, financial account object 432 about 71 financial plan object 438 querying data using Web Services 72 financial product object 440 QueryPage method (Web Services v1.0) financial transaction object 442 about 69 fund object 362 QueryPage method (Web Services v2.0) group object 321 arguments 92 household object 236, 444 call return value 93 insurance property object 446 usage 85 interests child object 477 queued request limit (stateful) 511 inventory audit report object 386 queued request limit (stateless) 511 inventory period object 389 quota object 295 invitee child object 479 532 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 533. Index ■ R involved party object 448 recipient object 296 lead child object 480 record types lead object 241, 322 Oracle CRM On Demand parent and child MDF request object 364 record types 19 MedEd object 247, 390 related account object 296 message response object 392 related contact child object messaging plan item object 397 about 488 messaging plan item relation object 400 fields 489 messaging plan object 395 pick map 489 modification tracking object 402 picklists 490 note child object 482 read-only fields 489 note object 250, 325 required fields 489 objective object 403 status key 489 opportunity child object 483 user key fields 489 opportunity object 252, 326 related contact object 296 partner object 366 release, what’s new 13 plan account object 406, 410 reliability plan contact object 408 Web services reliability 19 policy holder object 452 request rate limit 512 policy object 450 request size limit 512 portfolio object 264, 454 required fields price list line item object 371 account child object 463 price list object 369 account object 160, 300 product category object 271 accreditation object 340 product object 268, 328 accreditation request object 342 products detailed child object 485 activity child object 464 promotional items dropped child object 486 activity object 180, 302 recipient child object 488 address child object 466 related contact child object 489 allocation object 378 revenue child object 490 application object 344 sample disclaimer object 412 asset child object 468 sample dropped child object 492 asset object 187, 306 sample inventory object 414 attachment child object 469 sample lot object 416 book child object 470 sample transaction object 418 book object 190, 308 service request child object 493 business plan object 380 service request object 273, 331 campaign object 193, 310 signature object 420 category object 312 solution object 278, 333 certification object 346 SP request line item object 375 certification request object 348 SP request object 373 contact best time object 382 territory object 281, 335 contact child object 472 transaction item object 422 contact object 202, 314 user child object 495 contact state license object 384 user group object 285 contact team child object 473 user object 283, 337 course enrollment object 353 vehicle object 288, 459 course object 351 recipient child object current user object 221 about 487 custom object child object 475 fields 488 CustomObject1 object 223, 318 read-only fields 488 deal registration object 355 required fields 488 dealer object 232, 457 status key 488 delegated user child object 476 user key fields 488 exam object 358 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 533 Release 18)
- 534. Index ■ S exam registration object 360 user group object 285 financial account holder object 434 user object 283, 337 financial account holding object 436 vehicle object 288, 459 financial account object 432 revenue child object financial plan object 438 about 490 financial product object 440 fields 490 financial transaction object 442 pick map 491 fund object 362 picklists 491 group object 321 read-only fields 490 household object 236, 444 required fields 490 interests child object 477 status key 490 inventory audit report object 386 user key fields 491 inventory period object 389 revenue object 296 invitee child object 479 RoleReadAll method lead child object 480 arguments 146 lead object 241, 322 call return value 146 MDF request object 364 RoleUpsert method MedEd object 390 arguments 148 message response object 392 call return value 148 messaging plan item object 397 messaging plan item relation object 400 S messaging plan object 395 SalesProcessQueryPage method modification tracking object 402 about 110 note child object 482 arguments 111 note object 250, 325 call return value 112 objective object 403 sample disclaimer object opportunity child object 483 about 411 opportunity object 252, 326 fields 412 plan account object 406 methods 411 plan contact object 408 pick map field 412 plan opportunity object 410 picklists 413 price list line item object 371 read-only fields 412 price list object 369 required fields 412 product category object 271 status key 412 product object 268, 328 user keys 412 products detailed child object 485 sample dropped child object promotional items dropped child object 486 about 492 recipient child object 488 fields 492 related contact child object 489 pick map 492 revenue child object 490 read-only fields 492 sample disclaimer object 412 required fields 492 sample dropped child object 492 status key 492 sample inventory object 414 user key fields 493 sample lot object 416 sample dropped object 297 sample transaction object 418 sample inventory object service request child object 493 about 413 service request object 273, 331 fields 414 signature object 420 methods 413 solution object 278, 333 pick map field 414 SP request line item object 375 read-only fields 414 SP request object 373 required fields 414 territory object 281, 335 status key 414 transaction item object 422 user keys 415 user child object 495 534 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 535. Index ■ S sample lot object required fields 273, 331 about 415 status key 274, 331 fields 416 user key fields 332 methods 416 session management 35, 55 pick map field 417 session management, client-side 37 read-only fields 416 session management, server-side 24, 36 required fields 416 session pooling 55 status key 416 session time-outs 55 user keys 417 SetPasswordAPI 112 sample transaction object SetSessionTimeZone method about 417 about 113 fields 418 call return value 114 methods 418 setting up, Web services 31 pick map field 419 setting up, Web services session picklists 419 establishing and managing 35 read-only fields 418 integration requests 40 required fields 418 limits 511 status key 418 logging in 38 user keys 419 logging off 40 security signature object Web services security 17 about 420 server-side session management 24, 36 fields 420 Service API calls 94 methods 420 DeletedItemQueryPage 95 pick map field 421 DeleteEvents 99 read-only fields 420 GetEvents 100 required fields 420 GetMapping 103 status key 420 GetPicklistValues 104 user keys 421 GetServerTime 105 Single Sign-On (SSO) LoginHistoryQueryPage 106 logging in using 39 MetadataChangeSummaryQueryPage 109 outbound SSO 39 SalesProcessQueryPage 110 solution object SetPasswordAPI 112 about 277, 332 SetSessionTimeZone 113 child components 277 UpdateCascadingPicklists 115 fields 278, 333 UpdatePicklist 114 filterable fields 279 UserUsageQueryPage 117 list of value fields 280, 334 service request child object methods 278, 333 about 493 read-only fields 278, 333 fields 493 required fields 278, 333 pick map 494 status key 279, 333 read-only fields 493 user key fields 334 required fields 493 SP request line item object status key 494 about 374 user key fields 495 fields 375 service request object methods 375 about 272, 330 pick map fields 376 child components 272 read-only fields 375 fields 273, 331 required fields 375 filterable fields 276 status key 375 methods 273, 330 user key fields 376 pick map 275, 331 SP request object picklists 277, 332 about 372 read-only fields 273, 331 fields 373 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 535 Release 18)
- 536. Index ■ S list of values 374 group object 321 methods 372 household object 237, 445 pick map fields 373 insurance property object 447 read-only fields 373 interests child object 478 required fields 373 inventory audit report object 387 status key 373 inventory period object 389 user key fields 374 invitee child object 479 stateful Web services 32, 38, 55 involved party object 449 stateless Web services 24, 32, 45 lead child object 481 status key lead object 242, 323 about 157 MDF request object 365 account child object 463 MedEd object 247, 391 account object 163, 300 message response object 393 accreditation object 340 messaging plan item object 398 accreditation request object 342 messaging plan item relation object 400 activity child object 465 messaging plan object 395 activity object 182, 303 modification tracking object 402 address child object 467 note child object 482 allocation object 378 note object 250, 325 application object 344 objective object 404 asset child object 468 opportunity child object 484 asset object 188, 306 opportunity object 255, 326 attachment child object 470 partner object 367 book child object 471 plan account object 406 book object 190, 309 plan contact object 408 business plan object 380 plan opportunity object 410 campaign object 195, 310 policy holder object 453 category object 312 policy object 451 certification object 347 portfolio object 265, 455 certification request object 349 price list line item object 371 claim object 425 price list object 369 contact best time object 383 product category object 271 contact child object 472 product object 269, 329 contact object 206, 315 products detailed child object 485 contact state license object 384 promotional items dropped child object 487 contact team child object 473 recipient child object 488 course enrollment object 353 related contact child object 489 course object 351 revenue child object 490 coverage object 428 sample disclaimer object 412 custom object child object 475 sample dropped child object 492 CustomObject1 object 225, 318 sample inventory object 414 damage object 430 sample lot object 416 deal registration object 356 sample transaction object 418 dealer object 233, 457 service request child object 494 delegated user child object 476 service request object 274, 331 exam object 358 signature object 420 exam registration object 360 solution object 279, 333 financial account holder object 434 SP request line item object 375 financial account holding object 436 SP request object 373 financial account object 432 territory object 281, 335 financial plan object 438 transaction item object 422 financial product object 440 user child object 496 financial transaction object 442 user group object 286 fund object 363 user object 284, 337 536 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)
- 537. Index ■ T vehicle object 289, 459 user key fields 496 sub book object 297 user group object about 285 T child components 285 team object 297 fields 285, 288, 321, 459 territory object filterable fields 287 about 280, 334 methods 285 fields 281, 335 pick map field 286 methods 281, 334 read-only fields 285 picklists 282, 336 required fields 285 read-only fields 281, 335 status key 286 required fields 281, 335 user key status key 281, 335 inventory period object 389 user key 336 MedEd object 391 time and date fields 27 message response object 394 transaction item object messaging plan item object 399 about 421 messaging plan item relation object 401 fields 422 messaging plan object 396 methods 422 modification tracking object 403 pick map field 423 objective object 405 read-only fields 422 plan account object 407 required fields 422 plan contact object 409 status key 422 plan opportunity object 411 user keys 423 user keys about 156 account object 301 U accreditation object 341 Update method accreditation request object 343 arguments 78 activity object 304 call return value 79 allocation object 379 parent and child objects, effect of 78 application object 345 Update method (Web Services v1.0) asset object 307 usage 78 book object 309 Update method (Web Services v2.0) business plan object 381 arguments 93 campaign object 311 call return value 94 category object 313 usage 93 certification object 347 UpdateCascadingPicklists method certification request object 349 arguments 116 claim object 426 call return value 117 contact best time object 383 UpdateChild method contact object 316 arguments 79 contact state license object 385 usage 79 course enrollment object 354 UpdatePicklist method course object 352 arguments 115 coverage object 428 call return value 115 CustomObejct1 object 320 URL parameterization 58 damage object 431 user child object deal registration object 356 about 495 dealer object 458 fields 495 exam object 359 pick map 496 exam registration object 361 read-only fields 495 financial account holder object 435 required fields 495 financial account holding object 437 status key 496 financial account object 433 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand 537 Release 18)
- 538. Index ■ V financial plan object 439 V financial product object 440 vehicle object financial transaction object 443 about 287 fund object 363 child components 287 group object 321 filterable fields 289 household object 445 methods 288, 459 insurance property object 447 pick map field 289, 460 inventory audit report object 387 picklists 290, 460 involved party object 449 read-only fields 288, 459 lead object 323 required fields 288, 459 MDF request object 365 status key 289, 459 note object 325 user key fields 460 opportunity object 327 ViewMode argument 81 partner object 368 policy holder object 453 policy object 451 W portfolio object 455 Web service request rate 511 price list line item object 372 Web service request size 512 price list object 370 Web service session inactivity time product category object 272 limit 512 product object 269, 329 Web services sample disclaimer object 412 core technologies 15 sample inventory object 415 custom fields 23 sample lot object 417 integration tag 23 sample transaction object 419 reliability 19 service request object 332 security 17 signature object 421 Web services privilege 31 solution object 334 Web services privilege, Manage Access to SP request line item object 376 Web Services 31 SP request object 374 Web services proxy classes 48 territory object 336 Web Services R16 Compatibility Mode transaction item object 423 setting 32 user object 284, 338 Web services session vehicle object 460 establishing and managing 35 user object integration requests 40 about 282, 336 logging in 38 fields 283, 337 logging off 40 methods 283, 337 maximum objects in Web Services pick map field 282, 284, 335, 338 request 512 read-only fields 283, 337 maximum records returned 512 required fields 283, 337 request rate limit 512 status key 284, 337 request size limit 512 user keys 284, 338 Web Services Toolkit UserNameToken profile 18 See Oracle CRM On Demand Web Services UserUsageQueryPage method Toolkit about 117 WSDL, generating company-specific 24 arguments 118 WS-I Basic Security Profile 17, 18 call return value 118 WSSE namespace 18, 32 538 Oracle Web Services On Demand Guide Version 6.0 (Oracle CRM On Demand Release 18)