kumanekoの設定情報を取得する

このページでは、kumanekoの設定情報を取得するAPIを紹介します。

Index

  1. アプリ設定

  2. ダッシュボード設定

kumanekoの設定情報を取得する

メソッド

GET

URI
[your kumaneko domain]/api/config.php
認証

リクエストヘッダに「X-Authorization」を追加し、「account:password」をBase64エンコードしたものを値に指定します。

Content-Type

application/json

戻り値

アプリ設定

プロパティ名 型 説明
file.apps.user オブジェクト

ユーザーアプリ設定のデータを持つオブジェクト
file.apps.system オブジェクト

システムアプリ設定のデータを持つオブジェクト
file.apps.{user or sysytem}.{app ID}.id 文字列

アプリID
file.apps.{user or sysytem}.{app ID}.name 文字列

アプリ名
file.apps.{user or sysytem}.{app ID}.fields オブジェクト

フィールド設定のデータを持つオブジェクト
file.apps.{user or sysytem}.{app ID}.styles オブジェクト

フィールド幅に関するデータを持つオブジェクト
file.apps.{user or sysytem}.{app ID}.layout 配列

フォームの行毎のレイアウトデータを持つ配列
file.apps.{user or sysytem}.{app ID}.views 配列

ビュー設定のデータを持つ配列
file.apps.{user or sysytem}.{app ID}.linkages 配列

リンクビュー設定のデータを持つ配列

 
{
	file: {
		"apps": {
			"user": {
				"1": {
					"id": "1",
					"name": "Daily report",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				},
				"2": {
					"id": "2",
					"name": "Items",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				}
			},
			"system": {
				"project": {
					"id": "project",
					"name": "project",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				},
				"users": {
					"id": "users",
					"name": "users",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				},
				"departments": {
					"id": "departments",
					"name": "departments",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				},
				"groups": {
					"id": "groups",
					"name": "groups",
					"fields": { ... },
					"styles": { ... },
					"layout": [ ... ],
					"views": [ ... ],
					"linkages": [ ... ]
				}
			}
		},
		"dashboard": { ... }
	}
}
フィールド設定
プロパティ名 型 説明
{app ID}.fields.{field ID}.id 文字列

フィールドID
{app ID}.fields.{field ID}.type 文字列

フィールド形式
{app ID}.fields.{field ID}.caption 文字列

フィールド名
{app ID}.fields.{field ID}.required 真偽値

入力が必須かどうかの設定
{app ID}.fields.{field ID}.nocaption 真偽値

フィールド名を非表示にするかどうかの設定
{app ID}.fields.{field ID}.placeholder 文字列

フィールドに表示する入力ヒント
{app ID}.fields.{field ID}.format 文字列

textフィールドの表示形式

text フリー
alphabet 英字
alphanum 英数字
mail メールアドレス
password パスワード
tel 電話番号
url URL
{app ID}.fields.{field ID}.lines 数値

可視行数
{app ID}.fields.{field ID}.demiliter 真偽値

数値の桁区切りを表示するかどうかの設定
{app ID}.fields.{field ID}.decimals 数値

小数点以下の表示桁数
{app ID}.fields.{field ID}.unit 文字列

単位記号
{app ID}.fields.{field ID}.unitposition 文字列

単位記号の表示位置

接頭 Prefix
接尾 Suffix
{app ID}.fields.{field ID}.options 配列

選択肢データの配列
{app ID}.fields.{field ID}.options[].option.value 文字列

選択肢の値
{app ID}.fields.{field ID}.app 文字列

lookupフィールドの「参照元アプリ」
{app ID}.fields.{field ID}.search 文字列

lookupフィールドの「参照元フィールド」
{app ID}.fields.{field ID}.query 文字列

lookupフィールドの「参照するレコードの絞り込み条件」 (絞り込み)
{app ID}.fields.{field ID}.sort 文字列

lookupフィールドの「参照するレコードの絞り込み条件」 (並び順)
{app ID}.fields.{field ID}.ignore 真偽値

lookupフィールドの「このアプリの関連付けフィールドが空である場合は、その関連付けを無視する」
{app ID}.fields.{field ID}.mapping オブジェクト

