Agilite (預覽版)
Agilit-e 可讓您集中商務邏輯和流程,並將它們作為微服務公開給新的或現有的應用程式。 透過 Agilit-e 連接器,您可以存取許多服務,包括業務流程管理 (BPM)、角色、關鍵字、範本等。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Agilit-e 支援團隊 |
| URL | https://agilite.io |
| support@agilite.io |
| 連接器中繼資料 | |
|---|---|
| Publisher | 阿吉利特-e |
| 網站 | https://agilite.io |
| 隱私策略 | https://agilite.io/privacy-policy/ |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 可共用 |
預設
適用:所有地區
建立連線的參數。
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 指定 Agilit-e API 伺服器 URL。 (對 Agilit-e Cloud 使用 'https://api.agilite.io') | 字串 | 指定 Agilit-e API 伺服器 URL。 (對 Agilit-e Cloud 使用 'https://api.agilite.io') | 對 |
| API 金鑰 (在「管理」下的「https://portal.agilite.io」中產生) | securestring | API 金鑰 (在「管理」下的「https://portal.agilite.io」中產生) | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 依值取得標籤 (關鍵字) |
根據提供的 'profile-key' 和 'value-key' 傳回關鍵字標籤 |
| 依群組取得設定檔金鑰 (關鍵字) |
根據提供的「群組名稱」傳回所有關鍵字設定檔索引鍵 |
| 取得指派的角色 (角色) |
取得先前為特定記錄指派的角色的負責人 () |
| 取得角色 (角色) |
取得指派給 Agilit-e 系統管理入口網站中角色的負責人 () 。 這些角色不僅與特定記錄或業務流程相關,而且更常用於組織中的公司範圍角色 |
| 取得記錄狀態 (BPM) |
取得一或多筆記錄的 BPM 記錄狀態,以包括目前狀態、記錄負責人、工作流程歷程記錄和其他資訊,以描述記錄的目前狀態和規則 |
| 執行 (BPM) |
在其目前的工作流程步驟中提交選項。 根據業務規則,記錄將進展到流程中的下一個步驟,並將下一個步驟的相關資訊傳回給呼叫 API |
| 執行 (範本) |
根據提供的 'profile-key' 處理並傳回來自 Agilit-e 的範本 |
| 指派角色 (角色) |
指派適用於特定記錄的使用者指定角色。 這方面的一個例子是文件審核員或休假審批人 |
| 按設定檔金鑰取得 (關鍵字) |
根據提供的「profile-key」傳回特定關鍵字設定檔的索引鍵/值對 |
| 按配置文件鍵獲取 (BPM) |
取得完整的 BPM 設定檔,其中包含流程的配置和選項。 |
| 產生編號 (編號) |
根據提供的「profile-key」產生唯一編號 |
| 登錄 BPM 記錄 (BPM) |
註冊新的 BPM 記錄。 記錄會指派 recordID,該 recordID 用於記錄生命週期,以隨時識別記錄、記錄進度、歷程記錄和狀態 |
| 透過標籤取得價值 (關鍵字) |
根據提供的 'profile-key' 和 'label-key' 傳回關鍵字值 |
依值取得標籤 (關鍵字)
根據提供的 'profile-key' 和 'value-key' 傳回關鍵字標籤
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
|
值鍵
|
value-key | True | string |
目標設定檔的標籤/值清單中的值索引鍵 |
傳回
依群組取得設定檔金鑰 (關鍵字)
根據提供的「群組名稱」傳回所有關鍵字設定檔索引鍵
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
群組名稱
|
group-name | True | string |
用於分組關鍵字設定檔的群組名稱 |
|
排序
|
sort | string |
選擇性參數,用於排序傳回的索引鍵/值結果 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of string |
取得指派的角色 (角色)
取得先前為特定記錄指派的角色的負責人 ()
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
進程金鑰
|
process-key | True | string |
目標設定檔的唯一金鑰 |
|
BPM 記錄 ID
|
bpm-record-id | True | string |
識別要設定角色的記錄。 ID 由新記錄的 registerBPMRecord API 登錄,可在 BPM API 回應的 recordID 內容中找到 |
|
角色名稱
|
role-names | True | string |
要查詢的角色(使用逗號分隔) |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
名稱
|
name | string | |
|
使用者
|
users | array of object | |
|
Email
|
users.email | string |
取得角色 (角色)
取得指派給 Agilit-e 系統管理入口網站中角色的負責人 () 。 這些角色不僅與特定記錄或業務流程相關,而且更常用於組織中的公司範圍角色
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
角色名稱
|
role-names | True | string |
指定您要擷取負責使用者的角色名稱 - (使用逗號分隔) |
|
條件式層級
|
conditional-levels | string |
指定可用來判斷角色正確人員的其他層級。 層級的範例可能是部門名稱 (如果您想要擷取部門經理) 或產品名稱 (如果您想要擷取產品經理) - (以逗號分隔) |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
負責任的用戶
|
responsibleUsers | array of string |
負責任的用戶 |
取得記錄狀態 (BPM)
取得一或多筆記錄的 BPM 記錄狀態,以包括目前狀態、記錄負責人、工作流程歷程記錄和其他資訊,以描述記錄的目前狀態和規則
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
處理金鑰
|
process-keys | string |
篩選器以識別將傳回記錄的商務程序。 此金鑰可在 Agilit-e 管理入口網站的 BPM 設定檔中找到 - (使用逗號分隔) |
|
|
BPM 記錄 ID
|
bpm-record-ids | string |
篩選器,以僅傳回具有特定 recordIds 的記錄。 recordId 由新記錄的 registerBPMRecord API 登錄,可在 BPM API 回應的 recordID 內容中找到 - (使用逗點分隔) |
|
|
步驟名稱
|
step-names | string |
篩選為僅傳回目前屬於指定工作流程步驟的記錄 - (使用逗號分隔) |
|
|
負責任的用戶
|
responsible-users | string |
篩選以僅傳回目前指派給指定電子郵件地址的記錄 - (使用逗號分隔) |
|
|
相關用戶
|
relevant-users | string |
篩選為僅傳回與指定電子郵件地址相關的記錄 - (使用逗號分隔) |
|
|
包括歷史記錄
|
include-history | boolean |
指定是否應該傳回歷程記錄物件以及記錄狀態資訊 |
|
|
包括步驟選項
|
include-step-options | boolean |
指定是否應該傳回步驟選項物件以及記錄狀態資訊 |
|
|
包括可見物件
|
include-visible-objects | boolean |
指定是否應該傳回可見物件物件,並搭配記錄狀態資訊 |
傳回
執行 (BPM)
在其目前的工作流程步驟中提交選項。 根據業務規則,記錄將進展到流程中的下一個步驟,並將下一個步驟的相關資訊傳回給呼叫 API
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
進程金鑰
|
process-key | True | string |
目標設定檔的唯一金鑰 |
|
BPM 記錄 ID
|
bpm-record-id | True | string |
識別正在提交的記錄。 ID 由新記錄的 registerBPMRecord API 登錄,可在 BPM API 回應的 recordID 內容中找到 |
|
已選取選項
|
option-selected | True | string |
識別使用者選取要在提交程序中執行的選項。 此值必須與工作流程設定檔中的有效步驟選項相對應 |
|
目前使用者
|
current-user | True | string |
提交 BPM 步驟之使用者的電子郵件地址。 這通常是呼叫 API 時登入的使用者 |
|
工作流程步驟註解
|
comments | string |
將註解傳遞至執行程序,該處理程序將戳記到工作流程歷程記錄中。 如果使用者拒絕步驟或要求詳細資訊,通常會使用此選項 |
|
|
|
object |
傳回
執行 (範本)
根據提供的 'profile-key' 處理並傳回來自 Agilit-e 的範本
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
|
|
object |
傳回
指派角色 (角色)
指派適用於特定記錄的使用者指定角色。 這方面的一個例子是文件審核員或休假審批人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
進程金鑰
|
process-key | True | string |
目標設定檔的唯一金鑰 |
|
BPM 記錄 ID
|
bpm-record-id | True | string |
識別要設定角色的記錄。 ID 由新記錄的 registerBPMRecord API 登錄,可在 BPM API 回應的 recordID 內容中找到 |
|
目前使用者
|
current-user | True | string |
設定角色之使用者的電子郵件地址。 這通常是呼叫 API 時登入的使用者 |
|
角色名稱
|
role-name | True | string |
要指派的角色名稱。 例如:核准者或檢閱者 |
|
負責任的用戶
|
responsible-users | True | string |
指派給此角色之使用者的電子郵件地址 - (以逗號分隔) |
傳回
資料
- 資料
- object
按設定檔金鑰取得 (關鍵字)
根據提供的「profile-key」傳回特定關鍵字設定檔的索引鍵/值對
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
|
排序
|
sort | string |
選擇性參數,用於排序傳回的索引鍵/值結果 |
傳回
按配置文件鍵獲取 (BPM)
取得完整的 BPM 設定檔,其中包含流程的配置和選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
傳回
產生編號 (編號)
根據提供的「profile-key」產生唯一編號
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
|
|
object |
傳回
登錄 BPM 記錄 (BPM)
註冊新的 BPM 記錄。 記錄會指派 recordID,該 recordID 用於記錄生命週期,以隨時識別記錄、記錄進度、歷程記錄和狀態
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
進程金鑰
|
process-key | True | string |
目標設定檔的唯一金鑰 |
|
目前使用者
|
current-user | True | string |
註冊記錄之使用者的電子郵件地址。 這通常是呼叫 API 時登入的使用者 |
傳回
透過標籤取得價值 (關鍵字)
根據提供的 'profile-key' 和 'label-key' 傳回關鍵字值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔金鑰
|
profile-key | True | string |
目標設定檔的唯一金鑰 |
|
標籤鍵
|
label-key | True | string |
目標設定檔的標籤/值清單中的標籤索引鍵 |
傳回
定義
執行BPMResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
流程步驟說明
|
description | string |
說明「處理步驟」的簡短說明 |
|
SLA 持續時間 (小時)
|
duration | string |
SLA 持續時間 (以小時為單位)。 如果不適用,請提供值 0 |
|
處理步驟事件戳記
|
eventStamp | string |
目前製程步驟的事件戳記 |
|
步驟說明
|
instructions | string |
步驟中給負責用戶的說明 |
|
處理步驟索引鍵
|
key | string |
用於識別流程步驟的唯一索引鍵 |
|
處理步驟名稱
|
name | string |
「處理步驟」的簡短名稱 |
|
BPM 設定檔金鑰
|
processKey | string |
識別 BPM 設定檔的唯一金鑰 |
|
程序階段
|
processStage | string |
定義目前步驟的「處理階段」的索引鍵 |
|
責任類型
|
responsibility | string |
基於使用者/角色的責任 |
|
流程步驟責任角色
|
responsibleRole | string |
負責目前流程步驟的角色 |
|
處理步驟負責的使用者
|
responsibleUsers | array of string |
負責目前處理程序步驟的使用者 |
|
步驟選項
|
stepOptions | array of object | |
|
步驟選項說明
|
stepOptions.description | string |
說明步驟選項的簡短說明 |
|
步驟選項事件戳記
|
stepOptions.eventStamp | array of string |
目前步驟選項的事件戳記 |
|
步驟選項名稱
|
stepOptions.name | string |
步驟選項的簡短名稱 |
|
後續步驟
|
stepOptions.nextStep | string |
商務程序將路由傳送至下一個步驟。 如果沒有進一步的步驟,請留空 |
|
步驟選項附註
|
stepOptions.notes | string |
步驟選項的選用附註 |
|
visible物件
|
stepOptions.visibleObjects | array of object | |
|
步驟選項物件識別碼
|
stepOptions.visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
stepOptions.visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
stepOptions.visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
步驟選項物件是否可編輯
|
stepOptions.visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
步驟選項物件是否為必要
|
stepOptions.visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
|
visible物件
|
visibleObjects | array of object | |
|
處理步驟物件識別碼
|
visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
「處理步驟物件」是否可編輯
|
visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
流程步驟物件是否為必要
|
visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
GetBPMProfile
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
應用程式管理員
|
appAdmin | array of object | |
|
應用程式管理員電子郵件
|
appAdmin.email | string |
目前 BPM 設定檔管理員的電子郵件地址 |
|
BPM 應用程式網址
|
appUrl | string |
使用目前 BPM 設定檔的應用程式的選用 URL |
|
BPM 設定檔說明
|
description | string |
說明 BPM 設定檔的簡短說明 |
|
BPM 設定檔群組名稱
|
groupName | string |
BPM 設定檔的選用分組 |
|
BPM 設定檔金鑰
|
key | string |
識別 BPM 設定檔的唯一金鑰 |
|
BPM 設定檔名稱
|
name | string |
BPM 設定檔的簡短名稱 |
|
BPM 設定檔註釋
|
notes | string |
BPM 設定檔的選用注意事項 |
|
process步驟
|
processSteps | array of object | |
|
流程步驟說明
|
processSteps.description | string |
說明「處理步驟」的簡短說明 |
|
SLA 持續時間 (小時)
|
processSteps.duration | string |
SLA 持續時間 (以小時為單位)。 如果不適用,請提供值 0 |
|
是第一步
|
processSteps.firstStep | boolean |
指定「流程步驟」記錄是否為「商業流程」中的第一個步驟 |
|
步驟說明
|
processSteps.instructions | string |
步驟中給負責用戶的說明 |
|
處理步驟索引鍵
|
processSteps.key | string |
用於識別流程步驟的唯一索引鍵 |
|
處理步驟名稱
|
processSteps.name | string |
「處理步驟」的簡短名稱 |
|
程序階段
|
processSteps.processStage | string |
定義目前步驟的「處理階段」的索引鍵 |
|
處理步驟參考 URL
|
processSteps.referenceUrl | string |
處理步驟的參考 URL |
|
責任類型
|
processSteps.responsibility | string |
基於使用者/角色的責任 |
|
流程步驟責任角色
|
processSteps.responsibleRole | string |
負責目前步驟的角色 |
|
角色層級
|
processSteps.roleLevels | array of string |
條件式角色層級 |
|
步驟選項
|
processSteps.stepOptions | array of object | |
|
步驟選項說明
|
processSteps.stepOptions.description | string |
說明步驟選項的簡短說明 |
|
步驟選項名稱
|
processSteps.stepOptions.name | string |
步驟選項的簡短名稱 |
|
後續步驟
|
processSteps.stepOptions.nextStep | string |
商務程序將路由傳送至下一個步驟。 如果沒有進一步的步驟,請留空 |
|
步驟選項附註
|
processSteps.stepOptions.notes | string |
步驟選項的選用附註 |
|
visible物件
|
processSteps.stepOptions.visibleObjects | array of object | |
|
步驟選項物件識別碼
|
processSteps.stepOptions.visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
步驟選項物件是否可編輯
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
步驟選項物件是否為必要
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
|
visible物件
|
processSteps.visibleObjects | array of object | |
|
處理步驟物件識別碼
|
processSteps.visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
processSteps.visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
processSteps.visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
processSteps.visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
processSteps.visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
processSteps.visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
「處理步驟物件」是否可編輯
|
processSteps.visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
流程步驟物件是否為必要
|
processSteps.visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
|
BPM 設定檔參考 URL
|
referenceUrl | string |
可針對目前 BPM 設定檔參照的選用 URL |
GetBPMRecordState
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
流程步驟說明
|
description | string |
說明「處理步驟」的簡短說明 |
|
SLA 持續時間 (小時)
|
duration | string |
SLA 持續時間 (以小時為單位)。 如果不適用,請提供值 0 |
|
eventStamp歷史
|
eventStampHistory | array of object | |
|
事件戳記歷史記錄名稱
|
eventStampHistory.eventName | string |
活動戳記的名稱 |
|
事件戳記歷史記錄時間戳記
|
eventStampHistory.timeStamp | date-time |
事件戳記發生的時間戳記 |
|
歷程
|
history | array of object | |
|
歷史評論
|
history.comments | string |
建立歷程記錄項目時新增的選擇性註解 |
|
歷史 目前的角色
|
history.currentRole | string |
記錄項目時的當前角色 |
|
歷史記錄當前用戶
|
history.currentUser | string |
記錄項目時的當前使用者 |
|
步驟持續時間
|
history.duration | string |
記錄在執行動作之前存在於目前處理步驟中的時間 (以分鐘為單位) |
|
歷史事件印章
|
history.eventStamp | array of string |
在「歷程記錄」項目時發生的事件戳記 |
|
從步驟
|
history.fromStep | string |
BPM 記錄在「歷程記錄」項目時來自的處理步驟的索引鍵 |
|
從步驟名稱
|
history.fromStepName | string |
BPM 記錄在「歷程記錄」項目時所來源的處理步驟名稱 |
|
已選取歷程記錄選項
|
history.optionSelected | string |
執行 BPM 記錄時選取的選項 |
|
歷史 BPM 流程鍵
|
history.processKey | string |
「歷程記錄」項目的唯一 BPM 程序金鑰 |
|
歷史處理階段
|
history.processStage | string |
歷程記錄項目時的「處理」階段 |
|
歷程記錄 BPM 記錄 ID
|
history.recordId | string |
在「登錄 BPM 記錄」處理程序期間產生之 BPM 相關記錄的記錄 ID |
|
歷史責任角色
|
history.responsibleRole | string |
BPM 記錄在「歷程記錄」項目時的負責角色 |
|
歷史責任用戶
|
history.responsibleUsers | array of string |
記錄時的負責用戶 |
|
歷史提交日期
|
history.submissionDate | date-time |
BPM 記錄的執行日期/時間 |
|
前往處理階段
|
history.toProcessStage | string |
在「歷程」項目時,BPM 記錄的「處理」階段 |
|
步驟
|
history.toStep | string |
「歷程記錄」項目時 BPM 記錄的「處理步驟」索引鍵 |
|
至步驟名稱
|
history.toStepName | string |
在「歷程記錄」項目時,BPM 記錄的處理步驟名稱 |
|
步驟說明
|
instructions | string |
步驟中給負責用戶的說明 |
|
處理步驟索引鍵
|
key | string |
用於識別流程步驟的唯一索引鍵 |
|
處理步驟名稱
|
name | string |
「處理步驟」的簡短名稱 |
|
BPM 設定檔金鑰
|
processKey | string |
識別 BPM 設定檔的唯一金鑰 |
|
程序階段
|
processStage | string |
定義目前步驟的「處理階段」的索引鍵 |
|
BPM 記錄 ID
|
recordId | string |
BPM模組在註冊BPM記錄時產生的記錄ID |
|
BPM 記錄參考
|
recordRef | string |
BPM 模組在註冊 BPM 記錄時使用編號模組產生的可讀取編號 |
|
處理步驟參考 URL
|
referenceUrl | string |
處理步驟的參考 URL |
|
流程步驟責任角色
|
responsibleRole | string |
負責目前步驟的角色 |
|
處理步驟負責的使用者
|
responsibleUsers | array of string |
目前流程步驟的負責人使用者 |
|
角色
|
roles | array of object | |
|
角色名稱
|
roles.name | string |
角色名稱 |
|
users
|
roles.users | array of object | |
|
角色電子郵件
|
roles.users.email | string |
連結至角色名稱的電子郵件地址 |
|
步驟選項
|
stepOptions | array of object | |
|
步驟選項說明
|
stepOptions.description | string |
說明步驟選項的簡短說明 |
|
步驟選項事件戳記
|
stepOptions.eventStamp | array of string |
目前步驟選項的事件戳記 |
|
步驟選項名稱
|
stepOptions.name | string |
步驟選項的簡短名稱 |
|
後續步驟
|
stepOptions.nextStep | string |
商務程序將路由傳送至下一個步驟。 如果沒有進一步的步驟,請留空 |
|
步驟選項附註
|
stepOptions.notes | string |
步驟選項的選用附註 |
|
visible物件
|
stepOptions.visibleObjects | array of object | |
|
步驟選項物件識別碼
|
stepOptions.visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
stepOptions.visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
stepOptions.visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
步驟選項物件是否可編輯
|
stepOptions.visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
步驟選項物件是否為必要
|
stepOptions.visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
|
提交步驟
|
submittedIntoStep | date-time |
BPM 記錄提交至現行流程步驟的日期/時間 |
|
目標持續時間
|
targetTimeDuration | date-time |
BPM 記錄需要根據 SLA 持續時間採取行動的日期/時間 |
|
visible物件
|
visibleObjects | array of object | |
|
處理步驟物件識別碼
|
visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
「處理步驟物件」是否可編輯
|
visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
流程步驟物件是否為必要
|
visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
關鍵字值
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
標籤
|
label | string | |
|
價值觀
|
value | string |
註冊BPM代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
流程步驟說明
|
description | string |
說明「處理步驟」的簡短說明 |
|
SLA 持續時間 (小時)
|
duration | string |
SLA 持續時間 (以小時為單位)。 如果不適用,請提供值 0 |
|
eventStamp歷史
|
eventStampHistory | array of object | |
|
事件戳記歷史記錄名稱
|
eventStampHistory.eventName | string |
活動戳記的名稱 |
|
事件戳記歷史記錄時間戳記
|
eventStampHistory.timeStamp | date-time |
事件戳記發生的時間戳記 |
|
歷程
|
history | array of object | |
|
歷史評論
|
history.comments | string |
建立歷程記錄項目時新增的選擇性註解 |
|
歷史 目前的角色
|
history.currentRole | string |
記錄項目時的當前角色 |
|
歷史記錄當前用戶
|
history.currentUser | string |
記錄項目時的當前使用者 |
|
步驟持續時間
|
history.duration | string |
記錄在執行動作之前存在於目前處理步驟中的時間 (以分鐘為單位) |
|
歷史事件印章
|
history.eventStamp | array of string |
在「歷程記錄」項目時發生的事件戳記 |
|
從步驟
|
history.fromStep | string |
BPM 記錄在「歷程記錄」項目時來自的處理步驟的索引鍵 |
|
從步驟名稱
|
history.fromStepName | string |
BPM 記錄在「歷程記錄」項目時所來源的處理步驟名稱 |
|
已選取歷程記錄選項
|
history.optionSelected | string |
執行 BPM 記錄時選取的選項 |
|
歷史 BPM 流程鍵
|
history.processKey | string |
「歷程記錄」項目的唯一 BPM 程序金鑰 |
|
歷史處理階段
|
history.processStage | string |
歷程記錄項目時的「處理」階段 |
|
歷程記錄 BPM 記錄 ID
|
history.recordId | string |
在「登錄 BPM 記錄」處理程序期間產生之 BPM 相關記錄的記錄 ID |
|
歷史責任角色
|
history.responsibleRole | string |
BPM 記錄在「歷程記錄」項目時的負責角色 |
|
歷史責任用戶
|
history.responsibleUsers | array of string |
記錄時的負責用戶 |
|
歷史提交日期
|
history.submissionDate | date-time |
BPM 記錄的執行日期/時間 |
|
前往處理階段
|
history.toProcessStage | string |
在「歷程」項目時,BPM 記錄的「處理」階段 |
|
步驟
|
history.toStep | string |
「歷程記錄」項目時 BPM 記錄的「處理步驟」索引鍵 |
|
至步驟名稱
|
history.toStepName | string |
在「歷程記錄」項目時,BPM 記錄的處理步驟名稱 |
|
步驟說明
|
instructions | string |
步驟中給負責用戶的說明 |
|
處理步驟索引鍵
|
key | string |
用於識別流程步驟的唯一索引鍵 |
|
處理步驟名稱
|
name | string |
「處理步驟」的簡短名稱 |
|
BPM 設定檔金鑰
|
processKey | string |
識別 BPM 設定檔的唯一金鑰 |
|
程序階段
|
processStage | string |
定義目前步驟的「處理階段」的索引鍵 |
|
BPM 記錄 ID
|
recordId | string |
BPM模組在註冊BPM記錄時產生的記錄ID |
|
BPM 記錄參考
|
recordRef | string |
BPM 模組在註冊 BPM 記錄時使用編號模組產生的可讀取編號 |
|
處理步驟參考 URL
|
referenceUrl | string |
處理步驟的參考 URL |
|
流程步驟責任角色
|
responsibleRole | string |
負責目前流程步驟的角色 |
|
處理步驟負責的使用者
|
responsibleUsers | array of string |
負責目前處理程序步驟的使用者 |
|
角色
|
roles | array of object | |
|
角色名稱
|
roles.name | string |
角色名稱 |
|
users
|
roles.users | array of object | |
|
角色電子郵件
|
roles.users.email | string |
連結至角色名稱的電子郵件地址 |
|
步驟選項
|
stepOptions | array of object | |
|
步驟選項說明
|
stepOptions.description | string |
說明步驟選項的簡短說明 |
|
步驟選項事件戳記
|
stepOptions.eventStamp | array of string |
目前步驟選項的事件戳記 |
|
步驟選項名稱
|
stepOptions.name | string |
步驟選項的簡短名稱 |
|
後續步驟
|
stepOptions.nextStep | string |
商務程序將路由傳送至下一個步驟。 如果沒有進一步的步驟,請留空 |
|
步驟選項附註
|
stepOptions.notes | string |
步驟選項的選用附註 |
|
visible物件
|
stepOptions.visibleObjects | array of object | |
|
步驟選項物件識別碼
|
stepOptions.visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
stepOptions.visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
stepOptions.visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
步驟選項物件是否可編輯
|
stepOptions.visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
步驟選項物件是否為必要
|
stepOptions.visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
|
visible物件
|
visibleObjects | array of object | |
|
處理步驟物件識別碼
|
visibleObjects.id | string |
在UI中參考的元件ID |
|
選擇
|
visibleObjects.inputOptions.choices | array of object | |
|
選擇類型標籤
|
visibleObjects.inputOptions.choices.label | string |
所選選項的標籤 |
|
選擇類型值
|
visibleObjects.inputOptions.choices.value | string |
所選選項的值 |
|
輸入選項標籤
|
visibleObjects.inputOptions.label | string |
定義輸入欄位或可編輯元件的標籤 |
|
輸入選項訊息
|
visibleObjects.inputOptions.messages | array of string |
輸入選項驗證失敗時要使用的訊息 |
|
輸入選項類型
|
visibleObjects.inputOptions.type | string |
定義要使用的輸入欄位或可編輯元件的類型 |
|
「處理步驟物件」是否可編輯
|
visibleObjects.isEditable | boolean |
參考的元件是否可編輯以供使用者輸入使用 |
|
流程步驟物件是否為必要
|
visibleObjects.isMandatory | boolean |
參考的元件是否需要使用者輸入 |
StdJSONResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Result
|
result | string |
Result |
物件
這是類型 'object'。