Data Service (v12.2.18)

The data services a web service connector provides allow SOAP requests for seeding and submitting data to be sent from a determinations server. Requests include name of tables, attribute and links to request data for, attachments and audit reports. Responses from the web service connector include data which is used to define existing links and populate values of attributes of tables.

 

WSDL

Download the Current Version of the Web Service Connector WSDL

Namespaces

http://xmlns.oracle.com/connector/webservice/12.2.13/data/types

http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types

Actions

Load, Save, SetCheckpoint, GetCheckpoint, ExecuteQuery

Headers

Security

Load

This action is sent at the start of an interview to request data for each of the tables, links and attributes which were mapped to in a policy model. The response returned by the web service connector is expected to contain values for each of the requested items.

The web service will receive a SOAPAction of Load with a security header (if the connection was configured with a username and password) with information about the policy model such as the global input table, localization information, tables, links and attributes which were mapped, and any additional parameters that may have been specified by the start session url. The response must not contain any tables, links or fields which were listed in the request, or the interview will fail to start and the error will be logged.

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
            xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
            xmlns:r="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types"
            xmlns:m="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
    <s:Header>
        <wsse:Security s:mustUnderstand="1">
            <wsse:UsernameToken>
                <wsse:Username>[USERNAME]</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">[PASSWORD]</wsse:Password>
            </wsse:UsernameToken>
            <wsu:Timestamp>
                <wsu:Created>2015-02-12T01:10:33Z</wsu:Created>
                <wsu:Expires>2015-02-12T01:15:33Z</wsu:Expires>
            </wsu:Timestamp>
        </wsse:Security>
    </s:Header>
    <s:Body>
        <m:load-request root="Catalog" region="en-US" language="en-US" timezone="Etc/GMT">
            <m:tables>
                <r:table name="Camera">
                    <r:field name="price"/>
                    <r:field name="color_code"/>
                    <r:field name="has_redeye"/>
                    <r:field name="has_portrait"/>
                    <r:field name="has_timer"/>
                    <r:field name="has_flash"/>
                    <r:field name="camera_model"/>
                </r:table>
                <r:table name="Phone Type">
                    <r:field name="type_desc"/>
                </r:table>
                <r:table name="Catalog">
                    <r:link name="Cameras" target="Camera"/>
                    <r:link name="Chosen cameras" target="Camera"/>
                    <r:link name="Loaded Phone Types" target="Phone Type"/>
                </r:table>
            </m:tables>
        </m:load-request>
    </s:Body>
