データベースに必須のプロパティ

データモデルでは、一部のエンティティフィールドが必須です。フィールドの値を指定せずにエンティティのインスタンスを作成できません。また、値は null にすることができません。例えば、ある保険会社が、すべてのアクティビティに終了日（完了予想日）を設定する必要があるというビジネスルールを適用しているとします。これを強制するために、Activity エンティティの EndDate フィールドは必須です。このようなフィールドは、データベースに必須と呼ばれることがあります。

スキーマでは、データベースに必須であることを反映するようにリソースプロパティをコンフィギュレーションできます。これを行うには、次のプロパティを設定する必要があります。

• "requiredForCreate": true
  • この x-gw-extensions 属性は、プロパティを POST ペイロードに含める必要があることを示します。
• "x-gw-nullable": false
  • この属性は、プロパティが指定された場合は、その値を null に設定できないことを示します。

"requiredForCreate": true 属性自体は、プロパティを POST で指定する必要があることを指示するだけです。呼び出し元がプロパティを含めるが、その値を null に設定しないようにする手段はありません。

"x-gw-nullable": false 属性自体は、プロパティが指定された場合は、その値を null に設定できないことを指示するだけです。呼び出し元がプロパティを省略しないようにする手段はありません。

2 つの式を組み合わせることによって、プロパティを POST で指定して、非 null 値に設定し、その後でプロパティが指定された場合は、必ず、非 null 値に設定する必要があることを指示します。これは、データモデルエンティティフィールドを必須に設定することと等価です。

例えば、CustomEntity_Ext エンティティに文字列の CustomDescription フィールドがあるとします。このフィールドは必須です。プロパティ宣言は次のようになります。

  "definitions": {
    "CustomEntityExt": {
      ...
      "properties": {
        ...
        "customDescription": {
          "type": "string",
          "x-gw-nullable": false,
          "x-gw-extensions": {
            "requiredForCreate": true
          }
        }
        ...