Assess Service - Generic (v12.2.1)
The generic assess service uses supplied data to determine one or more outcomes, can work out what additional data is needed to reach a conclusion, and provides reports on how decisions were reached.
WSDL
https://<site>/determinations-server/assess/soap/generic/12.2.1/<deployname>?wsdl
Namespace
http://oracle.com/determinations/server/12.2.1/rulebase/assess/types
Actions
Headers
Internationalization, Security
Assess
When provided with an assess-request containing data in a global-instance, returns an assess-response containing a similar global-instance, into which the results of the assess operation have been placed.
All attribute, relationship and entity text returned in a decision report is in the language specified in the WS-I18N locale element for the request. If not specified, the default language for the policy model is used.
Errors that occur, including any error events raised in a rule, are returned via a SOAP fault.
Request
Example
This assess request is for the example policy model RetailDiscounts.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://oracle.com/determinations/server/12.2.1/rulebase/assess/types">
<soapenv:Header/>
<soapenv:Body>
<typ:assess-request>
<typ:config>
<typ:show-version>true</typ:show-version>
<typ:outcome>
<typ:entity id="updatedorder">
<typ:attribute-outcome id="updated_order" outcome-style="value-only"/>
<typ:attribute-outcome id="Discount_Amount_Loyalty" outcome-style="value-only"/>
<typ:attribute-outcome id="Total_Payable" outcome-style="value-only"/>
</typ:entity>
<typ:entity id="updatedorderlineitem">
<typ:attribute-outcome id="updated_order_line_item" outcome-style="value-only"/>
</typ:entity>
</typ:outcome>
</typ:config>
<typ:global-instance>
<typ:attribute id="Discount_Amount_Brand" outcome-style="value-only"/>
<typ:attribute id="Free_Shipping" outcome-style="value-only"/>
<typ:attribute id="Membership_Level">
<typ:text-val>Gold</typ:text-val>
</typ:attribute>
<typ:entity id="order">
<typ:instance id="the order1">
<typ:attribute id="order">
<typ:text-val>Order 1</typ:text-val>
</typ:attribute>
<typ:attribute id="order_date">
<typ:date-val>2016-06-02</typ:date-val>
</typ:attribute>
<typ:entity id="orderlineitem">
<typ:instance id="the order line item1">
<typ:attribute id="OLI_quantity">
<typ:number-val>100.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_unitprice">
<typ:number-val>2.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_brand">
<typ:text-val>Soft Stuff</typ:text-val>
</typ:attribute>
<typ:attribute id="OLI_product">
<typ:text-val>Facial Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
<typ:instance id="the order line item2">
<typ:attribute id="OLI_quantity">
<typ:number-val>200.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_unitprice">
<typ:number-val>3.5</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_brand">
<typ:text-val>Soft Stuff</typ:text-val>
</typ:attribute>
<typ:attribute id="OLI_product">
<typ:text-val>Toilet Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
</typ:entity>
</typ:instance>
</typ:entity>
<typ:entity id="previousorder">
<typ:instance id="the previous order1">
<typ:attribute id="PO_date">
<typ:date-val>2015-08-27</typ:date-val>
</typ:attribute>
<typ:attribute id="PO_total">
<typ:number-val>500.0</typ:number-val>
</typ:attribute>
</typ:instance>
</typ:entity>
</typ:global-instance>
</typ:assess-request>
</soapenv:Body>
</soapenv:Envelope>An assess-request contains an optional config node and a mandatory global-instance node.
| Parameter | Type | Description |
|---|---|---|
| config | AssessmentConfiguration | Options that control how the data provided to the assess operation should be processed, and how the response should be constructed. |
| global-instance | GlobalInstanceType | Input data on which to perform the assessment, using the policy model deployed at the service URL |
Errors
For error events that are raised from the policy model during an assess request, an Error response is returned in a SOAP fault. Error event text is translatable in the policy modeling project.
For any other errors that occur, the SOAP fault error message describes the problem. These messages are always in 'en-US' locale, ignoring any other locale that is set.
Response
Example
The following response is returned when the example request, above, is passed to the assess service for the RetailDiscounts example policy model.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i18n="http://www.w3.org/2005/09/ws-i18n" xmlns:typ="http://oracle.com/determinations/server/12.2.1/rulebase/assess/types">
<SOAP-ENV:Header>
<i18n:international>
<i18n:locale>en_US</i18n:locale>
<i18n:tz>Etc/GMT</i18n:tz>
</i18n:international>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<typ:assess-response>
<typ:version-info>
<typ:deployment-version>2</typ:deployment-version>
<typ:version-uid>76f140c2-8155-4113-a8c0-d66df6feba0e</typ:version-uid>
<typ:build-time>2017-03-30T04:06:45Z</typ:build-time>
</typ:version-info>
<typ:global-instance>
<typ:attribute id="Free_Shipping" type="boolean" inferred="true">
<typ:boolean-val>true</typ:boolean-val>
</typ:attribute>
<typ:attribute id="Discount_Amount_Brand" type="currency" inferred="true">
<typ:number-val>270.0</typ:number-val>
</typ:attribute>
<typ:attribute id="Membership_Level" type="text">
<typ:text-val>Gold</typ:text-val>
</typ:attribute>
<typ:entity id="previousorder" inferred="false">
<typ:instance id="the previous order1">
<typ:attribute id="PO_date" type="date">
<typ:date-val>2015-08-27</typ:date-val>
</typ:attribute>
<typ:attribute id="PO_total" type="number">
<typ:number-val>500.0</typ:number-val>
</typ:attribute>
</typ:instance>
</typ:entity>
<typ:entity id="brand" inferred="true">
<typ:instance id="0xed6fe5a347f29be3"/>
</typ:entity>
<typ:entity id="order" inferred="false">
<typ:instance id="the order1">
<typ:attribute id="order" type="text">
<typ:text-val>Order 1</typ:text-val>
</typ:attribute>
<typ:attribute id="order_date" type="date">
<typ:date-val>2016-06-02</typ:date-val>
</typ:attribute>
<typ:entity id="orderlineitem" inferred="false">
<typ:instance id="the order line item1">
<typ:attribute id="OLI_quantity" type="number">
<typ:number-val>100.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_unitprice" type="currency">
<typ:number-val>2.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_brand" type="text">
<typ:text-val>Soft Stuff</typ:text-val>
</typ:attribute>
<typ:attribute id="OLI_product" type="text">
<typ:text-val>Facial Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
<typ:instance id="the order line item2">
<typ:attribute id="OLI_quantity" type="number">
<typ:number-val>200.0</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_unitprice" type="currency">
<typ:number-val>3.5</typ:number-val>
</typ:attribute>
<typ:attribute id="OLI_brand" type="text">
<typ:text-val>Soft Stuff</typ:text-val>
</typ:attribute>
<typ:attribute id="OLI_product" type="text">
<typ:text-val>Toilet Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
</typ:entity>
</typ:instance>
</typ:entity>
<typ:entity id="updatedorder" inferred="true">
<typ:instance id="0xff93b06162a3aec3">
<typ:attribute id="Total_Payable" type="currency" inferred="true">
<typ:number-val>567.0</typ:number-val>
</typ:attribute>
<typ:attribute id="Discount_Amount_Loyalty" type="currency" inferred="true">
<typ:number-val>63.0</typ:number-val>
</typ:attribute>
<typ:attribute id="updated_order" type="text" inferred="true">
<typ:text-val>Updated Order 1 on 02/06/2016</typ:text-val>
</typ:attribute>
<typ:entity id="updatedorderlineitem" inferred="true">
<typ:instance id="0xb4b06164c54c37b0">
<typ:attribute id="updated_order_line_item" type="text" inferred="true">
<typ:text-val>Soft Stuff brand Facial Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
<typ:instance id="0x92d79cf55e63e83f">
<typ:attribute id="updated_order_line_item" type="text" inferred="true">
<typ:text-val>Soft Stuff brand Toilet Tissues</typ:text-val>
</typ:attribute>
</typ:instance>
</typ:entity>
</typ:instance>
</typ:entity>
</typ:global-instance>
</typ:assess-response>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>| Parameter | Type | Description |
|---|---|---|
| version-info | VersionInfoType | Version information about the policy model. Only populated if show-version is true in the AssessmentConfiguration |
| events | ListEventsType | Warning events that occurred during an Assess action. Only populated if show-events is true in the AssessmentConfiguration |
| global-instance | GlobalInstanceType | Results of the assessment that was performed using the policy model deployed at the service URL |
ListGoals
A list-goals-request returns a list-goals-response containing the list of top-level attributes for a policy model.
Top-level attributes are those for which a rule exists to infer the attribute, and the attribute is not used to infer any other attributes.
The attribute text for each attribute will use the language specified in the WS-I18N locale element for the request. If not specified, the default language for the policy model is used.
Version information for the policy model may also be provided.
Errors that occur are returned via a SOAP fault.
Request
ListGoals request example
This request is the same of all policy models.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://oracle.com/determinations/server/12.2.1/rulebase/assess/types">
<soapenv:Header/>
<soapenv:Body>
<typ:list-goals-request show-version="true"/>
</soapenv:Body>
</soapenv:Envelope>A list-goals-request has one optional parameter.
| Parameter | Type | Description |
|---|---|---|
| show-version | xsd:boolean
|
Choose whether to show version information about the policy model (optional) |
Response
ListGoals response example
In this example, there are two global goals: Discount_Amount_Brand, which is a currency (money) value, and Default_PO_date, which is a date value; There is also a goal for each updated order: Total_Payable, which is another currency (money) value.
The version information shows that this is the second deployed version from Policy Modeling Hub, built on the 30th of March, 2017, at 4:06am GMT.
Note: This example uses the RetailDiscounts example policy model.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i18n="http://www.w3.org/2005/09/ws-i18n" xmlns:typ="http://oracle.com/determinations/server/12.2.1/rulebase/assess/types">
<SOAP-ENV:Header>
<i18n:international>
<i18n:locale>en_US</i18n:locale>
<i18n:tz>Etc/GMT</i18n:tz>
</i18n:international>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<typ:list-goals-response>
<typ:version-info>
<typ:deployment-version>2</typ:deployment-version>
<typ:version-uid>76f140c2-8155-4113-a8c0-d66df6feba0e</typ:version-uid>
<typ:build-time>2017-03-30T04:06:45Z</typ:build-time>
</typ:version-info>
<typ:entity entity-id="global">
<typ:attribute id="Default_PO_date" text="What is the default previous order date?" type="date"/>
<typ:attribute id="Discount_Amount_Brand" text="What is the total saved in brand discounts?" type="currency"/>
</typ:entity>
<typ:entity entity-id="previousorder">
<typ:attribute id="previous_order" text="What is the previous order?" type="text"/>
</typ:entity>
<typ:entity entity-id="brand">
<typ:attribute id="brand" text="What is the brand?" type="text"/>
</typ:entity>
<typ:entity entity-id="order">
<typ:attribute id="order" text="What is the order?" type="text"/>
</typ:entity>
<typ:entity entity-id="updatedorder">
<typ:attribute id="updated_order" text="What is the updated order?" type="text"/>
<typ:attribute id="Total_Payable" text="What is the updated order amount payable?" type="currency"/>
</typ:entity>
<typ:entity entity-id="updatedorderlineitem">
<typ:attribute id="updated_order_line_item" text="What is %updated_order% line item?" type="text"/>
</typ:entity>
</typ:list-goals-response>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>| Parameter | Type | Description |
|---|---|---|
| version-info | VersionInfoType | Version information about the policy model. Only populated if show-version is true in the ListGoals request. |
| entity[] | ListGoalsEntityType | For each entity with top-level attributes, the information about those attributes. |