アプリ情報の取得

フォローする

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 文字列

アプリ名

  • 言語ごとの名称を設定している場合、APIの実行ユーザーが設定している言語に応じた名称。
description 文字列

アプリの説明

  • 未設定の場合は空文字列。言語ごとの名称を設定している場合、APIの実行ユーザーが設定している言語に応じた名称。
spaceId 文字列 スペース内アプリではスペースID。それ以外ではnull。
threadId 文字列 スレッド内アプリではスレッドID。それ以外ではnull。
createdAt 文字列 作成日時
creator オブジェクト 作成者情報
creator.code 文字列

作成者のコード

  • 停止/削除/非利用ユーザーの場合は空文字列。
creator.name 文字列
作成者の名前
  • 停止/削除/非利用ユーザーの場合は空文字列。
modifiedAt 文字列 更新日時
modifier オブジェクト 更新者情報
modifier.code 文字列
更新者のコード
  • 停止/削除/非利用ユーザーの場合は空文字列。
modifier.name 文字列
更新者の名前
  • 停止/削除/非利用ユーザーの場合は空文字列。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

アプリ情報の一括取得

アプリの閲覧権限のあるユーザーが、指定した条件にあてはまるアプリの情報を一括取得できます。

  • 一度に取得できるアプリ数は、最大で100件です。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/k/v1/apps.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/apps.json

リクエストパラメータ 

パラメータ名 必須 説明
ids 配列   アプリID
  • 各要素は1以上9223372036854775807以下の整数で数値又は文字列で指定。
  • 最大100件。
  • nullまたは空配列の場合はパラメータが省略されたものとみなされる。
codes 配列    アプリコード
  • 各要素は1文字以上64文字以下で文字列で指定。
  • 完全一致検索
  • 大文字と小文字を区別
  • 最大100件
  • nullまたは空配列の場合はパラメータが省略されたものとみなされます
name 文字列   アプリ名またはその一部
  • 最大64文字。
  • 部分一致検索。
  • 大文字と小文字を区別しない。
  • 複数の言語でアプリ名を設定している場合は、標準のアプリ名とAPI実行ユーザーの表示言語のアプリ名が検索されます。
  • nullまたは空文字列の場合はパラメータが省略されたものとみなされます。
spaceIds 配列   スペースID
  • 各要素は1以上9223372036854775807以下の整数で数値又は文字列で指定。
  • 最大100件。
  • nullまたは空配列の場合はパラメータが省略されたものとみなされます。
limit 数値又は文字列   取得する件数
  • 1以上100以下。
  • 省略すると100。
offset 数値又は文字列   取得をスキップする件数
  • 0以上2147483647以下。
  • 省略されたら0。

リクエストの例

パラメータを 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

XMLHttpRequest

関連Tips

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

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

Avatar
Sugawara Genki

「パラメータを JSON形式で送信する場合」の
6 | "name": "TEST",6 | "name": "TEST"(末尾のカンマなし)の
間違いでしょうか?

Avatar
Sugawara Genki

些細な指摘で恐縮なのですが
「レスポンス例」の「"description": ""」の末尾にカンマがないように見えます

Avatar
cybozu Development team

Sugawara Genkiさん

cybozu.com developer network事務局です。
ご指摘いただきありがとうございます。本文を修正致しました。

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