獲取流程管理設置

連結已複製

獲取應用程式的流程管理設置。

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

請求參數

連結已複製

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

應答屬性

連結已複製

屬性名稱	類型	說明
enable	布爾值	是否啟用流程管理 `true`：啟用流程管理 `false`：禁用流程管理
states	物件	更新狀態如果應用從未設置過流程管理，它將返回「null」。
states.`狀態名`.name	字串	狀態名稱
states.`狀態名`.index	字串	狀態順序這些值以`0`開頭，並按升序排序。
states.`狀態名`.assignee	物件	狀態的執行者
states.`狀態名`.assignee.type	字串	狀態中的執行者類型 `ONE`：從以下使用者中選擇執行者 `ALL`：以下所有使用者 `ANY`：以下使用者中其中一人開始的狀態（`states.狀態名.index` 最低是最低的）返回「ONE」。
states.`狀態名`.assignee.entities	陣列	具有狀態的執行者清單排序順序與畫面相同。
states.`狀態名`.assignee.entities[].entity	物件	狀態的執行者用戶資訊如果指定了已刪除或無效的使用者、組織或使用者，並且指定了已刪除的自定義項，則該自定義項將不會包含在回應中。
states.`狀態名`.assignee.entities[].entity.type	字串	狀態的執行者規範格式 `USER`：使用者 `GROUP`：群組 `ORGANIZATION`：組織 `FIELD_ENTITY`：在「選擇表單中的欄位」中指定的欄位 `CREATOR`：應用程式建立人 `CUSTOM_FIELD`：.com共通管理員的自訂項目什麼是自訂項目？
states.`狀態名`.assignee.entities[].entity.code	字串	狀態執行者代碼這取決於`entity.type`值。對於「USER」：登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼 FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位對於「CREATOR」：「null」對於「CUSTOM_FIELD」：自訂項目代碼如果您是訪客，則您的登入名前面有「guest/」。
states.`狀態名`.assignee.entities[].includeSubs	布爾值	設置是否由子單位繼承 `true`：繼承 `false`：不繼承 `entity.type` 僅當為「ORGANIZATION」或在「FIELD_ENTITY」中指定組織選擇欄位時，才返回「true」。
actions	陣列	返回動作清單排序順序與畫面相同。如果應用從未設置過流程管理，它將返回「null」。
actions[].name	字串	動作名稱
actions[].from	字串	動作執行前的狀態
actions[].to	字串	動作執行前的狀態
actions[].filterCond	字串	執行動作的條件
actions[].type	字串	動作類型 `PRIMARY`: 表示只有動作執行前的狀態里指定的執行者可執行的動作。如果未指定執行者，則任何可以查看記錄的人都可以執行此動作。 `SECONDARY`: 表示「執行者以外使用者可執行的動作」。`actions[].executableUser`中指定的使用者可以執行的作
actions[].executableUser	物件	「執行者以外使用者可執行的動作」的可執行使用者。僅當`actions[].type`為`SECONDARY`時才包含在回應中。
actions[].executableUser.entities	陣列	「執行者以外使用者可執行的動作」的可執行使用者的資訊如果陣列為空，則可以查看記錄的所有使用者都可執行動作。
actions[].executableUser.entities[].entity	物件	「執行者以外使用者可執行的動作」的可執行使用者的資訊已刪除或停用的使用者、組織和組不包括在回應中。
actions[].executableUser.entities[].entity.type	字串	「執行者以外使用者可執行的動作」的可執行使用者的指定形式 `USER`: 使用者 `GROUP`: 群組 `ORGANIZATION`: 組織 `FIELD_ENTITY`: 使用者欄位
actions[].executableUser.entities[].entity.code	字串	「執行者以外使用者可執行的動作」的可執行使用者的代碼這取決於`entity.type`值。對於「USER」：登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼 FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位如果您是訪客，則您的登入名前面有「guest/」。
actions[].executableUser.entities[].includeSubs	布爾值	設置是否由子單位繼承 `true`：繼承 `false`：不繼承 `entity.type` 僅當為「ORGANIZATION」或在「FIELD_ENTITY」中指定組織選擇欄位時，才返回「true」。
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

取得正式環境的設定

連結已複製

您必須具有以下權限之一：

應用程式中記錄的查看權限
應用程式的記錄添加權限

取得操作測試環境的設定

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

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

1

https\://sample.cybozu.com/k/v1/app/status.json?app=1&lang=ja

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

1
2
3


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

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

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

1

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

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

1
2
3
4


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

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

請求主體

1
2
3
4


{
  "app": "1",
  "lang": "ja"
}

範例回應

 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89


{
  "enable": true,
  "states": {
    "未處理": {
      "name": "未處理",
      "index": "0",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    },
    "處理中": {
      "name": "處理中",
      "index": "1",
      "assignee": {
        "type": "ALL",
        "entities": [
          {
            "entity": {
              "type": "USER",
              "code": "user1"
            },
            "includeSubs": false
          },
          {
            "entity": {
              "type": "FIELD_ENTITY",
              "code": "建立人"
            },
            "includeSubs": false
          },
          {
            "entity": {
              "type": "CUSTOM_FIELD",
              "code": "supervisor"
            },
            "includeSubs": false
          }
        ]
      }
    },
    "完成": {
      "name": "完成",
      "index": "2",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    }
  },
  "actions": [
    {
      "name": "開始處理",
      "from": "未處理",
      "to": "處理中",
      "filterCond": "記錄編號 = \“1\”“，
      "type": "PRIMARY",
      "executableUser": {
        "entities": []
      }
    },
    {
      "name": "完成",
      "from": "處理中",
      "to": "完成",
      "filterCond": "",
      "type": "PRIMARY"
    },
    {
      "name": "由執行者以外使用者完成”
      "from": "處理中",
      "to": "完成",
      "filterCond": "",
      "type": "SECONDARY",
      "executableUser": {
        "entities": [
          {
            "entity": {
              "type": "FIELD_ENTITY",
              "code": "creator"
            },
            "includeSubs": false
          }
        ]
      }
    }
  ],
  "revision": "3"
}

範例程式碼

使用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/status.json', true), 'GET', body);

使用curl傳送請求

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

1
2
3
4
5
6
7


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

限制事項

連結已複製

即使通過「禁用新功能」禁用了「在流程管理設定中新增設定項目『執行者以外使用者可執行的動作』」，執行API返回的應答中，也會包含該功能的資訊。
獲取kintone REST API的Schema資訊

kintone API

kintone API文件

獲取流程管理設置

目錄

請求參數

應答屬性

所需存取權限

取得正式環境的設定

取得操作測試環境的設定

範例

限制事項