Oracle Web Services On Demand Guide
What's New in This Release
Back to top
Overview of Web Services On Demand
About Web Services
Web Services Core Technologies
Oracle CRM On Demand Web Services Toolkit
Oracle CRM On Demand Web Services and Integration with Oracle CRM On Demand
Web Services Security
Web Services Reliability
Web Services and the Oracle CRM On Demand Objects
Web Service APIs
About Parent-Child Relationships
Web Services On Demand and Custom Fields
Field Types Supported by Oracle CRM On Demand
Web Services v1.0
Web Services v2.0
Special Search Fields
Support for Multi-Select Picklists
Locale-Dependent Access to Oracle CRM On Demand
Validation of Email Fields
Mapping Primary Address Fields Using Web Services
Support for Web Link Fields
Support for Concatenated Fields
Support for Maskable Fields
Web Services Utilization
Web Service Client Name Identification
Supported Client Name Characters and Usage
Sending the Client Name in Stateless Web Services Requests
Sending the Client Name in Stateful Web Services
Web Services R16 Compatibility Mode
About Service Allotments
Determining Current Usage
Determining Historical Allotment Usage
When a Service Allotment Is Reached
Calculation of Allotment Usage
Back to top
Getting Started with Web Services
Accessing Data in Oracle CRM On Demand
Requesting Web Services Integration
Web Services Privileges
Enabling Stateless Web Services Support
Downloading WSDL Files and Schema Files
Downloading WSDL Files
Downloading Schema Files
Incorporating WSDL Files into the Development Environment
Back to top
Establishing and Managing the Web Services Session
About Establishing and Managing the Web Services Session
Oracle CRM On Demand Stateful and Stateless Request Support
Using Stateless Web Service Requests
Enabling Support for Stateless Requests
Oracle CRM On Demand Stateless Authentication Mechanisms
Stateless Server Affinity Support
Maintenance of a Stateless Java Session
Using Stateful Web Services Requests
Oracle CRM On Demand Stateful Authentication Mechanisms
Logout of the Web Services Session
Integration Requests for the Web Services Session
Comparison of Stateless Versus Stateful Web Services Transactions
Single Sign-On
Outbound SSO
SSO Token Validation
Inbound SSO
Back to top
Best Practices for Designing Client Application
Best Practices for Integration Design
Sending of Web Services Requests to Oracle CRM On Demand
Flushing of Caches
Using Stateless Web Services
Setting and Querying Blank Values
Working with Opportunity Product Revenue Records
Error Handling and Logging
Handling Outages and Failures
Understanding Web Services Transactions
Best Practices for Generating Web Services Proxy Classes in Java Environments
Avoiding Proxy Class Compilation Failure Due to the Java 64KB Limit
Entering Telephone Number Values through Web Services
Best Practices for Adhering to Web Service Allotments
Working with Record Ownership Modes
Best Practices for Integration Performance
Batch Processing
Session Management and Pooling
API Calls
Handling Bad Events in Integration Event Queues
Best Practices for Integration Management
Moving Customers Between Pods
Handling Outages
Maintaining SSL Certificates
Back to top
Web Services On Demand API Calls
Web Services On Demand API Calls
Considerations When Deleting Child Records
Web Services v1.0 API Calls
User Keys
The Echo Argument
Delete
DeleteChild
Insert
InsertChild
InsertOrUpdate
QueryPage
Update
UpdateChild
Web Services v2.0 API Calls
The Echo Argument
The ViewMode Argument
The LOVLanguageMode Argument
The Field-level Replace Operation
Delete
Execute
Insert
QueryPage
Update
Service API Calls
AuditTrailQueryPage
AuthAuthorizationUser
DeletedItemQueryPage
DeleteEvents
ExportWebServiceCreateExportRequest
ExportWebServiceMonitorExportRequest
ExportWebServiceRetrieveExportAttachment
GetEvents
GetLists
GetMapping
GetPicklistValues
GetServerTime
LeadConvert
LoginHistoryQueryPage
MergeRecords
MetadataChangeSummaryQueryPage
SalesProcessQueryPage
SetPassword
SetSessionTimeZone
UpdatePicklist
UpdateCascadingPicklists
UserUsageQueryPage
Administrative Services API Calls
Access to the Administrative Services APIs for Nonadministrative Users
Record Ownership Mode
AccessProfileRead
AccessProfileReadAll
AccessProfileUpsert
ActionBarCustomWebAppletRead
ActionBarCustomWebAppletReadAll
ActionBarCustomWebAppletUpsert
ActionBarLayoutReadAll
ActionBarLayoutUpsert
CascadingPicklistRead
CascadingPicklistReadAll
CascadingPicklistUpsert
ConcatenatedFieldRead
ConcatenatedFieldReadAll
ConcatenatedFieldUpsert
CurrencyRead
CurrencyReadAll
CurrencyUpsert
CurrentOrganizationRead
CustomHTMLHeadTagRead
CustomHTMLHeadTagUpsert
CustomRecordTypeRead
CustomRecordTypeReadAll
CustomRecordTypeUpsert
CustomWebLinkRead
CustomWebLinkReadAll
CustomWebLinkUpsert
CustomWebTabDelete
CustomWebTabRead
CustomWebTabReadAll
CustomWebTabUpsert
DetailPageCustomWebAppletRead
DetailPageCustomWebAppletReadAll
DetailPageCustomWebAppletUpsert
DynamicLayoutRead
DynamicLayoutReadAll
DynamicLayoutUpsert
FieldAuditSetupRead
FieldAuditSetupReadAll
FieldAuditSetupUpsert
FieldManagementCreate
FieldManagementRead
FieldManagementReadAll
FieldManagementUpsert
HomepageLayoutReadAll
HomepageLayoutUpsert
HomepageCustomWebAppletRead
HomepageCustomWebAppletReadAll
HomepageCustomWebAppletUpsert
HomeTabCustomWebAppletRead
HomeTabCustomWebAppletReadAll
HomeTabCustomWebAppletUpsert
IndustryRead
IndustryReadAll
PageLayoutFieldRead
PageLayoutFieldReadAll
PageLayoutFieldUpsert
PageLayoutRelatedInformationRead
PageLayoutRelatedInformationReadAll
PageLayoutRelatedInformationUpsert
PageLayoutSectionReadAll
PageLayoutSectionUpsert
PicklistRead
PicklistReadAll
PicklistUpsert
PicklistValueGroupRead
PicklistValueGroupReadAll
PicklistValueGroupUpsert
RelatedInformationLayoutRead
RelatedInformationLayoutReadAll
RelatedInformationLayoutUpsert
RoleRead
RoleReadAll
RoleUpsert
SalesAssessmentTemplateRead
SalesAssessmentTemplateReadAll
SalesAssessmentTemplateUpsert
SalesCategoryRead
SalesCategoryReadAll
SalesCategoryUpsert
SSOTokenRead
WorkflowActionSetRead
WorkflowActionSetReadForRuleSet
WorkflowActionSetUpsert
WorkflowActionSetInsertOrUpdate
WorkflowRuleSetDelete
WorkflowRuleSetRead
WorkflowRuleSetReadAll
WorkflowRuleSetUpsert
WorkflowRuleSetInsertOrUpdate
Data Loader API Calls
BulkOpImportCreateRequest
BulkOpImportSendData
BulkOpImportGetRequestDetail
Back to top
Oracle CRM On Demand Objects Accessible Through Web Services
Reference Information About the Parent Objects
Field Names in WSDL Files
Required and Read-Only Fields
Oracle CRM On Demand User Keys
Audit Fields
Oracle CRM On Demand Status Keys
Oracle CRM On Demand Pick Maps
Filterable Fields
Core Parent Objects (Web Services v1.0)
Account
Activity
Asset
Book
Campaign
Contact
Current User
CustomObject1 - CustomObject3
Lead
Note
Opportunity
Product
Product Category
Service Request
Solution
Territory
User
User Group
Life Sciences Edition Parent Objects (Web Services v1.0)
Event
Financial Services Edition Parent Objects (Web Services v1.0)
Household
Portfolio
Automotive Edition Parent Objects (Web Services v1.0)
Dealer
Vehicle
Child Objects (Web Services v1.0)
Address
Attachment
Audit Trail
BookUser
Competitor
DelegatedUser
HouseholdTeam
Interests
Invitee
Login History
Multiple Contact Roles
OpportunityTeam
PortfolioTeam
ProductsDetailed
PromotionalItemsDropped
Quota
Recipient
Related Account
Related Contact
Revenue
SampleDropped
Shared Address
SubBook
Team
Core Parent Objects (Web Services v2.0)
Account
Activity
Address
Address Location
Allotment Usage
Asset
Book
Campaign
Category
Contact
CustomObject
Division
Exchange Rate
Group
Lead
Modification Tracking
Note
Opportunity
Product
Service Allotment
Service Request
Social Media
Social Profile
Solution
Territory
User
Partner Relationship Management Edition Objects (Web Services v2.0)
Accreditation
Accreditation Request
Application
Certification
Certification Request
Course
Course Enrollment
Deal Registration
Exam
Exam Registration
Fund
MDF Request
Partner
Price List
Price List Line Item
Special Pricing Product
Special Pricing Request
Life Sciences Edition Parent Objects (Web Services v2.0)
Allocation
Blocked Product
Business Plan
Call Activity History
Call Product Detail
Contact Best Times
Contact State License
Event
HCP Contact Allocation
Inventory Audit Report
Inventory Period
Message Response
Messaging Plan
Messaging Plan Item
Messaging Plan Item Relation
Objective
Order
Order Item
Plan Account
Plan Contact
Plan Opportunity
Product Indication
Related Disclaimer
Sample Disclaimer
Sample Inventory
Sample Lot
Sample Request
Sample Request Item
Sample Transaction
Signature
Transaction Item
Financial Services Edition Parent Objects (Web Services v2.0)
Claim
Coverage
Damage
Financial Account
Financial Account Holder
Financial Account Holding
Financial Plan
Financial Product
Financial Transaction
Household
Insurance Property
Involved Party
Policy
Policy Holder
Portfolio
Automotive Edition Parent Objects (Web Services v2.0)
Dealer
Vehicle
Child Objects (Web Services v2.0)
Account
Account Contact
Account Opportunity
Activity
Address
Asset
Attachment
Attendee Call
Book
Book User
Campaign
Competitor
Contact
Contact Role
Custom Object 1 through 3
Custom Object 4 through 15
Custom Web Applet
Delegated User
Exchange Rate History
Image
Interests
Invitee
Lead
Note
Opportunity
Opportunity Child
Products Detailed
Promotional Items Dropped
Recipient
Related Contact
Revenue
Sales Assessment
Sales Assessment Value
Sample Dropped
Service Request
Shared Address
Subbook
Team
User
User Default Book Per Type
Back to top
Using Attachments with Web Services On Demand
About Attachments
About The Attachment Element
Specifying File Attachment Content
Attaching Binary Data
Attaching a Text File
Attaching a File to Multiple Records
Retrieving or Querying File Attachments
Specifying URL Attachments
Back to top
Mapping of Display Names to Service API Object Names
Mapping of Display Names
Back to top
Web Services On Demand Limiters
Web Services On Demand Limiters
Web Services Request Rate
Back to top
|