</s:Envelope>
Parameter Type Description
root xsd:string The name of the table which was mapped to Global input. (optional)
region xsd:string The deployment's region code. The connector may need to utilize this information if it is responsible for formatting currency, dates or other values to a field designated as a STRING field. Values passed as DECIMAL, DATE, DATETIME or TIMEOFDAY will be formatted in the interview according to the settings of the policy model. (see Localization – Region)
language xsd:string The deployment's language code. Useful if the connector is responsible for returning data in different languages, i.e. string values for fields which were described by the metadata as STRING data types.
timezone xsd:string The timezone attribute is the Timezone as specified in the deployment. This affects all Date and Time Policy Modeling attributes as the value mapped out will carry this Timezone value. Any Date and Time values in the response must already be converted to the project's Timezone.
request-context RequestContext This element contains additional parameters specified on the start session url. See Data Integration.
tables SeedDataDescription An element containing a list of Tables for the request. (optional)

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:load-response user-role="Anonymous" user-id=""
                           xmlns="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types"
                           xmlns:ns2="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
            <ns2:tables>
                <table name="Camera">
                    <row id="BenchmarkPro">
                        <field name="price" field-type="currency">
                            <number-val>85.00</number-val>
                        </field>
                        <field name="color_code" field-type="text">
                            <text-val>STD</text-val>
                        </field>
                        <field name="has_redeye" field-type="boolean">
                            <boolean-val>true</boolean-val>
                        </field>
                        <field name="has_portrait" field-type="boolean">
                            <boolean-val>true</boolean-val>
                        </field>
                        <field name="has_timer" field-type="boolean">
                            <boolean-val>true</boolean-val>
                        </field>
                        <field name="has_flash" field-type="boolean">
                            <boolean-val>true</boolean-val>
                        </field>
                        <field name="camera_model" field-type="text">
                            <text-val>BenchmarkPro</text-val>
                        </field>
                    </row>
                  [...more camera rows...]
                </table>
                <table name="Phone Type">
                    <row id="Home">
                        <field name="type_desc" field-type="text">
                            <text-val>Home</text-val>
                        </field>
                    </row>
                    <row id="Mobile">
                        <field name="type_desc" field-type="text">
                            <text-val>Mobile</text-val>
                        </field>
                    </row>
                    <row id="Work">
                        <field name="type_desc" field-type="text">
                            <text-val>Work</text-val>
                        </field>
                    </row>
                </table>
                <table name="Catalog">
                    <row id="global">
                        <link name="Cameras" target="Camera">
                            <ref id="BenchmarkPro"/>
                            <ref id="BenchmarkX"/>
                            <ref id="BrightShot-EM"/>
                            <ref id="ColorAnswer-NJ"/>
                          [...more camera references...]
                        </link>
                        <link name="Loaded Phone Types" target="Phone Type">
                            <ref id="Home"/>
                            <ref id="Mobile"/>
                            <ref id="Work"/>
                        </link>
                    </row>
                </table>
            </ns2:tables>
        </ns2:load-response>
    </S:Body>
</S:Envelope>
Parameter Type Description
user-role UserRoleType The role of the user that initiated the interview. If the user has multiple roles, the value must define the role the user is acting in for the interview session. (optional)
user-id xsd:string The unique identifier for the user that initiated the interview. The same unique value must be returned for every interview session initiated by the same user. (optional)
tables LoadData An element containing the list of Tables retrieved by the request.

Errors

If the response of a Load action contains unexpected values or structure will be logged. Depending on the severity of the issue, the interview may fail to start, be aware that an interview that starts did not necessarily start without errors.

If an error is raised by the web service connector, the body of the response may instead consist of a RequestFault. This defined fault structure allows the Hub log to display the error in a cleaner format, as opposed to a stack trace.

Save

The Save action may be called during an interview with a defined Global output table. The request will include data for tables, links and fields which were mapped for output on, as well as any audit reports. The response looks similar to a Load response because some attributes are populated with data only after a Submit occurs.

Rows that were loaded in at the start that are included in the Save response will have action="update", but rows that did not exist will have action="create".

