クラウド版製品マニュアル 楽々Webデータベース
ホーム > エクセル業務効率化支援ツール 楽々Webデータベース > マニュアルトップ > 添付資料. API > 共通仕様:リクエスト

リクエストOption

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

前提

  • API に指定するパラメータの長さは、ブラウザやWebサーバーの URL 長さ制限にしたがいます。
    Google Chrome、Microsoft Edge、Firefoxには、URL 長さ制限はありません。ただし、WebサーバーのURL 長さ制限にしたがいます。
    Tomcat のURL 長さ制限は、8000byte です。
  • リクエストのエンコーディングは、UTF-8 です。

リクエスト

ヘッダー

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
…略…