RefTable

Upsert refTable row.

紐付けテーブルの行を更新します。

主キー、スキーマが設定されていない紐付けテーブルが対象の場合は、最初に受信したリクエストの値で、主キーとスキーマが紐付けテーブルに設定されます。

Required Scope

APIの実行に必要なScopeです。

beta.track.refTable.row.upsert

Required Role

管理画面でScopeを追加する際に必要な権限です。

紐付けテーブル > 紐付けテーブルの管理
post/v2beta/track/refTable/row/upsert

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/track/refTable/row/upsert
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

idstring required

upsert対象の紐付けテーブルのid

rowKeyRowkey required

対象の行の主キーのフィールド名と値。

valuesobject required

紐付けテーブルに書き込む値。フィールド名と値のkey-value値を指定します。

スキーマ定義済みのテーブルに書き込む際は、スキーマ(String, Number, Boolean, Date)の型に対応する値を指定します。

  • String型: 文字列を指定 ("abc", "012", "true" など)
  • Number型: 数値を指定(123, 0, など)
  • Boolean型: 真偽値(true, false)
  • Date型: 数値をUnixtime(秒)で指定. 時・分・秒の値は切り捨てられます。
    • ex1) 1667228400 (2022-11-01 (JST))
    • ex2) 4502271600 (2112-09-03 (JST))
    • ex3) 0 (1969-12-31 (JST))

String, Date型のみnull値を指定できます。

スキーマ未定義のテーブルへの書き込みの場合、値の型(文字列、数値、真偽値)からフィールドの型を推定してスキーマを生成します。 スキーマの生成にあたっては以下の制約があります。

  • nullを指定したフィールドの型はString型となります。
  • フィールドにDate型は指定できません。

Example request

{
  "rowKey": {
    "memberid": "member01"
  }
}

Response

A successful response.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.