When the Load response contains the expected Global table, but the Global table has no rows, it will be logged in the Message logs, but the interview will proceed anyway. If the web service connector developer wants to prevent this, they should make sure to validate that a Global row exists otherwise throw a RequestFault.

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
            xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
            xmlns:r="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types"
            xmlns:m="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
    <s:Header>
        <wsse:Security s:mustUnderstand="1">
            <wsse:UsernameToken>
                <wsse:Username>serviceuser</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">servicepassword</wsse:Password>
            </wsse:UsernameToken>
            <wsu:Timestamp>
                <wsu:Created>2018-10-12T03:27:11Z</wsu:Created>
                <wsu:Expires>2018-10-12T03:32:11Z</wsu:Expires>
            </wsu:Timestamp>
        </wsse:Security>
    </s:Header>
    <s:Body>
        <m:save-request root="Customer Request" region="en-US" language="en-US" timezone="Etc/GMT">
            <r:tables>
                <r:table name="Customer Request">
                    <r:row id="3" action="update">
                        <r:input-field name="first_name">
                            <r:text-val>Fred</r:text-val>
                        </r:input-field>
                        <r:input-field name="email">
                            <r:text-val>fred@oracle.com</r:text-val>
                        </r:input-field>
                        <r:input-field name="request_date">
                            <r:date-val>2015-02-12</r:date-val>
                        </r:input-field>
                        <r:input-field name="last_name">
                            <r:text-val>Smith</r:text-val>
                        </r:input-field>
                        <r:input-field name="comment">
                            <r:text-val>Great interview!</r:text-val>
                        </r:input-field>
                        <r:output-field name="request_ID"/>
                        <r:link name="Chosen cameras" target="Camera">
                            <r:ref id="BenchmarkPro"/>
                        </r:link>
                        <r:link name="Customer's Phone Numbers" target="Customer's Phone Number">
                            <r:ref id="the customer's phone number1"/>
                            <r:ref id="the customer's phone number2"/>
                        </r:link>
                        <r:attachments group-name="generated forms">
                            <r:attachment name="Product Order" filename="Product Order.pdf"
                                          description="Form auto generated by Intelligent Advisor.">JVBERi0xLjY... (Base64 encoded string)...</r:attachment>
                        </r:attachments>
                    </r:row>
                </r:table>
                <r:table name="Customer's Phone Number">
                    <r:row id="the customer's phone number1" action="update">
                        <r:input-field name="phone_number">
                            <r:text-val>123456</r:text-val>
                        </r:input-field>
                        <r:input-field name="is_preferred">
                            <r:boolean-val>true</r:boolean-val>
                        </r:input-field>
                        <r:link name="Customer's phone number type" target="Phone Type">
                            <r:ref id="Home"/>
                        </r:link>
                    </r:row>
                    <r:row id="the customer's phone number2" action="update">
                        <r:input-field name="phone_number">
                            <r:text-val>654321</r:text-val>
                        </r:input-field>
                        <r:input-field name="is_preferred">
                            <r:boolean-val>false</r:boolean-val>
                        </r:input-field>
                        <r:link name="Customer's phone number type" target="Phone Type">
                            <r:ref id="Mobile"/>
                        </r:link>
                    </r:row>
                </r:table>
            </r:tables>
            <r:audit-reports>
                <r:report node-id="0" attribute-id="66204b9f-9960-4fd0-a278-09fedcee8481" attribute-type="boolean"
                          entity-id="bedd6125-22f3-4de3-a2c8-26c9f03210f3" instance-id="BenchmarkPro" is-user-set="false"
                          text="BenchmarkPro meets the customer's needs.">
                    <r:boolean-val>true</r:boolean-val>
                    <r:attribute-node node-id="1" attribute-id="e8c1d63f-c76e-415e-b545-4c0a4a64c534"
                                      attribute-type="boolean" entity-id="bedd6125-22f3-4de3-a2c8-26c9f03210f3"
                                      instance-id="BenchmarkPro" is-user-set="false"
                                      text="BenchmarkPro meets the customer's price requirements.">
                        <r:boolean-val>true</r:boolean-val>
                        <r:attribute-node node-id="2" attribute-id="product_price" attribute-type="currency"
                                          entity-id="bedd6125-22f3-4de3-a2c8-26c9f03210f3" instance-id="BenchmarkPro"
                                          is-user-set="true" text="BenchmarkPro's price is $85.00.">
                            <r:number-val>85.0</r:number-val>
                        </r:attribute-node>
                        <r:attribute-node node-id="3" attribute-id="ae191da0-17be-47b5-86a9-65e8daa218be"
                                          attribute-type="currency" entity-id="global" instance-id="global"
                                          is-user-set="true" text="The customer's maximum desired price is $1,000.00.">
                            <r:number-val>1000.0</r:number-val>
                        </r:attribute-node>
                        <r:attribute-node node-id="4" attribute-id="82195c88-d3a0-4c40-acb9-b7422a6206c5"
                                          attribute-type="currency" entity-id="global" instance-id="global"
                                          is-user-set="true" text="The customer's minimum desired price is $0.00.">
                            <r:number-val>0.0</r:number-val>
                        </r:attribute-node>
                    </r:attribute-node>
                    [more attribute-nodes]
                </r:report>
                [more reports]
            </r:audit-reports>
        </m:save-request>
    </s:Body>
</s:Envelope>

