Oracle Siebel Business Services API

openapi: 3.2.0
info:
  title: Oracle Siebel REST Business Services API
  description: RESTful API for accessing Siebel CRM business objects, business services, and repository objects. The Siebel REST API supports standard CRUD operations using HTTP verbs (GET, POST, PUT, DELETE) against business object data resources, business service invocation, and workspace-based repository management. Responses are available in JSON or XML format, and the API provides built-in metadata discovery through describe endpoints that return OpenAPI-compatible specifications.
  version: '1.0'
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://{siebel-server}/siebel/v1.0
  description: Siebel Application Interface Server
  variables:
    siebel-server:
      default: localhost
      description: Hostname and port of the Siebel Application Interface running the siebel-rest.war deployment on Apache Tomcat
security:
- basicAuth: []
- oauth2: []
tags:
- name: Business Services
  description: Invocation of Siebel business services and their methods for executing server-side business logic including integration object operations
paths:
  /service/{ServiceName}/{MethodName}:
    post:
      operationId: invokeBusinessService
      summary: Invoke a business service method
      description: Execute a method on a named Siebel business service. The service name and method name are specified in the URL path. The request body contains the input parameters as a Siebel property set or integration object message. Business services must be explicitly configured for REST access and associated with a responsibility to control access.
      tags:
      - Business Services
      parameters:
      - name: ServiceName
        in: path
        required: true
        description: Name of the Siebel business service to invoke
        schema:
          type: string
          examples:
          - Siebel Account
      - name: MethodName
        in: path
        required: true
        description: Name of the method to execute on the business service
        schema:
          type: string
          examples:
          - Insert
          - QueryById
          - QueryByExample
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessServiceRequest'
      responses:
        '200':
          description: Business service method executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessServiceResponse'
        '400':
          description: Invalid request or method parameters
        '401':
          description: Authentication credentials missing or invalid
        '500':
          description: Business service execution error
  /service/describe:
    get:
      operationId: describeBusinessServices
      summary: Get business service catalog
      description: Retrieve a catalog of all Siebel business service names, methods defined for each service, and links to individual service descriptions. Returns an OpenAPI-compatible specification.
      tags:
      - Business Services
      responses:
        '200':
          description: Business service catalog retrieved successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Authentication credentials missing or invalid
  /service/{ServiceName}/describe:
    get:
      operationId: describeBusinessService
      summary: Describe a business service
      description: Retrieve the metadata description for a specific business service including its methods, input and output arguments, and data types.
      tags:
      - Business Services
      parameters:
      - name: ServiceName
        in: path
        required: true
        description: Name of the Siebel business service to describe
        schema:
          type: string
      responses:
        '200':
          description: Business service description retrieved successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Authentication credentials missing or invalid
        '404':
          description: Business service not found
components:
  schemas:
    BusinessServiceRequest:
      type: object
      description: Request payload for invoking a Siebel business service method. Contains optional body with SiebelMessage integration object format for structured data operations.
      properties:
        body:
          type: object
          description: Wrapper containing the SiebelMessage integration object
          properties:
            SiebelMessage:
              type: object
              description: Siebel integration object message containing the data payload for the business service operation
              properties:
                MessageId:
                  type: string
                  description: Optional message identifier
                MessageType:
                  type: string
                  description: Message type identifier
                  default: Integration Object
                IntObjectName:
                  type: string
                  description: Name of the integration object (e.g., Account Interface)
                IntObjectFormat:
                  type: string
                  description: Format of the integration object
                  default: Siebel Hierarchical
    BusinessServiceResponse:
      type: object
      description: Response payload from a Siebel business service method invocation. Contains the output data from the executed business service method.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Siebel CRM user credentials encoded as Base64 in the Authorization header
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for token-based access to the Siebel REST API
      flows:
        authorizationCode:
          authorizationUrl: https://{siebel-server}/siebel/v1.0/auth/authorize
          tokenUrl: https://{siebel-server}/siebel/v1.0/auth/token
          scopes: {}
externalDocs:
  description: Oracle Siebel REST API Documentation
  url: https://docs.oracle.com/cd/E95904_01/books/RestAPI/overview-of-using-the-siebel-rest-api.html