mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 23:41:31 +08:00
95 lines
6.2 KiB
JSON
95 lines
6.2 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"supported_soap_calls",
|
|||
|
|
"supported_rest_api_http_methods",
|
|||
|
|
"fields",
|
|||
|
|
"validationrule_metadata",
|
|||
|
|
"wsdl_segment"
|
|||
|
|
],
|
|||
|
|
"title": "ValidationRule - Tooling API",
|
|||
|
|
"description": "Represents a validation rule or workflow rule which specifies the formula for when a condition is met. Available from API version 34.0 or later.",
|
|||
|
|
"supported_soap_calls": "`create()`, `delete()`, `query()`, `retrieve()`, `update()`, `upsert()`",
|
|||
|
|
"supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"properties",
|
|||
|
|
"description"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"Active": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"properties": "Defaulted on create, Filter, Group, Sort.",
|
|||
|
|
"description": "Indicates whether this validation rule is active, (true), or not active (false).",
|
|||
|
|
"required": true
|
|||
|
|
},
|
|||
|
|
"Description": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Nillable, Sort.",
|
|||
|
|
"description": "A description of the validation rule."
|
|||
|
|
},
|
|||
|
|
"EntityDefinition": {
|
|||
|
|
"type": "EntityDefinition",
|
|||
|
|
"properties": "Filter, Group, Sort.",
|
|||
|
|
"description": "The entity definition for the object associated with the validation rule.",
|
|||
|
|
"required": true
|
|||
|
|
},
|
|||
|
|
"EntityDefinitionId": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort.",
|
|||
|
|
"description": "ID of the record in EntityDefinition.",
|
|||
|
|
"required": true
|
|||
|
|
},
|
|||
|
|
"ErrorDisplayField": {
|
|||
|
|
"type": "string",
|
|||
|
|
"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",
|
|||
|
|
"properties": "Filter, Group, Nillable, Sort .",
|
|||
|
|
"description": "The message that appears if the validation rule fails. The message must be 255 characters or less.",
|
|||
|
|
"required": true
|
|||
|
|
},
|
|||
|
|
"FullName": {
|
|||
|
|
"type": "string",
|
|||
|
|
"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."
|
|||
|
|
},
|
|||
|
|
"Id": {
|
|||
|
|
"type": "Id",
|
|||
|
|
"properties": "Defaulted on create, Filter, Group, idLookup, Sort.",
|
|||
|
|
"description": "The unique system ID for this record."
|
|||
|
|
},
|
|||
|
|
"ManageableState": {
|
|||
|
|
"type": "ManageableState enumerated list",
|
|||
|
|
"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"
|
|||
|
|
},
|
|||
|
|
"Metadata": {
|
|||
|
|
"type": "ValidationRule Metadata",
|
|||
|
|
"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",
|
|||
|
|
"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",
|
|||
|
|
"properties": "Filter, Group, Namefield, Sort.",
|
|||
|
|
"description": "The name or ID of the object that this rule is associated with."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"validationrule_metadata": {
|
|||
|
|
"errorConditionFormula": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The formula defined in the validation rule. If the formula returns a value of true, an error message is displayed.",
|
|||
|
|
"required": true
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"wsdl_segment": "```xml\n<xsd:complexType name=\"ValidationRule\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:ValidationRule\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"ValidationRule\">\n <xsd:complexContent>\n <xsd:extension base=\"mns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"active\" type=\"xsd:boolean\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"errorConditionFormula\" type=\"xsd:string\"/>\n <xsd:element name=\"errorDisplayField\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"errorMessage\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
|
|||
|
|
}
|