REST API
目次
アプリ
| API | HTTPメソッド | URL |
|---|---|---|
| カテゴリの設定情報を取得する | GET |
/k/v1/app/categories.json /k/v1/preview/app/categories.json |
| カテゴリの設定情報を変更する | PUT | /k/v1/preview/app/categories.json |
| プラグインの設定情報を取得する | GET |
/k/v1/app/plugin/config.json /k/v1/preview/app/plugin/config.json |
| プラグインの設定情報を変更する | PUT | /k/v1/preview/app/plugin/config.json |
| プロセス管理の設定を取得する | GET |
/k/v1/app/status.json /k/v1/preview/app/status.json |
| プロセス管理の設定を変更する | PUT | /k/v1/preview/app/status.json |
レコード
| API | HTTPメソッド | URL |
|---|---|---|
| 複数のレコードを更新する (UPSERTモードを利用できる) |
PUT | /k/v1/records.json |
スペース
| API | HTTPメソッド | URL |
|---|---|---|
| スペースを作成する | POST | /k/v1/space.json |
正式リリース済みのAPI
アプリ
| API | HTTPメソッド | URL |
|---|---|---|
| アプリの一般設定を取得する (取得できる項目が増える) |
GET |
/k/v1/app/settings.json /k/v1/preview/app/settings.json |
| アプリの一般設定を変更する (変更できる項目が増える) |
PUT | /k/v1/preview/app/settings.json |
| アプリ管理者用メモを取得する | GET |
/k/v1/app/adminNotes.json /k/v1/preview/app/adminNotes.json |
| アプリ管理者用メモを変更する | PUT | /k/v1/preview/app/adminNotes.json |
| アプリに追加されているプラグインの一覧を取得する | GET |
/k/v1/app/plugins.json /k/v1/preview/app/plugins.json |
| アプリにプラグインを追加する | POST | /k/v1/preview/app/plugins.json |
| アプリの所属するスペースを変更する | POST | /k/v1/app/move.json |
| アプリの一般設定を取得する (「レコード一覧でのインライン編集」の設定を取得できる) |
GET |
/k/v1/app/settings.json /k/v1/preview/app/settings.json |
| アプリの一般設定を変更する (「レコード一覧でのインライン編集」の設定を変更できる) |
PUT | /k/v1/preview/app/settings.json |
スペース
| API | HTTPメソッド | URL |
|---|---|---|
| スペースの情報を取得する (取得できる項目が増える) |
GET | /k/v1/space.json |
| スペースの設定を変更する | PUT | /k/v1/space.json |
| スペースのスレッドを作成する | POST | /k/v1/space/thread.json |
プラグイン
| API | HTTPメソッド | URL |
|---|---|---|
| インストール済みのプラグインの一覧を取得する | GET | /k/v1/plugins.json |
| インストールが必要なプラグインの一覧を取得する | GET | /k/v1/plugins/required.json |
| プラグインを読み込む | POST | /k/v1/plugin.json |
| プラグインを更新する | PUT | /k/v1/plugin.json |
| プラグインをアンインストールする | DELETE | /k/v1/plugin.json |
| 対象のプラグインを追加しているアプリの一覧を取得する | GET | /k/v1/plugin/apps.json |