QAS_FIELDS_PROPS_REST_GET

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:

  • Date

  • Time

  • Datetime

  • Character

  • Long Character

  • Number

  • Signed Number

  • Image

  • Image Reference

  • File

FIELD_FORMAT

Field format. Valid values are:

  • None

  • Name

  • Phone

  • Zip Code

  • Social Security Number

  • Upper

  • Mixed Case

  • Century

  • Numbers Only

  • Social Insurance Number

  • International Phone Number

  • International Postal Code

  • Seconds

  • Microseconds

  • Century/Seconds

  • Century/Microseconds

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>