コンテンツにスキップ

dataset.record.put

データセットにレコードを登録または更新します。

パラメータ

  • dataset_name: string -- データセット名。
  • records: array -- 登録または更新するレコードの配列。 データセットに定義された順番に値を指定してください。
  • on_conflict: string -- レコードが既に存在するときの処理。 error, update, nothing のいずれかの文字列を指定できます。 本項目は省略可能です。 省略された場合は error となります。
    • error -- レコードが既に存在した場合はエラーにします。他のレコードも登録されません。
    • update -- レコードが既に存在した場合は内容を更新します。
    • nothing -- レコードが既に存在した場合は何もせずにスキップします。他のレコードは登録されます。

戻り値

データセットに登録または更新されたレコード数が戻されます。

実行例

リクエストデータ

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "dataset.record.put",
    "params": {
      "dataset_name": "my_dataset",
      "records": [
        [1, "石塚 洋次", "WzxKRGR6J@sample.com"],
        [2, "近藤 恭之", "KefD6KU@test.net"],
        [3, "玉井 真帆", null]
      ],
      "on_conflict": "error"
    }
}

リクエスト実行

curl -H "Content-type: application/json" \
     -H "APIKey: 9c6f4574-89d1-4e3c-8af7-2549dc217fcf" \
     -H "Secret: aef8caingiej1ieNieJ3Phool4maeGohcies" \
     -X POST -d "@request.json" \
     https://localhost/api/v2/dataset/jsonrpc

レスポンス

{
  "result": 3,
  "id": 1,
  "jsonrpc": "2.0"
}