事業体

エンティティオブジェクトはエンティティの状態を含みます。以下のプロパティが存在します:

名称

種類

概要

id

番号

エンティティのID。

identifier

ストリング

エンティティの一意識別子。

self

リンク

この団体のリソースへのリンクです。

entitydefinition

リンク

このエンティティを定義するエンティティ定義リソースへのリンクです。

properties

目的

プロパティと値を含む辞書オブジェクトです。内容は、このエンティティに関連付けられたエンティティの定義に大きく依存します。

relations

目的

各リレーションに対して、そのリレーションにちなんで名付けられたプロパティを含む辞書オブジェクト。値としては、特定のリレーションが「ネスト」として設定されているかどうかによってエンティティリ レーションオブジェクト または リンクオブジェクト のいずれかです。

DiscussionOptions

目的

コメントが作成されたページの詳細(URL、ページID、ページ名)を含むオブジェクト。これはコメントを製品にリンクするには任意ですが、メール通知やコメントページへのリダイレクトには必須です。

プロパティ辞書内のプロパティの値は、このエンティティに関連付けられたエンティティ定義で定義されたプロパティの種類に従ってフォーマットされています。以下の表は、さまざまなプロパティタイプとサポートされる値フォーマットを説明します。

種類

サポートされるバリューフォーマット

整数

有効な32ビット整数を含む数、有効な32ビット整数を含む文字列、ブール値(それぞれ真と偽を1と0に変換)

小数点

数字、有効な小数点を含む文字列、ブール(真と偽をそれぞれ1と0に変換)

ストリング

数(文字列に変換)、文字列、ブール(文字列に変換)

デートタイム

ISO 8601形式の日付と時間を含む文字列

ブール

1または0のいずれかを含む数、真または「偽」を含む文字列、ブール

多言語プロパティ(エンティティ定義でis_multilanguageでマーク)は、値をオブジェクトとして格納します。各文化は、Labelsオブジェクトに似たRFC 4647言語コードにちなんだプロパティで表現されます。

さらに、複数の値を持てるプロパティ(エンティティ定義のプロパティ定義がis_multivalue property)は、それぞれのタイプの配列を含みます。

多言語、多値プロパティは、前述の文化オブジェクト内の配列で値を含みます。