リクエストOption

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

前提

APIに指定するパラメータの長さは、ブラウザやWebサーバのURL長さ制限に従います。
Google Chrome、Microsoft Edge、Firefoxには、URL 長さ制限はありません。ただし、WebサーバのURL長さ制限に従います。
TomcatのURL長さ制限は、8000byteです。

リクエストのエンコーディングは、UTF-8です。

リクエストのJSONでは特殊文字を以下のように入力してください。

特殊文字入力方法
改行(CR)\r
改行(LF)\n
改行(CRLF)\r\n
タブ\t
シングルクォーテーション\’
ダブルクォーテーション\”
バックスラッシュ\\

リクエスト

ヘッダー

content-type
以下のいずれかを設定します。
application/x-www-form-urlencoded

multipart/form-data

パラメータ

appcode 必須
アプリコード を設定します。
appkey 必須
アプリの認証キーを設定します。
認証キーは、 API 公開設定 で取得します。
execuserid 任意
APIを実行するユーザを設定します。
アプリの認証キーに紐づくユーザがアプリの管理者の場合に使用します。
アプリの認証キーに紐づくユーザがアプリの管理者でない場合、このパラメータの値は使用しません。
lang 任意
アプリをどの言語で使用するかを指定します。言語区分を設定します。
日本語
0
英語
1
中国語
2

省略した場合は、以下の初期表示言語を使用します。

  • execuserid がある場合
    execuserid で指定したユーザ
  • execuserid がない場合
    認証キーに紐づく実行ユーザ

言語区分によって、日付型項目のフォーマットが変わります。
日付型項目の値を指定する際は、言語区分にあわせたフォーマットで日付を記述する必要があります。

param 必須
処理対象のデータをJSON形式で設定します。APIによって書式が異なります。
一件更新
{
  "プライマリキーの項目ID ": {
    "value": "値"
  },
  "項目ID ": {
    "value": "値"
  },
  …項目の数だけ繰り返す…
}
項目ID
項目の項目IDを設定します。
項目項目ID
フォームの項目項目IDは アプリの編集 > 一覧設定 で確認できます。

例
rakwdb_app1234_main_0
プライマリキー項目項目IDの末尾「_連番」を「_primarykey」に置換した値です。

例
rakwdb_app1234_main_primarykey
データ登録者pms_i_usr
データ登録日pms_i_ymd
データ更新者pms_u_usr
データ更新日pms_u_ymd
発行状態rkwa_wf_issuestatus
WF状態rkwa_wf_workflowstatus
状況rkwa_wf_status
担当者rkwa_wf_titleworker
ファイル項目、画像項目の項目ID（任意）
ファイル項目、画像項目にファイルを登録するときは、パラメータ名に項目IDを指定し、ファイル名とファイルを送信します。

リクエスト例

ファイル項目にファイルを登録するときは、multipart/form-data で送信します。

Request header

POST /RakWDB/webapi/v1/data/update HTTP/1.1
HOST: localhost:8080
content-type: multipart/form-data; boundary=----WebKitFormBoundaryAvHx7MhNxAfc2fcd
cookie: SeiSessID=Sei.rakwdb.RakWDB.06251718.8000JR5qubUh3ze8705
content-length: 1678

------WebKitFormBoundaryAvHx7MhNxAfc2fcd
Content-Disposition: form-data; name="appkey"

P7byWKRlvr6381WeYS2e7eJUPCnAItGIv4LeKRHa
------WebKitFormBoundaryAvHx7MhNxAfc2fcd
Content-Disposition: form-data; name="rakwdb_app1234_main_1"; filename="image.gif"
Content-Type: image/gif
…略…