メタデータ API 開発者ガイド
jValidationRule
入力規則を表します。入力規則は、ユーザがレコードに入力したデータが有効で保存可能かどうかを確認するために使用されます。入力規則には、1 つ以上の項目のデータを評価する数式が含まれ、true または false の値を返します。入力規則には、無効なデータによりルールが true の値を返すときに、クライアントアプリケーションがユーザに表示できるエラーメッセージも含まれます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
API バージョン 20.0 の時点で、入力規則には複合項目を設定できません。複合項目の例には、住所、姓名、連動選択リスト、連動ルックアップがあります。
バージョン
入力規則は、API バージョン 12.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| active | boolean | 必須。この入力規則が有効であるか (true)、否か (false) を示します。 |
| description | string | 入力規則の説明。 |
| errorConditionFormula | string |
必須。入力規則で定義される数式。数式で true の値が返されると、エラーメッセージが表示されます。
Salesforce オンラインヘルプの「入力規則の定義」を参照してください。 |
| errorDisplayField | string | アプリケーション内の項目の完全に指定された名前。値を指定すると、指定した項目の横にエラーメッセージが表示されます。値を指定しない場合や、項目がページレイアウトに表示されない場合、自動的に値が Top of Page に変更されます。 |
| errorMessage | string | 必須。入力規則が失敗した場合に表示されるメッセージ。メッセージは 255 文字以下にする必要があります。 |
| fullName | string |
オブジェクトの内部名。有効性のために空白と特殊文字はエスケープされます。名前は次の条件を満たしている必要があります。
この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。 |
宣言的なメタデータの定義のサンプル
カスタムオブジェクトの入力規則の XML 定義のサンプルを以下に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <deploymentStatus>Deployed</deploymentStatus>
4 <fields>
5 <fullName>Mommy_Cat__c</fullName>
6 <label>Mommy Cat</label>
7 <referenceTo>Cat__c</referenceTo>
8 <relationshipName>Cats</relationshipName>
9 <type>Lookup</type>
10 </fields>
11 <label>Cat</label>
12 <nameField>
13 <label>Cat Name</label>
14 <type>Text</type>
15 </nameField>
16 <pluralLabel>Cats</pluralLabel>
17 <sharingModel>ReadWrite</sharingModel>
18 <validationRules>
19 <fullName>CatsRule</fullName>
20 <active>true</active>
21 <errorConditionFormula>OR(Name = 'Milo',Name = 'Moop')</errorConditionFormula>
22 <validationMessage>Name must be that of one of my cats</validationMessage>
23 </validationRules>
24</CustomObject>