Contents

• Title and Copyright Information
• Preface

1 What’s New in This Release

• What’s New in Oracle CRM On Demand REST API Developer’s Guide, Release 45

2 Overview of Using the Oracle CRM On Demand REST API

• Overview of Using the Oracle CRM On Demand REST API
• About Oracle CRM On Demand REST API
• About Oracle CRM On Demand REST API Requests and Responses
• Oracle CRM On Demand REST API URL Format
• Oracle CRM On Demand REST API Supported Resources
  • About Working with Oracle CRM On Demand Resources
  • Supported Core Oracle CRM On Demand Resources
  • Supported Partner Relation Management Edition Resources
  • Supported Life Sciences Edition Resources
  • Supported Financial Services Edition Resources
  • Supported Automotive Edition Resources
• Supported HTTP Methods
• Supported HTTP and Oracle CRM On Demand Header Fields
• Oracle CRM On Demand REST API Formats
  • Language Format
  • Supported Languages
  • Date and Time Formats
  • Currency Formats
  • Number Formats
• REST API Request Rate Limits
• Error Response Format
• Standard HTTP Status Codes
• Oracle CRM On Demand REST API Response Links
  • Example of a Response Link for Self, Canonical, Parent, and Child Links
  • Example of an Association Response Link

3 Getting Started with the Oracle CRM On Demand REST API

• Getting Started with the Oracle CRM On Demand REST API
• Oracle CRM On Demand REST API Privilege Required
• About Oracle CRM On Demand REST API Authentication
  • Login with Oracle CRM On Demand REST API
  • REST API Connection Attributes
    • REST API Connection Attributes Example
  • Logoff with Oracle CRM On Demand REST API
  • Using SSO with the Oracle CRM On Demand REST API
• About Customizing REST Integration Tags
• Customizing REST API Integration Tags
• Using JavaScript to Send REST API Requests

4 Using the Oracle CRM On Demand REST API

• Using the Oracle CRM On Demand REST API
• About Using the Oracle CRM On Demand REST API with Oracle CRM On Demand
• Getting a List of Available Oracle CRM On Demand Versions
  • Version Attributes
  • Getting A Specific Oracle CRM On Demand Version Description
  • Getting a List of All Oracle CRM On Demand Versions
• Creating Oracle CRM On Demand Resources
  • Creating Oracle CRM On Demand Top-Level Resources
  • Creating Oracle CRM On Demand Child Resources
• Retrieving Oracle CRM On Demand Resources
  • Retrieving Oracle CRM On Demand Top-Level Resources
  • Retrieving Oracle CRM On Demand Child Resources
• Updating Oracle CRM On Demand Resources
  • Updating Oracle CRM On Demand Top-Level Resources
  • Updating Oracle CRM On Demand Child Resources
• Deleting Oracle CRM On Demand Resources
  • Deleting Oracle CRM On Demand Top-Level Resources
  • Deleting Oracle CRM On Demand Child Resources
• About Collection Resources
• Retrieving Oracle CRM On Demand REST API Collection Lists
  • Retrieving a Collection Top-Level Resource List
  • Retrieving a Collection Child Resource List
• Using the Finder Parameter for Predefined Queries and Customized Lists
• Querying a Collection Resource
  • Supported Query Operators
  • Supported Query Characters
    • Special Search Fields
    • LOVLanguageMode Querying
  • Sample Query Request and Response
  • REST API Query Expression Parser Errors
• Sorting Collection Resources
• Paging Collection Resources
• Retrieving Metadata about Oracle CRM On Demand Resources
  • Describe Fields Parameters
  • Describe Field Attributes
  • Describe Examples
    • Retrieving Metadata for All Oracle CRM On Demand Resources
    • Retrieving Metadata for a Specific Oracle CRM On Demand Resource
    • Retrieving Metadata for an Oracle CRM On Demand Collection
    • Retrieving Metadata for an Oracle CRM On Demand Child Resource
• Retrieving Only Resource Field Values Using the onlyData Parameter
• Working with Resource Attachments
  • Adding or Updating an Attachment
  • Retrieving Attachments
  • Removing Attachments
• Converting Oracle CRM On Demand Leads
• Associating Books to REST API Resources
• Associating Teams to REST API Resources
• Associating Accounts to Contacts Resources
• Associating Contacts to Accounts and Opportunities Resources
• Working with Account Contact Role Resources
  • Creating an Account Contact Role
  • Retrieving an Account Contact Role List
  • Updating an Account Contact Role
  • Deleting an Account Contact Role