QAS_QUERY_DETAILS

QAS_QUERY_DETAILS_OPER

Use this service operation to return the complete details of an existing query in XML format.

Request Message: QAS_QUERY_DETAILS_REQ_MSG

Element Name	Description
QUERY_NAME Required element	Complete query name. Required.
IS_CONNECTED_QUERY Required element	Indicates that this is connected query. Valid values are Y and N. The default value is N.

Element Name

Description

QUERY_NAME

Required element

Complete query name. Required.

IS_CONNECTED_QUERY

Required element

Indicates that this is connected query. Valid values are Y and N.

The default value is N.

Example Request:

This request will return the query details for the query XRFWIN.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_QUERY_DETAILS_REQ_MSG.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_QUERY_DETAILS_REQ_MSG>
         <QUERY_NAME>QUERY_WITH_EXPRESSION</QUERY_NAME>
      </qas:QAS_QUERY_DETAILS_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_QUERY_DETAILS_RESP_MSG

The response will include the details for the query definition. This message has several groupings, and depending on the specific query, some groupings may appear multiple times, while other groupings do not apply. The elements are listed here in groups.

<Properties> Returns the properties of the query definition.

Properties Elements	Description
QUERY_NAME	Query name.
DESCRIPTION	Query description.
DESCRLONG	Long description
QUERY_OWNER	Query owner type.
CREATION_TIME	Time of query creation in PeopleSoft database.
LAST_UPDATE_TIME	Time of most recent update of the query in PeopleSoft database. Format is YYYY-MM-DD-HH.MM.SS.FF where FF is the fractional part of a second.

<Selects> Returns the select information of the query definition.

Select Elements	Description
SELECTNUM	SELECT number.
PARENTSELECTNUM	Number of parent SELECT.
SELECTTYPE	Type of selection, Main, Subquery, or Union.
QRYDISTINCT	Indicates whether this query is distinct.

<Records> Returns the record correlation and join information of the query definition.

Records Elements	Description
RCDNUM	Record number.
RCDNAME	Record name.
RCDSELECTNUM	Select number.
CORRNAME	Alias name such as A,B,C, and so on.
JOINTYPE	Join type.
JOINRCDALIAS	Join record alias.
JOINFIELD	Join field.

<Fields> Returns the field of the query definition.

Fields Elements	Description
FIELDNUM	Field number in the corresponding select.
FIELDNAME	Field name.
DESCR	Description.
FORMAT	Field format as a combination of field type and field length.
AGGREGRATE_TYPE	Aggregation type.
HEADING_TYPE	Heading type.
HEADING	Heading text.
FIELDSELECTNUM	Identifier of SELECT in which this field is included.
ORDERBYNUM	Order by number.
COLUMNNUM	Column number.
ORDERBYDIR	Direction of field ordering.
FIELDTYPE	Field type.
FIELDRCDALIAS	Alias of the record to which this field belongs.

<Criteria> Returns the criteria information of the query definition.

Criteria Elements	Description
CRTNUM	Criterion number in the corresponding select statement.
CRTTYPE	Specifies whether the HAVING clause is used.
CRTNAME	Criterion name.
CRTSELECTNUM	Select Number.
NEGATION	Returns True if NOT is specified in the operator; otherwise, returns False.
CONDITION_TYPE	Condition type in criterion.
LEFT_PARENTHESIS_LEVEL	Left parenthesis level specified from 0 onwards.
RIGHT_PARENTHESIS_LEVEL	Right parenthesis level specified from 0 onwards.
CRTEXP1TYPE	Specifies whether the criterion is Field or Expression.
CRTEXP1RCDALIAS	Alias for record used in expression 1 criterion, such as A, B, and so on.
CRTEXP1FIELD	Field used in expression 1 criterion.
CRTEXP1TEXT	Expression text for criterion 1.
CRTEXP1NUM	Expression number for the criterion.
CRTEXP2RCDALIAS	Alias for record used in expression 2 criterion.
CRTEXP2FIELD	Field used in expression 2 criterion.
CRTEXP2TYPE	Expression 2 type in criterion.
CRTEXP2TEXT	Expression 2 text.
CRTLOGICALOPER	Logical operator that links the criteria.

<Expression> Returns the expression information of the query definition.

Expression Elements	Description
EXPNUM	Expression number.
EXPSELECTNUM	Expression's SELECT number.
EXPNAME	Expression name.
EXPTYPE	Expression type.
EXPLENGTH	Expression length.
EXPDECIMALPOS	Number of decimal places.
EXPTEXT	Expression text.
EXPAGGREGATE	Specifies whether the expression is an aggregate function.

