kintone Customization Gallery

更改應用的操作設置

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

更改應用的操作設置

連結已複製

如果您的應用中存在同名操作，或者更新后的操作名稱與其他操作名稱重複，則在運行此 API 時將收到錯誤。

此 API 在測試環境中修改應用。
如果要將更改傳播到生產環境，請運行此 API，然後 運行將應用設置傳播到生產環境的 API 。

URL

連結已複製

常規應用
https://sample.cybozu.com/k/v1/preview/app/actions.json
建立訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/actions.json

HTTP 方法

連結已複製

PUT

所需許可權

連結已複製

  • 應用程式管理

請求

連結已複製

參數
參數名稱 型 必須 說明
app 數位或字串 必須 應用ID
actions 物件 必須 動作的設定
添加或更新操作配置時，請在 中 actions 指定現有操作的配置。
如果未指定，則將刪除該操作的配置。
actions.操作名 物件 自選 動作的設定
  • 新增操作時：
    指定要添加的操作的名稱 操作名 。
  • 變更操作時：
    指定要更新的操作的名稱 操作名 。
  • 刪除操作時：
    不要指定要刪除的操作名稱的屬性。
actions.操作名.name 字串 條件必填項 動作名稱
指定 1 到 32 個字元。
如果要添加操作，請指定操作名 與 相同的值，這是必需的。
如果要更改現有操作的名稱，請指定新操作的名稱。
如果省略，則不會更改。
actions.操作名.index 數位或字串 條件必填項 按其顯示順序執行的操作
按值升序排序。
操作名 如果指定，則為必填項。
actions.操作名.destApp 物件 條件必填項 目標應用程式
如果要添加操作，則為必填項。
如果省略，則不會更改。
actions.操作名.destApp.app 數位或字串 條件必填項 目標應用的應用ID
destApp.app 或 destApp.code 為必填項。
如果兩者都指定destApp.code ，則設定值 。
actions.操作名.destApp.code 字串 條件必填項 目標應用的應用代碼
destApp.app 或 destApp.code 為必填項。
如果兩者都指定destApp.code ，則設定值 。
如果指定了"null"或空字元，則假定它未指定。
actions.操作名.mappings 陣列 條件必填項 相關欄位：
如果指定「添加」或 destApp 「添加操作」 則為必填項。
如果省略，則不會更新。
如果指定了空陣列，則將其設置為無欄位關聯。
actions.操作名.mappings[].srcType 字串 條件必填項 源類型
指定以下值之一：
  • FIELD：欄位
  • 記錄的連結
mappings 如果指定，則為必填項。
actions.操作名.mappings[].srcField 字串 條件必填項 源欄位的域代碼
mappings[].srcType 如果為"FIELD"，則為必填項。
actions.操作名.mappings[]destField 字串 條件必填項 目標欄位的欄位代碼
mappings 如果指定，則為必填項。
actions.操作名.entities 陣列（字串） 條件必填項 使用該操作的成員清單
如果要添加新操作，則為必填項。
如果省略，則不會更新。
如果指定了空陣列，則不會設置使用該操作的成員。
actions.操作名.entities[].type 字串 條件必填項 使用該操作的成員類型
指定以下值之一：
  • USER：使用者
  • GROUP：群組
  • ORGANIZATION：組織
在訪客空間應用程式中，無法指定"ORGANIZATION"。
entities 如果指定，則為必填項。
actions.操作名.entities[].code 字串 條件必填項 使用操作的成員的代碼
entity.type 這取決於的值。
  • 對於"USER"：登錄名
  • 對於"GROUP"：組代碼
  • 對於"ORGANIZATION"：組織代碼
如果要指定來賓使用者，請在登錄名前加上"guest/"。
entities 如果指定，則為必填項。
revision 數位或字串 自選 預期修訂號
如果與實際修訂號不匹配，則會發生錯誤，並且不會更改設置。
如果指定值"-1"或未指定值，則不會驗證修訂號。
示例請求
URL

https://sample.cybozu.com/k/v1/preview/app/actions.json

頁眉
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
31
32
33
34
35

{
  "app": "1",
  "actions": {
    "註冊訂單管理": {
      "name": "註冊訂單管理",
      "index": "0",
      "destApp": {
        "code": "INVOICE"
      },
      "mappings": [
        {
          "srcType": "FIELD",
          "srcField": "CompanyName",
          "destField": "CompanyName"
        },
        {
          "srcType": "FIELD",
          "srcField": "DivisionName",
          "destField": "DivisionName"
        },
        {
          "srcType": "RECORD_URL",
          "destField": "URL"
        }
      ],
      "entities": [
        {
          "type": "USER",
          "code": "userA"
        }
      ]
    }
  },
  "revision": "2"
}

回應

連結已複製

財產
屬性名稱 型 說明
actions 物件 建立動作
actions.操作名.id 字串 操作ID
revision 字串 更新後應用設置的修訂號
示例回應
1
2
3
4
5
6
7
8

{
  "revision": "2",
  "actions": {
    "註冊訂單管理": {
      "id": "7319"
    }
  }
}

示例代碼

連結已複製

使用 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
29
30
31
32
33
34
35
36
37

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/actions.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "actions": {
      "註冊訂單管理"： {
        "name": "註冊訂單管理"，
        "index": "0",
        "destApp": {
          "code": "INVOICE",
        },
        "mappings": [
          {
            "srcType": "FIELD",
            "srcField": "CompanyName",
            "destField": "CompanyName",
          },
          {
            "srcType": "FIELD",
            "srcField": "DivisionName",
            "destField": "DivisionName",
          },
          {
            "srcType": "RECORD_URL",
            "destField": "URL",
          },
        ],
        "entities": [
          {
            "type": "USER",
            "code": "userA",
          },
        ],
      },
    },
  }'
發送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
27
28
29
30
31
32
33
34
35
36

const body = {
  app: kintone.app.getId(),
  actions: {
    註冊訂單管理: {
      name: '註冊訂單管理',
      index: '4',
      destApp: {
        code: 'INVOICE',
      },
      mappings: [
        {
          srcType: 'FIELD',
          srcField: 'CompanyName',
          destField: 'CompanyName',
        },
        {
          srcType: 'FIELD',
          srcField: 'DivisionName',
          destField: 'DivisionName',
        },
        {
          srcType: 'RECORD_URL',
          destField: 'URL',
        },
      ],
      entities: [
        {
          type: 'USER',
          code: 'userA',
        },
      ],
    },
  },
};

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