lookupフィールドの「コピーするフィールド」のデータを持つオブジェクト

Key コピー元に指定されたフィールドのフィールドID
Value コピー先に指定されたフィールドのフィールドID
{app ID}.fields.{field ID}.picker 配列

lookupフィールドの「参照するレコードの選択時に表示するフィールド」のデータを持つフィールドIDの配列
{app ID}.fields.{field ID}.criteria 配列

lookupフィールドの「参照するレコードの関連付け」のデータを持つ配列
{app ID}.fields.{field ID}.criteria[].external 文字列

lookupフィールドの「参照するレコードの関連付け」の「参照元アプリのフィールド」
{app ID}.fields.{field ID}.criteria[].operator 文字列

lookupフィールドの「参照するレコードの関連付け」の演算子
{app ID}.fields.{field ID}.criteria[].internal 文字列

lookupフィールドの「参照するレコードの関連付け」の「このアプリのフィールド」
{app ID}.fields.{field ID}.table 配列

lookupフィールドの「コピーするテーブル」のデータを持つ配列
{app ID}.fields.{field ID}.table[].id.external 文字列

lookupフィールドの「コピーするテーブル」の「参照元アプリのテーブル」
{app ID}.fields.{field ID}.table[].id.internal 文字列

lookupフィールドの「コピーするテーブル」の「このアプリのテーブル」
{app ID}.fields.{field ID}.table[].fields 配列

lookupフィールドの「コピーするテーブル」の「コピーするフィールド」のデータを持つ配列
{app ID}.fields.{field ID}.table[].fields[].external 文字列

lookupフィールドの「コピーするテーブル」の「コピーするフィールド」の参照元アプリのフィールド
{app ID}.fields.{field ID}.table[].fields[].internal 文字列

lookupフィールドの「コピーするテーブル」の「コピーするフィールド」のこのアプリのフィールド
{app ID}.fields.{field ID}.mapping.lat 文字列

addressフィールドの「緯度フィールド」
{app ID}.fields.{field ID}.mapping.lng 文字列

addressフィールドの「経度フィールド」
{app ID}.fields.{field ID}.mapping.prefecture 文字列

postalcodeフィールドの「都道府県コードフィールド」
{app ID}.fields.{field ID}.mapping.prefecturename 文字列

postalcodeフィールドの「都道府県名フィールド」
{app ID}.fields.{field ID}.mapping.city 文字列

postalcodeフィールドの「市区町村コードフィールド」
{app ID}.fields.{field ID}.mapping.cityname 文字列

postalcodeフィールドの「市区町村名フィールド」
{app ID}.fields.{field ID}.mapping.streetname 文字列

postalcodeフィールドの「町名フィールド」
{app ID}.fields.{field ID}.mapping.address 文字列

postalcodeフィールドの「住所フィールド」
{app ID}.fields.{field ID}.fields オブジェクト

テーブル内のフィールドのデータを持つオブジェクト

オブジェクトのパラメータは、「fields」パラメータと同じです。
{app ID}.fields.{field ID}.fixed 数値

autonumberフィールドの「連番の桁数」
{app ID}.fields.{field ID}.group 配列

autonumberフィールドの「グループ化のフィールド」のデータを持つフィールドIDの配列
{app ID}.fields.{field ID}.multiuse 真偽値

spacerフィールドの「一覧画面でも使用する」
{app ID}.fields.{field ID}.contents 文字列

