ValidationRule

Represents a validation rule or workflow rule which specifies the formula for when a condition is met.

Version 

Introduced in API version 34.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

Active 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Required. Indicates whether this validation rule is active, (true), or not active (false).

• Default value: false

Description 

• Type: string

• Required: No

• Properties: Filter, Nillable, Sort

• Description: A description of the validation rule.

EntityDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. ID of the record in EntityDefinition.

ErrorDisplayField 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The fully specified name of a field in the application. If a value is supplied, the error message appears next to the specified field. If you do not specify a value or the field isn’t visible on the page layout, the value changes automatically to Top of Page.

ErrorMessage 

• Type: string

• Required: No

• Properties: Filter, Nillable, Sort

• Description: Required. The message that appears if the validation rule fails. The message must be 255 characters or less.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Description: The internal name of the object. White spaces and special characters are escaped for validity. The name must:

• Contain characters, letters, or the underscore (_) character

• Must start with a letter

• Can’t end with an underscore

• Can’t contain two consecutive underscore characters.

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.

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: Validation rule metadata.

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.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

• In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

ValidationName 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The name or ID of the object that this rule is associated with.

ValidationRule Metadata 

active, description, errorDisplayField, and errorMessage are described in the previous table.

Field Name	Details
errorConditionFormula	- Type: string - Properties: Filter, Group, Nillable, Sort - Description: Required. The formula defined in the validation rule. If the formula returns a value of true, an error message is displayed.