エンティティ登録

以下のJSON形式のリストにてエンティティを受け取り、{unique_id}で指定したアプリケーションにエンティティの登録または更新を行います。

リクエスト

■ リクエストメソッド

POST

■ リクエストボディ

以下の値を持つJSONオブジェクトのリスト

パラメータ 必須 説明
update_type   更新タイプ
1:新規追加(既にエンティティ名が存在する場合はスキップ)
2:部分追加(既にエンンティティが存在する場合は、エンティティの値のみを追加する)
3:置き換え(既にエンティティ名が存在する場合は置き換え、存在しない場合は追加)
4:削除(エンティティ名を指定して削除する)
*何も指定しない場合は"3:置き換え"となる
entity   エンティティ名
指定されない場合は自動でエンティティ名が採番される
description   エンティティの説明
entity_values   エンティティ値のリスト
以下のJSONオブジェクトを持つリスト
  entity_value エンティティの値
  synonyms   エンティティの同意語のリスト
  attribute   エンティティの属性値
JSON形式の文字列で指定し、任意の値を持たせることが可能

■ リクエストボディの例

[
  {"update_type":"1", "entity":"entity1", "description":"エンティティ1", "entity_values":[{"entity_value":"エンティティ1-1", "synonyms":["1-1","エンティティー1-1"]}, {"entity_value":"エンティティ1-2", "synonyms":["1-2","エンティティー1-2"]}]},
  {"update_type":"2", "entity":"entity2", "entity_values":[{"entity_value":"エンティティ2-2"}]},
  {"update_type":"3", "entity":"entity3", "entity_values":[{"entity_value":"エンティティ3-1", "attribute":"{'code':'5'}"},{"entity_value":"エンティティ3-2", "attribute":"{'code':'8'}"}]},
  {"update_type":"4", "entity":"entity4"},
  {"entity_values":[{"entity_value":"自動採番1"}, {"entity_value":"自動採番2"}]}
]

 

レスポンス

項目 説明
updated 更新されたエンティティのリスト
["action2", "action3"]
deleted 削除されたエンティティのリスト
["action4"]
skipped スキップされたエンティティのリスト
["action1"]