削除
ノード内のID、もしくはノード自体の削除を行います。 ノードからwhereで指定した条件のIDを削除します。 whereが指定されなかった場合はノード自体を削除します。
POST /v1/{CUSTOMER_ID}/node/_delete
リクエストヘッダ
keyもしくはidsにsecure:trueの属性を持つIDタイプが含まれている場合、認証が必要になります。
コンテンツタイプ
- Content-Type: application/json
リクエスト
{
"schema": string,
"key": {
"type": string,
"id": string
},
"where": {
"type": string,
"id": string
}
}
キー名 | タイプ | 必須 | 説明 |
---|---|---|---|
schema | STRING | ◯ | 対象ノードが所属しているスキーマ。 |
key | OBJECT | ◯ | 対象ノードを特定するためのIDタイプとIDの組み合わせ。 |
key.type | STRING | ◯ | 対象ノードを特定するためのIDタイプ。スキーマのIDタイプと一致する必要があります。 |
key.id | STRING | ◯ | 対象ノードを識別するためのID。 |
where | OBJECT | 削除するIDの条件。IDを削除する場合、削除対象のIDタイプ、IDを指定します。ノードを削除する場合は使用しません。 | |
where.type | STRING | ◯ | 削除するIDタイプ。 |
where.id | STRING | 削除するID。 |
リクエストサンプル
ノードの削除を行う場合
curl -X POST -H "Content-type: application/json" https://{HOST_NAME}/v1/{CUSTOMER_ID}/node/_delete \
-d '{"schema": "popinfo_app", "key": {"type": "popinfo_id", "id": "00000000-0000-0000-0000-000000000000"}}'
ノード内の特定のIDの削除を行う場合
curl -X POST -H "Content-type: application/json" https://{HOST_NAME}/v1/{CUSTOMER_ID}/node/_delete \
-d '{"schema": "popinfo_app", "key": {"type": "popinfo_id", "id": "00000000-0000-0000-0000-000000000000"}, "where": {"type": "ad_id", "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"}}'
レスポンス
HTTP/1.1 204