アプリの一覧の設定を取得します。
URI
URIは、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/app/views.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/views.json
動作テスト環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/preview/app/views.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/views.json
HTTPメソッド
GET
必要なアクセス権
運用環境の設定を取得する場合、次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
動作テスト環境の設定を取得する場合。
- アプリ管理権
※2020年4月版からAPIトークンを利用してAPIを実行できます。
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値 | 必須 | アプリのIDを指定します。 |
lang | 文字列 | 一覧やフィールドの名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
|
リクエストの例
送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。
URLにパラメータを含める場合
GET /k/v1/app/views.json?app=8&lang=ja HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストボディにパラメーターを含める場合
ヘッダ
GET /k/v1/app/views.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンスパラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
views | オブジェクト | 一覧の設定を表すオブジェクトです。 |
views.(一覧名).type | 文字列 | 一覧の表示形式です。
|
views.(一覧名).builtinType | 文字列 | 作業者が自分のレコードを表示する一覧の場合に出力されます。値は「ASSIGNEE」です。 この一覧は、プロセス管理機能を有効にすると、自動で設定されます。 |
views.(一覧名).name | 文字列 | 一覧名です。 |
views.(一覧名).id | 文字列 | 一覧のIDです。 |
views.(一覧名).fields | 配列 | 表形式の一覧で出力されます。表示するフィールドのコードの配列です。 |
views.(一覧名).date | 文字列 | カレンダー形式の一覧で出力されます。日付として使用するフィールドのコードです。 |
views.(一覧名).title | 文字列 | カレンダー形式の一覧で出力されます。タイトルとして使用するフィールドのコードです。 |
views.(一覧名).html | 文字列 | カスタマイズ形式の一覧で出力されます。カスタマイズに使用するHTMLの内容です。 |
views.(一覧名).pager | 真偽値 | カスタマイズ形式の一覧で出力されます。ページネーションを表示するかどうかの設定です。
|
views.(一覧名).device |
文字列 | カスタマイズ形式の一覧で出力されます。一覧を表示する範囲です。
|
views.(一覧名).filterCond | 文字列 | レコードの絞り込み条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。 レコードの一括取得(クエリで条件を指定) |
views.(一覧名).sort | 文字列 | レコードのソート条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。 レコードの一括取得(クエリで条件を指定) |
views.(一覧名).index | 文字列 | 一覧の表示順(昇順)です。 |
revision | 文字列 | アプリの設定のリビジョン番号です。 |
レスポンスの例
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
制限事項
アプリ内で重複した名前の一覧が存在する場合、 このAPIで設定を取得することができません。
お世話になります。
最近kintoneでは列幅の設定が出来るようになったのですが、この情報はAPIから取得、設定可能でしょうか?
金田 晃 様
お世話になっております。 cybozu developer network 事務局です。
恐れ入りますが、現在REST API経由では、列幅の情報取得・設定ともに未対応となっております。