kintone API文件

獲取流程管理設置

information

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

目錄

獲取流程管理設置

連結已複製

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

URL

連結已複製

獲取正式環境的設置時，URL 與獲取測試環境的設置時不同。

如果要獲取正式環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/app/status.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/status.json
獲取操作測試環境的設置
常規應用程式
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 方法

連結已複製

GET

所需存取權限

連結已複製

如果要獲取正式環境的設置

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

  • 應用程式中記錄的查看權限
  • 應用程式中新增記錄的權限
獲取操作測試環境的設置
  • 應用程式管理

請求

連結已複製

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

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

標頭
1
2
3

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

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

要求範例（如果要在要求內文中包含參數）
URL

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

標頭
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
正文
1
2
3
4

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

回應

連結已複製

屬性
屬性名稱 類型 說明
enable 布爾值 是否啟用流程管理
  • true：啟用流程管理
  • false：禁用流程管理
states 物件 更新狀態
如果應用從未設置過流程管理，它將返回「null」。
states.狀態名.name 字串 狀態名稱
states.狀態名.index 字串 狀態順序
這些值以0開頭，並按升序排序。
states.狀態名.assignee 物件 狀態的執行者
states.狀態名.assignee.type 字串 狀態中的執行者類型
  • ONE：從以下使用者中選擇執行者
  • ALL：以下所有使用者
  • ANY：以下使用者中其中1人
開始的狀態（states.狀態名.index 最低是最低的）返回「ONE」。
states.狀態名.assignee.entities 陣列 具有狀態的執行者清單
排序順序與畫面相同。
states.狀態名.assignee.entities[].entity 物件 狀態的執行者用戶資訊
如果指定了已刪除或無效的使用者、組織或使用者，並且指定了已刪除的自定義項，則該自定義項將不會包含在回應中。
states.狀態名.assignee.entities[].entity.type 字串 狀態的執行者規範格式
  • USER：使用者
  • GROUP：群組
  • ORGANIZATION：組織
  • FIELD_ENTITY：在「選擇表單中的欄位」中指定的欄位
  • CREATOR：應用程式建立人
  • CUSTOM_FIELD：.com共通管理員的自訂項目
    自訂 (External link)
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 字串 執行動作的條件
revision 字串 應用設置的修訂號
應答範例
 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

{
  "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": "上司"
            },
            "includeSubs": false
          }
        ]
      }
    },
    "完成": {
      "name": "完成",
      "index": "2",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    }
  },
  "actions": [
    {
      "name": "開始處理",
      "from": "未處理",
      "to": "處理中",
      "filterCond": "記錄號碼 = \"1\""
    },
    {
      "name": "完成",
      "from": "處理中",
      "to": "完成",
      "filterCond": ""
    }
  ],
  "revision": "3"
}

示例代碼

連結已複製

使用 curl 的請求
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
  }'
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);