spacerフィールドの「表示内容」

 
...
"user": {
	"1": {
		...
		"fields": {
			"field_27_": {
				"id": "field_27_",
				"type": "text",
				"caption": "text",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"format": "text"
			},
			"field_31_": {
				"id": "field_31_",
				"type": "textarea",
				"caption": "textarea",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"lines": 3
			},
			"field_32_": {
				"id": "field_32_",
				"type": "number",
				"caption": "number",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"demiliter": true,
				"decimals": 2,
				"unit": "",
				"unitposition": "suffix"
			},
			"field_33_": {
				"id": "field_33_",
				"type": "date",
				"caption": "date",
				"required": false,
				"nocaption": false
			},
			"field_34_": {
				"id": "field_34_",
				"type": "datetime",
				"caption": "datetime",
				"required": false,
				"nocaption": false
			},
			"field_35_": {
				"id": "field_35_",
				"type": "time",
				"caption": "time",
				"required": false,
				"nocaption": false
			},
			"field_36_": {
				"id": "field_36_",
				"type": "radio",
				"caption": "radio",
				"required": false,
				"nocaption": false,
				"options": [
					{
						"option": {
							"value": "A"
						}
					},
					{
						"option": {
							"value": "B"
						}
					},
					{
						"option": {
							"value": "C"
						}
					}
				]
			},
			"field_37_": {
				"id": "field_37_",
				"type": "dropdown",
				"caption": "dropdown",
				"required": false,
				"nocaption": false,
				"options": [
					{
						"option": {
							"value": "fruit"
						}
					},
					{
						"option": {
							"value": "vegetable"
						}
					},
					{
						"option": {
							"value": "processed meat"
						}
					},
					{
						"option": {
							"value": "dairy products"
						}
					}
				]
			},
			"field_38_": {
				"id": "field_38_",
				"type": "checkbox",
				"caption": "checkbox",
				"required": false,
				"nocaption": false,
				"options": [
					{
						"option": {
							"value": "A"
						}
					},
					{
						"option": {
							"value": "B"
						}
					},
					{
						"option": {
							"value": "C"
						}
					},
					{
						"option": {
							"value": "D"
						}
					},
					{
						"option": {
							"value": "E"
						}
					}
				]
			},
			"field_39_": {
				"id": "field_39_",
				"type": "file",
				"caption": "file",
				"required": false,
				"nocaption": false
			},
			"field_40_": {
				"id": "field_40_",
				"type": "user",
				"caption": "user",
				"required": false,
				"nocaption": false
			},
			"field_41_": {
				"id": "field_41_",
				"type": "department",
				"caption": "department",
				"required": false,
				"nocaption": false
			},
			"field_42_": {
				"id": "field_42_",
				"type": "group",
				"caption": "group",
				"required": false,
				"nocaption": false
			},
			"field_43_": {
				"id": "field_43_",
				"type": "lookup",
				"caption": "lookup",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"app": "2",
				"search": "field_8_",
				"query": "",
				"sort": "",
				"ignore": true,
				"criteria": [
					{
						"external": "field_9_",
						"operator": "in",
						"internal": "field_37_"
					}
				],
				"mapping": {
					"field_10_": "field_45_"
				},
				"picker": [
					"field_9_",
					"field_8_",
					"field_10_"
				],
				"table": [
					{
						"id": {
							"external": "field_100_",
							"internal": "field_61_"
						},
						"fields": [
							{
								"external": "field_101_",
								"internal": "field_62_"
							},
							{
								"external": "field_102_",
								"internal": "field_63_"
							}
						]
					}
				]
			},
			"field_45_": {
				"id": "field_45_",
				"type": "number",
				"caption": "lookup mapping",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"demiliter": false,
				"decimals": 0,
				"unit": "",
				"unitposition": "suffix"
			},
			"field_51_": {
				"id": "field_51_",
				"type": "address",
				"caption": "address",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"mapping": {
					"lat": "field_52_",
					"lng": "field_53_"
				}
			},
			"field_52_": {
				"id": "field_52_",
				"type": "number",
				"caption": "lat",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"demiliter": false,
				"decimals": 0,
				"unit": "",
				"unitposition": "suffix"
			},
			"field_53_": {
				"id": "field_53_",
				"type": "number",
				"caption": "lng",
				"required": false,
				"nocaption": false,
				"placeholder": "",
				"demiliter": false,
				"decimals": 0,
				"unit": "",
				"unitposition": "suffix"
			},
			"field_55_": {
				"id": "field_55_",
				"type": "color",
				"caption": "color",
				"required": false,
				"nocaption": false
			},
			"field_56_": {
				"id": "field_56_",
				"type": "canvas",
				"caption": "canvas",
				"required": false,
				"nocaption": false
			},
			"field_61_": {
				"id": "field_61_",
				"type": "table",
				"caption": "table",
				"nocaption": false,
				"fields": {
					"field_62_": {
						"id": "field_62_",
						"type": "date",
						"caption": "date",
						"required": false,
						"nocaption": false
					},
					"field_63_": {
						"id": "field_63_",
						"type": "number",
						"caption": "number",
						"required": false,
						"nocaption": false,
						"placeholder": "",
						"demiliter": false,
						"decimals": "0",
						"unit": "",
						"unitposition": "suffix"
					},
					"field_64_": {
						"id": "field_64_",
						"type": "text",
						"caption": "text",
						"required": false,
						"nocaption": false,
						"placeholder": "",
						"format": "text"
					}
				}
			},
			"field_68_": {
				"id": "field_68_",
				"type": "spacer",
				"caption": "spacer",
				"nocaption": true,
				"multiuse": false,
				"contents": "Hello!"
			},
			"__id": {
				"id": "__id",
				"type": "id",
				"caption": "id",
				"required": false,
				"nocaption": false
			},
			"__autonumber": {
				"id": "__autonumber",
				"type": "autonumber",
				"caption": "autonumber",
				"required": false,
				"nocaption": false,
				"fixed": 10,
				"group": [
					"field_36_"
				]
			},
			"__creator": {
				"id": "__creator",
				"type": "creator",
				"caption": "creator",
				"required": false,
				"nocaption": false
			},
			"__createdtime": {
				"id": "__createdtime",
				"type": "createdtime",
				"caption": "createdtime",
				"required": false,
				"nocaption": false
			},
			"__modifier": {
				"id": "__modifier",
				"type": "modifier",
				"caption": "modifier",
				"required": false,
				"nocaption": false
			},
			"__modifiedtime": {
				"id": "__modifiedtime",
				"type": "modifiedtime",
				"caption": "modifiedtime",
				"required": false,
				"nocaption": false
			}
		},
		...
	}
}
フィールド幅設定
プロパティ名 型 説明
{app ID}.styles.{field ID}.width 文字列

