QAS_LISTQUERYPROMPTS_REST_GET

Use this service operation to retrieve a list of the prompts and associated prompt table for a specific query.

Request Message: QAS_LISTQUERYPROMPTS_TEMPL

Element Name Description

QueryName

Enter the complete Query Name. It is a required element.

OwnerType

Optionally, enter the query owner type.

If no value is entered, both public and private are searched.

isConnectedQuery

Indicate whether this is a connected query. It is a required element. Valid values are Y and N..

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-3 Example Request:

This request will return the prompt field and prompt table for the query TWO_PROMPT_QUERY.

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

Example 4-4 Example of an URI template

{OwnerType}/{QueryName}?isconnectedquery={IsConnectedQuery}&json_resp={json_response}

Response Message: QAS_LISTQUERYPROMPTS_RESP_MSG

Element Name Description

QueryName

Query name.

FieldName

If this prompt uses a translate table, the field name for the prompt is returned.

HeadingText

Heading text for the prompt.

FieldType

Prompt field type.

FormatText

Format for the text.

FieldLength

Field length for the prompt.

FieldDecimal

Number of decimal places in the prompt field.

UniquePromptName

The unique name used for the prompt. This value is case-sensitive.

EditType

The type of edit:

  • Translate table

  • Yes/No table

  • Prompt table

  • No table edit

PromptTable

If this prompt uses a prompt table, the table name is returned.

Example Response:

This response has two prompts, one for a prompt table and one for a translate table edit.

<?xml version="1.0"?>
<QAS_LISTQUERYPROMPTS_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_LISTQUERYPROMPTS_RESP_MSG.VERSION_1">
    <QAS_LISTQUERYPROMPTS_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERYPROMPTS_RESP.VERSION_1">
            <QueryName>MESSAGES_FOR_MSGSET</QueryName>
            <PTQASPRMPTWRK class="R">
                <FieldName>MESSAGE_SET_NBR</FieldName>
                <HeadingText>Message Set Number</HeadingText>
                <FieldType>decimal</FieldType>
                <FormatText>upper</FormatText>
                <FieldLength>5</FieldLength>
                <FieldDecimal>0</FieldDecimal>
                <UniquePromptName>MESSAGE_SET_NBR</UniquePromptName>
                <EditType>Prompt table</EditType>
                <PromptTable>PSMSGSETDEFN</PromptTable>
            </PTQASPRMPTWRK>
        </PTQASWRK>
    </QAS_LISTQUERYPROMPTS_RESP>
</QAS_LISTQUERYPROMPTS_RESP_MSG>

Example response

When the parameter json_response is set to true: 

{   "status": "success","data": {   "QueryPrompts": [   {"queryName": "MESSAGES_FOR_MSGSET","Prompts": [   {"fieldName": "MESSAGE_SET_NBR","headingText": "Message Set Number","fieldType": 
     "decimal","formatText": "upper","fieldLength": 5,"fieldDecimal": 0,
     "uniquePromptName":"MESSAGE_SET_NBR","editType": 
     "Prompt table","promptTable": "PSMSGSETDEFN"}	]}	]}}