A save-request.

Parameter Type Description
root xsd:string The name of the table which was mapped to Global output.
region xsd:string The deployment's region code. The connector may need to utilize this information if it is responsible for formatting currency, dates or other values to a field designated as a STRING field. Values passed as DECIMAL, DATE, DATETIME or TIMEOFDAY will be formatted in the interview according to the settings of the policy model. (see Localization – Region)
language xsd:string The deployment's language code. Useful if the connector is responsible for returning data in different languages, i.e. string values for fields which were described by the metadata as STRING data types.
timezone xsd:string The timezone attribute is the Timezone as specified in the deployment. This affects all Date and Time Policy Modeling attributes as the value mapped out will carry this Timezone value. Any Date and Time values in the response must already be converted to the project's Timezone.
request-context RequestContext This element contains additional parameters specified on the start session url. See Data integration.
tables SubmitData An element containing a list of Tables for the request.
audit-reports AuditReportList An element containing a list of AuditAttributeNodes.

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:save-response xmlns="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types"
                           xmlns:ns2="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
            <ns2:tables>
                <table name="Customer Request">
                    <row id="3">
                        <field name="request_ID" field-type="number">
                            <number-val>3</number-val>
                        </field>
                    </row>
                </table>
                <table name="Customer's Phone Number">
                    <row id="the customer's phone number1"/>
                    <row id="the customer's phone number2"/>
                </table>
            </ns2:tables>
        </ns2:save-response>
    </S:Body>
</S:Envelope>
Parameter Type Description
tables UpdateData An element containing the list of tables of the response.

Errors

If the response of a Save action contains unexpected values or structure will be logged. Depending on the severity of the issue, the interview may fail to proceed after the Submit. Be aware that the interview may have continued if the errors were not blocking.

If an error is raised by the web service connector, the body of the response may instead consist of a RequestFault. This defined fault structure allows the Hub log to display the error in a cleaner format, as opposed to a stack trace.

SetCheckpoint

The SetCheckpoint action may be called during an interview to send the serialized session data (a checkpoint) to the web service connector, which is then responsible for storing the data. Later on, a GetCheckpoint request can be made which will expect to have the requested checkpoint data returned. If the web service connector is unable to store the session data for whatever reason, a RequestFault should be returned to explain the cause.

Request

Note that for brevity, the checkpoint data has been truncated

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" 
            xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" 
            xmlns:r="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types" 
            xmlns:m="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
    <s:Header>
        <wsse:Security s:mustUnderstand="1">
            <wsse:UsernameToken>
                <wsse:Username>serviceuser</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">servicepassword</wsse:Password>
            </wsse:UsernameToken>
            <wsu:Timestamp>
                <wsu:Created>2016-01-20T04:23:09Z</wsu:Created>
                <wsu:Expires>2016-01-20T04:28:09Z</wsu:Expires>
            </wsu:Timestamp>
        </wsse:Security>
    </s:Header>
    <s:Body>
        <m:set-checkpoint-request>
            <m:request-context>
                <m:parameter name="resume-id" value="13"/>
                <m:parameter name="user" value="scott"/>
            </m:request-context>
            <m:checkpoint-data checkpoint-id="13">UEsDBBQACAgIAOR6NEg...AAAAA==</m:checkpoint-data>
        </m:set-checkpoint-request>
    </s:Body>
</s:Envelope>
Parameter Type Description
request-context RequestContext This element contains additional parameters specified on the start session URL See Data Integration.
checkpoint-data CheckpointData Checkpoint data (serialized interview session data) being sent to a web service connector.

Response

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:set-checkpoint-response xmlns:ns2="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types" 
                                     xmlns="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types" 
                                     checkpoint-id="13"/>
    </S:Body>
</S:Envelope>
Parameter Type Description
checkpoint-id xsd-string The ID associated with the checkpoint data. If populated, this ID will be used in subsequent set checkpoint requests from this interview session. This is useful information for the web service connector to keep only one copy of a single interview session's data.

Errors