フィールド幅

 
...
"user": {
	"1": {
		...
		"styles": {
			"field_27_": {
				"width": "235px"
			},
			"field_31_": {
				"width": "235px"
			}
		},
		...
	}
}
レイアウト設定
プロパティ名 型 説明
{app ID}.layout[].type 文字列

行の種類

row 標準の行
box boxフィールド
table tableフィールド
{app ID}.layout[].id 文字列

boxフィールド、またはtableフィールドのフィールドID
{app ID}.layout[].fields 配列

行に含まれるフィールドのフィールドIDの配列
{app ID}.layout[].rows 配列

boxフィールド内フィールドのレイアウトデータを持つ配列

配列のパラメータは、「layout」パラメータと同じです。

 
...
"user": {
	"1": {
		...
		"layout": [
			{
				"type": "row",
				"fields": [
					"__autonumber",
					"field_27_",
					"field_31_",
					"field_32_"
				]
			},
			{
				"type": "box",
				"id": "field_70_",
				"caption": "box",
				"rows": [
					{
						"fields": [
							"field_43_",
							"field_45_"
						]
					}
				]
			},
			{
				"type": "table",
				"id": "field_61_"
			}
		],
		...
	}
}
ビュー設定
プロパティ名 型 説明
{app ID}.views[].id 文字列

ビューID
{app ID}.views[].name 文字列

ビュー名
{app ID}.views[].type 文字列

ビューの表示形式

list 一覧形式
edit 編集型一覧形式
calendar カレンダー形式
crosstab クロス集計形式
gantt ガントチャート形式
timeseries 時系列集計形式
kanban カンバン形式
map 地図形式
customize カスタマイズ形式
{app ID}.views[].query 文字列

表示するレコードの条件
{app ID}.views[].sort 文字列

表示するレコードの並び順
{app ID}.views[].skip 真偽値

一覧形式の「表示する条件に一致しないテーブル行は非表示にする」
{app ID}.views[].fields 配列

一覧形式のビューに表示するフィールドのフィールドIDの配列
{app ID}.views[].fields オブジェクト

