Listing Fields

This section describes the service operation that is available for listing the fields in a query.

Use this service operation to return a list of fields for a given query. This service operation will help the user discover the unique field names to use in the FilterFieldName when the query is executed.

Request Message: QAS_LISTQUERYFIELDS_REQ_MSG

Element Name

Description

QueryName

Required element

Complete query name. Required.

OwnerType

Indicate whether it is a public orprivate query.

If no value is specified, QAS will first look for a private query and if it is not found, will look for a public query.

IsconnectedQuery

Required element

Indicate whether this is connected query. Required. Valid values are Y andN.

Example Request:

This request will return the fields for the query XRFWIN.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_LISTQUERYFIELDS_REQ_MSG.VERSION_1"
xmlns:qas1="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_LISTQUERYFIELDS_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_LISTQUERYFIELDS_REQ_MSG>
         <!--Zero or more repetitions:-->
         <qas:QAS_LISTQUERYFIELDS_REQ>
            <qas1:PTQASWRK class="R">
               <qas1:QueryName>XRFWIN</qas1:QueryName>
               <!--Optional:-->
               <qas1:OwnerType>Public</qas1:OwnerType>
               <qas1:isConnectedQuery>n</qas1:isConnectedQuery>
            </qas1:PTQASWRK>
         </qas:QAS_LISTQUERYFIELDS_REQ>
      </qas:QAS_LISTQUERYFIELDS_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_LISTQUERYFIELDS_RESP_MSG

Element Name

Description

ColumnNumber

Column number.

FieldName

Field name.

FieldType

Field type.

FieldLength

Field length.

FieldDecimal

Number of decimal positions.

HeadingText

Unique heading text.

UniqueFieldName

Unique field name. Unique field names are used to set up field filtering when the query is executed.

Example Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <QAS_LISTQUERYFIELDS_RESP_MSG
      xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      QAS_LISTQUERYFIELDS_RESP_MSG.VERSION_1">
         <QAS_LISTQUERYFIELDS_RESP>
            <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/QAS_LISTQUERYFIELDS_RESP.VERSION_1">
               <QueryName>XRFWIN</QueryName>
               <PTQASFIELDWRK class="R">
                  <ColumnNumber>1</ColumnNumber>
                  <FieldName>MENUNAME</FieldName>
                  <FieldType>string</FieldType>
                  <FieldLength>30</FieldLength>
                  <FieldDecimal>0</FieldDecimal>
                  <HeadingText>Menu Name</HeadingText>
                  <UniqueFieldName>Menu Name</UniqueFieldName>
               </PTQASFIELDWRK>
            </PTQASWRK>
         </QAS_LISTQUERYFIELDS_RESP>
      </QAS_LISTQUERYFIELDS_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Use this service operation to return a list of fields for a given query. This service operation will help the user discover the unique field names to use in the FilterFieldName when the query is executed.

Request Message: QAS_LISTQUERYFIELDS_TEMPL

Element Name

Description

QueryName

Required element

Complete query name. Required.

OwnerType

Indicate whether it is a public orprivate query.

If no value is specified, QAS will first look for a private query and if it is not found, will look for a public query.

IsconnectedQuery

Required element

Indicate whether this is connected query. Required. Valid values are Y andN.

Example Request:

https://<servername>:<port>/PSIGW/RESTListeningConnector/<defaultlocal node>/QueryFields.v1/public/XRFWIN?isconnectedquery=N

Response Message: QAS_LISTQUERYFIELDS_RESP_MSG

Element Name

Description

ColumnNumber

Column number.

FieldName

Field name.

FieldType

Field type.

FieldLength

Field length.

FieldDecimal

Number of decimal positions.

HeadingText

Unique heading text.

UniqueFieldName

Unique field name. Unique field names are used to set up field filtering when the query is executed.

Example Response:

<?xml version="1.0"?>
<QAS_LISTQUERYFIELDS_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_LISTQUERYFIELDS_RESP_MSG.VERSION_1">
    <QAS_LISTQUERYFIELDS_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERYFIELDS_RESP.VERSION_1">
            <QueryName>XRFWIN</QueryName>
            <PTQASFIELDWRK class="R">
                <ColumnNumber>1</ColumnNumber>
                <FieldName>MENUNAME</FieldName>
                <FieldType>string</FieldType>
                <FieldLength>30</FieldLength>
                <FieldDecimal>0</FieldDecimal>
                <HeadingText>Menu Name</HeadingText>
                <UniqueFieldName>Menu Name</UniqueFieldName>
            </PTQASFIELDWRK>
        </PTQASWRK>
    </QAS_LISTQUERYFIELDS_RESP>
</QAS_LISTQUERYFIELDS_RESP_MSG>