Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Administrative Services API Calls >

FieldManagementUpsert

Updates existing field management data or inserts field management data for an object.

Usage

Use the FieldManagementUpsert method to insert field management data or update existing field management data for an object.

The object is specified with the <ObjectName> child element of apData:FieldSet.

The apdata:FieldSet argument contains the following elements containing field management data:

• Name. The system name of the field.
• DisplayName. The name of the field used in the UI. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <FieldManagementTranslation> element.
• FieldType. The type of field.
• IntegrationTag. The field's custom integration tag name. This tag can be modified by the user.
• GenericIntegrationTag. The field's default integration tag name assigned by Oracle CRM On Demand. This tag cannot be modified by the user. The default integration tag name has the format fieldtypeDisplay_Name. For example, stMy_Custom_Field would be assigned to a custom field of type Text (Short) with the display name of My Custom Field.

  NOTE:  For noncustom fields, the <GenericIntegrationTag> and <IntegrationTag> values are the same.

• Required. Whether the field is a required field (true), or is not a required field (false).
• RequiredCondition. An expression used to determine whether the field is required. If the <Required> element is set to true, any value in the <RequiredCondition> element produces an error message. For more information about conditionally-required fields, see Oracle CRM On Demand Online Help.
• ReadOnly. Whether the field is a read-only field (true), or is not a read-only field (false).
• Optimized. Whether the field is an optimized custom field. You cannot update this value.
• DefaultValue. The default value of the field.
• FieldValidation. The expression for the field validation rules for the field.
• PostDefault. Whether the field is prepopulated with the default value when a user creates a new record and the record is saved.
• DenormalizedControl. This maps to the Related Information check box in field management.

  For Custom Object record types and certain other record types, you can create custom related information fields. For these record types, the following fields are available on the Field Edit page in the UI: Related Information, Related Record Type, and Related Field. These fields are used only for creating custom related information fields. Most of the other fields on the Field Edit page become read-only fields after you select the Related Information check box. For more information about custom related information fields, see Oracle CRM On Demand Online Help.

• DenormalizedAssociateControlName. This maps to the Related Record Type picklist in field management.
• DenormalizedControlName. This maps to the Related Field picklist in field management.
• ValidationErrorMsg. The custom error message displayed if the field fails field validation.
• TooltipFormat. The format of the tooltip text, which can be HTML or Plain Text.
• TooltipText. The tooltip text that is displayed for the field in the UI.
• Description. Additional information about the field.
• ListOfFieldTranslations. The field management data in the languages activated for your company:
  • LanguageCode. The three-letter language code for the language.
  • DisplayName. The display name of the field in the language identified by the language code.
  • ValidationErrorMsg. The custom validation error message in the language identified by the language code.
  • TooltipText. The tooltip text for the field in the language identified by the language code.
  • Description. The description of the field in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.
• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about field management, including field validation, see Oracle CRM On Demand Online Help.

Arguments

Table 120 describes the arguments taken by the FieldManagementUpsert method.

Return Value of the Call

The status is returned.