Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

BriefcaseRule

Represents a rule that specifies records for a briefcase definition. This object is available in API version 50.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field	Details
BriefcaseId	Type reference Properties Filter, Group, Sort Description Required. ID of the briefcase definition. Label is Briefcase Definition ID.
FilterLogic	Type string Properties Filter, Group, Nillable, Sort Description The filter logic for record selection, for example, `1 AND 2` where 1 and 2 correspond to filter 1 and filter 2. Filter logic operators include `AND` and `OR`. Limited to 255 characters. Label is Filter Logic.
IsAscendingOrder	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates whether the records should be sorted in ascending order. Label is Ascending.
OrderBy	Type picklist Properties Nillable, Restricted picklist Description The field to order the records by, which determines how the records can be sorted. For example, `AccountName` or `CreatedBy`. Label is Order By.
QueryScope	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. A group of records to restrict the scope of this rule. Possible values are: `assignedToMe` `everything` The default value is `everything` (All Records). The value `assignedToMe` is available only for the `ServiceAppointment` object.
RecordLimit	Type int Properties Filter, Group, Nillable, Sort Description The record limit for the object. The recommended number for record limit is up to 500 records per object for optimal performance. The maximum number is 2000. Label is Limit.
TargetEntity	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The standard or custom object that the briefcase rule evaluates. Label is Target Object.