If the response of a SaveCheckpoint action contains unexpected values or structure will be logged.

If an error is raised by the web service connector, the body of the response may instead consist of a RequestFault. This defined fault structure allows the Hub log to display the error in a cleaner format, as opposed to a stack trace.

GetCheckpoint

The GetCheckpoint action may be called to retrieve checkpoint (serialized interview session) data. This data should have previously been stored as the result of a SetCheckpoint request and should be retrieved using the request parameters and (if used) an OAuth token. Once returned, if the deserialized session data matches the deployed policy model the session will be resumed. If the checkpoint data cannot be retrieved by the web service connector because it does not exist or any other reason, a RequestFault should be returned to explain the cause.

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" 
            xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" 
            xmlns:r="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types" 
            xmlns:m="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
    <s:Header>
        <wsse:Security s:mustUnderstand="1">
            <wsse:UsernameToken>
                <wsse:Username>serviceuser</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">servicepassword</wsse:Password>
            </wsse:UsernameToken>
            <wsu:Timestamp>
                <wsu:Created>2016-01-20T04:29:06Z</wsu:Created>
                <wsu:Expires>2016-01-20T04:34:06Z</wsu:Expires>
            </wsu:Timestamp>
        </wsse:Security>
    </s:Header>
    <s:Body>
        <m:get-checkpoint-request>
            <m:request-context>
                <m:parameter name="resume-id" value="13"/>
                <m:parameter name="user" value="scott"/>
            </m:request-context>
        </m:get-checkpoint-request>
    </s:Body>
</s:Envelope>
Parameter Type Description
request-context RequestContext This element contains additional parameters specified on the resume session URL. See Data Integration.

Response

Note that for brevity, the checkpoint data has been truncated

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:get-checkpoint-response xmlns:ns2="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types" 
                                     xmlns="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types">
            <ns2:checkpoint-data checkpoint-id="13">UEsDBBQACAgIAOR6NEg...AAAAA==</ns2:checkpoint-data>
        </ns2:get-checkpoint-response>
    </S:Body>
</S:Envelope>
Parameter Type Description
checkpoint-data CheckpointData The checkpoint data associated with the request context parameters, and (if used) OAuth information. A checkpoint ID may be specified in the response so that subsequent set checkpoint actions maintain a single checkpoint for the interview.

Errors

If the response of a GetCheckpoint action contains unexpected values or structure will be logged.

If an error is raised by the web service connector, the body of the response may instead consist of a RequestFault. This defined fault structure allows the Hub log to display the error in a cleaner format, as opposed to a stack trace.

ExecuteQuery

The ExecuteQuery action is called to load data during an interview that matches the query parameters provided. The request comes in two parts:

  1. The query to be evaluated to determine which rows in the root table should be returned
  2. A description of the data being requested.

The format of both the requested data and the data in the response is the same as the Load action detailed above.

The response data should contain rows that have unique identifiers across all responses - if the same ID appears when a query gets re-evaluated then it will be treated as the same instance inside OPA, even if the fields returned are different. Similarly, if the same row is returned in a subsequent response, it should have the same ID as it did in any prior responses.

