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


REST stands for Representational State Transfer and is an architectural style that makes use of existing technology and protocols of the Web, such as HTTP and JSON. A REST API allows you to send data requests and receive responses over an HTTP interface. REST requests and responses include a header and a body. The header defines the operating parameters of the interaction and contains metadata, such as HTTP methods or encoding information. The body contains data that you want to transmit over the network. The body header contains instructions on how to use the transmitted data. The body can also remain empty.

An important concept of REST is the existence of resources, which are sources of specific information. Each resource is referenced with a global identifier, a URL in HTTP. To manipulate these resources, clients and servers communicate through an HTTP interface and exchange abstractions of these resources, such as a record or a list of records.

The Oracle CRM On Demand REST API exposes Oracle CRM On Demand records (resources), allowing you to integrate with Oracle CRM On Demand by using the GET, POST, PATCH, and DELETE HTTP methods to take actions on the Oracle CRM On Demand Server.

For example, you can do the following:

  • Use the POST HTTP method to create a new Oracle CRM On Demand resource.
  • Use the GET HTTP method to retrieve information about an Oracle CRM On Demand resource.
  • Use the PATCH HTTP method to update an Oracle CRM On Demand resource.
  • Use the DELETE HTTP method to delete an Oracle CRM On Demand resource.
  • Perform a query or search on Oracle CRM On Demand collection resources.

Use the Oracle CRM On Demand REST API for interactive operations with Oracle CRM On Demand. For Oracle CRM On Demand bulk operations, use Web services. For more information about Oracle CRM On Demand Web services, see Oracle Web Services On Demand Guide.

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