Contents

• Title and Copyright Information
• Preface
• 1 What's New in This Release
  • What’s New in Siebel REST API Guide, Siebel CRM 19.11 Update
  • What’s New in Siebel REST API Guide, Siebel CRM 19.3 Update
  • What’s New in Siebel REST API Guide, Siebel CRM 19.1 Update
  • What’s New in Siebel REST API Guide, Siebel CRM 18.12 Update
  • What’s New in, Siebel CRM 18.7 Update
• 2 Overview of Using the Siebel REST API
  • 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 Siebel CRM REST API Unsupported 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
    • Client Credentials Grant Authentication Flow
    • Web Server Authentication Flow
  • 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
• 3 Getting Started with the Siebel REST API
  • 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 REST Inbound Authentication Parameters
    • Configuring REST Inbound Default Parameters
    • Configuring REST Resource Parameters
  • 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
  • Re-importing an Open API Compliant JSON File to Recreate an Outbound Web Service
• 4 Using the Siebel REST API
  • 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 to Return a Subset of Fields
    • Querying for a Siebel CRM Repository Resource To Return Only One Child Link
    • Querying for a Siebel CRM Repository Resource That Returns a Subset of Child Links
    • Querying for a Siebel CRM Repository Resource to Return No Child Links
    • Querying for a Siebel CRM Repository Resource Using the ViewMode Access Control Parameter
    • Inserting a Siebel CRM Repository Resource
    • Upserting a Siebel CRM Repository Resource
    • Deleting a Siebel CRM Repository Resource
    • Using the Describe Parameter to Return a Catalog of Repository Objects
    • Querying for Repository Resource Metadata
    • Querying for Child Repository Object MetaData
  • Using Siebel REST API to Access Siebel Business Objects JSON Examples
    • 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
    • Inserting a Siebel CRM Business Component
    • Inserting a Siebel CRM Child Business Component
    • Inserting Multiple Siebel CRM Child Business Components
    • Upserting a Siebel CRM Business Component
    • Upserting a Siebel CRM Child Business Component
    • Deleting a Siebel CRM Business Component
    • 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
    • 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 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
  • Using Siebel REST API to Access Siebel Business Services JSON Examples
    • Accessing a Siebel Business Service with Arguments in the Request Body
    • Accessing 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 QueryById 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 the Describe Parameter to Return Methods of a Business Service
    • Using the Describe Parameter to Return a Catalog of Paths 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 Object to Return a Subset of Fields
    • 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 To Return Only One Child Link
    • Querying for a Siebel CRM Repository Resource To Return Subset of Child Links
    • Querying for a Siebel CRM Repository Resource To Return No Child Links
    • Querying for Siebel CRM Repository Resources by Using the ViewMode Access Control Parameter
  • Using Siebel REST API to Access Siebel CRM Business Objects XML Examples
    • 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 Specific Subset of Fields
    • Inserting a Siebel CRM Parent Business Component
    • Upserting a Siebel CRM Parent Business Component
    • Deleting a Siebel CRM Parent Business Component
    • 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 To Return No Child Links
    • Querying for a Siebel CRM Business Component by Using the ViewMode Access Control Parameter
    • 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 an Account
    • Accessing the QueryByExample Method of the Siebel Account Business Service
• 5 Using Siebel REST API For Siebel Clinical
  • 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