1. エンティティ

エンティティ オブジェクト

エンティティ オブジェクトには、エンティティの状態が含まれています。次のプロパティが存在します。

名前説明
id数値エンティティの ID
identifier文字列エンティティの一意の識別子
selfリンクこのエンティティのリソースへのリンク
entitydefinitionリンクこのエンティティを定義するエンティティ定義リソースへのリンク。
propertiesオブジェクトプロパティと値を含むディクショナリ オブジェクト。内容は、そのエンティティに関連付けられているエンティティ定義に大きく依存します。以下を参照
relationsオブジェクトリレーションごとに、リレーションに従った名前を持つプロパティと値を含むディクショナリ オブジェクト。値は、特定のリレーションがネストとして設定されているかどうかに応じて、エンティティ リレーション オブジェクトまたはリンク オブジェクトのいずれかになります。

プロパティ ディクショナリのプロパティの値は、そのエンティティに関連付けられたエンティティ定義で定義されているプロパティの型に従ってフォーマットされます。次の表は、プロパティの型とそれぞれがサポートしている値のフォーマットを示したものです。

サポートされている値のフォーマット
Integer有効な 32 ビットの整数を含む数値、有効な 32 ビットの整数を含む文字列、ブール値 (true と false をそれぞれ 1 と 0 に変換)
Decimal数値、有効な 10 進数を含む文字列、ブール値 (true と false をそれぞれ 1 と 0 に変換)
String数値 (文字列に変換)、文字列、ブール値 (文字列に変換)
DateTimeISO 8601 形式の日付と時刻を含む文字列
ブール値1 または 0 のいずれかを含む数値、「true」または「false」のいずれかを含む文字列、ブール値

言語ごとの値を含むプロパティ (エンティティ定義のプロパティ定義では、is_multilanguage プロパティによってこのようなプロパティを示します) には、カルチャごとに、RFC 4647 言語コードに従ったプロパティ名とそのカルチャの値を持つオブジェクトが含まれます。これは、ラベル オブジェクトと同様です。

さらに、複数の値を持つことができるプロパティ (エンティティ定義のプロパティ定義では、is_multivalue プロパティによってこのようなプロパティを示します) には、それぞれの型の値の配列が含まれます。

多言語、複数値のプロパティ値は、前述のカルチャ オブジェクト内の配列に含まれています。

{
"id":1,
"identifier": "00amyWGct0y_ze4lIsj2Mw",
"properties":{
"Property1":"Hello, World!",
"Property2":[41, 42, 43],
"Property3":{
"en-US":true,
"nl-BE":false
},
"Property4":"2013-04-30T14:22:42+02:00",
"Property5":3.1415
},
"relations":{
"R1":{
"href":"http://<hostname>/api/entities/1/relations/R1"
},
"R2": {
"children":[
{
"href":"http://<hostname>/entities/2"
},
{
"href":"http://<hostname>/entities/3"
}
],
"self":{
"href":"http://<hostname>/entities/1/relations/R2"
}
}
},
"entitydefinition":{
"href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
}
}
この記事を改善するための提案がある場合は、 お知らせください!