Siebel REST API Guide > Overview of Using the Siebel REST API >

About REST Outbound

Siebel CRM supports outbound REST communications for on-premises or cloud applications, allowing the external applications to interact with other on-premises or cloud applications that communicate through REST APIs.

Siebel outbound REST functionality is built on SOAP Outbound functionality and allows Siebel CRM to call any external endpoint that provides a valid Open API or SWAGGER compliant schema.

Siebel outbound REST functionality leverages Siebel Tools to import the REST contract and create the required metadata, such as business services or integration objects. For more information about Siebel Tools, see Using Siebel Tools.

To use REST Outbound in Siebel CRM:

• Create a new outbound Web Service based on an OpenAPI compiant JSON file. For information about creating an Outbound Web Service based on an OpenAPI compliant JSON file, see Creating an Outbound Web Service Based on an OpenAPI Compliant JSON File.
• Once you have successfully imported the schema in Siebel Tools, open the Siebel Application and navigate to the Administration - Web Services screen and then to the Outbound REST Services screen. Verify the newly imported artifacts are all present in the Outbound REST Services, Service Params, and Operations applets. Make sure you configure the exact endpoint URL in the Address column of the Service Params Applet.
• Create a 64-bit Java Subsystem. For more information about creating a 64-bit Java Subsystem, see Transports and Interfaces: Siebel Enterprise Application Integration.
• Configure any new Siebel Business Services for RESTful access. For more information, see Configuring Business Service Methods for RESTful Access.
• Configure new Siebel Business Services by associating a responsibility with a business service to control access to the business service and its methods. For more information, see Siebel Security Guide.
• Setting up the proxy for external endpoint access. For more information, see Integration Platform Technologies: Siebel Enterprise Application Integration.
• Configure external REST endpoints. For external REST endpoints, the following parameters must be added in the Input PropertySet:
  • isExternalURL: true

    Setting the isExternal parameter value to true removes the body keyword in the POST request body.

  • isEnclosedArray: true

    If the whole POST body has to be enclosed in any array, then set the isEnclosedArray parameter to true.

  • methodValue: <value>

    For path templating, add a value for the methodValue parameter. Path templating is the use of curly braces ({}) to mark a section of a URL path as replaceable.