About Oracle Customer Hub (UCM) REST APIs

UCM processes are build using Siebel Workflow Processes and Siebel Business Services. You can use Siebel REST Interfaces to invoke the workflows or execute the business services. Siebel REST Interface supports both JSON and XML format. For more information refer to Siebel REST API Guide.

Generalized format of HTTP POST request to run Siebel Workflow Process via REST Interface:

Request URL:

http://<Server Name>:<port>/Siebel/v1.0/workflow/<WF Process Name>

Request Headers:

Content-Type: application/json (or application/xml)

Authorization: <authorization info>

Request body in JSON format:

{
     “WFProcessProp1”: “Value1”,
     “WFProcessProp2”: “Value2”,
     //For hierarchy objects, such as “Siebel Message”, pass it as child properties
}

Request body in XML format:

<?xml version="1.0" ?>
<request>
     <WFProcessProp1>Value1</WFProcessProp1>
     <WFProcessProp2>Value1</WFProcessProp2>
     //Complex hierarchy such as “Siebel Message” if any as a child
</request>

Generalized format of HTTP POST request to execute Siebel Business Service via REST Interface:

Request URL:

http://<Server Name>:<port>/Siebel/v1.0/service/<Business Service Name>/<Business Service Method Name>

Request Headers:

Content-Type: application/json (or application/xml)

Authorization: <authorization info>

Request body in JSON format:

{
     “BSMethodParam1”: “Value1”,
     “BSMethodParam2”: “Value2”,
     //For hierarchy objects, such as “Siebel Message”, pass it as child properties
}

Request body in XML format:

<?xml version="1.0" ?>
<request>
     <BSMethodParam1>Value1</BSMethodParam1>
     <BSMethodParam2>Value1</BSMethodParam2>
     //Complex hierarchy such as “Siebel Message” if any as a child
</request>