Siebel REST API Guide


What's New in This Release


Back to top


Overview of Using the Siebel REST API

About Siebel CRM REST API

About Siebel CRM REST API Architecture

About Siebel CRM REST API Requests and Responses

About Siebel CRM REST API URI Formats

About URI Parameters

About Siebel CRM REST API Supported Resources

About Supported HTTP Methods

About Supported HTTP Header Fields

About Standard HTTP Status Codes and Error Messages

About Siebel CRM REST API Response Links

About User Authentication

About Configuring OAuth 2.0 for Authentication

About REST Outbound

About Getting the Siebel REST API Specification in the OpenAPI 2.0 Standard Using Describe

About Access Controls for Siebel Business Component REST Requests


Back to top


Getting Started with the Siebel REST API

About Setting Up the Siebel CRM REST API

Using Siebel Management Console to Configure a Siebel Application Interface Profile

Configuring the worker.properties File for Load Balancing

Configuring Business Service Methods for RESTful Access

Configuring Integration Objects for REST API Data Access

Creating an Outbound Web Service Based on an OpenAPI Compliant JSON File


Back to top


Using the Siebel REST API

About Using the Siebel REST API

Using Siebel REST API to Access Siebel Repository Resources JSON Examples

Querying for a Siebel CRM Repository Resource

Querying for a Siebel CRM Repository Resource with a Search Specification

Querying for a Siebel CRM Repository Resource with a Returned Field List

Querying for a Siebel CRM Repository Resource That Returns Child Links Only for Lists

Querying for a Siebel CRM Repository Resource That Returns Child Links Only for Lists and Charts

Querying for a Siebel CRM Repository Resource That Does Not Return Any Child Links

Querying for a Siebel CRM Repository Resource with Access Controls

Inserting a Siebel CRM Repository Resource

Upserting a Siebel CRM Repository Resource

Deleting a Siebel CRM Repository Resource

Using the Describe Parameter to Return Top-Level Repository Objects

Using Describe to Return Metadata for a Repository Object and Children Catalog URLs

Using Describe to Return Metadata for Child Repository Objects and Catalog URLs for Grand Child Repository Objects

Using Siebel REST API to Access Siebel Business Objects JSON Examples

Querying for a Siebel CRM Business Object

Querying for a Siebel CRM Business Object with a Search Specification

Querying for a Siebel CRM Business Object with a Returned Fields List

Inserting a Siebel CRM Business Object

Inserting a Siebel CRM Child Business Object

Inserting Multiple Siebel CRM Child Business Objects

Upserting a Siebel CRM Business Object

Upserting a Siebel CRM Child Business Object

Deleting a Siebel CRM Business Object

Querying for a Siebel CRM Business Object That Returns Specified Child Links

Querying for a Siebel CRM Business Object That Returns Child Links to CUT

Querying for a Siebel CRM Business Object That Returns Child Links Only for Lists

Querying for a Siebel CRM Business Object with Access Controls

Querying for a Siebel CRM Business Object That Does Not Return Child Links

Using Describe to Return the Siebel Base Business Object Catalog

Using the Describe Parameter to Return the Business Object Catalog of a Parent Business Component

Using the Describe Parameter to Return Metadata for a Parent Business Component and Catalog of Child Business Components

Using Siebel REST API to Access Siebel Business Services JSON Examples

Accessing a Siebel Business Service with Arguments in the Request Body

Acessing a Siebel Business Service with Arguments in the Request URI

Accessing the QueryByExample Method of the Siebel Account Business Service

Querying for an Account Using the Siebel Business Service QueryId Method

Inserting an Account Using the Siebel Account Business Service

Updating an Account Using a Siebel Account Business Service

Upserting an Account Using a Siebel Account Business Service

Using Describe to Return Methods for a Business Service

Using Describe to Return a Catalog of URLs for All Available Business Services

Using Siebel REST API to Access Siebel Repository Data XML Examples

Querying for a Siebel CRM Repository Resource

Querying for a Siebel CRM Repository Resource with a Search Specification

Querying for a Siebel CRM Repository Resource that Returns Fields List

Inserting a Siebel CRM Repository Resource

Upserting a Siebel CRM Repository Resource

Deleting a Siebel CRM Repository Resource

Querying for a Siebel CRM Repository Resource That Returns Child Links Only for Lists

Querying for a Siebel CRM Repository Resource That Returns Only List and Chart Child Links

Querying for a Siebel CRM Repository Resource That Does Not Return Child Links

Querying for a Siebel CRM Repository Resource with Access Controls

Using Siebel REST API to Access Siebel CRM Business Objects XML Examples

Querying for a Siebel CRM Business Object

Querying for a Siebel CRM Business Object with a Search Specification

Querying for a Siebel CRM Business Object Resource that Returns Fields List

Inserting a Siebel CRM Parent Business Object

Upserting a Siebel CRM Parent Business Object

Deleting a Siebel CRM Parent Business Object

Querying for a Siebel CRM Business Object Resource that Returns UT Account Partner Child Links

Querying for a Siebel CRM Business Object That Returns Child Links to CUT

Querying for a Siebel CRM Business Object Resource That Returns List Management List Child Links

Querying for a Siebel CRM Business Object Resource That Does Not Return Child Links

Querying for a Siebel CRM Business Object Resource with Access Controls

Using Siebel REST API to Access Siebel Business Services XML Examples

Using a Siebel CRM Business Service to Insert an Account

Using a Siebel CRM Business Service to Update an Account

Using a Siebel CRM Business Service to Delete an Account

Using a Siebel CRM Business Service to Query for an Account

Accessing the QueryByExample Method of the Siebel Account Business Service

Using a Siebel CRM Business Service to Insert an Account


Back to top


Using Siebel REST API For Siebel Clinical

Configuring Siebel Clinical Users

Using the Siebel REST API with Siebel Clinical

Creating a Siebel Clinical User

Synchronizing a Siebel Clinical User

Deleting a Siebel Clinical User

Back to top

Siebel REST API Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.