QAS_LISTQUERY_REST_GET

Use this service operation to return a list of queries, along with the query descriptions, and owner type. If no queries match the search string, the response message will be empty.

Request Message: QAS_LISTQUERY_TEMPL

Element Name All elements are optional	Description
SearchString	Search string used for specifying the query name or the first few characters of the query name. If no value is entered, all queries for the user will be returned.
OwnerType	Optionally enter either public or private for the owner type. If no value is entered, all queries both public and private for the user will be returned.
MaxRows	Optionally enter the maximum number of rows to return.
isConnectedQry	Enter Y to return list of connected queries; enter N to return list of queries. If the no value is entered, a list of all queries, including connected queries, is returned.
json_response	Enter true for JSON response type; enter false for standard XML response. If no value is provided, the default is standard XML response.

Example 4-1 Example Request

This request will retrieve a list of all public queries that start with XRFW.

https://<servername>:<port>/PSIGW/RESTListeningConnector/<defaultlocal node>/ListQuery.v1/public/listquery?search=QE&maxrows=1000&isconnectedquery=N

Example 4-2 Example of an URI template

{OwnerType}/listquery?search={SearchString}&maxrows={MaxRows}&isconnectedquery={IsConnectedQry}&json_resp={json_response}

Response Message: QAS_LISTQUERY_RESP_MSG

Example Response

When the parameter json_response is set to false:

<?xml version="1.0"?>
<QAS_LISTQUERY_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_LISTQUERY_RESP_MSG.VERSION_1">
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
         Tools/schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECECHAR</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECEDATE</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECEDESC</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECEDTTM</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECENUM</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QECESNUM</QueryName>
            <OwnerType>public</OwnerType>
            <Description>Query for CE Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
        schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QENVSPROMPT1</QueryName>
            <OwnerType>public</OwnerType>
            <Description>nVision Single Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QENVSPROMPT2</QueryName>
            <OwnerType>public</OwnerType>
            <Description>nVision Multi Prompt Testing</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
        schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QETOWORD</QueryName>
            <OwnerType>public</OwnerType>
            <Description>CRW GLOBAL STRING TEST</Description>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
    <QAS_LISTQUERY_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
        schemas/QAS_LISTQUERY_RESP.VERSION_1">
            <QueryName>QE_ALL_CAT_Q</QueryName>
            <OwnerType>public</OwnerType>
            <Description/>
            <isConnectedQry>N</isConnectedQry>
        </PTQASWRK>
    </QAS_LISTQUERY_RESP>
</QAS_LISTQUERY_RESP_MSG>

Example Response

When the parameter json_response is set to true:

{
"status": "success","data": 
 {"Query": 
  [{"queryName": "QECECHAR","ownerType": "public","description": 
     "Query for CE Prompt Testing","isConnectedQry": false},

    {"queryName": "QECEDATE","ownerType": "public","description":
     "Query for CE Prompt Testing","isConnectedQry": false},

    {"queryName": "QECEDESC","ownerType": "public","description":
     "Query for CE Prompt Testing","isConnectedQry": false},

    {"queryName": "QECEDTTM","ownerType": "public","description":
     "Query for CE Prompt Testing","isConnectedQry": false},

    {"queryName": "QECENUM","ownerType": "public","description":
     "Query for CE Prompt Testing","isConnectedQry": false},

     {"queryName": "QECESNUM","ownerType": "public","description":
     "Query for CE Prompt Testing","isConnectedQry": false}     ]}
  }