カレンダー形式、クロス集計形式、時系列集計形式、地図形式に関するフィールドデータを持つオブジェクト
{app ID}.views[].fields.date 文字列

カレンダー形式の「日付フィールド」
{app ID}.views[].fields.title 文字列

カレンダー形式、地図形式の「タイトルフィールド」
{app ID}.views[].fields.lat 文字列

地図形式の「緯度フィールド」
{app ID}.views[].fields.lng 文字列

地図形式の「経度フィールド」
{app ID}.views[].fields.color 文字列

地図形式の「マーカーカラーフィールド」
{app ID}.views[].fields.address 文字列

地図形式の「住所フィールド」
{app ID}.views[].fields.postalcode 文字列

地図形式の「郵便番号フィールド」
{app ID}.views[].fields.handover 真偽値

地図形式の「クリック位置を登録する」
{app ID}.views[].fields.column オブジェクト

クロス集計形式、ガントチャート形式、時系列集計形式の「列」に関するデータを持つオブジェクト

  • クロス集計形式

    プロパティ名 型 説明
    column.field 文字列

    フィールドID
    column.format 文字列

    dateフィールド、datetimeフィールド、timeフィールドにおける集計単位

    year 年次
    month 月次
    day 日次
    hour 時次
    column.sort 文字列

    並び順

  • ガントチャート形式

    プロパティ名 型 説明
    column.period 文字列

    タスクの表示単位

    month 月次
    day 日次
    column.width 数値

    列幅

  • 時系列集計形式

    プロパティ名 型 説明
    column.field 文字列

    フィールドID
    column.period 文字列

    集計期間

    month 月次
    day 日次
{app ID}.views[].fields.groups 配列

カンバン形式のグループ化に関するデータを持つ配列

プロパティ名 型 説明
groups[].caption 文字列

グループ名
groups[].query 文字列

グループ化対象のレコードの絞り込み条件
{app ID}.views[].fields.rows 配列

クロス集計形式、ガントチャート形式、時系列集計形式の「行」に関するデータを持つ配列

  • クロス集計形式とガントチャート形式

    プロパティ名 型 説明
    rows[].field 文字列

    フィールドID
    rows[].format 文字列

    dateフィールド、datetimeフィールド、timeフィールドにおける集計単位

    year 年次
    month 月次
    day 日次
    hour 時次
    rows[].sort 文字列

    並び順

  • 時系列集計形式

    プロパティ名 型 説明
    rows[].caption 文字列

    行タイトル
    rows[].formula 文字列

    計算式
{app ID}.views[].fields.task オブジェクト

ガントチャート形式、カンバン形式のタスクに関するデータを持つオブジェクト

  • ガントチャート形式

    プロパティ名 型 説明
    task.start 文字列

    開始日付フィールド
    task.end 文字列

    終了日付フィールド
    task.title 文字列

    タイトルフィールド

  • カンバン形式

    プロパティ名 型 説明
    task.title 文字列

    タイトルフィールド
    task.date 文字列

    日付フィールド
    task.width 数値

    列幅
{app ID}.views[].fields.value オブジェクト

クロス集計形式の「集計方法」に関するデータを持つオブジェクト

プロパティ名 型 説明
value.field 文字列

フィールドID
value.func 文字列

集計方法

CNT 件数
SUM 合計
AVG 平均
MAX 最大
MIN 最小
{app ID}.views[].fields.values 配列

時系列集計形式の「集計方法」に関するデータを持つ配列

プロパティ名 型 説明
values[].id 文字列

集計方法の識別ID
values[].field 文字列

集計対象のフィールドID
values[].func 文字列

集計方法

CNT 件数
SUM 合計
AVG 平均
MAX 最大
MIN 最小
PPCNT 前期件数
PPSUM 前期合計
PPAVG 前期平均
PPMAX 前期最大
PPMIN 前期最小
values[].query 文字列

集計対象のレコードの絞り込み条件
{app ID}.views[].chart.type 文字列

グラフの種類

