Siebel Application Integration for Oracle Fusion Middleware Guide > Working with Siebel RESTful Services >

Architecture of Siebel RESTful Services Messages


Generally, you can accomplish interaction with Siebel RESTful Services by providing parameters to a URI. This task requires only a browser. More complicated interactions, however, such as querying a record by example, or inserting or updating a new record, need more than just the URI. The more complicated interactions (including any interaction more complicated than queries with row IDs or simple search strings) require you to also post a message body, not just a message header. The message header is what you can pass in a browser's address or location bar. For example, the following is a request header:

http://localhost:7101/oracle-crm/api/rest/siebel/MyRest/Internal Contact Interface?updatemode=insert

It has no apparent information, because the pertinent details are contained in the message body, (not in the header) as is typical with a query.

A message body contains XML that holds all the data for the fields necessary to delete, update, or insert the correct record data. It has the following structure:

<XML header>

<SiebelREST>

<IntegrationComponentWrapperName>

<IntegrationComponentXMLName>

<operation></operation>

<IntegrationComponentFieldName1>DataForField1</ IntegrationComponentFieldName1>

...

<IntegrationComponentFieldNameN>DataForFieldN</ IntegrationComponentFieldNameN>

</IntegrationComponentXMLName>

<IntegrationComponentWrapperName>

</SiebelREST>

NOTE:  SiebelREST is the root node.

Using this structure, you can insert a new contact into the Internal Contact Interface integration object providing values to produce the following message body for the message header above.

<?xml version="1.0" encoding="ISO-8859-1"?>

<SiebelREST>

<ListOfInternal_0x20_Contact_0x20_Interface>

<Contact>

<operation>insert</operation>

<Last_0x20_Name>MyLastName</Last_0x20_Name>

<First_0x20_Name>MyFirstName</First_0x20_Name>

<Middle_0x20_Name>MyMiddleName</Middle_0x20_Name>

...

</Contact>

</ListOfInternal_0x20_Contact_0x20_Interface>

</SiebelREST>

Use the same structure for updates and deletes, but change the operation element's value and the update mode in the header as necessary.

Siebel Application Integration for Oracle Fusion Middleware Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.