コンテンツにスキップ

紐付けを行う

あるノードに対して別のノードを紐付けます。 指定されたいずれかのノードが存在しなければ新たに作成します。

POST /v1/{CUSTOMER_ID}/links/_insert

リクエストヘッダ

いずれかのkeyにsecure:trueの属性を持つIDタイプが含まれている場合、認証が必要になります。

コンテンツタイプ

  • Content-Type: application/json

リクエストボディ

{
    "from": {
        "schema": string,
        "key": {
             "type": string,
             "id": string
        }
    },
    "to": {
        "schema": string,
        "key": {
            "type": string,
            "id": string
        }
    }
}
キー名 タイプ 必須 説明
from OBJECT ◯ 紐付け元のノード。
from.schema STRING ◯ 紐付け元のノードが所属するスキーマ。
from.key OBJECT ◯ 紐付け元のノードを特定するためのIDタイプとIDの組み合わせ。
from.key.type STRING ◯ 紐付け元のノードのIDタイプ。スキーマのIDタイプと一致する必要があります。
from.key.id STRING ◯ 紐付け元のノードのID。
to OBJECT ◯ 紐付け先のノード。
to.schema STRING ◯ 紐付け先のノードが所属するスキーマ。
to.key OBJECT ◯ 紐付け先のノードを特定するためのIDタイプとIDの組み合わせ。
to.key.type STRING ◯ 紐付け先のノードを特定するためのIDタイプ。スキーマのIDタイプと一致する必要があります。
to.key.id STRING ◯ 紐付け先のノードを特定するためのID。

リクエストサンプル

curl -X POST -H "Content-type: application/json" https://{HOST_NAME}/v1/{CUSTOMER_ID}/links/_insert \
-d '{"from": {"schema": "popinfo_app", "key": {"type": "popinfo_id", "id": "00000000-0000-0000-0000-000000000000"}}, "to": {"schema": "member_app", "key": {"type": "member_id", "id": "user_001"}}}'

レスポンス

HTTP/1.1 201 {}