kintone API

獲取記錄的通知條件的設置

獲取記錄的通知條件設置。

目錄

HTTP 方法GET
URLhttps://sample.cybozu.com/k/v1/app/notifications/perRecord.json
URL(訪客空間)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/notifications/perRecord.json
URL(操作測試環境)https://sample.cybozu.com/k/v1/preview/app/notifications/perRecord.json
URL(測試環境中的訪客空間)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/notifications/perRecord.json
認證 密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Typeapplication/json(透過查詢字串指定查詢時不需要指定此項)

請求參數

參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
lang 字串 可省略 要選取的名稱的語言
如果已在選擇公式欄位的選項欄位中設置了多語言對應,請指定。
多語言對應 (External link)
  • ja:日文
  • en:英語
  • zh:中文
  • user:執行 API 的使用者設置為顯示語言的語言
    如果語言設置為「與網路瀏覽器設定相同」,則要獲取的語言取決於是否存在「Accept-Language」標頭。
    • 帶標題:帶標頭:「Accept-Language」標頭中指定的語言
    • 無標頭:在cybozu.com通用管理的地區設定中設置的語言
      地區設定 (External link)
  • default:預設
如果省略,則獲取預設名稱。

回應屬性

屬性名稱 類型 說明
notifications 陣列 通知條件設置清單
notifications[].filterCond 字串 記錄的條件
它以查詢的形式表示。有關查詢格式的詳細資訊,請參閱以下頁面。
如何編寫查詢
notifications[].title 字串 通知內容
notifications[].targets 陣列 通知收件者清單
notifications[].targets[].entity 物件 通知的接收者
notifications[].targets[].entity.type 字串 通知收件者的類型
  • USER:使用者
  • GROUP:群組
  • ORGANIZATION:組織
  • FIELD_ENTITY:在「選擇表單中的欄位」中指定的欄位
    • 建立人
    • 更新人
    • 選擇使用者
    • 選擇組織
    • 選擇群組
notifications[].targets[].entity.code 字串 通知目標目標的代碼
entity.type的值而異。
  • 對於「USER」:用戶的登入名稱
  • 對於「GROUP」:群組代碼
  • 對於「ORGANIZATION」:組織代碼
  • FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位
如果您是訪客,則您的登入名前面有「guest/」。
notifications[].targets[].includeSubs 布爾值 設置是否由子單位繼承
  • true:繼承
  • false:不繼承
如果entity.type的值為「ORGANIZATION」或「FIELD_ENTITY」指定組織選擇欄位,則返回「true」。
revision 字串 應用設置的修訂號

所需存取權限

  • 應用程式管理權限

範例

1
https\://sample.cybozu.com/k/v1/app/notifications/perRecord.json?app=8&lang=ja
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

1
https\://sample.cybozu.com/k/v1/app/notifications/perRecord.json
1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

1
2
3
4
{
  "app": "8",
  "lang": "ja"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "notifications": [
    {
      "filterCond": "選擇使用者_0 in (\"user1\")",
      "title": "user1已選擇",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "revision": "2"
}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
const body = {
  app: kintone.app.getId()
};

await kintone.api(kintone.api.url('/k/v1/app/notifications/perRecord.json'), 'GET', body);

根據您的環境,curl的格式可能會有所不同。
有關說明,請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

1
2
3
4
5
6
curl -X GET 'https://sample.cybozu.com/k/v1/app/notifications/perRecord.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "8"
  }'