更改流程管理設置

information

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

目錄

更改流程管理設置

更改應用程式的流程管理設置。

此 API 在測試環境中修改應用。
如果要將更改傳播到正式環境,執行該 運行將應用設置傳播到正式環境的API

URL

常規應用程式
https://sample.cybozu.com/k/v1/preview/app/status.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/status.json

HTTP 方法

PUT

所需存取權限

  • 應用程式管理

請求

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
enable 布爾值或字串 可省略 是否啟用流程管理
  • true:啟用流程管理
  • false:禁用流程管理
states 物件 可省略 更新狀態
新增或更新狀態時,請將現有狀態指定為 states
如果未指定,則刪除狀態。
states.狀態名稱 物件 可省略 配置每個狀態
  • 新增狀態時:
    指定要添加到的狀態的名稱 狀態名稱
  • 變更狀態時:
    指定更新為 之前的狀態名稱 狀態名稱
  • 刪除狀態時:
    不指定要刪除的狀態名稱屬性。
您無法新增第一個狀態。
如果要更改第一個狀態的狀態,請更改現有前導狀態的狀態名稱。
states.狀態名稱.name 字串 條件必填項 狀態名稱
最多指定 64 個字元。
如果要添加新狀態,則為必需,請指定狀態名稱 與 相同的值。
states.狀態名稱.index 數值或字串 條件必填項 狀態順序
指定一個介於 0 和 2 之間的數值。按值升序排序。
狀態名稱 如果指定,則為必填項。
states.狀態名稱.assignee 物件 可省略 狀態的執行者
states.狀態名稱.assignee.type 字串 條件必填項 狀態的執行者規範格式
  • ONE:從以下使用者中選擇執行者
  • ALL:以下所有使用者
  • ANY:以下使用者中其中1人
assignee 如果指定,則為必填項。
states.狀態名稱.assignee.entities 陣列 條件必填項 狀態執行者資訊
assignee 如果指定,則為必填項。
states.狀態名稱.assignee.entities[].entity 物件 條件必填項 狀態的執行者用戶資訊
entities內是必需的。
states.狀態名稱.assignee.entities[].entity.type 字串 條件必填項 輔助角色類型狀態
  • USER:使用者
  • GROUP:群組
  • ORGANIZATION:組織
  • FIELD_ENTITY:要指定為“選擇表單中的欄位”的欄位
  • CREATOR:應用程式建立人
  • CUSTOM_FIELD:.com共通管理者的 自訂項目 (External link)
entity 如果指定,則為必填項。
在訪客空間應用程式中,無法指定“ORGANIZATION”。
states.狀態名稱.assignee.entities[].entity.code 字串 條件必填項 狀態執行者代碼
entity.type 這取決於的值。
  • 對於“USER”:登入名稱
  • 對於“GROUP”:群組代碼
  • 對於“ORGANIZATION”:組織代碼
  • 對於FIELD_ENTITY:指定以下欄位的網域代碼:
    • 建立人
    • 更新人
    • 選擇使用者
    • 選擇組織
    • 選擇群組
  • CREATOR:不需要。
  • CUSTOM_FIELD:自訂項目代碼
entity.type 如果在 中指定了“CREATOR”以外的其他內容,則為必填項。
如果要指定訪客,請在登入名稱前加上“guest/”。
states.狀態名稱.assignee.entities[].includeSubs 布爾值或字串 可省略 執行者是否應包括子組織
  • true:包括
  • false:不包括
