更改流程管理設置
更改應用程式的進程管理設置。
此 API 在測試環境中修改應用。
如果要將更改傳播到生產環境,請運行此 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 | 布爾值或字串 | 自選 | 是否啟用進程管理
|
states | 物件 | 自選 | 更新狀態 新增或更新狀態時,請將現有狀態指定為 states 。如果未指定,則刪除狀態。 |
states.状態名 |
物件 | 自選 | 配置每個狀態
如果要更改第一個狀態的狀態,請更改現有前導狀態的狀態名稱。 |
states.状態名 .name |
字串 | 條件必填項 | 更新狀態 最多指定 64 個字元。 如果要添加新狀態,則為必需,請指定 状態名 與 相同的值。 |
states.状態名 .index |
數位或字串 | 條件必填項 | 更新狀態 指定一個介於 0 和 2 之間的數位。按值升序排序。 状態名 如果指定,則為必填項。 |
states.状態名 .assignee |
物件 | 自選 | 狀態 Worker |
states.状態名 .assignee.type |
字串 | 條件必填項 | 狀態的工作器規範格式
assignee 如果指定,則為必填項。 |
states.状態名 .assignee.entities |
陣列 | 條件必填項 | 狀態工作人員資訊assignee 如果指定,則為必填項。 |
states.状態名 .assignee.entities[].entity |
物件 | 條件必填項 | 狀態的輔助角色用戶資訊entities 要求: |
states.状態名 .assignee.entities[].entity.type |
字串 | 條件必填項 | 輔助角色類型狀態
entity 如果指定,則為必填項。在訪客空間應用程式中,無法指定"ORGANIZATION"。 |
states.状態名 .assignee.entities[].entity.code |
字串 | 條件必填項 | 狀態工作器代碼entity.type 這取決於的值。
entity.type 如果在 中指定了"CREATOR"以外的其他內容,則為必填項。如果要指定來賓使用者,請在登錄名前加上"guest/"。 |
states.状態名 .assignee.entities[].includeSubs |
布爾值或字串 | 自選 | 工作人員是否應包括子組織
entity.type 僅當在組織選擇欄位中指定「ORGANIZATION」或「FIELD_ENTITY」時才指定。否則,將忽略該設置。 |
actions | 陣列 | 自選 | 返回動作清單 |
actions[].name | 字串 | 條件必填項 | 動作名稱 最多指定 64 個字元。 actions 如果指定,則為必填項。 |
actions[].from | 字串 | 條件必填項 | 動作執行前的狀態actions 如果指定,則為必填項。如果更改了狀態名稱,請指定新的狀態名稱。 |
actions[].to | 字串 | 條件必填項 | 動作執行前的狀態actions 如果指定,則為必填項。如果更改了狀態名稱,請指定新的狀態名稱。 |
actions[].filterCond | 字串 | 自選 | 執行操作的條件 以查詢格式指定。有關查詢格式, 請參閱如何 編寫查詢。 不能將「狀態」欄位指定為精簡程式。 |
revision | 數位或字串 | 自選 | 預期修訂號 如果與實際修訂號不匹配,則會發生錯誤,並且不會更改設置。 如果指定值"-1"或未指定值,則不會驗證修訂號。 |
示例請求
頁眉
|
|
關於請求頭,請參見 kintone REST API的通用規範 。
身體
|
|
回應
財產
屬性名稱 | 型 | 說明 |
---|---|---|
revision | 字串 | 更改應用設置后的修訂號 |
示例回應
|
|
樣本
使用 curl 的請求
|
|
發送kintone REST API請求 使用API 發送請求
|
|