一覧の設定の取得

フォローする

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

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

アクセス権

  • 運用環境の設定を取得する場合、アプリにレコード閲覧権限が必要です。
  • テスト環境の設定を取得する場合、アプリに管理権限が必要です。
  • このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

パラメータ名 指定する値 必須 説明
app 数値 必須 アプリのIDを指定します。
lang 文字列   一覧やフィールドの名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
  • 日本語の名称を取得する場合:ja
  • 英語の名称を取得する場合:en
  • 中国語の名称を取得する場合:zh
  • ログインユーザーの言語設定で取得する場合:user*
    *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、
    Accept-Languageヘッダがあればその設定が反映され、
    Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。
  • デフォルトの名称を取得する場合:default
省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「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 文字列 一覧の表示形式です。
  • LIST:表形式
  • CALENDAR:カレンダー形式
  • CUSTOM:カスタマイズ形式
views.(一覧名).builtinType 文字列 作業者が自分のレコードを表示する一覧の場合に出力されます。値は「ASSIGNEE」です。
この一覧は、プロセス管理機能を有効にすると、自動で設定されます。
views.(一覧名).name 文字列 一覧名です。
views.(一覧名).id 文字列 一覧のIDです。
views.(一覧名).fields 配列 表形式の一覧で出力されます。表示するフィールドのコードの配列です。
views.(一覧名).date 文字列 カレンダー形式の一覧で出力されます。日付として使用するフィールドのコードです。
views.(一覧名).title 文字列 カレンダー形式の一覧で出力されます。タイトルとして使用するフィールドのコードです。
views.(一覧名).html 文字列 カスタマイズ形式の一覧で出力されます。カスタマイズに使用するHTMLの内容です。
views.(一覧名).pager 真偽値 カスタマイズ形式の一覧で出力されます。ページネーションを表示するかどうかの設定です。
  • true:表示する
  • false:表示しない
views.(一覧名).filterCond 文字列 レコードの絞り込み条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)
views.(一覧名).sort 文字列 レコードのソート条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)
views.(一覧名).index 文字列 一覧の表示順(昇順)です。
revision 文字列 アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk