スキーマコンフィギュレーションファイルの構文

ファイル属性

スキーマ拡張ファイルの最初の部分には、ファイルそれ自体に関する属性が含まれています。これらの属性は変更しないでください。変更すると、Cloud API が予期せぬ動作をする可能性があります。

definitions セクション

definitions セクションには、1 つまたは複数のスキーマの定義が列挙されます。スキーマごとに、以下の属性が指定されます。

• API 定義ドキュメントで使用される、スキーマの title と description。
• Cloud API 用で、通常は object に設定される、リソース type。
• スキーマの properties のリスト。

すべてのスキーマプロパティに以下が含まれています。

• プロパティ名（下の例内の activityPattern など）
• API 定義ドキュメントで使用される、プロパティの title と description。
• プロパティの「データ型」。
  • スカラー値プロパティの場合は、type が指定されます。これにより、プロパティの JSON データ型が定義されます。
  • 複合値プロパティ（タイプキーなど）の場合は、ref が指定されます。これにより、プロパティの URI 参照が定義されます。
• プロパティの業務機能に必要なオプション属性。

"definitions": {
  "Activity": {
    "title": "Activity",
    "description": "An `Activity` is an assignable item...",
    "type": "object",
    "properties": {
      "activityPattern": {
        "title": "Activity pattern",
        "description": "The code of the `ActivityPattern` used...
        "type": "string"
        ...
      },
      "activityType": {
        "title": "Activity type",
        "description": "The type of this activity, such as `general`...",
        "$ref": "#/definitions/TypeKeyReference",
        ...
      },
      ...
    }
  }
}

ファイル属性

マッピング拡張ファイルの最初の部分には、ファイルそれ自体に関する属性が含まれています。これらの属性は変更しないでください。変更すると、Cloud API が予期せぬ動作をする可能性があります。

mapping セクション

マッピングファイルには mappers セクションが含まれています。このセクションでは、1 つまたは複数の API リソースと、リソース内の読み取り可能なプロパティごとのデータとプロパティのマッピングが列挙されます。

リソースごとに、以下の属性が指定されます。

• リソースの構造を定義する schemaDefinition
  • これは、schema.json ファイル内で宣言されたスキーマを参照します。
• このリソースに関するマッピング情報の root として機能するデータモデルエンティティ。
• properties のリスト

すべてのマッパープロパティに以下が含まれています。

• プロパティ名（下の例内の closeDate、description、mandatory など）
  • path 属性これは、プロパティの値を生成するために使用される Gosu 式です。通常、この式は、ルート属性で定義されたエンティティからの値を返します。
  • プロパティの特性によっては、追加の属性がある場合があります。

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

次の点に注目します。

• このリソースは、名前が Activity のスキーマで定義されます（このスキーマは、他の schema.json ファイルで定義されます）。
• リソースマッピングのルートは entity.Activity です。
• リソースのインスタンスごとに：
  • closeDate プロパティが Activity エンティティの CloseDate フィールドに設定されます。
  • description プロパティが Activity エンティティの Description フィールドに設定されます。
  • mandatory プロパティが Activity エンティティの Mandatory フィールドに設定されます。

ファイル属性

アップデータファイルの最初の部分には、ファイルそれ自体に関する属性が含まれています。これらの属性は変更しないでください。変更すると、Cloud API が予期せぬ動作をする可能性があります。

updaters セクション

アップデータファイルには updaters セクションが含まれています。このセクションでは、1 つまたは複数の API リソースと、リソース内の書き込み可能なプロパティごとのデータとデータモデルのマッピングが列挙されます。

リソースごとに、以下の属性が指定されます。

• リソースの構造を定義する schemaDefinition
  • これは、schema.json ファイル内で宣言されたスキーマを参照します。
• このリソースに関するマッピング情報の root として機能するデータモデルエンティティ。
• properties のリスト

すべてのアップデータプロパティに以下が含まれています。

• プロパティ名（下の例内の description や mandatory など）
• path 属性これにより、リソースプロパティごとに、リソースプロパティが書き込まれるデータモデルエンティティプロパティが定義されます。
• プロパティの特性によっては、追加の属性がある場合があります。

"updaters": {
  "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 フィールドに書き込まれます。

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