API 一覧

目次

レコード

レコードの取得/登録/更新/削除

HTTPメソッド URL
1件のレコードを取得する GET /k/v1/record.json
1件のレコードを登録する POST /k/v1/record.json
1件のレコードを更新する PUT /k/v1/record.json
複数のレコードを取得する GET /k/v1/records.json
複数のレコードを登録する POST /k/v1/records.json
複数のレコードを更新する PUT /k/v1/records.json
複数のレコードを削除する DELETE /k/v1/records.json
(レコードの一括取得)カーソルを作成する POST /k/v1/records/cursor.json
(レコードの一括取得)カーソルからレコード取得を取得する GET /k/v1/records/cursor.json
(レコードの一括取得)カーソルを削除する DELETE /k/v1/records/cursor.json

レコードのコメントの操作

HTTPメソッド URL
レコードのコメントを取得する GET /k/v1/record/comments.json
レコードにコメントを投稿する POST /k/v1/record/comment.json
レコードのコメントを削除する DELETE /k/v1/record/comment.json

プロセス管理の操作

HTTPメソッド URL
レコードの作業者を更新する PUT /k/v1/record/assignees.json
1 件のレコードのステータスを更新する PUT /k/v1/record/status.json
複数のレコードのステータスを更新する PUT /k/v1/records/status.json

その他

HTTPメソッド URL
複数アプリのレコード操作を一括処理する POST /k/v1/bulkRequest.json
API を実行したユーザーのレコードのアクセス権の設定を取得する GET /k/v1/records/acl/evaluate.json

ファイル

HTTPメソッド URL
ファイルをダウンロードする GET /k/v1/file.json
ファイルをアップロードする POST /k/v1/file.json

アプリ

アプリに関する API には、2 つの URL があります。詳細は、各ドキュメントを確認してください。

  • アプリの動作を確認するテスト環境に反映する URL:「/k/v1/preview/API のパス.json」
  • 本番環境に反映する URL:「/k/v1/API のパス.json」

アプリ情報

HTTPメソッド URL
1件のアプリの情報を取得する GET /k/v1/app.json
複数のアプリの情報を取得する GET /k/v1/apps.json
動作テスト環境にアプリを作成する POST /k/v1/preview/app.json

フォーム

HTTPメソッド URL
フィールドを取得する GET /k/v1/app/form/fields.json
/k/v1/preview/app/form/fields.json
フィールドを追加する POST /k/v1/preview/app/form/fields.json
フィールドの設定を変更する PUT /k/v1/preview/app/form/fields.json
フィールドを削除する DELETE /k/v1/preview/app/form/fields.json
フォームのレイアウトを取得する GET /k/v1/app/form/layout.json
/k/v1/preview/app/form/layout.json
フォームのレイアウトを変更する PUT /k/v1/preview/app/form/layout.json
フォームの設計情報を取得する GET /k/v1/form.json
/k/v1/preview/form.json

一覧

HTTPメソッド URL
一覧の設定を取得する GET /k/v1/app/views.json
/k/v1/preview/app/views.json
一覧の設定を変更する PUT /k/v1/preview/app/views.json

グラフ

HTTPメソッド URL
グラフの設定を取得する GET /k/v1/app/reports.json
/k/v1/preview/app/reports.json
グラフの設定を変更する PUT /k/v1/preview/app/reports.json

アプリの設定

一般設定
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/status.json
/k/v1/preview/app/status.json
プロセス管理の変更を取得する PUT /k/v1/preview/app/status.json
アプリの設定の運用環境への反映状況を確認する GET /k/v1/preview/app/deploy.json
アプリの設定を運用環境へ反映する POST /k/v1/preview/app/deploy.json
カスタマイズ/サービス連携
HTTPメソッド URL
JavaScript / CSS カスタマイズ設定を取得する GET /k/v1/app/customize.json
/k/v1/preview/app/customize.json
JavaScript / CSS カスタマイズ設定を変更する PUT /k/v1/preview/app/customize.json
通知
HTTPメソッド URL
アプリの条件通知の設定を取得する GET /k/v1/app/notifications/general.json
/k/v1/preview/app/notifications/general.json
アプリの条件通知の設定を変更する PUT /k/v1/preview/app/notifications/general.json
レコードの条件通知の設定を取得する GET /k/v1/app/notifications/perRecord.json
/k/v1/preview/app/notifications/perRecord.json
レコードの条件通知の設定を変更する PUT /k/v1/preview/app/notifications/perRecord.json
リマインダーの条件通知の設定を取得する GET /k/v1/app/notifications/reminder.json
/k/v1/preview/app/notifications/reminder.json
リマインダーの条件通知の設定を変更する PUT /k/v1/preview/app/notifications/reminder.json
アクセス権
HTTPメソッド URL
アプリのアクセス権の設定を取得する GET /k/v1/app/acl.json
/k/v1/preview/app/acl.json
アプリのアクセス権の設定を変更する PUT /k/v1/app/acl.json
/k/v1/preview/app/acl.json
レコードのアクセス権の設定を取得する GET /k/v1/record/acl.json
/k/v1/preview/record/acl.json
レコードのアクセス権の設定を変更する PUT /k/v1/record/acl.json
/k/v1/preview/record/acl.json
フィールドのアクセス権の設定を取得する GET /k/v1/field/acl.json
/k/v1/preview/field/acl.json
フィールドのアクセス権の設定を変更する PUT /k/v1/field/acl.json
/k/v1/preview/field/acl.json
その他の設定
HTTPメソッド URL
アプリのアクション設定を取得する GET /k/v1/app/actions.json
/k/v1/preview/app/actions.json
アプリのアクション設定を変更する PUT /k/v1/preview/app/actions.json

スペース

スペース

HTTPメソッド URL
スペースの情報を取得する GET /k/v1/space.json
スペースを作成する POST /k/v1/template/space.json
スペースを削除する DELETE /k/v1/space.json
スペースの本文を更新する PUT /k/v1/space/body.json
スペースのメンバーとスペース管理者の情報を取得する GET /k/v1/space/members.json
スペースのメンバーを更新する PUT /k/v1/space/members.json

スレッド

HTTPメソッド URL
スペースのスレッドを更新する PUT /k/v1/space/thread.json
スペースのスレッドにコメントを投稿する POST /k/v1/space/thread/comment.json

ゲストユーザーとゲストスペース

HTTPメソッド URL
ゲストユーザーを追加する POST /k/v1/guests.json
ゲストユーザーを削除する DELETE /k/v1/guests.json
ゲストスペースのゲストメンバーを更新する PUT /k/guest/ゲストスペース ID/v1/space/guests.json

API 情報

HTTPメソッド URL
kintone REST API の一覧を取得する GET /k/v1/apis.json
kintone REST API のスキーマ情報を取得する GET /k/v1/apis/*.json