獲取應用的通知條件設置

連結已複製

獲取應用的通知條件的設置。

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

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用程式ID

應答屬性

連結已複製

屬性名稱	類型	說明
notifications	陣列（物件）	通知條件設置的物件陣列
notifications[].entity	物件	為其設置條件通知的物件
notifications[].entity.type	字串	通知條件設置的類型 `USER`：使用者 `GROUP`：群組 `ORGANIZATION`：組織 `FIELD_ENTITY`：在「選擇表單中的欄位」中指定的欄位建立人更新人選擇使用者選擇組織選擇群組
notifications[].entity.code	字串	設置條件通知的代碼這取決於`entity.type`值。對於「USER」：用戶的登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼 FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位如果您是訪客，則您的登入名前面有「guest/」。
notifications[].includeSubs	布爾值	設置是否由子單位繼承 `true`：繼承 `false`：不繼承 `entity.type` 僅當的值為「ORGANIZATION」或「FIELD_ENTITY」指定組織選擇欄位時，才返回「true」。
notifications[].recordAdded	布爾值	添加記錄時是否通知 `true`：添加記錄時通知 `false`：添加記錄時不通知
notifications[].recordEdited	布爾值	編輯記錄時是否通知 `true`：通過記錄編輯通知 `false`：編輯記錄時不通知
notifications[].commentAdded	布爾值	是否在撰寫評論時通知 `true`：通過寫評論通知 `false`：寫評論時不通知
notifications[].statusChanged	布爾值	是否希望收到狀態更新的通知 `true`：通知我狀態更新 `false`：不通知我狀態更新
notifications[].fileImported	布爾值	載入檔時是否通知 `true`：通過載入檔通知 `false`：載入檔時不通知
notifyToCommenter	布爾值	曾填寫回覆的使用者，將於該記錄新增回覆時收到通知。 `true`：在撰寫評論時接收通知 `false`：在撰寫評論時不接收通知
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

https\://sample.cybozu.com/k/v1/app/notifications/general.json?app=1

請求標頭（在URL中包含參數的情況）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

請求URL（在請求主體中包含參數的情況）

1

https\://sample.cybozu.com/k/v1/app/notifications/general.json

請求標頭（在請求主體中包含參數的情況）

1
2
3
4


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

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

請求主體

1
2
3


{
  "app": "1"
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "notifications": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "includeSubs": false,
      "recordAdded": true,
      "recordEdited": true,
      "commentAdded": false,
      "statusChanged": false,
      "fileImported": true
    }
  ],
  "notifyToCommenter": true,
  "revision": "2"
}

範例程式碼

使用kintone.api()傳送請求

有關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/general.json', true), 'GET', body);

使用curl傳送請求

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

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/app/notifications/general.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1
  }'

kintone API

kintone API文件

獲取應用的通知條件設置

目錄

請求參數

應答屬性

所需存取權限

範例