About Using the Siebel REST API

Each topic in this chapter provides both JSON and XML examples that demonstrate how to use the Siebel REST API calls to interact with Siebel Server resources.

Note: In Siebel CRM 21.2 Update and later, any changes to repository objects (such as a business service, business component or an integration object), do not require a restart of the object manager component used by REST. These changes are available immediately in the REST APIs once the changed workspace is delivered or migrated.

The example REST API calls use the following format:

• An example request, with 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 payload for the Siebel REST API request.

• An example response, with 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 Siebel REST API response.

Note: Because of the length of REST responses, some REST responses have been omitted.