Oracle Web Determinations URL API

Oracle Web Determinations is a web application that must interpret the user's request in order to determine what action is required.

In order to provide a high level of security and to prevent unauthorized changes to interview session data, it is not possible to manipulate the interview data through the URL.

The general structure of the URL follows the Representational State Transfer (REST) schema, where the action comprises the first part of the URL and the resource to be acted upon constituting the rest.

Note that the very first request to Oracle Web Determinations must contain the user=<username> query parameter in the URL if a particular user name is to be assigned to an Oracle Web Determinations session. Also note that the encoding to be used both in the URLs and the request and response content objects is UTF-8.

Basic and advanced URL structures

Click on the following topic links to display information about the basic and advanced URL structures. Please refer to the Placeholder Definitions topic below for further information about each placeholder.

Placeholder definitions

The following is a table containing the definitions for the placeholders to be used in the URL structures (Note: The encoding to be used both in the URLs and the request and response content objects is UTF-8):

 

Placeholder Description Notes
<webserver-url> The address of the webserver
http://localhost:8080/
For a Tomcat install the address of the webserver would be:
http://localhost:8080/
<web-determinations app> The name of the Oracle Web Determinations webapp inside the webserver The default Oracle Web Determinations webapp name is 'web-determinations'
<web-determinations url>
The address of the Oracle Web Determinations webapp
Usually <webserver-url> and <web-determinations app> combined; for example:
http://localhost:8080/web-determinations/
<rulebase> The rulebase to use
usually the normal name of the rulebase (for example, My Rulebase) and convert space to + (e.g. My+Rulebase)
<locale> The locale to use, follows a strict format en-GB, fr-FR, zh-CN. For a list of the locale codes that Oracle Policy Automation supports out of the box, see:
Implement support for non-English language

For more information about the format see:
Locale Format
<goal-id> The goal-id, follows a strict format For more information about the format see:
Goal ID Format

Examples:
  • Attribute~a1~global~global
  • Procedural~MyFlow{global~global~}
<authored-screen-name> The screen name, has URL encoded chars. Follows a format
For more information about the format see:
Authored Screen Name Format

Example: 
http://localhost:8080/web-determinations/screen/Controlling+Screen+Order/en-US/qs%24s1%40Interviews_Screens_xint%24global%24global?postredirect=%2fscreen%2fControlling%2bScreen%2bOrder%2fen-US%2freport%2524attr%2524eligible%2524global%2524global%2524Relevant%2524false%2524false%3fuser%3dguest
  • qs%24s1%40Interviews_Screens_xint%24global%24global
  • dr%24My+Data+Review%24global%24global
<screen-post-url> The POST URL to be used by the screen being invoked. Follows a format For more information about the format see Screen Post URL Format

Example:
http://localhost:8080/web-determinations/screen/Controlling+Screen+Order/en-US/qs%24s1%40Interviews_Screens_xint%24global%24global?postredirect=%2fscreen%2fControlling%2bScreen%2bOrder%2fen-US%2freport%2524attr%2524eligible%2524global%2524global%2524Relevant%2524false%2524false%3fuser%3dguest

%2fscreen%2fControlling%2bScreen%2bOrder%2fen-US%2freport%2524attr%2524eligible%2524global%2524global%2524Relevant%2524false%2524false%3fuser%3dguest
<non-authored-screen-name> Screen names for non-authored screens To see the values for the non-authored screen names see:
Non-authored Screen values

Examples:
  • Default+Data+Review
  • summary
  • report%24attr%24a1%24global%24global%24Relevant%24false%24false
<document-id>
identifies the document to display. This ID is generated during the Build process in OPM.
An example of a document ID is: 6e2d1953-3a8c-493e-a36e-c82ebbb45b9b

This ID can be found in the Screen xgen file (.exs) in the rulebase output folder, or can be extracted from the Document link itself in the Summary screen.
<commentary-target>
specifies the commentary-target, the value is encoded. Follows a format
For more information about the format see:
Commentary Target Format

Example:
%2fs2%40Screens_screens_xint (URL decoded - /s2@Screens_screens_xint)

 

When looking at the placeholder descriptions that follow, use the following table as a handy reference for URL character encoding:

 

Character Encoding
$
%24
@
%40
%
%25
?
%3d
+
%2b
;
%3b
&
%26
&
%26amp%3b
(whitespace)
%20
/ (slash)
%2f
œ %c5%93

Note: in cases when an entity instance identifier contains a forward slash (for example: "person/0-1"), use %c5%93 instead of %2f, so that url parsing will not be broken.

 

Click on any of the following topics for a description of each of the placeholders that requires a strict format: