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

AssignmentRuleGroupUpsert


Updates assignment rule group configuration data.

Usage

Use the AssignmentRuleGroupUpsert method to insert or update assignment rule group data. The Data Rules and Assignment privilege is required.

The apData:AssignmentRuleGroup argument contains the following elements specifying the data for the assignment rule group:

  • RecordType. The record type: Account, Lead, Opportunity, or Service Request.
  • RuleGroupName. The name of the rule group.
  • Active. Whether the rule group is active.
  • UnassignedOwner. A user who inherits the records that are not assigned by one of the rules.
  • UnassignedTerritory. For account and opportunity rule groups only, a territory that inherits the records that are not assigned by one of the rules.
  • ReturnEmail. For lead and service request rule groups only, the email address that appears in the Sender field in the email notifications that are sent to the owners of leads and service requests.
  • ListOfRule. Contains all of the rule data, in the following child elements of <AssignmentRule>:
    • RuleName. The name of the rule.
    • Order. The order in which the rules are evaluated.
    • AssignTo. The user to whom the record is assigned, if the rule criteria are met.
    • EmailNotification. Whether an email notification is sent to the user to whom the record is assigned. This field is applicable for the Service Request record type only.
    • AssignToTerritory. For account and opportunity rules only, the territory to which the record is assigned, if the rule criteria are met.
    • IncludeTeamAssignment. For account and opportunity rules only, whether team members are assigned to the account, if the rule criteria are met.
    • IncludeRelatedContacts. For account rules only, whether contacts linked to the account are assigned to the specified account owner and territory if the rule criteria are met.
    • IncludeRelatedOpportunities. For account rules only, whether opportunities linked to the account are assigned to the specified account owner and territory if the rule criteria are met.

You use <RecordType> + <RuleGroupName> to identify rule groups for upsert operations.

You can use the following combinations of fields to identify rules for upsert operations:

  1. <RuleGroupName> + <RecordType> + <RuleName>
  2. <RuleGroupName> + <RecordType> + <Order>

If both of these user key combinations have matches, user key 1 takes priority over user key 2. Upserts without a value for <Order> return an error.

For information about assignment rules, see Oracle CRM On Demand Online Help.

Arguments

Table 82 describes the arguments taken by the AssignmentRuleGroupUpsert method.

Table 82. Arguments Taken by the AssignmentRuleGroupUpsert Method
Name
Description
Required
Default
I/O

apData:AssignmentRuleGroup

The assignment rule group data to be updated or inserted.

Yes

Not applicable

Input

Status

The status of the call.

Not applicable

Not applicable

Output

Return Value of the Call

The status is returned.

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.