Oracle CRM On Demand REST API Developer's Guide > Overview of Using the Oracle CRM On Demand REST API >

About Oracle CRM On Demand REST API Requests and Responses


To use the Oracle CRM On Demand REST API to interact with Oracle CRM On Demand, you must send a request to the Oracle CRM On Demand Server.

A request can include the following information:

  • A request URL. For more information about the Oracle CRM On Demand REST API URL, see Oracle CRM On Demand REST API URL Format.
  • The object type of the Oracle CRM On Demand resource that you want to take action on. For more information about the supported Oracle CRM On Demand resources, see Oracle CRM On Demand REST API Supported Resources.
  • The HTTP method that you use to perform a REST API operation (create, retrieve, update, or delete) on the Oracle CRM On Demand Server. For more information about supported HTTP methods, see Supported HTTP Methods.
  • Header information to define the parameters of the interaction with the Oracle CRM On Demand Server and the information and format you want in the response. For more information about supported HTTP headers, see Supported HTTP and Oracle CRM On Demand Header Fields.
  • Optional query parameters to search for specific resources in a collection. For more information about querying a collection, see Querying a Collection Resource.
  • Optional sorting parameters to sort collection lists. For additional information about sorting, see Sorting Collection Resources.
  • Optional paging parameters to limit large collection resource lists. For additional information about paging, see Paging Collection Resources.

After the Oracle CRM On Demand Server processes the request, the server sends back a response. The response body contains the results of the REST API call and also additional metadata and information based on what was specified in the request.

The response can include the following information:

Oracle CRM On Demand REST API Developer's Guide, Release 32 Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.