About REST Response Base URIs

REST Response Base Uniform Resource Identifiers (URI) instruct the REST API how to reach the Siebel web application layer during the inbound rest call. The REST Response Base URI is prefixed with the resource URLs that are returned by REST responses, such as child links, self-links, and so on.

The format of the base URI is as follows: <AI_HOST>:<AI_HTTPS_PORT>/siebel/v1.0/

  • <AI_HOST>. Application interface hostname.
  • <AI_HTTPS_PORT>. Application interface port number
  • Siebel. Application name
  • v1.0. REST version
<AI_HOST>:<AI_HTTPS_PORT>/siebel/v1.0/

The following request is a full URI to access data resources:

https://SampleHostname:8080/siebel/v1.0/data/Account/Account/<acc_id>/Contact/<cont_id>
        

In this example, the base URI is: <AI_HOST><AI_HTTPS_PORT>/siebel/v1.0/

Note: If the setup has an internet-facing reverse proxy, or if the setup has a load balancer before the request reaches the application interface node, then you must use the hostname and port number of the internet-facing reverse proxy, or of the load balancer, so that the REST URLs synthesized are valid from outside the setup.