如果省略,則設置“false”。
entity.type 僅當在組織選擇欄位中指定“ORGANIZATION“或“FIELD_ENTITY“時才指定。
否則,將忽略該設置。
actions 陣列 可省略 返回動作清單
actions[].name 字串 條件必填項 動作名稱
最多指定 64 個字元。
actions 如果指定,則為必填項。
actions[].from 字串 條件必填項 動作執行前的狀態
actions 如果指定,則為必填項。
如果更改了狀態名稱,請指定新的狀態名稱。
actions[].to 字串 條件必填項 動作執行前的狀態
actions 如果指定,則為必填項。
如果更改了狀態名稱,請指定新的狀態名稱。
actions[].filterCond 字串 可省略 執行動作的條件
以查詢格式指定。有關查詢格式,請參閱 如何編寫查詢
不能將“狀態“欄位指定為精簡程式。
revision 數值或字串 可省略 預期修訂號
如果與實際修訂號不匹配,則會發生錯誤,並且不會更改設置。
如果指定值“-1”或未指定值,則不會驗證修訂號。
示例請求
標頭
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
  "app": "5",
  "enable": true,
  "states": {
    "未處理": {
      "name": "未處理",
      "index": "0",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    },
    "處理中": {
      "name": "處理中",
      "index": "1",
      "assignee": {
        "type": "ALL",
        "entities": [
          {
            "entity": {
              "type": "USER",
              "code": "user1"
            }
          },
          {
            "entity": {
              "type": "FIELD_ENTITY",
              "code": "creator"
            },
            "includeSubs": false
          },
          {
            "entity": {
              "type": "CUSTOM_FIELD",
              "code": "上司"
            }
          }
        ]
      }
    },
    "完成": {
      "name": "完成",
      "index": "2",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    }
  },
  "actions": [
    {
      "name": "開始處理",
      "from": "未處理",
      "to": "處理中",
      "filterCond": "記錄號碼 = \"1\""
    },
    {
      "name": "完成",
      "from": "處理中",
      "to": "完成",
      "filterCond": ""
    }
  ],
  "revision": "3"
}

回應

屬性
屬性名稱 類型 說明
revision 字串 更改應用設置后的修訂號
示例回應
1
2
3
{
  "revision": "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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/status.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "5",
      "enable": true,
      "states": {
        "未處理": {
          "name": "未處理",
          "index": "0",
          "assignee": {
            "type": "ONE",
            "entities": [
            ]
          }
        },
        "處理中": {
          "name": "處理中",
          "index": "1",
          "assignee": {
            "type": "ALL",
            "entities": [
              {
                "entity": {
                  "type": "USER",
                  "code": "user1"
                }
              },
              {
                "entity": {
                  "type": "FIELD_ENTITY",
                  "code": "creator"
                },
                "includeSubs": false
              },
              {
                "entity": {
                  "type": "CUSTOM_FIELD",
                  "code": "上司"
                }
              }
            ]
          }
        },
        "完了": {
          "name": "完了",
          "index": "2",
          "assignee": {
            "type": "ONE",
            "entities": [
            ]
          }
        }
      },
      "actions": [
        {
          "name": "処理開始",
          "from": "未處理",
          "to": "處理中",
          "filterCond": "記錄號碼 = \"1\""
        },
        {
          "name": "完了",
          "from": "處理中",
          "to": "完了",
          "filterCond": ""
        }
      ]
  }"
使用 發送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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
const body = {
  app: kintone.app.getId(),
  enable: true,
  states: {
    未處理: {
      name: '未處理',
      index: '0',
      assignee: {
        type: 'ONE',
        entities: [
        ]
      }
    },
    處理中: {
      name: '處理中',
      index: '1',
      assignee: {
        type: 'ALL',
        entities: [
          {
            entity: {
              type: 'USER',
              code: 'user1'
            }
          },
          {
            entity: {
              type: 'FIELD_ENTITY',
              code: 'creator'
            },
            includeSubs: false
          },
          {
            entity: {
              type: 'CUSTOM_FIELD',
              code: '上司'
            }
          }
        ]
      }
    },
    完了: {
      name: '完了',
      index: '2',
      assignee: {
        type: 'ONE',
        entities: [
        ]
      }
    }
  },
  actions: [
    {
      name: '処理開始',
      from: '未處理',
      to: '處理中',
      filterCond: '記錄號碼 = "1"'
    },
    {
      name: '完了',
      from: '處理中',
      to: '完了',
      filterCond: ''
    }
  ]
};

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