2015/1/11
2015の定期メンテナンスにおけるAPI更新の事前情報

年1月11日の定期メンテナンスの、kintone API の更新に関する情報をお知らせします。

kintone JavaScript API

月11日のアップデートでkintoneプラグイン読み込み機能をリリース予定です。それに伴い、プラグイン開発時にご利用いただけるAPIが追加されます。
1

追加される機能指定したプラグインの設定情報を取得するAPI
例：
var config = kintone.plugin.app.getConfig(PLUGIN_ID);
console.log(config['key1']);

プラグインに設定を保存するAPI
例：
var config = {"key1": "value1","key2": "value2"};
kintone.plugin.app.setConfig(config);

ブラグインから外部のREST APIを実行するAPI
例:
kintone.plugin.app.proxy(PLUGIN_ID, 'https://api.example.com', 'GET', {}, {}, showResponse(body, status, headers) {});
function showResponse(body, status, headers) {console.log(status, JSON.parse(body));};

外部の REST API の実行に必要な情報をプラグインに保存するAPI
例：
var headers = {"Content-Type": "application/json","Authorization": "1234567890abcdefg"};
var data = {"key1": "secretValue"};kintone.plugin.app.setProxyConfig('https://api.example.com', "GET", headers, data);

外部の REST API の実行に必要なプラグインに保存した情報を取得するAPI
例：
var config = kintone.plugin.app.getProxyConfig("https://api.example.com", "GET");console.log(config['key1']);

kintone REST API

改修される不具合

作成日時を指定して登録したレコードがある状態で同一の時刻のレコードがある場合、ソートするとレコード番号順でソートされてしまう。
※本件は改修をとりやめました。

追加される機能
ファイルをダウンロードするREST API（/k/v1/file.json）」で、APIトークンを使用する機能。
テスト環境のアプリに設定されたフォームの設計情報を取得するREST API。
リクエストURL:
https://(サブドメイン名).cybozu.com/k/v1/preview/form.json※リクエストとレスポンスは、フォーム設計情報取得APIと同等です。
フォームの設計情報を取得するREST API（/k/v1/form.json）で取得できるフィールドに、下記を追加。
フィールド 取得するプロパティ型
フィールド名フィールドコード
ユーザー選
フィールドタイプ
択
フィールド名の非表
示
フィールド名フィールドコード
必須項目かどうか
フィールド名の非表
ルックアッ示プ
参照するアプリのID
参照するフィールドのタイプフィールド名
フィールドコードフィールドタイプ
関連レコー
フィールド名の非表
ド一覧
示
参照するアプリのID
フィールド名フィールドコードレコード番フィールドタイプ号
フィールド名の非表
示
フィールド名フィールドコードフィールドタイプ
作成者
フィールド名の非表
示
フィールド名フィールドコードフィールドタイプ
作成日時
フィールド名の非表
示
フィールド名フィールドコードフィールドタイプ
更新者
フィールド名の非表
示

更新日時

テーブル

フィールド名フィールドコードフィールドタイプ
フィールド名の非表
示
フィールドコードフィールドタイプ中に含まれるフィー
ルドの情報

User API

追加される機能
指定した組織の所属ユーザーの一覧を取得するAPI
リクエストURL:
https://(サブドメイン名).cybozu.com/v1/organization/users.json
HTTPメソッド:
GET

リクエスト例(組織コード,位置,件数を指定)：{"code": "Dev","offset": 0,"size": 50}

レスポンス例：{"userTitles":[{"user":{"birthDate":"2011-05-01","callto":"","code":"a","ctime":"2013-07-22T08:12:18Z","customItemValues":[{"code":"item1","value":"aitem1"},{"code":"secret","value":"aitem2"}],"description":"","email":"","employeeNumber":"","extensionNumber":"","givenName":"","givenNameReading":"","id":"1","joinDate":"2013-01-01","localName":"","localNameLocale":"ja","locale":"","mobilePhone":"","mtime":"2013-07-22T09:00:45Z","name":"a","phone":"","primaryOrganization":null,"sortOrder":2147483647,"surName":"a","surNameReading":"","timezone":"Asia/Tokyo","url":"","valid":true},"title":{"code":"leader",まとめやく","description":""id":"1","name":""}

リーダー},{"user":{"birthDate":"2011-05-01","callto":"","code":"b","ctime":"2013-07-22T08:12:18Z","customItemValues":[{"code":"item1","value":"bitem1"},{"code":"secret","value":"bitem2"}],"description":"","email":"","employeeNumber":"","extensionNumber":"","givenName":"","givenNameReading":"","id":"1","joinDate":"2013-01-01","localName":"","localNameLocale":"ja","locale":"","mobilePhone":"","mtime":"2013-07-22T09:00:45Z","name":"a","phone":"","primaryOrganization":null,"sortOrder":2147483647,"surName":"a","surNameReading":"","timezone":"Asia/Tokyo","url":"","valid":true},"title":null}]}

指定したユーザーの所属組織と役職を取得するAPI
リクエストURL:
https://(サブドメイン名).cybozu.com/v1/user/organizations.json
HTTPメソッド:
GET

リクエスト例(ログイン名を指定)：{"code":"user1"}

レスポンス例：{"organizationTitles":[{"organization":{"code":"B","description":"B","id":"2","localName":"B","localNameLocale":"ja","name":"B","parentCode":"A"},"title":{"code":"leader","description":"","id":"1","name":""}

組織 です
本部

組織まとめやくリーダー}]}

指定したユーザーの情報をJSON形式で出力するAPIで、ユーザーをログイン名で指定する機能。
※idsとcodesの両方が指定された場合は、エラーになります。
リクエスト例：{"codes": ["user1", "user2"]}