<Prompts> Returns the prompt information of the query definition.

Prompt Elements	Description
PROMPT_NUM	Prompt number.
PROMPT_NAME	Unique prompt name.
PROMPT_UNIQUE_NAME	Unique prompt name.
PROMPT_FLDNAME	Name of the field used as prompt.
PROMPT_TABLE	Prompt table name.
PROMPT_EDITTYPE	Edit type.
PROMPT_FLDFORMAT	Field format.
PROMPT_FLDLENGTH	Field length for prompt.
PROMPT_FLDDECIMALPOS	Number of decimal places in prompt.
PROMPT_FLDTYPE	Field type.
PROMPT_HEADING	Heading of prompt.
PROMPT_HEADINGTYPE	Type of prompt heading.

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>
      <qcs:QAS_QUERY_DETAILS_RESP_MSG xmlns:qcs=
      "http://xmlns.oracle.com/Enterprise/Tools/schemas/
      QAS_QUERY_DETAILS_RESP_MSG.VERSION_1">
         <QUERY_NAME>QUERY_WITH_EXPRESSION</QUERY_NAME>
         <DESCRIPTION>Example query</DESCRIPTION>
         <DESCRLONG>Sample query with expression, criterion and prompt</DESCRLONG>
         <QUERY_OWNER>QEDMO, Public</QUERY_OWNER>
         <CREATION_TIME>2009-05-15-192.0.2.000001</CREATION_TIME>
         <LAST_UPDATE_TIME>2009-05-15-192.0.2.000240</LAST_UPDATE_TIME>
         <PROMPT>
            <PROMPT_NUM>1</PROMPT_NUM>
            <PROMPT_NAME>QE_ORDER_NBR</PROMPT_NAME>
            <PROMPT_FLDNAME>QE_ORDER_NBR</PROMPT_FLDNAME>
            <PROMPT_UNIQUE_NAME>BIND1</PROMPT_UNIQUE_NAME>
            <PROMPT_EDITTYPE>Prompt table</PROMPT_EDITTYPE>
            <PROMPT_TABLE>QEORDER_HDR</PROMPT_TABLE>
            <PROMPT_FLDFORMAT>Upper</PROMPT_FLDFORMAT>
            <PROMPT_FLDDECIMALPOS>0</PROMPT_FLDDECIMALPOS>
            <PROMPT_FLDLENGTH>8</PROMPT_FLDLENGTH>
            <PROMPT_FLDTYPE>Character</PROMPT_FLDTYPE>
            <PROMPT_HEADING>Order</PROMPT_HEADING>
            <PROMPT_HEADINGTYPE>RFT Short</PROMPT_HEADINGTYPE>
         </PROMPT>
         <SELECT>
            <SELECTNUM>1</SELECTNUM>
            <PARENTSELECTNUM>0</PARENTSELECTNUM>
            <SELECTTYPE>Main</SELECTTYPE>
            <QRYDISTINCT>False</QRYDISTINCT>
         </SELECT>
         <RECORD>
            <RCDNUM>1</RCDNUM>
            <RCDNAME>QEORDER_DTL</RCDNAME>
            <RCDSELECTNUM>1</RCDSELECTNUM>
            <CORRNAME>A</CORRNAME>
         </RECORD>
         <FIELD>
            <FIELDNUM>1</FIELDNUM>
            <FIELDNAME>QE_ORDER_NBR</FIELDNAME>
            <DESCR>Order Number</DESCR>
            <FORMAT>CHAR 8</FORMAT>
            <AGGREGATE_TYPE>None</AGGREGATE_TYPE>
            <HEADING_TYPE>RFT Short</HEADING_TYPE>
            <HEADING>Order</HEADING>
            <FIELDSELECTNUM>1</FIELDSELECTNUM>
            <ORDERBYNUM>0</ORDERBYNUM>
            <ORDERBYDIR>Ascending</ORDERBYDIR>
            <COLUMNNUM>1</COLUMNNUM>
            <FIELDTYPE>Character</FIELDTYPE>
            <FIELDRCDALIAS>A</FIELDRCDALIAS>
         </FIELD>
         <FIELD>
            <FIELDNUM>2</FIELDNUM>
            <FIELDNAME>QE_ORDER_LINE_NBR</FIELDNAME>
            <DESCR>Order Line Number</DESCR>
            <FORMAT>NUMBER 3</FORMAT>
            <AGGREGATE_TYPE>None</AGGREGATE_TYPE>
            <HEADING_TYPE>RFT Short</HEADING_TYPE>
            <HEADING>Order Line</HEADING>
            <FIELDSELECTNUM>1</FIELDSELECTNUM>
            <ORDERBYNUM>0</ORDERBYNUM>
            <ORDERBYDIR>Ascending</ORDERBYDIR>
            <COLUMNNUM>2</COLUMNNUM>
            <FIELDTYPE>Number</FIELDTYPE>
            <FIELDRCDALIAS>A</FIELDRCDALIAS>
         </FIELD>
         <FIELD>
            <FIELDNUM>3</FIELDNUM>
            <FIELDNAME>QE_QTY</FIELDNAME>
            <DESCR>Quantity</DESCR>
            <FORMAT>SIGNED 17</FORMAT>
            <AGGREGATE_TYPE>None</AGGREGATE_TYPE>
            <HEADING_TYPE>RFT Short</HEADING_TYPE>
            <HEADING>Qty</HEADING>
            <FIELDSELECTNUM>1</FIELDSELECTNUM>
            <ORDERBYNUM>0</ORDERBYNUM>
            <ORDERBYDIR>Ascending</ORDERBYDIR>
            <COLUMNNUM>3</COLUMNNUM>
            <FIELDTYPE>Signed Number</FIELDTYPE>
            <FIELDRCDALIAS>A</FIELDRCDALIAS>
         </FIELD>
         <FIELD>
            <FIELDNUM>4</FIELDNUM>
            <FIELDNAME>QE_PRICE</FIELDNAME>
            <DESCR>Price</DESCR>
            <FORMAT>NUMBER 9</FORMAT>
            <AGGREGATE_TYPE>None</AGGREGATE_TYPE>
            <HEADING_TYPE>RFT Short</HEADING_TYPE>
            <HEADING>Price</HEADING>
            <FIELDSELECTNUM>1</FIELDSELECTNUM>
            <ORDERBYNUM>0</ORDERBYNUM>
            <ORDERBYDIR>Ascending</ORDERBYDIR>
            <COLUMNNUM>4</COLUMNNUM>
            <FIELDTYPE>Number</FIELDTYPE>
            <FIELDRCDALIAS>A</FIELDRCDALIAS>
         </FIELD>
         <FIELD>
            <FIELDNUM>5</FIELDNUM>
            <FIELDNAME>EXPR5_5</FIELDNAME>
            <DESCR/>
            <FORMAT>NUMBER 11</FORMAT>
            <AGGREGATE_TYPE>None</AGGREGATE_TYPE>
            <HEADING_TYPE>Text</HEADING_TYPE>
            <HEADING>A.QE_QTY*A.QE_PRICE</HEADING>
            <FIELDSELECTNUM>1</FIELDSELECTNUM>
            <ORDERBYNUM>0</ORDERBYNUM>
            <ORDERBYDIR>Ascending</ORDERBYDIR>
            <COLUMNNUM>5</COLUMNNUM>
            <FIELDTYPE>Number</FIELDTYPE>
            <FIELDRCDALIAS/>
         </FIELD>
         <CRITERION>
            <CRTNUM>1</CRTNUM>
            <CRTSELECTNUM>1</CRTSELECTNUM>
            <NEGATION>False</NEGATION>
            <LEFT_PARENTHESIS_LEVEL>0</LEFT_PARENTHESIS_LEVEL>
            <RIGHT_PARENTHESIS_LEVEL>0</RIGHT_PARENTHESIS_LEVEL>
            <CONDITION_TYPE>equal to</CONDITION_TYPE>
            <CRTEXP1TYPE>Field</CRTEXP1TYPE>
            <CRTEXP1RCDALIAS>A</CRTEXP1RCDALIAS>
            <CRTEXP1FIELD>QE_ORDER_NBR</CRTEXP1FIELD>
            <CRTEXP2TYPE>Prompt</CRTEXP2TYPE>
            <CRTEXP2TEXT>:1</CRTEXP2TEXT>
            <CRTLOGICALOPER>not used</CRTLOGICALOPER>
         </CRITERION>
         <EXPRESSION>
            <EXPNUM>1</EXPNUM>
            <EXPSELECTNUM>1</EXPSELECTNUM>
            <EXPTYPE>Number</EXPTYPE>
            <EXPTEXT>A.QE_QTY*A.QE_PRICE</EXPTEXT>
            <EXPLENGTH>11</EXPLENGTH>
            <EXPDECIMALPOS>2</EXPDECIMALPOS>
            <EXPAGGREGATE>False</EXPAGGREGATE>
         </EXPRESSION>
      </qcs:QAS_QUERY_DETAILS_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>