Siebel REST API Guide > Overview of Using the Siebel REST API >

About Siebel CRM REST API Requests and Responses

A request can include the following information:

• A request URI. For more information about URI formats, see About Siebel CRM REST API URI Formats.
  • The request URI contains the base URI signifying what category of Siebel resources to invoke. Siebel resources include: Business Objects, Repository Objects, and Business Services.
  • The request URI contains the object type of the invoked Siebel CRM resource. For example, Account Business Component under Account Business Object. For more information about the supported Siebel CRM resources, About Siebel CRM REST API Supported Resources.
• The HTTP method that you use to perform a REST API operation (query, insert, upsert, or delete) on the Siebel CRM Server. For more information about supported HTTP methods, see About Supported HTTP Methods
• Header information to define the parameters of the interaction with the Siebel CRM Server and the information and format you want in the response. For more information about supported HTTP headers, see About Supported HTTP Header Fields.

After the Siebel CRM Server processes the request, the server sends back a response. The response body contains the results of the REST API call and also additional information based on what was specified in the request.

The response can include the following information:

• A HTTP status code that indicates whether the request was successful or failed. For more information about HTTP status codes, see About Standard HTTP Status Codes and Error Messages
• A list of Siebel proprietary field and value pairs.
• If the request failed, then the response body includes additional information about the error. For additional information about HTTP error status codes, see About Standard HTTP Status Codes and Error Messages.
• Hypertext links to Siebel CRM child resources, in the REST API response, such as links to Child Business Components in the case of the Data API. For more information about links, see About Siebel CRM REST API Response Links.