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

CustomWebLinkUpsert

Updates custom Web link data or inserts new custom Web link data for an object.

Usage

Use the CustomWebLinkUpsert method to insert custom Web link or update existing custom Web link data for an object.

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

The apdata:WebLinkSet argument contains the following elements containing custom Web link data:

• Name. The name of the custom Web link field. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <WebLinkTranslation> element.
• IntegrationTag. The field's integration tag name.
• DisplayText. The label for the hyperlink of the custom Web link.
• WebLinkTarget. The behavior when a user clicks the hyperlink. Open in Current window, Open in Custom Tab, or Open in New window.
• TargetCustomWebTab. The required custom Web tab, if Open in Custom Tab is specified for WebLinkTarget.
• RefreshParentWindow. Whether the parent window is refreshed after a new window is opened. Only applicable if Open in New window is specified for WebLinkTarget.
• DisplayOptions. A character indicating the pages where the custom Web link is displayed: D for Detail Page, E for Edit Page, or B for Both.
• ActiveLinkCondition. The condition that controls whether the custom Web link is active on the Detail and Edit pages.
• DisplayLinkCondition. The condition that controls whether the custom Web link is visible on the Detail and Edit pages.
• URL. The URL that is invoked when the user clicks the custom Web link.
• ListOfWebLinkTranslations. The display names in the languages activated for your company:
  • DisplayName. The display name of the custom Web link in the language identified by the language code.
  • DisplayText. The label for the hyperlink, in the language identified by the language code.
  • LangCode. The three-letter language code for the language.

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 custom Web links, see Oracle CRM On Demand Online Help.

NOTE:  Internally, concatenated fields are custom Web links, however you cannot use the CustomWebLinkUpsert method to update or insert concatenated field data.

Arguments

Table 97 describes the arguments taken by the CustomWebLinkUpsert method.

Return Value of the Call

The status is returned.