レコードコメントを投稿する

目次

レコードコメントを投稿する

レコードにコメントを投稿します。

  • APIトークンを利用した場合、投稿ユーザーは「Administrator」になります。
  • 宛先の名前には、APIを実行したユーザーの言語設定が利用されます。
  • 停止ユーザー、削除ユーザー、組織、グループには通知されません。
  • ゲストスペースの場合、退会したユーザーは削除ユーザーと同じ動作になります。
  • 宛先に招待中のゲストユーザーを指定すると、エラーになります。
  • レコードのコメント機能を無効にしたアプリで実行すると、エラーになります。

URL

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

HTTPメソッド

POST

必要なアクセス権

  • コメントを投稿するアプリの閲覧権限
  • コメントを投稿するレコードの閲覧権限

リクエスト

パラメーター
パラメーター名 必須 説明
app 数値または文字列 必須 アプリID
record 数値または文字列 必須 レコードID
comment オブジェクト 必須 コメントの情報
comment.text 文字列 必須 コメントの内容
コメントの最大文字数は65,535文字です。
comment.mentions 配列 省略可 コメントの宛先情報
comment.mentions[].code 文字列 省略可 宛先のユーザー/組織/グループコードです。
指定できる宛先の数の上限値は10です。
宛先を指定すると、本文の前に宛先情報が挿入されます。
宛先のユーザーにゲストユーザーを指定する場合、codeに「guest/ログインメールアドレス」を指定する必要があります。
comment.mentions[].type 文字列 省略可 宛先のユーザー/組織/グループの種類です。
  • USER:ユーザー
  • GROUP:グループ
  • ORGANIZATION:組織
リクエストの例
ヘッダー
1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "app": 12343,
  "record": 4,
  "comment": {
    "text": "システムからのコメントです。ご確認をお願いします。",
    "mentions": [
      {
        "code": "takahashi",
        "type": "USER"
      },
      {
        "code": "guest/yamada@test.jp",
        "type": "USER"
      },
      {
        "code": "営業本部_OZKQWZ",
        "type": "ORGANIZATION"
      },
      {
        "code": "管理部受付_zX6C6r",
        "type": "GROUP"
      }
    ]
  }
}

レスポンス

プロパティ
プロパティ名 説明
id 数値 投稿したコメントのコメントID
レスポンスの例
1
2
3
{
  "id": 3
}

サンプルコード

curlを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
curl -X POST 'https://sample.cybozu.com/k/v1/record/comment.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": 1001,
    "comment": {
      "text": "システムからのコメントです。ご確認をお願いします。",
      "mentions": [
        {
          "code": "takahashi",
          "type": "USER"
        },
        {
          "code": "guest/yamada@test.jp",
          "type": "USER"
        },
        {
          "code": "営業本部_OZKQWZ",
          "type": "ORGANIZATION"
        },
        {
          "code": "管理部受付_zX6C6r",
          "type": "GROUP"
        }
      ]
    }
  }'
kintone REST APIリクエストを送信するAPIを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const body = {
  app: kintone.app.getId(),
  record: 1001,
  comment: {
    text: 'システムからのコメントです。\nご確認をお願いします。',
    mentions: [
      {
        code: 'takahashi',
        type: 'USER'
      },
      {
        code: 'guest/yamada@test.jp',
        type: 'USER'
      },
      {
        code: '営業本部_OZKQWZ',
        type: 'ORGANIZATION'
      },
      {
        code: '管理部受付_zX6C6r',
        type: 'GROUP'
      }
    ]
  }
};
await kintone.api(kintone.api.url('/k/v1/record/comment.json'), 'POST', body);