Adding Fields to Query Content
This section describes the service operations that are available for adding fields to a query. These include:
QAS SOAP based service
QAS_FIELDS_OPER
QAS_FIELDS_PROPS_OPER
QAS RESTful based service
QAS_FIELDS_REST_GET
QAS_FIELDS_PROPS_REST_GET
Use this service operation to return the fields from all records that the user can access.
Request Message: QAS_FIELDS_REQ_MSG
Element Name |
Description |
---|---|
SEARCH_STRING Required element |
Search string used for specifying the field name or the first few characters of the field name. If a string is not entered, fields from all records that are the user can access will be returned. |
Example Request:
This request will return all the fields that start with MESSAGE_N.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_FIELDS_REQ_MSG.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<qas:QAS_FIELDS_REQ_MSG>
<SEARCH_STRING>MESSAGE_N</SEARCH_STRING>
</qas:QAS_FIELDS_REQ_MSG>
</soapenv:Body>
</soapenv:Envelope>
Response Message: QAS_FIELDS_RESP_MSG
Element Name |
Description |
---|---|
FIELD_NAME |
Field name. |
INFO_MESSAGE |
Returns information about the request. For example if the criterion in the request is incorrect or if no fields meet the criteria, a message indicating the error is returned. |
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_FIELDS_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_FIELDS_RESP_MSG.VERSION_1">
<FIELD_NAME>MESSAGE_NBR</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR01</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR02</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR03</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR04</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR05</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR06</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR07</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR08</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR09</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR10</FIELD_NAME>
</qcs:QAS_FIELDS_RESP_MSG>
</soapenv:Body>
</soapenv:Envelope>
Use this service operation to return the fields from all records that the user can access.
Request Message: QAS_FIELDS_TEMPL
Element Name |
Description |
---|---|
SEARCH_STRING Required element |
Search string used for specifying the field name or the first few characters of the field name. If a string is not entered, fields from all records that are the user can access will be returned. |
Example Request:
This request will return all the fields that start with MESSAGE_N.
https://<servername>:<port>/PSIGW/RESTListeningConnector/<default local node>/Fields.v1/getfields?search=MESSAGE_N
Response Message: QAS_FIELDS_RESP_MSG
Element Name |
Description |
---|---|
FIELD_NAME |
Field name. |
INFO_MESSAGE |
Returns information about the request. For example if the criterion in the request is incorrect or if no fields meet the criteria, a message indicating the error is returned. |
Example Response:
<?xml version="1.0"?>
<qcs:QAS_FIELDS_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_FIELDS_RESP_MSG.VERSION_1">
<FIELD_NAME>MESSAGE_NBR</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR01</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR02</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR03</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR04</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR05</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR06</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR07</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR08</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR09</FIELD_NAME>
<FIELD_NAME>MESSAGE_NBR10</FIELD_NAME>
</qcs:QAS_FIELDS_RESP_MSG>
Use this service operation to return the properties of a given field.
Request Message: QAS_FIELD_PROPS_REQ_MSG
Element Name |
Description |
---|---|
FIELD_NAME Required element |
Complete field name. Required. |
Example Request:
This request message will return the details for field MESSAGE_NBR.
Response Message: QAS_FIELD_PROPS_RESP_MSG
Element Name |
Description |
---|---|
FIELD_NAME |
Field name. |
FIELD_DESCRIPTION |
Field description. |
FIELD_TYPE |
Field type. Valid values are:
|
FIELD_FORMAT |
Field format. Valid values are:
|
FIELD_LENGTH |
Field length. |
FIELD_DECIMALS |
Number of decimal positions. |
FIELD_SHORT_NAME |
Field's short name. |
FIELD_LONG_NAME |
Field's long name. |
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_FIELD_PROPS_RESP_MSG
xmlns:qcs="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_FIELD_PROPS_RESP_MSG.VERSION_1">
<PROPERTY>
<FIELD_NAME>MESSAGE_NBR</FIELD_NAME>
<FIELD_DESCRIPTION>Message Number</FIELD_DESCRIPTION>
<FIELD_TYPE>Number</FIELD_TYPE>
<FIELD_FORMAT>None</FIELD_FORMAT>
<FIELD_LENGTH>5</FIELD_LENGTH>
<FIELD_DECIMALS>0</FIELD_DECIMALS>
<FIELD_SHORT_NAME>Msg</FIELD_SHORT_NAME>
<FIELD_LONG_NAME>Message Number</FIELD_LONG_NAME>
</PROPERTY>
</qcs:QAS_FIELD_PROPS_RESP_MSG>
</soapenv:Body>
</soapenv:Envelope>
Use this service operation to return the properties of a given field.
Request Message: QAS_FIELD_PROPS_TEMPL
Element Name |
Description |
---|---|
FIELD_NAME Required element |
Complete field name. Required. |
Example Request:
This request message will return the details for field MESSAGE_NBR.
https://<servername>:<port>/PSIGW/RESTListeningConnector/<default local node>/FieldProperties.v1/MESSAGE_NBR
Response Message: QAS_FIELD_PROPS_REST_RESP_MSG
Element Name |
Description |
---|---|
FIELD_NAME |
Field name. |
FIELD_DESCRIPTION |
Field description. |
FIELD_TYPE |
Field type. Valid values are:
|
FIELD_FORMAT |
Field format. Valid values are:
|
FIELD_LENGTH |
Field length. |
FIELD_DECIMALS |
Number of decimal positions. |
FIELD_SHORT_NAME |
Field's short name. |
FIELD_LONG_NAME |
Field's long name. |
Example Response:
<?xml version="1.0"?>
<qcs:QAS_FIELD_PROPS_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_FIELD_PROPS_RESP_MSG.VERSION_1">
<PROPERTY>
<FIELD_NAME>MESSAGE_NBR</FIELD_NAME>
<FIELD_DESCRIPTION>
Message Number. This field refers to the Message
Number in the Message Catalog.
</FIELD_DESCRIPTION>
<FIELD_TYPE>Number</FIELD_TYPE>
<FIELD_FORMAT>None</FIELD_FORMAT>
<FIELD_LENGTH>5</FIELD_LENGTH>
<FIELD_DECIMALS>0</FIELD_DECIMALS>
<FIELD_SHORT_NAME>?</FIELD_SHORT_NAME>
<FIELD_LONG_NAME>?</FIELD_LONG_NAME>
</PROPERTY>
</qcs:QAS_FIELD_PROPS_RESP_MSG>