The sample below describes a query to load all rows from the Track table where the track's title contains the word "black" and whose price is less than or equal to $1.50. It also specifies that for each matching track, load their related ratings from the Rating table.

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
            xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
            xmlns:r="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types"
            xmlns:m="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types">
    <s:Header>
        <wsse:Security s:mustUnderstand="1">
            <wsse:UsernameToken>
                <wsse:Username>[USERNAME]</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">[PASSWORD]</wsse:Password>
            </wsse:UsernameToken>
            <wsu:Timestamp>
                <wsu:Created>2015-02-12T01:10:33Z</wsu:Created>
                <wsu:Expires>2015-02-12T01:15:33Z</wsu:Expires>
            </wsu:Timestamp>
        </wsse:Security>
    </s:Header>
    <s:Body>
        <m:execute-query-request root="Track" region="en-AU" language="en-GB" timezone="Australia/Sydney" result-limit="5">
            <m:and-expr>
                <m:comparison-expr>
                    <m:field>Price</m:field>
                    <m:operator>LessThanEquals</m:operator>
                    <m:value>
                        <r:number-val>1.5</r:number-val>
                    </m:value>
                </m:comparison-expr>
                <m:comparison-expr>
                    <m:field>Name</m:field>
                    <m:operator>Contains</m:operator>
                    <m:value>
                        <r:text-val>Black</r:text-val>
                    </m:value>
                </m:comparison-expr>
            </m:and-expr>
             <m:tables>
                <r:table name="Track">
                    <r:field name="Name" field-type="text"/>
                    <r:field name="Artist" field-type="text"/>
                    <r:field name="Album" field-type="text"/>
                    <r:field name="Gene"  field-type="text">
                    <r:field name="Price" field-type="number"/>
                    <r:link name="TrackRatings" target="Rating"/>
                </r:table>
                <r:table name="Rating">
                    <r:field name="UserName" field-type="text"/>
                    <r:field name="Rating" field-type="number"/>
                </r:table>
            </m:tables>
        </m:execute-query-request>
    </s:Body>
</s:Envelope>
Parameter Type Description
root xsd:string The name of the table being queried.
region xsd:string The deployment's region code. The connector may need to utilize this information if it is responsible for formatting currency, dates or other values to a field designated as a STRING field.
language xsd:string The deployment's language code. Useful if the connector is responsible for returning data in different languages, i.e. string values for fields which were described by the metadata as STRING data types.
timezone xsd:string The timezone attribute is the Timezone as specified in the deployment. This affects all "Date and Time" Policy Modeling attributes as the value mapped out will carry this Timezone value. Any Date and Time values in the response must already be converted to the project's Timezone.
result-limit xsd:integer Optional. Defines the maximum number of rows in the root table that should be returned as a result of the query.

And one of the following:

Parameter Type Description
and-expr AndExpression Represents an expression where all child expressions should be conjoined using the AND operator.
or-expr OrExpression Represents an expression where all child expressions should be conjoined using the OR operator.
comparison-expr ComparisonExpression Represents an expression where a field is compared to a value.
not-null-expr NotNullExpression Represents an expression that evaluates to true if the field is not null.
null-expr NullExpression Represents an expression that evaluates to true if the field is null.
all-expr AllExpression Represents an expression in which all rows should be returned.
tables SeedDataDescription Describes the data to be returned as a result of the query.

Response

