Oracle CRM On Demand REST API Developer's Guide > Using the Oracle CRM On Demand REST API > Retrieving Metadata about Oracle CRM On Demand Resources >

Describe Field Attributes


Table 18 contains the describe field attributes returned in the REST API response.

Table 18. Describe Field Attributes
Attribute
Description

name

Indicates the REST integration tag name.

type

Indicates the field type.

updatable

Indicates whether the field is read-only.

mandatory

Indicates whether the field is required and must contain a value.

queryable

Indicates whether the field is searchable.

title

Indicates the display name.

controlType

Indicates how users select the value for a filter.

The choices are to select the value from a calendar, a drop-down list, or a multiple list of values, or type it into an edit box.

maxLength

Indicates the maximum length of the field.

currencyCode

Indicates the currency code when applicable.

markfortranslation

Indicates whether an administrator needs a translator to enter the field's title in another language.

copyenabled

Indicates which fields can be copied using the Copy button.

optimized

Indicates if the field is optimized to improve performance during searches and when sorting lists.

postdefault

Indicates the field is not prepopulated with the specified value when a user creates a new record, but the field takes the specified default value when the record is saved, if:

  • The user leaves the field blank.
  • The field is hidden from the layout.
  • A value has not been supplied by the integration tools.

fieldvalidation

Indicates whether field validation is performed for a field to ensure that it has a particular value.

fieldvalidationerrormessage

The field validation error message.

casesensitivity

Indicates whether the field is case sensitive. The default value is false.

htmlfieldtag

The name of the HTML field tag.

customwsintegrationtag

The name of the custom integration tag.

Oracle CRM On Demand REST API Developer's Guide, Release 32 Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.