QAS_RECORD_DEFN_OPER

Use this service operation to return the definition of a given record, including field descriptions and key information.

Request Message: QAS_RECORD_DEFN_REQ_MSG

Element Name	Description
RECORD_NAME Required element	Complete record name. Required.

Example Request:

This request will return the record definition for PSMSGCATDEFN.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_RECORD_DEFN_REQ_MSG.VERISON_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_RECORD_DEFN_REQ_MSG>
         <RECORD_NAME>psmsgcatdefn</RECORD_NAME>
      </qas:QAS_RECORD_DEFN_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>
   

Response Message: QAS_RECORD_DEFN_RESP_MSG

Element Name	Description
RECORD_NAME	Record name.
FIELD_NAME	Field name.
FIELD_DESCRIPTION	Field description.
KEY	Indicates whether this field is a key; value will be Yes or No.
FIELD_TYPE	Field type.
FIELD_LENGTH	Field length.
FIELD_LOOKUP_TABLE	Prompt table name, if applicable.
FIELD_EDIT_TYPE	Field edit type is a 32-bit binary number. Counting from 1 from the right, a 1 in bit 10 indicates translate values, a 1 in bit 14 indicates a yes/no table, and a 1 in bit 15 indicates a prompt table. Client applications need to do bit-wise AND on this value. For example, the value 2337 represents: Key = 1 Search item = 2048 List item = 32 Required = 256 See PeopleCode API Reference: Flag property: QueryDBRecordField class.
FIELD_SHORT_NAME	Short name.
FIELD_LONG_NAME	Long name.
INFORMATION_MESSAGE	Returns information about the request. For example if the criterion in the request is incorrect or if no records 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_RECORD_DEFN_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
       Enterprise/Tools/schemas/QAS_RECORD_DEFN_RESP_MSG.VERSION_1">
         <RECORD_NAME>PSMSGCATDEFN</RECORD_NAME>
         <FIELD>
            <FIELD_NAME>MESSAGE_SET_NBR</FIELD_NAME>
            <FIELD_DESCRIPTION>Message Set Number</FIELD_DESCRIPTION>
            <KEY>Yes</KEY>
            <FIELD_TYPE>Number</FIELD_TYPE>
            <FIELD_LENGTH>5</FIELD_LENGTH>
            <FIELD_LOOKUP_TABLE/>
            <FIELD_EDIT_TYPE>2337</FIELD_EDIT_TYPE>
            <FIELD_SHORT_NAME>Set</FIELD_SHORT_NAME>
            <FIELD_LONG_NAME>Message Set Number</FIELD_LONG_NAME>
         </FIELD>
         <FIELD>
            <FIELD_NAME>MESSAGE_NBR</FIELD_NAME>
            <FIELD_DESCRIPTION>Message Number</FIELD_DESCRIPTION>
            <KEY>Yes</KEY>
            <FIELD_TYPE>Number</FIELD_TYPE>
            <FIELD_LENGTH>5</FIELD_LENGTH>
            <FIELD_LOOKUP_TABLE/>
            <FIELD_EDIT_TYPE>2337</FIELD_EDIT_TYPE>
            <FIELD_SHORT_NAME>Msg</FIELD_SHORT_NAME>
            <FIELD_LONG_NAME>Message Number</FIELD_LONG_NAME>
         </FIELD>
         <FIELD>
            <FIELD_NAME>MESSAGE_TEXT</FIELD_NAME>
            <FIELD_DESCRIPTION>Message Text</FIELD_DESCRIPTION>
            <KEY>No</KEY>
            <FIELD_TYPE>Character</FIELD_TYPE>
            <FIELD_LENGTH>100</FIELD_LENGTH>
            <FIELD_LOOKUP_TABLE/>
            <FIELD_EDIT_TYPE>33554720</FIELD_EDIT_TYPE>
            <FIELD_SHORT_NAME>Message</FIELD_SHORT_NAME>
            <FIELD_LONG_NAME>Message Text</FIELD_LONG_NAME>
         </FIELD>
         .....
      </qcs:QAS_RECORD_DEFN_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>