table 表
bar 横棒グラフ
stacking_bar 積み上げ横棒グラフ
stacking_percent_bar 100%積み上げ横棒グラフ
column 縦棒グラフ
stacking_column 積み上げ縦棒グラフ
stacking_percent_column 100%積み上げ縦棒グラフ
pie 円グラフ
line 折れ線グラフ
spline 曲線グラフ
area 面グラフ
scatter 散布図 
...
"user": {
	"3": {
		...
		"views": [
			{
				"id": "5",
				"name": "Sales this month",
				"type": "edit",
				"query": "field_11_ >= FROM_THISMONTH(\"0\",\"day\")",
				"sort": "field_11_ asc",
				"skip": false,
				"fields": [
					"field_11_",
					"field_25_",
					"field_79_",
					"field_12_",
					"field_24_"
				]
			},
			{
				"id": "6",
				"name": "Sales calendar",
				"type": "calendar",
				"query": "field_24_ >= 100",
				"sort": "field_12_ asc",
				"fields": {
					"date": "field_11_",
					"title": "field_12_"
				}
			},
			{
				"id": "7",
				"name": "Customer Map in this month",
				"type": "map",
				"query": "field_11_ >= FROM_THISMONTH(\"0\",\"day\")",
				"sort": "field_12_ asc",
				"fields": {
					"lat": "field_74_",
					"lng": "field_75_",
					"title": "field_12_",
					"color": "",
					"address": "",
					"postalcode": "",
					"handover": false
				}
			},
			{
				"id": "8",
				"name": "This month's aggregate by seller",
				"type": "crosstab",
				"query": "field_11_ >= FROM_THISMONTH(\"0\",\"day\")",
				"fields": {
					"column": {
						"field": "field_12_",
						"format": "",
						"sort": "asc"
					},
					"rows": [
						{
							"field": "field_78_",
							"format": "",
							"sort": "asc"
						}
					],
					"value": {
						"field": "field_24_",
						"func": "SUM"
					}
				},
				"chart": {
					"type": "pie"
				}
			},
			{
				"id": "9",
				"name": "Shipping status",
				"type": "gantt",
				"query": "",
				"sort": "",
				"fields": {
					"column": {
						"period": "day",
						"width": 64
					},
					"rows": [
						{
							"field": "field_78_",
							"format": "",
							"sort": "asc"
						}
					],
					"task": {
						"start": "field_11_",
						"end": "field_99_",
						"title": "field_12_"
					}
				}
			},
			{
				"id": "10",
				"name": "Timeseries",
				"type": "timeseries",
				"query": "field_78_ in (\"2\",\"3\")",
				"fields": {
					"column": {
						"field": "field_11_",
						"period": "month"
					},
					"rows": [
						{
							"caption": "Total",
							"formula": "F1_"
						},
						{
							"caption": "Rate for US",
							"formula": "CONCAT(ROUND(F2_\/F1_,2)*100,\"%\")"
						},
						{
							"caption": "Rate for Other",
							"formula": "CONCAT(ROUND(F3_\/F1_,2)*100,\"%\")"
						}
					],
					"values": [
						{
							"id": "F1_",
							"field": "field_24_",
							"func": "SUM",
							"query": ""
						},
						{
							"id": "F2_",
							"field": "field_24_",
							"func": "SUM",
							"query": "field_77_ = \"USA\""
						},
						{
							"id": "F3_",
							"field": "field_24_",
							"func": "SUM",
							"query": "field_77_ != \"USA\""
						}
					]
				},
				"chart": {
					"type": "table"
				}
			},
			{
				"id": "11",
				"name": "Shipment verification",
				"type": "kanban",
				"fields": {
					"groups": [
						{
							"caption": "Group1",
							"query": "field_101_ in (\"in progress\")"
						},
						{
							"caption": "Group2",
							"query": "field_101_ in (\"waiting for shipping\")"
						}
					],
					"task": {
						"title": "field_98_",
						"date": "",
						"width": 250
					}
				},
				"query": "",
				"sort": ""
			},
			{
				"id": "12",
				"name": "My Customize view",
				"type": "customize",
				"query": "",
				"sort": "",
				"fields": []
			},
			{
				"id": "0",
				"name": "all",
				"type": "list",
				"query": "",
				"sort": "",
				"fields": []
			}
		],
		...
	}
}
リンクビュー設定
プロパティ名 型 説明
{app ID}.linkages[].id 文字列

