レスポンスOption

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

前提

APIの実行結果を JSON形式で返します。
レスポンスのエンコーディングは、UTF-8 です。
HTTP ステータスコードは、処理の成功／失敗にかかわらず 200 です。
エラーの有無は、レスポンスボディを解析し、パラメータから判断します。
HTTP レスポンスヘッダーに Access-Control-Allow-Origin が付加されません。

レスポンス

ヘッダー

content-type

application/json;charset=UTF-8

パラメータ

rkwa_status

処理に成功した場合は"OK"、処理に失敗した場合は"NG"を返します。

rkwa_errcode

処理に失敗した場合に、エラーコードを返します。
エラーコードは、エラーコード一覧をご参照ください。

rkwa_errorcount

処理に失敗した場合、入力エラーがある場合に、エラー件数を返します。
処理に失敗した場合は、1 です。入力エラーがある場合は、入力エラーが発生している項目の数です。

rkwa_errmsg

処理に失敗した場合、入力エラーがある場合に、エラーメッセージを返します。
エラーメッセージが複数ある場合は、配列で返します。エラーメッセージの言語は、APIでアプリを実行した言語です。

例

"rkwa_errmsg": "DB接続に失敗しました。"

rkwa_error

入力エラーがある場合に、エラーがある項目とエラーメッセージを返します。

type

固定値「rkwa_error」です。

value

エラーがある項目の項目IDとエラーメッセージです。

例

rkwa_error: {
  type: rkwa_error,
  value: {
    rakwebdb_app1234_main_1: "数値フォーマットエラー。",
    rakwebdb_app1234_main_2: "数値フォーマットエラー。"
  }
}

TABLE_1

検索結果です。
配列形式で、検索条件に該当する複数件のデータを返します。

例

TABLE_1: [
]

データの配列です。
検索の場合は、検索結果のデータを複数件含みます。登録／更新の場合は、登録／更新した結果の1件のデータを含みます。

項目ID

検索／登録／更新／削除の結果を返します。項目の数だけ繰り返します。
削除の場合は、削除した項目のプライマリキーの項目IDのみ返します。

type

項目型です。


type	説明
id	プライマリキー
text	文字列(1行)
number	数値
text_area	文字列(複数行)
mail_address	メールアドレス
postal_code	郵便番号
phone_number	電話番号
date	日付
datetime	日付時刻
time	時刻
time_amount	時間量
drop_down	ドロップダウン
check_box	チェックボックス
radio_button	ラジオボタン
calc	計算
string_concat	文字列結合
rich_text	リッチテキスト
select_multiple	選択リスト
url	URL
file	ファイル
image	画像
user	ユーザー
sequence	自動採番
group	グループ
pms_i_usr	データ登録者
pms_i_ymd	データ登録日
pms_u_usr	データ更新者
pms_u_ymd	データ登録日

value

登録／更新の場合は、登録／更新した後の値です。削除の場合は、削除したプライマリキー項目の値です。
項目型によって書式が異なります。

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

選択肢の配列です。

例

"rakwdb_app1234_main_0": {
  "type": "check_box",
  "value": [
    "選択肢１",
    "選択肢２",
    "選択肢３",
  ]  
}

ユーザー、データ登録者、データ更新者

ユーザーIDとユーザー名です。

例

"rakwdb_app1234_main_0": {
  "type": "user",
  "value": [
    "id": "aa010001",
    "name": "住友太郎"
  ]  
}

id: ユーザーIDです。
name: ユーザー名称です。

グループ

グループコードとグループ名です。

例

"rakwdb_app1234_main_0": {
  "type": "group",
  "value": [
    "code": "PRDV00001",
    "name": "住友電工情報システム株式会社"
  ]  
}

code: グループコードです。
name: グループ名です。

上記以外の項目

値です。

例

"rakwdb_app1234_main_0": {
  "type": "text",
  "value": "ABC"
}

value_formatted

フォーマット付きの数値です。
項目型が「数値」のときのみ使用します。

例

"rakwdb_app1234_main_0": {
  "type": "number",
  "value": "1000",
  "value_formatted": "1,000"
}

filename

ファイル名です。
項目型が「ファイル」「画像」のときのみ使用します。

filesize

ファイルサイズです。単位はbyteです。
項目型が「ファイル」「画像」のときのみ使用します。

例

"rakwdb_app1234_main_0": {
  "type": "file",
  "value": "1000",
  "filename": "営業日報.xlsx"
  "filesize": "325995"  
}

レスポンス例

{
  "rkwa_status": "OK",
  "rkwa_errorcount": 0,
  "rkwa_errmsg": null,
  "TABLE_1": [
    {
      "rakwdb_app1234_main_primarykey": {
        "type": "id",
        "value": "1000"
      },
      "rakwdb_app1234_main_0": {
        "type": "text",
        "value": "u101"
      },
      "rakwdb_app1234_main_1": {
        "type": "date",
        "value": "2021-06-01"
      },
      "rakwdb_app1234_main_2": {
        "type": "text_area",
        "value": "以下のシートをご参照ください。\r\n「表A」\r\n「表B」"
      },
      "rakwdb_app1234_main_3": {
        "type": "file",
        "value": "1011",
        "filename": "サンプル.xlsx",
        "filesize": "51200"
      },
      "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:10:00"
      }
    }
  ]
}