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

About Using the Oracle CRM On Demand REST API with Oracle CRM On Demand

Each topic in this chapter provides examples demonstrating how to use the Oracle CRM On Demand REST API calls to interact with Oracle CRM On Demand resources. For more information about supported Oracle CRM On Demand resources, see Oracle CRM On Demand REST API Supported Resources.

Top-level and child Oracle CRM On Demand resources include fields. Field names used in the fields URL parameter, request, or response body are Web service integration tags. For more information regarding supported fields and Web service integration tags, please refer to the Oracle Web Services On Demand Guide.

Each REST API call in this chapter uses the following format:

• An example request, which includes the following information:
  • URL. The location of the Oracle CRM On Demand REST API resource on the Oracle CRM On Demand Server. For more information about the Oracle CRM On Demand REST API URL format, see Oracle CRM On Demand REST API URL Format.
  • HTTP Method. The HTTP method used to call the Oracle CRM On Demand REST API to interact with the Oracle CRM On Demand Server. For more information about supported HTTP Methods, see Supported HTTP Methods.
  • Content-Type. The part of the HTTP header that indicates the media type of the data that is sent by the Oracle CRM On Demand REST API HTTP methods. For more information about supported HTTP headers, see Supported HTTP and Oracle CRM On Demand Header Fields.
  • Request Body. The code example for the Oracle CRM On Demand REST API request.
• An example response, which includes the following information:
  • HTTP Code. The HTTP status code returned to indicate whether the request was successful or if there was an error. For more information about supported HTTP codes, see Standard HTTP Status Codes. For information about error formats, see Error Response Format.
  • Content-Type. The part of the HTTP header that indicates the media type of the data that is returned by the Oracle CRM On Demand REST API HTTP methods. For more information about supported HTTP headers, see Supported HTTP and Oracle CRM On Demand Header Fields.
  • Location. The header that indicates the location of a new resource created on the Oracle CRM On Demand Server.
  • Response Body. The code example for the Oracle CRM On Demand REST API response.