The following is a sample response base on example request above.

 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
            xmlns:h="http://xmlns.oracle.com/policyautomation/hub/12.2.18/metadata/types"
            xmlns:w="http://xmlns.oracle.com/connector/webservice/12.2.13/data/types">
    <s:Header/>
    <s:Body>
        <h:execute-query-response>
            <h:tables>
                <w:table name="Track">
                    <w:row id="43f9b75ed46b">
                        <w:field name="Name">
                            <w:text-val>Paint It Black</w:text-val>
                        </w:field>
                        <w:field name="Artist">
                            <w:text-val>The Rolling Stones</w:text-val>
                        </w:field>
                        <w:field name="Album">
                            <w:text-val>Aftermath</w:text-val>
                        </w:field>
                        <w:field name="Genre">
                            <w:text-val>Rock</w:text-val>
                        </w:field>
                        <w:field name="Price">
                            <w:number-val>0.99</w:number-val>
                        </w:field>
                        <w:link name="TrackRatings" target="Rating">
                            <w:ref id="8ab71374"/>
                            <w:ref id="0b0d0f0b"/>
                        </w:link>
                    </w:row>
                    <w:row id="478577dcc558">
                        <w:field name="Name">
                            <w:text-val>Black</w:text-val>
                        </w:field>
                        <w:field name="Artist">
                            <w:text-val>Perl Jam</w:text-val>
                        </w:field>
                        <w:field name="Album">
                            <w:text-val>Ten</w:text-val>
                        </w:field>
                        <w:field name="Genre">
                            <w:text-val>Grunge</w:text-val>
                        </w:field>
                        <w:field name="Price">
                            <w:number-val>1.26</w:number-val>
                        </w:field>
                        <w:link name="TrackRatings" target="Rating">
                            <w:ref id="8c378a0b"/>
                            <w:ref id="7836807e"/>
                        </w:link>
                    </w:row>
                    <w:row id="c73fa76ff091">
                        <w:field name="Name">
                            <w:text-val>Black Dog</w:text-val>
                        </w:field>
                        <w:field name="Artist">
                            <w:text-val>Led Zeppelin</w:text-val>
                        </w:field>
                        <w:field name="Album">
                            <w:text-val>IV</w:text-val>
                        </w:field>
                        <w:field name="Genre">
                            <w:text-val>Rock</w:text-val>
                        </w:field>
                        <w:field name="Price">
                            <w:number-val>1.49</w:number-val>
                        </w:field>
                        <w:link name="TrackRatings" target="Rating">
                            <w:ref id="97f41dab"/>
                        </w:link>
                    </w:row>
                    <w:row id="d45a6295f1f2">
                        <w:field name="Name">
                            <w:text-val>Black Hole Sun</w:text-val>
                        </w:field>
                        <w:field name="Artist">
                            <w:text-val>Soundgarden</w:text-val>
                        </w:field>
                        <w:field name="Album">
                            <w:text-val>Superunknown</w:text-val>
                        </w:field>
                        <w:field name="Genre">
                            <w:text-val>Grunge</w:text-val>
                        </w:field>
                        <w:field name="Price">
                            <w:number-val>0.75</w:number-val>
                        </w:field>
                        <w:link name="TrackRatings" target="Rating">
                            <w:ref id="459efbef"/>
                        </w:link>
                    </w:row>
                    <w:row id="a6a78c017c4c">
                        <w:field name="Name">
                            <w:text-val>Back to Black</w:text-val>
                        </w:field>
                        <w:field name="Artist">
                            <w:text-val>Amy Winehouse</w:text-val>
                        </w:field>
                        <w:field name="Album">
                            <w:text-val>Back to Black</w:text-val>
                        </w:field>
                        <w:field name="Genre">
                            <w:text-val>Soul</w:text-val>
                        </w:field>
                        <w:field name="Price">
                            <w:number-val>0.99</w:number-val>
                        </w:field>
                        <w:link name="TrackRatings" target="Rating">
                            <w:ref id="f922c5d9"/>
                        </w:link>
                    </w:row>
                </w:table>
                <w:table>
                    <w:row id="8ab71374">
                        <w:field name="UserName">
                            <w:text-val>MusicLover1</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>5</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="8c378a0b">
                        <w:field name="UserName">
                            <w:text-val>90sKid</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>5</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="459efbef">
                        <w:field name="UserName">
                            <w:text-val>90sKid</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>5</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="7836807e">
                        <w:field name="UserName">
                            <w:text-val>MusicLover1</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>5</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="97f41dab">
                        <w:field name="UserName">
                            <w:text-val>90sKid</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>4</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="f922c5d9">
                        <w:field name="UserName">
                            <w:text-val>SoulTrain</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>5</w:number-val>
                        </w:field>
                    </w:row>
                    <w:row id="0b0d0f0b">
                        <w:field name="UserName">
                            <w:text-val>SoulTrain</w:text-val>
                        </w:field>
                        <w:field name="Rating">
                            <w:number-val>1</w:number-val>
                        </w:field>
                    </w:row>
                </w:table>
            </h:tables>
        </h:execute-query-response>
    </s:Body>
</s:Envelope>
Parameter Type Description
tables LoadData An element containing the list of Tables matching the query.

Errors

If the response of an ExecuteQuery action contains unexpected values or structure will be logged.

If an error is raised by the web service connector, the body of the response may instead consist of a RequestFault. This defined fault structure allows the Hub log to display the error in a cleaner format, as opposed to a stack trace.