Using the Siebel REST API to Access Business Objects

You can use the Siebel REST API to access Siebel CRM Business Objects. Users can perform QUERY, INSERT, UPDATE, and DELETE operations on the Siebel Business Objects using REST API requests over HTTP as described in this section.

Note: When an incoming REST request sets a Siebel field of type DTYPE_BOOL, use “Y” for true and “N” for false. Do not pass JSON boolean literals such as true or false, or string values such as "true" or "false". Siebel boolean fields are stored in one-character columns, and longer values can cause an error such as “Value too long for field <field name>.”

This topic includes the following information:

• Querying for a Siebel CRM Business Component

• Querying for a Siebel CRM Business Component with a Search Specification

• Querying for a Siebel CRM Business Component Record to Return a Subset of Fields

• Querying a Root Business Component Using the recordcountneeded Parameter

• Querying A Root Business Component Using the recordneeded and Viewmode Parameters

• Querying Child Business Components Using the recordcountneeded Parameter

• Querying Grandchildren Business Components Using the recordcountneeded Parameter

• Querying for a Siebel CRM Business Component with a Sort Specification

• Inserting a Siebel CRM Business Component

• Inserting Multiple Siebel CRM Business Components

• Inserting Multiple Siebel CRM Business Components When a Record Already Exists

• Inserting a Siebel CRM Child Business Component

• Inserting Multiple Siebel CRM Child Business Components

• Upserting a Siebel CRM Business Component

• Upserting Multiple Siebel CRM Business Components

• Upserting a Siebel CRM Child Business Component

• Deleting a Siebel CRM Business Component

• Deleting Multiple Siebel CRM Business Components

• Deleting Multiple Siebel CRM Business Components When A Record is Already Deleted

• Delete Multiple Siebel CRM Business Components with Identifier in the URL and in the Request Body

• Querying for a Siebel CRM Business Component To Return a Subset of Child Links

• Querying for a Siebel CRM Business Component To Return Child Links for Multiple Child Business Components

• Querying for a Siebel CRM Child Business Component To Return Its Child Links

• Querying for a Siebel CRM Business Component by Specifying the ViewMode Parameter

• Querying for a Siebel CRM Business Component To Return No Child Links

• Querying a Siebel CRM Business Component Using the NewQuery Parameter

• Querying for a Siebel CRM Business Component To Return No Child Links

• Using the Describe Parameter to Return a REST Resource’s Metadata

• Using the Describe Parameter to Return the Siebel Base Business Object Catalog

• Using the Describe Parameter to Return Business Component Metadata

• Using the Describe Parameter to Return Child Business Component Metadata

• Using the Describe Parameter to Return OpenAPI Description of Multiple Object Operations

• Using the Uniformresponse Parameter

• Querying for All Contacts in an Account Without Using Uniformresponse to Return a Single Record

• Querying for All Contacts in an Account Using Uniformresponse to Return Multiple Records

• Querying for All Contacts in an Account Without Using Uniformresponse to Return Multiple Records

• Querying for a Single Account Record Without Using Uniformresponse

• Querying for a Single Account Record Using Uniformresponse

• Using the Developer Workspace Parameter to Preview Changes Without Compiling to the Repository

• Querying Records Using the ExecutionMode Parameter

• Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter