data/registerOption

アプリにデータを一件登録します。

APIを使用するには、WebAPIオプションが必要です。

POST

http://example.com/RakWDB/webapi/v1/data/register

リクエスト

ヘッダー

content-type

application/x-www-form-urlencoded

もしくは

multipart/form-data

パラメータ

appcode

アプリコードを設定します。

appkey

アプリの認証キーを設定します。

execuserid

APIを実行するユーザーを設定します。
アプリの認証キーに紐づくユーザーがアプリの管理者の場合に使用します。
アプリの認証キーに紐づくユーザーがアプリの管理者でない場合、このパラメータの値は使用しません。

lang

アプリを動作させる言語の言語区分を設定します。

param

登録するデータをJSON形式で設定します。

書式

{
  "項目ID": {
    "value": "値"
  },
  …他の項目の設定…
  "表コード": [
    {      
      "項目ID": {
        "value": "値"
      },
      …他の項目の設定…
    },
    …他の行の設定…
  ],
  …他の表の設定…
}

項目ID

登録対象の項目の項目IDを設定します。

value

登録する値を設定します。項目によって設定方法が異なります。

チェックボックス、選択リスト

登録する値を配列で設定します。

例

「A」「B」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": ["A", "B"]
  },
}

日付

言語区分に応じた日付を設定します。

日本語、中国語の場合

「yyyy-MM-dd」形式で設定します。

例

「2021-01-02」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "2021-01-02"
  },
}

英語の場合

「MM/dd/yyyy」形式で設定します。

例

「01/02/2021」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "01/02/2021"
  },
}

日付時刻

すべての言語で下記のフォーマットとします。
「yyyy-MM-dd HH:mm:ss」形式で設定します。

例

「2021-01-02 13:00:00」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "2021-01-02 13:00:00"
  },
}

時刻

すべての言語で下記のフォーマットとします。
「HH:mm:ss」形式で設定します。

例

「13:00:00」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "13:00:00"
  },
}

ユーザー

ユーザーIDを設定します。

例

「sis000001」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "sis000001"
  },
}

グループ

グループコードを設定します。

例

「SIS_EIGYO」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "SIS_EIGYO"
  },
}

上記以外

登録する値を設定します。

例

「A」を登録する。

{
  "rakwdb_app1234_main_0": {
    "value": "A"
  },
}

表コード

登録対象の表を設定します。表に値を登録するときのみ設定します。

例

{
  "rakwdb_app1234_main_0": {
    "value": "u100"
  },
  "rakwdb_app1234_main_1": {
    "value": "2021-06-01"
  },
  "TABLE_1": [
    {
      "rakwdb_app1234_dtl_3": {
        "value": "A"
      },
      "rakwdb_app1234_dtl_4": {
        "value": "1"
      }
    }
  ]
}

ファイル項目の項目ID

登録するファイルを設定します。

画像項目の項目ID

登録する画像ファイルを設定します。

レスポンス

ヘッダー

content-type

application/json;charset=UTF-8

レスポンス例

登録に成功した場合

{
  "rkwa_status": "OK",
  "rkwa_errorcount": 0,
  "rkwa_errmsg": null,
  "rakwdb_app1234_main_primarykey": {
    "type": "id",
    "value": "1000"
  },
  "rakwdb_app1234_main_0": {
    "type": "text",
    "value": "u100"
  },
  "rakwdb_app1234_main_1": {
    "type": "date",
    "value": "2021-06-01"
  },
  "pms_i_usr": {
    "type": "pms_i_usr",
    "value": {
      "id": "admin",
      "name": "admin"
    }
  },
  "pms_i_ymd": {
    "type": "pms_i_ymd",
    "value": "2021-06-25 17:00:00"
  },
  "pms_u_usr": {
    "type": "pms_u_usr",
    "value": {
      "id": "admin",
      "name": "admin"
    }
  },
  "pms_u_ymd": {
    "type": "pms_u_ymd",
    "value": "2021-06-25 17:00:00"
  },
  "TABLE_1": [
    {
      "rakwdb_app1234_dtl_primarykey": {
        "type": "id",
        "value": "1000"
      },
      "rakwdb_app1234_main_primarykey": {
        "type": "id",
        "value": "1000"
      },
      "rakwdb_app1234_dtl_3": {
        "type": "text",
        "value": "A"
      },
      "rakwdb_app1234_dtl_4": {
        "type": "number",
        "value": "1",
        "value_formatted": "1"
      }
    }
  ]
}

入力チェックのため、登録に失敗した場合

{
  "rkwa_status": "OK",
  "rkwa_errorcount": 3,
  "rkwa_errmsg": [
    "エラーが 3 個あります。修正して下さい。"
  ],
  "rakwdb_app1234_main_0": {
    "type": "text",
    "value": ""
  },
  "rakwdb_app1234_main_1": {
    "type": "date",
    "value": "2021-6-31"
  },
  "rakwdb_app1234_main_primarykey": {
    "type": "id",
    "value": ""
  },
  "rkwa_error": {
    "type": "rkwa_error",
    "value": {
      "rakwdb_app1234_main_0": "必須項目です。",
      "rakwdb_app1234_main_1": "日付が不正です。"
    }
  },
  "TABLE_1": [
    {
      "rakwdb_app1234_dtl_3": {
        "type": "text",
        "value": "A"
      },
      "rakwdb_app1234_dtl_4": {
        "type": "number",
        "value": "A",
        "value_formatted": "A"
      },
      "rkwa_error": {
        "type": "rkwa_error",
        "value": {
          "rakwdb_app1234_dtl_4": "数値フォーマットエラー。"
        }
      }
    }
  ]
}

注意事項

データ保護を設定した項目

設定した値は無視し、登録しません。

自動採番項目

設定した値は無視し、システム側で自動で採番した値を登録します。

ドロップダウン、チェックボックス、ラジオボタン、選択リスト項目

設定した値で登録します。選択肢に存在しない値も登録します。

文字列結合、計算、計算式を設定した日付項目

設定した値は無視し、文字列結合、計算式処理した結果で登録、更新します。

設定した値で登録、更新するためには以下の設定を「しない」に設定します。

管理モード - システム管理 - サーバー - 全般 - 互換性
「計算、文字列結合、自動入力設定を、ファイル登録、データインポート、メール取り込み、WebAPI実行時に処理」

自動入力設定している項目

設定した値は無視し、自動入力の結果で登録、更新します。

設定した値で登録、更新するためには以下の設定を「しない」に設定します。