コンテンツにスキップ

更新

紐付け情報の更新を行います。 いずれかのノードが存在しなければエラーとなります。

POST /v1/{CUSTOMER_ID}/links/_update

Info

条件に合致するIDが存在しなかった時に新規で登録が必要な場合は、更新または作成をご利用ください

リクエストヘッダ

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

コンテンツタイプ

  • Content-Type: application/json

リクエストボディ

{
    "from": {
        "schema": string,
        "key": {
             "type": string,
             "id": string
        }
    },
    "set": {
        "to": {
            "schema": string,
            "key": {
                "type": string,
                "id": string
            }
        }
    },
    "where": {
        "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。
set.to OBJECT 必須 更新後の紐付け先ノード。
set.to.schema STRING 必須 更新後の紐付け先ノードが所属するスキーマ。
set.to.key OBJECT 必須 更新後の紐付け先ノードを特定するためのIDタイプとIDの組み合わせ。
set.to.key.type STRING 必須 更新後の紐付け先ノードを特定するためのIDタイプ。スキーマのIDタイプと一致する必要があります。
set.to.key.id STRING 必須 更新後の紐付け先ノードを特定するためのID。
where OBJECT 必須 更新対象の紐付け先ノード。
where.to OBJECT 必須 更新対象の紐付け先ノード。
where.to.schema STRING - 更新対象の紐付け先ノードが所属するスキーマ。
where.to.key OBJECT 必須 更新対象の紐付け先ノードを特定するためのIDタイプとIDの組み合わせ。
where.to.key.type STRING 必須 更新対象の紐付け先ノードを特定するためのIDタイプ。
where.to.key.id STRING - 更新対象の紐付け先ノードを特定するためのID。

リクエストサンプル

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

レスポンス

HTTP/1.1 200 {}