kintone API ドキュメント

レコードの作業者を更新する

目次

レコードの作業者を更新する

レコードの作業者を更新します。

  • プロセス管理機能を有効にしたアプリで使用できます。
  • 作業者の変更後は、レコードの変更履歴に記録されます。
  • 権限のないユーザーを作業者に指定した場合は、エラーになります。
  • 1 名の作業者のみのステータスに、2 名以上の作業者を指定した場合にはエラーになります。

URL

通常のアプリ
https://sample.cybozu.com/k/v1/record/assignees.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/record/assignees.json

HTTP メソッド

PUT

必要なアクセス権

  • アプリ管理権限
  • アプリのレコード閲覧権限
  • 作業者を更新するレコードの閲覧権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
id 数値または文字列 必須 レコード ID
assignees 配列 必須 作業者に設定するユーザーのログイン名
空の配列を指定すると、作業者が解除されます
最大で 100 件の作業者を指定できます。
revision 数値または文字列 省略可 変更する前の、レコードのリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、作業者は変更されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ
1
2
3
4
5
6

{
  "app": 1,
  "id": 1,
  "assignees": ["user2"],
  "revision": 1
}

レスポンス

プロパティ
プロパティ名 型 説明
revision 文字列 変更したあとのレコードのリビジョン番号
レスポンスの例
1
2
3

{
  "revision": "2"
}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6
7
8
9

curl -X PUT 'https://sample.cybozu.com/k/v1/record/assignees.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "id": 1,
    "assignees": ["user2"],
    "revision": 1
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  id: 1001,
  assignees: ['user1']
};
await kintone.api(kintone.api.url('/k/v1/record/assignees.json', true), 'PUT', body);