變更應用程式的通知條件設置

連結已複製

變更應用程式的通知條件設置。

HTTP 方法	PUT
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`，則不變更。
notifications[].entity	物件	條件必填項	以通知條件設置為準如果`notifications`指定，則為必填項。
notifications[].entity.type	字串	條件必填項	通知條件設置的類型 `USER`：使用者 `GROUP`：群組 `ORGANIZATION`：組織 `FIELD_ENTITY`：要指定為「新增表單中的欄位」的欄位如果`entity`指定，則為必填項。
notifications[].entity.code	字串	條件必填項	設置條件通知的代碼這取決於`entity.type`值。對於「USER」：登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼對於「FIELD_ENTITY」：指定以下欄位的網域代碼：建立人更新人選擇使用者選擇組織選擇群組如果指定了`entity`參數，則為必填項。如果要指定訪客，請在登入名稱前加上「guest/」。
notifications[].includeSubs	布爾值或字串	可省略	設置是否繼承給下級組織 `true`：繼承 `false`：不繼承 `entity.type`為「ORGANIZATION」或「FIELD_ENTITY」中指定了選擇組織欄位時才有效。如果省略，則設置「false」。
notifications[].recordAdded	布爾值或字串	可省略	添加記錄時是否通知 `true`：添加記錄時通知 `false`：添加記錄時不通知如果省略，則設置「false」。
notifications[].recordEdited	布爾值或字串	可省略	編輯記錄時是否通知 `true`：通過記錄編輯通知 `false`：編輯記錄時不通知如果省略，則設置「false」。
notifications[].commentAdded	布爾值或字串	可省略	是否在撰寫評論時通知 `true`：通過寫評論通知 `false`：寫評論時不通知如果省略，則設置「false」。
notifications[].statusChanged	布爾值或字串	可省略	是否希望收到狀態更新的通知 `true`：通知我狀態更新 `false`：不通知我狀態更新如果省略，則設置「false」。
notifications[].fileImported	布爾值或字串	可省略	載入檔時是否通知 `true`：通過載入檔通知 `false`：載入檔時不通知如果省略，則設置「false」。
notifyToCommenter	布爾值或字串	可省略	曾填寫回覆的使用者，將於該記錄新增回覆時收到通知。 `true`：在撰寫評論時接收通知 `false`：在撰寫評論時不接收通知如果省略，則不會變更。
revision	數值或字串	可省略	預期修訂號如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。如果指定值「-1」或未指定值，則不會驗證修訂號。

應答屬性

連結已複製

屬性名稱	類型	說明
revision	字串	變更應用程式設置后的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求標頭

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
26
27
28
29
30


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

範例回應

1
2
3


{
  "revision": "2"
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送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
26
27
28
29
30
31
32


const body = {
  app: kintone.app.getId(),
  notifications: [
    {
      entity: {
        type: 'USER',
        code: 'user1'
      },
      recordAdded: true,
      recordEdited: true,
      commentAdded: false,
      statusChanged: false,
      fileImported: true
    },
    {
      entity: {
        type: 'ORGANIZATION',
        code: 'org1'
      },
      includeSubs: true,
      recordAdded: true,
      recordEdited: true,
      commentAdded: false,
      statusChanged: false,
      fileImported: true
    }
  ],
  notifyToCommenter: true,
  revision: '2'
};

await kintone.api(kintone.api.url('/k/v1/preview/app/notifications/general.json', true), 'PUT', body);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行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
27
28
29
30
31
32
33


curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/notifications/general.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "notifications": [
      {
        "entity": {
          "type": "USER",
          "code": "user1"
        },
        "recordAdded": true,
        "recordEdited": true,
        "commentAdded": false,
        "statusChanged": false,
        "fileImported": true
      },
      {
        "entity": {
          "type": "ORGANIZATION",
          "code": "org1"
        },
        "includeSubs": false,
        "recordAdded": true,
        "recordEdited": true,
        "commentAdded": false,
        "statusChanged": false,
        "fileImported": true
      }
    ],
    "notifyToCommenter": true,
    "revision": "2"
  }'

補充

連結已複製

此API可變更測試環境中的應用程式。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用程式設置反映到正式環境的API。
將應用程式設置套用到正式環境API

kintone API

kintone API文件

變更應用程式的通知條件設置

目錄

請求參數

應答屬性

所需存取權限

範例

補充