1. REST API Guide
  2. About Siebel CRM REST API

About Siebel CRM REST API

REST (Representational State Transfer) is a software architecture style that provides a convenient and consistent approach to requesting and modifying data. In the Siebel CRM REST system, resources are stored on the Siebel Server; a client sends a request using a HTTP verb (such as GET, POST, PUT, or DELETE) so that the Siebel Server performs a particular action (such as querying, inserting, upserting, or deleting a Siebel CRM resource), and the Siebel Server performs the action and sends a response.

REST API requests are used for migration resource discovery and for migrating data from the source environment by exporting the data, transferring the data to the target environment, and importing the data into the target environment. For information about migration resource discovery, see Siebel Database Upgrade Guide.

Siebel Approval Manager (SAM) has a plug-n-play architecture using REST APIs. REST APIs are used to feed data from external systems into SAM as well as write data back to those external systems. For more information, see Siebel Approval Manager Guide.

The Siebel REST API is provided with the Siebel Application Interface installation. For more information about installing Siebel Application Interface, see Siebel Installation Guide. The Siebel REST API is enabled by configuring and deploying a Siebel Application Interface profile. The Siebel Application Interface profile can be deployed to multiple Siebel Application Interface nodes.

The Siebel REST API exposes Siebel Business Objects, Siebel Business Services, and Siebel Repository Objects. For more information about Siebel Business Objects, Siebel Business Services, and Siebel Repository Objects, see Configuring Siebel Business Applications.

The following aspects of Siebel REST API are aligned with general best practices of REST APIs:

  • A base URI to access Siebel Server resources, for example:
    http://Server Name:port/Siebel/v1.0/

  • Support for JSON resource representations.

  • Support for XML resource representations.

  • Operations on Siebel CRM resources are mapped to semantically similar HTTP methods, such as GET, PUT, POST, and DELETE.

  • Hypertext links to Siebel CRM Child Business Components in the case of the Data API resources in the REST API response.

  • Support for Outbound to interact with other Cloud applications that communicate through REST.