リンクビューID
{app ID}.linkages[].name 文字列

リンクビュー名
{app ID}.linkages[].app 文字列

リンク元アプリ
{app ID}.linkages[].query 文字列

リンクするレコードの絞り込み条件 (絞り込み)
{app ID}.linkages[].sort 文字列

リンクするレコードの絞り込み条件 (並び順)
{app ID}.linkages[].display 配列

「表示するフィールドとコピー先テーブル内フィールド」のデータを持つフィールドIDの配列
{app ID}.linkages[].display[].external 文字列

「表示するフィールドとコピー先テーブル内フィールド」の「表示するフィールド」
{app ID}.linkages[].display[].internal 文字列

「表示するフィールドとコピー先テーブル内フィールド」の「コピー先テーブル内フィールド」
{app ID}.linkages[].criteria 配列

「リンクするレコードの関連付け」のデータを持つ配列
{app ID}.linkages[].criteria[].external 文字列

「リンクするレコードの関連付け」の「リンク元アプリのフィールド」
{app ID}.linkages[].criteria[].operator 文字列

「リンクするレコードの関連付け」の演算子
{app ID}.linkages[].criteria[].internal 文字列

「リンクするレコードの関連付け」の「このアプリのフィールド」
{app ID}.linkages[].bulk オブジェクト

一括コピーに関するデータを持つオブジェクト
{app ID}.linkages[].bulk.enable 真偽値

一括コピーを可能にするかどうかの設定
{app ID}.linkages[].bulk.caption 文字列

一括コピーボタンに表示されるラベルテキスト
{app ID}.linkages[].bulk.message 文字列

一括コピー実行前の確認ダイアログに表示されるメッセージ

 
...
"user": {
	"2": {
		...
		"linkages": [
			{
				"id": "2",
				"name": "Meetings",
				"app": "1",
				"query": "",
				"sort": "",
				"criteria": [
					{
						"external": "field_32_",
						"operator": "=",
						"internal": "field_10_"
					}
				],
				"display": [
					{
						"external": "field_27_",
						"internal": "field_11_"
					},
					{
						"external": "field_31_",
						"internal": ""
					}
				],
				"bulk": {
					"enable": false,
					"caption": "",
					"message": ""
				}
			}
		],
		...
	}
}

ダッシュボード設定

プロパティ名 型 説明
file.dashboard.frames 配列

ダッシュボードの行毎のデータを持つ配列
file.dashboard.frames[].styles.height 文字列

ダッシュボードの行の高さ
file.dashboard.frames[].panels 配列

パネルとして表示するアプリとビューのデータを持つ配列
file.dashboard.frames[].panels[].app 文字列

アプリID
file.dashboard.frames[].panels[].view 文字列

ビューID
file.dashboard.frames[].panels[].styles.height 文字列

パネルの幅

 
{
	file: {
		"apps": { ... },
		"dashboard": {
			"frames": [
				{
					"styles": {
						"height": "400px"
					},
					"panels": [
						{
							"app": "3",
							"view": "6",
							"styles": {
								"width": "50%"
							}
						},
						{
							"app": "3",
							"view": "8",
							"styles": {
								"width": "50%"
							}
						}
					]
				},
				{
					"styles": {
						"height": ""
					},
					"panels": [
						{
							"app": "3",
							"view": "9",
							"styles": {
								"width": "100%"
							}
						}
					]
				}
			]
		}
	}
}
サンプル

JavaScript

fetch('[your kumaneko domain]/api/config.php', {
	method: 'GET',
	headers: {
		'X-Authorization': window.btoa(pd.kumaneko.users.login().account.value+':'+pd.kumaneko.users.login().pwd.value)
	}
})
.then(response => {
	response.json().then((json) => {
		switch (response.status)
		{
			case 200:
				console.log(json);
				break;
			default:
				console.error('Error:', json);
				break;
		}
	});
})
.catch(error => {
	console.error('Error:', error);
});

curl

curl -X GET '[your kumaneko domain]/api/config.php' \
	-H 'X-Authorization: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
	-H 'Content-Type: application/json'