生成エンドポイントのアップデータファイルのコンフィギュレーション

1 つ以上の API リソースが列挙される updaters セクションが、アップデータファイルにあります。リソースごとに、以下の属性が指定されます。

• リソースの構造を定義する schemaDefinition
  • これは、schema.json ファイル内で宣言されたスキーマを参照します。
• このリソースに関するマッピング情報の root として機能するデータモデルエンティティ。
• properties のリスト
  • 各プロパティに 1 つの path 属性が含まれています。これにより、リソースプロパティごとに、リソースフィールドプロパティが書き込まれるデータモデルエンティティプロパティが定義されます。
  • プロパティの特性によっては、追加の属性が存在する場合があります。

例えば、ベースコンフィギュレーションの Activity リソースでアップデータの部分を以下に示します。

"Activity": {
  "schemaDefinition": "Activity",
  "root": "entity.Activity",
  "properties": {
    "description": {
      "path": "Activity.Description"
    },
    "mandatory": {
      "path": "Activity.Mandatory"
    },
    ...

次の点に注目します。

• 名前が Activity であるスキーマでこのリソースは定義されます（このスキーマは、他の schema.json ファイルで定義されます）。
• リソースマッピングのルートは entity.Activity です。
• リソースのインスタンスごとに以下のようになります。
  • description プロパティの値が Activity エンティティの Description フィールドに書き込まれます。
  • mandatory プロパティの値が Activity エンティティの Mandatory フィールドに書き込まれます。

マッピングファイルには表示されるがアップデータファイルには表示されないプロパティが存在する場合があることに注意してください。この現象は、読み取り専用のプロパティでよく見られます。例えば、アクティビティをクローズするときにアプリケーションが設定する CloseDate プロパティが、Activity エンティティにあります。このプロパティは、読み取り可能なため、マッピングファイルに表示されます。しかし、書き込みはできないため、アップデータファイルには表示されません。

ベースコンフィギュレーションには、API 固有の拡張アップデータファイルのセットが含まれています。これらのファイルの目的は、特定の API 用のカスタムリソースに関するアップデータ情報を定義することです。「<API>_ext-1.0.updater.json」のパターンを使用してこれらのファイルに名前が付けられます。<API> は API の内部名です。例えば、common_ext-1.0.updater.json ファイルを使用して、Common API でカスタムリソースに関するアップデータ情報を定義します。拡張マッピングファイルには、Studio で integration -> mappers -> ext -> <API>.v1 ノードを介してアクセスできます

カスタムエンティティ用のエンドポイントを生成すると、REST エンドポイントジェネレータが以下のコードを関連の拡張アップデータファイルに追加します。

    "<resourceName>": {
      "schemaDefinition": "<schemaNameForResource>",
      "root": "entity.<customEntity>",
      // TODO RestEndpointGenerator : Add updater properties here
      "properties": { }
    }

    "CustomEntityExt": {
      "schemaDefinition": "CustomEntityExt",
      "root": "entity.CustomEntity_Ext",
      // TODO RestEndpointGenerator : Add updater properties here
      "properties": { }
    }

REST エンドポイントジェネレータでは properties 情報を提供しないことに注意してください。スキーマ定義ファイルには id フィールドしか追加されないためです。このフィールドは書き込み可能ではないため、アップデータに追加されません。

開発者は以下の作業を担当します。

• カスタムエンティティで POST と PATCH が利用できる必要があるフィールドの決定。
• これらのフィールドに関するアップデータ情報の追加。

例えば、CustomEntity_Ext エンティティに次の 3 つのフィールドがあるとします。

• CustomDescription（文字列型）
• IsActive（Boolean 型）
• ExpirationDate（日付時刻型）

CustomDescription と IsActive を POST と PATCH で使用できる必要があることを開発者が決定します。以下の太字で示されているコードを開発者は追加する必要があります。

    "CustomEntityExt": {
      "schemaDefinition": "CustomEntityExt",
      "root": "entity.CustomEntity_Ext",
      // TODO RestEndpointGenerator : Add updater properties here
      "properties": {
        "customDescription": {
          "path": "CustomEntity_Ext.CustomDescription"
        },
        "isActive": {
          "path": "CustomEntity_Ext.IsActive"
        }
      }
    }

また、ExpirationDate を POST と PATCH で使用禁止にする必要があることを開発者が決定します。フィールドは、GET で使用できるため、スキーマとマッパーに表示される可能性があります。ただし、POST または PATCH では使用できないため、アップデータから省略されます。