kintone API ドキュメント

一覧の設定を取得する

目次

一覧の設定を取得する

アプリの一覧の設定を取得します。

URL

URL は、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/views.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/app/views.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/views.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app/views.json

HTTP メソッド

GET

必要なアクセス権

運用環境の設定を取得する場合

次のいずれかの権限が必要です。

  • アプリのレコード閲覧権限
  • アプリのレコード追加権限
動作テスト環境の設定を取得する場合
  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
app 数値 必須 アプリ ID
lang 文字列 省略可 取得する名称の言語
フィールドや選択肢の名前に 言語ごとの名称 (External link) を設定している場合に指定します。
  • ja：日本語
  • en：英語
  • zh：中国語
  • user：API を実行するユーザーが表示言語に設定している言語
    言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
    • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
    • ヘッダーなし：cybozu.com 共通管理の ロケールの設定 (External link) で設定した言語
  • default：デフォルト
省略すると、デフォルトの名称を取得します。
リクエストの例（URL にパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/app/views.json?app=8&lang=ja

ヘッダー
1
2
3

{
  "X-Cybozu-API-Token": "API_TOKEN"
}

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

リクエストの例（リクエストボディにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/app/views.json

ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ
1
2
3
4

{
  "app": 8,
  "lang": "ja"
}

レスポンス

プロパティ
プロパティ名 型 説明
views オブジェクト 一覧の設定
views.一覧名 文字列 各一覧の設定
views.一覧名.type 文字列 一覧の表示形式
  • LIST：表形式
  • CALENDAR：カレンダー形式
  • CUSTOM：カスタマイズ形式
views.一覧名.builtinType 文字列 一覧名 が「（作業者が自分）」の場合のみ出力されるプロパティ
「ASSIGNEE」が返ります。
「（作業者が自分）」の一覧は、プロセス管理機能を有効にすると自動で作成されます。
views.一覧名.name 文字列 一覧名
views.一覧名.id 文字列 一覧の ID
views.一覧名.fields 配列 表示するフィールドのフィールドコードの一覧
views.一覧名.type が「LIST」の場合に返ります。
views.一覧名.date 文字列 日付として使用するフィールドのフィールドコード
views.一覧名.type が「CALENDAR」の場合に返ります。
views.一覧名.title 文字列 タイトルとして使用するフィールドのフィールドコード
views.一覧名.type が「CALENDAR」の場合に返ります。
views.一覧名.html 文字列 カスタマイズに使用する HTML の内容
views.一覧名.type が「CUSTOM」の場合に返ります。
views.一覧名.pager 真偽値 ページネーションを表示するかどうか
  • true：表示する
  • false：表示しない
views.一覧名.type が「CUSTOM」の場合に返ります。
views.一覧名.device
 文字列 一覧を表示する範囲
  • DESKTOP：PC 版のみで表示する場合
  • ANY：PC 版とモバイル版で表示する場合
views.一覧名.type が「CUSTOM」の場合に返ります。
views.一覧名.filterCond 文字列 レコードの絞り込み条件
クエリ形式で表されます。クエリ形式は、 クエリの書き方 を参照してください。
views.一覧名.sort 文字列 レコードのソート条件
クエリ形式で表されます。クエリ形式は、 クエリの書き方 を参照してください。
views.一覧名.index 文字列 一覧の表示順（昇順）
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{
  "views": {
    "(作業者が自分)": {
      "type": "LIST",
      "builtinType": "ASSIGNEE",
      "name": "(作業者が自分)",
      "id": "1101",
      "fields": ["レコード番号", "更新日時", "更新者", "文字列1行_0"],
      "filterCond": "作業者 in (LOGINUSER())",
      "sort": "レコード番号 asc",
      "index": "0"
    },
    "一覧1": {
      "type": "LIST",
      "name": "一覧1",
      "id": "1102",
      "fields": ["レコード番号", "文字列1行_0"],
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc",
      "index": "2"
    },
    "カレンダー": {
      "type": "CALENDAR",
      "name": "カレンダー",
      "id": "1103",
      "date": "作成日時",
      "title": "文字列1行_0",
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc",
      "index": "3"
    },
    "カスタマイズ": {
      "type": "CUSTOM",
      "name": "カスタマイズ",
      "id": "1104",
      "html": "カスタマイズされた一覧のHTML<br />",
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc",
      "index": "1",
      "device": "ANY"
    }
  },
  "revision": "1"
}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/views.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 8,
    "lang": "ja"
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

await kintone.api(kintone.api.url('/k/v1/app/views.json', true), 'GET', body);

制限事項

  • 同じ名前の一覧が存在する場合には、設定を取得できません。