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

RoleUpsert

Updates an existing role or inserts a new role.

Usage

Use the RoleUpsert method to insert a role or update an existing role. The Manage Roles and Access privilege is required. The Manage Company privilege is required to update the <ExpirePasswordIn> element.

The role is specified with the <RoleName> element of apdata:Role.

The apdata:Role argument contains the following elements containing role data:

• RoleName. The name of the role. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <RoleTranslation> element.
• Description. The role description.
• DefaultSalesProcess. The default sales process for new opportunities created by users who are assigned this role.
• ThemeName. The default theme for the role.
• ModernThemeName. The tablet theme for the role.
• LeadConversionLayout. The lead conversion layout for the users assigned this role.
• ActionBarLayout. The action bar layout for the users assigned this role.
• RelatedInfoFormat. The format for related information sections on record Detail pages, which can be shown as lists or as tabs.
• ExpirePasswordIn. The length of time for which the password of users assigned this role is valid. Possible values are: 30 days, 60 days, 90 days, 180 days, One Year, Never expires. If no value is specified, then the password expiry period that is defined for the company applies to users who have this role.
• LimitRecordsInListExport. The maximum number of records that users who have this role can export at one time when exporting a list of records through the Export List menu option on List pages. By default, no restriction is applied and this element is empty. This element corresponds to the Maximum Number of Records per List Export field in the UI.

  NOTE:  If a maxumum is specified, it applies only to exports that are performed through the Export List menu option on List pages. It does not apply to export operations that are performed through the Export Assistant or through any other channel.

• ListOfRoleTranslation. The role name in the languages activated for your company:
  • LanguageCode. The three-letter language code for the language.
  • RoleName. The role name in the language identified by the language code.
• ListOfRecordTypeAccess. The record type access data:
  • RecordName. The record type.
  • HasAccess. Whether users assigned this role have access to records of this type.
  • CanCreate. Whether users assigned this role can create records of this type.
  • CanReadAll. Whether users assigned this role can see all records of this type.
• AccessProfile. The access profiles associated with the role:
  • DefaultAccessProfile. The default access profile.
  • OwnerAccessProfile. The owner access profile.
• ListOfPrivilege. The privileges associated with the role:
  • PrivilegeName. A privilege ID, equivalent to the name of a privilege in the Oracle CRM On Demand application. See Oracle Migration Tool On Demand Guide for reference tables about the mapping of privilege IDs to UI display names for the privileges.
  • Enabled. Whether the privilege is assigned to the role.
• TabAccessandOrder. The tabs available and selected for the role:
  • ListOfAvailableTab. The available tabs:
    • AvailableTab. The name of the tab.
  • ListOfSelectedTab. The selected tabs:
    • TabName. The name of the tab.
    • Order. The position in which the tab name appears in the Selected Tabs list. A value of 0 (zero) corresponds to the first tab in the Selected Tabs list.
• ListOfPageLayoutAssignment. The page layout assignment for each record type:
  • PageViewType. The page view type: Static or Dynamic.
  • RecordType. The record type.
  • LayoutName. The name of the page layout. If no name is specified, the default layout is applied.
• ListOfSearchLayoutAssignment. The search layout assignment for each record type:
  • RecordType. The record type.
  • LayoutName. The name of the search layout.
• ListOfHomepageLayoutAssignment. The homepage layout assignment for each record type:
  • RecordType. The record type.
  • LayoutName. The name of the homepage layout.

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

• Mappings of three-letter language codes to languages.
• Information on privilege IDs, and their corresponding names, and descriptions.

Arguments

Table 165 describes the arguments taken by the RoleUpsert method.

Return Value of the Call

The status is returned.