一覧の設定を取得する
アプリの一覧の設定を取得します。
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 | 文字列 | 省略可 | 取得する名称の言語 フィールドや選択肢の名前に 言語ごとの名称
|
リクエストの例(URL にパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/views.json?app=8&lang=ja
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/views.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
views | オブジェクト | 一覧の設定 |
views.一覧名 |
文字列 | 各一覧の設定 |
views.一覧名 .type |
文字列 | 一覧の表示形式
|
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 |
真偽値 | ページネーションを表示するかどうか
views.一覧名.type が「CUSTOM」の場合に返ります。 |
views.一覧名 .device |
文字列 | 一覧を表示する範囲
views.一覧名.type が「CUSTOM」の場合に返ります。 |
views.一覧名 .filterCond |
文字列 | レコードの絞り込み条件 クエリ形式で表されます。クエリ形式は、 クエリの書き方 を参照してください。 |
views.一覧名 .sort |
文字列 | レコードのソート条件 クエリ形式で表されます。クエリ形式は、 クエリの書き方 を参照してください。 |
views.一覧名 .index |
文字列 | 一覧の表示順(昇順) |
revision | 文字列 | アプリの設定のリビジョン番号 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|
制限事項
- 同じ名前の一覧が存在する場合には、設定を取得できません。