メンバー定義オブジェクト
メンバー定義オブジェクト
メンバー定義オブジェクトは、エンティティ定義にプロパティ定義またはリレーション定義のいずれかを定義します。
プロパティ定義
プロパティ定義には、ブール値、10 進数、整数、長整数、文字列、日時、ファイル参照、Json の 8 種類があります。それぞれは次のプロパティを指定します。
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | プロパティの種類。"Boolean"、"Decimal"、"Integer"、"Long"、"String"、"DateTime"、"FileReference"、または "Json" のいずれかを指定できます。 |
| name | 文字列 | プロパティの名前。 |
| labels | ラベル | このプロパティのラベル。 |
| is_indexed | ブール値 | このプロパティが検索可能である場合は true。 |
| is_mandatory | ブール値 | 検証でこのプロパティに値が必要な場合は true。 |
| is_multivalue | ブール値 | このプロパティに複数の値がある場合は true。 |
| is_multilanguage | ブール値 | このプロパティに複数の言語がある場合は true。 |
| is_display_property | ブール値 | このプロパティがエンティティの記述に使用される場合は true。エンティティ定義で true に設定できるプロパティは 1 つのみです。 |
"文字列"型のプロパティ定義では、次の 2 つのプロパティを追加で使用できます。
| 名前 | 型 | 説明 |
|---|---|---|
| is_multiline | ブール値 | この文字列プロパティで改行がサポートされている場合は true。 |
| validation_expression | 文字列 | プロパティ値が一致する必要がある正規表現を指定した文字列。 |
リレーション定義
リレーション定義は次のプロパティを指定します。
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | このメンバー定義をリレーション定義として定義するための "リレーション" を収めています。 |
| name | 文字列 | リレーションの名前。 |
| labels | ラベル | リレーションのラベル。 |
| role | 文字列 | リレーションの親側であるか子側であるかを示す "Parent" または "Child" が記述されています。 |
| is_indexed | ブール値 | このプロパティが検索をサポートしている場合は true。 |
| cardinality | 文字列 | このリレーションのカーディナリティを示す "OneToOne" または "OneToMany" のいずれかが記述されています。 |
| child_is_mandatory | ブール値 | このリレーションを有効にするために子が 1 つ以上必要な場合は true。 |
| parent_is_mandatory | ブール値 | このリレーションを有効にするために親が 1 つ以上必要な場合は true。 |
| Associated_entitydefinition | リンク | 関連するエンティティのエンティティ定義へのリンク。 |
| inherits_security | ブール値 | このリレーションがアクセス許可の解決に関与している場合は true。 |
例
表現の例については「エンティティ定義オブジェクト」を参照してください。