Index
アプリ情報の取得(1件)
アプリの情報を取得できます。
HTTP メソッド
GET
URI
https://(サブドメイン名).cybozu.com/k/v1/app.json
ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app.json
必要なアクセス権
次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
リクエストパラメータ
| パラメータ名 | 値 | 必須 | 説明 |
| id | 数値又は文字列 | 必須 | アプリの情報を取得するアプリIDを指定します。 |
リクエストの例
パラメータを HTTP のクエリ文字列で送信する場合
「id」パラメータを、HTTP のクエリ文字列として送信します。
HTTP のクエリ文字列
id=4
リクエストヘッダを含んだ例
GET /k/v1/app.json?id=4 HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
パラメータを JSON形式で送信する場合（HTTP リクエストのボディに JSON データをセットする場合）
リクエストの例は以下の通りです。
ヘッダ
GET /k/v1/app.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
ボディ
レスポンスの例
プロパティ
| プロパティ名 | 型 | 説明 |
| appId | 文字列 | アプリID |
| code | 文字列 |
アプリコード
|
| name | 文字列 |
アプリ名
|
| description | 文字列 |
アプリの説明
|
| spaceId | 文字列 | スペース内アプリではスペースID。それ以外ではnull。 |
| threadId | 文字列 | スレッド内アプリではスレッドID。それ以外ではnull。 |
| createdAt | 文字列 | 作成日時 |
| creator | オブジェクト | 作成者情報 |
| creator.code | 文字列 |
作成者のコード
|
| creator.name | 文字列 |
作成者の名前
|
| modifiedAt | 文字列 | 更新日時 |
| modifier | オブジェクト | 更新者情報 |
| modifier.code | 文字列 |
更新者のコード
|
| modifier.name | 文字列 |
更新者の名前
|
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
アプリ情報の一括取得
指定した条件にあてはまるアプリの情報を一括取得できます。
- 一度に取得できるアプリ数は、最大で100件です。
HTTP メソッド
GET
URI
https://(サブドメイン名).cybozu.com/k/v1/apps.json
ゲストスペース内のアプリの場合
https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/apps.json
必要なアクセス権
次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
| ids | 配列 | アプリID
|
|
| codes | 配列 | アプリコード
|
|
| name | 文字列 | アプリ名またはその一部
|
|
| spaceIds | 配列 | スペースID
|
|
| limit | 数値又は文字列 | 取得する件数
|
|
| offset | 数値又は文字列 | 取得をスキップする件数
|
リクエストの例
パラメータを HTTP のクエリ文字列で送信する場合
各パラメータを「&」で連結し、URLエンコードしたものをHTTPのクエリ文字列として送信します。
アプリ情報取得条件の例
- アプリコードが「FOO」または「BAR」
- アプリ名の一部に「test」が含まれる
HTTPのクエリ文字列の例
name=test&codes[0]=FOO&codes[1]=BAR
リクエストヘッダを含んだ例
GET /k/v1/apps.json?name=TEST&codes[0]=FOO&codes[1]=BAR HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
パラメータを JSON形式で送信する場合（HTTP リクエストのリクエストボディに JSON データをセットする場合）
リクエストの例
ヘッダ
GET /k/v1/apps.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON を解釈できないため、実行時エラーとなります。
レスポンスの例
指定したアプリケーションに該当する情報がレスポンスとして返されます。
結果が0件の場合
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
関連Tips
「パラメータを JSON形式で送信する場合」の
6 | "name": "TEST",は6 | "name": "TEST"(末尾のカンマなし)の間違いでしょうか？
些細な指摘で恐縮なのですが
「レスポンス例」の「"description": ""」の末尾にカンマがないように見えます
Sugawara Genkiさん
cybozu.com developer network事務局です。
ご指摘いただきありがとうございます。本文を修正致しました。
お世話になっております。
個別アプリ名を取得するAPI`がありますでしょう。
アプリの全体的情報を取りたくないです。アプリ名のみ取りたいですが、可能でしょうか。
よろしくお願いいたします。
chu thi hue 様
お世話になっております。cybozu developer network 事務局でございます。
理解が間違っていましたら申し訳ありませんが、
こちらの記事の「レコードの取得（1件）」部分の説明にありますように、
アプリ情報の取得APIのレスポンスから、「name」プロパティを指定してアプリ名の値を利用できます。
今後ともよろしくお願いいたします。
ゲストスペースアプリの場合のURIを指定した場合はゲストスペースのアプリだけが取得できますが、
通常のURIを指定した場合はゲストスペースのアプリも含んだすべてのアプリが取得されます。
ゲストスペースのアプリを除いたアプリだけを取得することは可能でしょうか？
yohmi 様
お世話になっております。cybozu developer network 事務局でございます。
ご記載の通り、「/k/v1/apps.json」を指定した場合、ゲストスペース内のアプリも対象となります。
アプリを取得する際に、取得したアプリがゲストスペースに所属しているかどうかの判別はできません。
ご期待に添えず、申し訳ございません。
今後ともよろしくお願いいたします。