Siebel REST API Guide > Using the Siebel REST API >

About Using the Siebel REST API

Each topic in this chapter provides examples demonstrating how to use the Siebel REST API calls to interact with Siebel Server resources.

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

• An example request, which includes the following information:
  • URI. The location of the Siebel REST API resource on the Siebel Server. For more information about Siebel REST API URL format, see About Siebel CRM REST API URI Formats.
  • HTTP Method. The HTTP method used to call the Siebel REST API to interact with the Siebel Server. For more information about supported HTTP Methods, About Supported HTTP Methods.
  • Content-Type. The part of the HTTP header that indicates the media type of the data that is sent by the Siebel REST API HTTP methods. For more information about supported HTTP headers, see About Supported HTTP Header Fields.
  • Request Body. The code example for the Siebel 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, About Standard HTTP Status Codes and Error Messages.
  • Content-Type. The part of the HTTP header that indicates the media type of the data that is returned by the Siebel REST API HTTP methods. For more information about supported HTTP headers, see About Supported HTTP Header Fields.
  • Response Body. The code example for the Siebel REST API response.