PreviousNext JavaScript must be enabled to correctly display this content
  • Title and Copyright Information
  • Preface
  • 1 What's New in This Release
    • What's New in Siebel REST API Guide, Siebel CRM 25.3 Update
    • What's New in Siebel REST API Guide, Siebel CRM 24.12 Update
    • What's New in Siebel REST API Guide, Siebel CRM 24.1 Update
    • What's New in Siebel REST API Guide, Siebel CRM 23.7 Update
    • What's New in Siebel REST API Guide, Siebel CRM 23.5 Update
    • What's New in Siebel REST API Guide, Siebel CRM 23.3 Update
    • What's New in Siebel REST API Guide, Siebel CRM 23.1 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.12 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.11 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.10 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.9 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.8 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.7 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.5 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.4 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.3 Update
    • What's New in Siebel REST API Guide, Siebel CRM 22.2 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.12 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.9 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.7 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.6 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.4 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.3 Update
    • What's New in Siebel REST API Guide, Siebel CRM 21.2 Update
  • 2 Overview of Using the Siebel REST API
    • Overview of Using the Siebel REST API
    • About Siebel CRM REST API
    • About REST Response Base URIs
    • 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 Getting the Siebel REST API Specification in the OpenAPI 2.0 Standard Using Describe
    • About Getting the Siebel REST API Specification in the OpenAPI 3.0 Standard Using Describe
    • About Access Controls for Siebel Business Component REST Requests
    • About Importing Lists Of Values (LOVs) Using REST API
  • 3 Getting Started with the Siebel REST API
    • Getting Started with the Siebel REST API
    • About Setting Up the Siebel CRM REST API
    • Configuring Preprocessing and Postprocessing Steps in Inbound 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
  • 4 Accessing Repository Resources
    • Using the Siebel REST API to Access Repository Resources
    • 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
      • Querying an Applet Using the recordcountneeded Parameter
      • Querying for Controls in an Applet Using the recordcountneeded Parameter
      • Querying for a Control's User Properties in an Applet Using the recordcountneeded Parameter
      • Querying for a Siebel CRM Repository Resource with a Sort Specification
      • Using the PageSize Parameter for Parent/Child/Grandchild Records
      • 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
      • Querying Records Using the ExecutionMode Parameter
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
    • 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
      • Querying Records Using the ExecutionMode Parameter
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
  • 5 Accessing Business Objects
    • Using the Siebel REST API to Access Business Objects
    • Configuring Integration Objects for REST API Data Access
    • Supporting RESTful Access to Siebel Business Objects Dynamically
    • About Using the Siebel REST API
    • 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
      • 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 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
      • 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
    • 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
      • Querying Records Using the ExecutionMode Parameter
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
    • Using Siebel REST API to Perform CRUD Operations on Hierarchies of Siebel Object Records
      • Fetching a Complete Hierarchy (Parent, Child, Grandchild)
      • Inserting a Hierarchy
      • Multi Insert for Hierarchy
      • Updating a Hierarchy
      • Multi Update for Hierarchy
      • Querying for a Specific Child
  • 6 Accessing Business Services
    • Using the Siebel REST API to Access Business Services
    • Configuring Business Service Methods for REST Access
    • About Using the Siebel REST API
    • 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
      • Accessing a Siebel Business Service with the matchrequestformat Parameter
      • 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 the Describe Parameter to Return the OpenAPI Specification of a Business Service Method
      • Using the Developer Workspace Parameter to Preview Changes to a Business Service Without Compiling to the Repository
      • Using the Describe Workspace Parameter to Preview the Modified OpenAPI Specification of a Business Service Method Without Compiling to the Repository
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse 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 Delete an Account
      • Using a Siebel CRM Business Service to Query an Account
      • Accessing the QueryByExample Method of the Siebel Account Business Service
      • Using a Siebel CRM Business Service to Update an Account
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
  • 7 Accessing Workflows
    • Using the Siebel REST API to Access Workflows
    • Configuring Siebel Workflows
    • About Using the Siebel REST API
    • Using Siebel REST API to Access Workflows JSON Examples
      • Cataloging API
      • Workflow API Description in OpenAPI Format
      • Workflow Invocation as REST API
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
    • Using Siebel REST API to Access Workflows XML Example
      • Workflow Invocation as REST API
      • Removing Empty Fields Using the ExcludeEmptyFieldsInResponse Parameter
  • 8 Accessing Attachments
    • Using the Siebel REST API to Access Attachments
    • About Using the Siebel REST API
    • Using Siebel REST API to Access Attachments JSON Examples
      • Querying the Details of an Attachment
      • Querying an Attachment to Return Attachment Contents
      • Querying an Attachment to Return Contents as a File
      • Querying a Child Level Attachment
      • Querying a Child Attachment to Return Attachment Contents
      • Querying Multiple or All Attachments in an Account
      • Querying Multiple Attachments to Return Content
      • Inserting a Parent Level Attachment
      • Updating a Single Record with Multiple Attachments
      • Deleting a Single Attachment in an Account
      • Inserting Multiple Parent Level Attachments
      • Updating a Single Account by Adding One Attachment
      • Updating a Multiple Accounts by Adding One Attachment to Each Account
      • Updating a Multiple Accounts by Adding Multiple Attachments to Each Account
      • Inserting an Attachment into a Child Account Quote
      • Deleting Multiple Attachments on a Single Record
      • Deleting a Single Attachment from Multiple Records
      • Deleting Multiple Attachments from Multiple Records
      • Deleting Multiple Attachments from a Child Record
    • Using Siebel REST API to Access Attachments XML Examples
      • Querying the Details of a Top Level Attachment
      • Querying an Attachment to Return Attachment Contents
      • Querying a Child Level Attachment
      • Querying a Child Attachment to Return Attachment Contents
      • Querying an Attachment to Return Contents as a File
      • Inserting a Top-Level Attachment
      • Inserting an Attachment into a Child Record
      • Deleting an Attachment from an Account
    • Using Siebel REST API Business Services to Access Attachments JSON Examples
      • Invoking a Business Service to Insert an Attachment
      • Invoking a Business Service to Retrieve Attachment Contents
    • Using Siebel REST API Business Services to Access Attachments XML Examples
      • Invoking a Business Service to Insert an Attachment
      • Invoking a Business Service to Retrieve Attachment Contents
  • 9 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
      • Inserting SVT from External Application to Siebel Clinical
      • Querying Sites in Siebel Clinical
      • Querying Item Library in Siebel Clinical
      • Upserting Source Data Verification in Siebel Clinical
      • Marking Visits as Planned or UnPlanned
      • Using Inbound Subject API in Siebel Clinical
  • 10 Using Siebel REST API For Siebel Telco
    • Using Siebel REST API For Siebel Telco
    • Configuring Siebel Telco Business Services
    • Using Siebel REST API with Siebel Telco
      • Applying a Promotion to a Quote or an Order
      • Adding an Item to a Promotion
      • Replacing an Item in a Promotion
      • Deleting an Item in a Promotion
      • Disconnecting a Promotion
      • Resuming a Promotion
      • Suspending a Promotion
      • Modifying a Promotion
      • Returning a List of Upgrade or Downgrade Paths for a Promotion
      • Upgrading or Downgrading a Promotion
      • Returning a Promotion Definition
      • Returning a List of Eligible Products in a Promotion
      • Refreshing the Cache
      • Performing a Paginated Product Search
      • Performing an Order Checkout
  • 11 Using Siebel REST API For Siebel Product Administration
    • Using Siebel REST API For Siebel Product Administration
    • Configuring Siebel Product Administration Business Services
    • Resetting State Attributes in Product Administration
    • Using Siebel REST API with Product Administration
      • SWI Catalog Admin
        • SWI Catalog Admin Operations
        • Swagger Definitions for SWI Catalog Admin
      • SWI Product
        • SWI Product Operations
        • Swagger Definitions for SWI Product
      • SWI Product Class
        • SWI Product Class Operations
        • Swagger Definitions for SWI Product Class
      • SWI Product Attribute
        • SWI Product Attribute Operations
        • Swagger Definitions for SWI Product Attribute
      • SWI Attribute Import
        • SWI Attribute Import Operations
        • Swagger Definitions for SWI Attribute Import
      • SWI Product Class Import
        • SWI Product Class Import Operations
        • Swagger Definitions for SWI Product Class Import
      • SWI Product Import
        • SWI Product Import Operations
        • Swagger Definitions for SWI Product Import
      • SWI Smart Part Number
        • SWI Smart Part Number Operations
        • Swagger Definitions for SWI Smart Part Number
      • SWI Price List Item
        • SWI Price List Item Operations
        • Swagger Definitions for SWI Price List Item
      • SWI Product Line
        • SWI Product Line Operations
        • Swagger Definitions for SWI Product Line
      • SWI Eligibility Compatibility Matrix
        • SWI Eligibility Compatibility Matrix Operations
        • Swagger Definitions for SWI Eligibility Compatibility Matrix
      • SWI Product Base
        • SWI Product Base Operations
        • Swagger Definitions for SWI Product Base
      • SWI Promotion Import
        • SWI Promotion Import Operations
        • Swagger Definitions for SWI Promotion Import
      • SWI Cfg Object Broker
        • SWI Cfg Object Broker Operations
        • Swagger Definitions for SWI Cfg Object Broker
      • Literature Web Service
        • Literature Web Service Operations
        • Swagger Definitions for Literature Web Service
      • Returning a Promotion Definition by ID
      • Returning a Promotion Definition by Name
      • ISS Promotion Definition Loader QP
        • ISS Promotion Definition Loader QP
        • Swagger Definitions for ISS Promotion Definition Loader QP
  • 12 Purging Old Versions Of Product, Class, and Attribute
    • Purging Old Versions of Product, Class, and Attribute
    • Query Versions of Product, Class, and Attribute
    • Removing Old Versions Of Product, Class, and Attribute
  • 13 Using Siebel REST API for Pricing Administration
    • Using Siebel REST API For Siebel Pricing Administration
    • Overview of Siebel REST APIs in Pricing Administration
  • 14 Using Siebel REST API For Siebel Loyalty
    • Using Siebel REST API for Siebel Loyalty
      • Deleting Member Data in Siebel Loyalty
      • Using Siebel Loyalty Business Components
  • 15 Using Siebel REST Outbound Services
    • Using Siebel REST Outbound Services
    • About REST Outbound
    • Considerations When Using REST Outbound in Siebel
    • Roadmap for Creating REST Outbound Services in Siebel CRM
    • Setting the Log Level for REST Outbound Services
    • Configuring Web Tools to Call a Java Business Service
    • Creating an Outbound REST Service Based on an OpenAPI Compliant JSON File
    • About the Repository Objects Generated by the JSON Import
      • About the REST Outbound Service Created by the JSON Import
      • Overview of the REST Outbound Proxy Business Service
      • Overview of the REST Outbound Filter Service
      • Overview of Generated Repository Integration Objects
      • Overview of Custom Headers in REST Outbound Proxy Business Service Methods
      • Adding Custom Headers in REST Outbound Proxy Business Service Methods
      • Using Existing Integration Objects in Outbound REST Services
    • Invoking the External REST Service Endpoint Using Proxy Business Service at Runtime