--- schema_version: "1" id: 2c65912bd3c13b24a374f3b01111fa40f27299241f164e6766f84f5f085a10e3 title: AnimationRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_animationrule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_animationrule.htm source_site: developer.salesforce.com content_type: documentation content_hash: 283e3e0f56ae542689ab8ae5e163cb4cc84889293acc083bb0dc9acc4882009f description: Represents criteria for determining when an animation is displayed to Path users. Available in API version 46.0 and later. --- # AnimationRule Represents criteria for determining when an animation is displayed to Path users. Available in API version 46.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name. ## Supported SOAP Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST HTTP Methods DELETE, GET, PATCH, POST ## Fields | Field | Details | | --- | --- | | AnimationFrequency | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The frequency with which an animation is displayed when a user selects the designated picklist values in a path. Valid values are: - always - often - sometimes - rarely A value of always triggers an animation every time. The values often, sometimes, and rarely trigger an animation progressively less frequently. | | DeveloperName | Type string Properties Filter, Group, Sort, Update Description The developer name for the animation rule. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FullName | Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | IsActive | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the animation rule is active (true) or not (false). | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language in the user’s personal settings. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description The label for the animation rule. | | Metadata | Type complexvalue Properties Create, Nillable, Update Description AnimationRule metadata from the mns namespace. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | RecordTypeContext | Type picklist Properties Filter, Group, Restricted picklist, Sort Description An enum to track whether this AnimationRule applies to all record types for the associated sObject, or only to a single or main record type. Valid values are All, Custom, and Master. | | RecordTypeId | Type reference Properties Filter, Group, Nillable, Sort Description The record type selected for the sObject in which the animation is displayed. | | SobjectType | Type string Properties Filter, Group, Restricted picklist, Sort Description The object on which the animation rule is run. | | TargetField | Type string Properties Filter, Group, Restricted picklist, Sort Description Name of the field used to determine when to display an animation. | | TargetFieldChangeToValues | Type string Properties Filter, Group, Sort Description Values used to determine when to display an animation. When a user selects a value in TargetField that matches a value stored in TargetFieldChangeToValues, the animation is displayed. |