K2 工作流程（預覽版）

使用 K2 工作流程 API 服務遠端處理工作流程和任務。

此連接器適用於以下產品和區域：

服務	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）

連絡人
URL	https://portal.k2.com/ticket/default

連接器中繼資料
Publisher	K2
網站	https://www.k2.com
隱私策略	https://www.k2.com/legal/privacy-policy

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
K2網址	字串	您的 K2 網址（例如：https://[K2ID].onk2.com）。	對
用戶名稱	securestring	此 API 的使用者名稱	對
密碼	securestring	此 API 的密碼	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

動作任務	執行工作流程動作。
取得任務	取得連線使用者可用的工作清單。
取得伺服器事件	依序號取得伺服器事件。
取得工作動作	取得任務的動作清單。
取得工作流程	取得可用工作流程的清單。
啟動工作流程	建立並啟動新的工作流程執行個體。
喚醒工作	喚醒睡眠任務。
完成伺服器事件	將完成回應傳送至等待回應的非同步伺服器工作
指派任務	將任務指派給目前使用者。
獲取任務	依序號取得任務。
獲取工作流程	依識別碼取得工作流程定義。
發布任務	釋放任務。
睡眠任務	將任務休眠一段時間，可以是秒數，也可以是直到某個日期。
重新導向工作	將任務傳送給另一個人。

動作任務

作業識別碼：: Tasks_TaskCustomAction

執行工作流程動作。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678
自訂動作	customAction	True	string	工作動作，由工作流程定義。
XML 欄位名稱	name		string	XML 欄位的名稱。
XML 欄位值	value		string	XML 欄位的值。
項目參考	ItemReferences		object	工作流程執行個體的 [項目參考] 欄位。
資料欄位	DataFields		object	工作流程執行個體的資料欄位。

取得任務

作業識別碼：: Tasks_Get

取得連線使用者可用的工作清單。

參數

名稱	機碼	必要	類型	Description
全部、已配置、睡眠、共用來源、共用至	state		string	傳回已連線使用者的工作清單。

傳回

身體: TasksResponse

取得伺服器事件

作業識別碼：: ServerEvent_Get

依序號取得伺服器事件。

參數

名稱	機碼	必要	類型	Description
伺服器事件序號	serialNumber	True	string	伺服器事件的序號。例如：1234_5678。

傳回

身體: ServerEventDataResponse

取得工作動作

作業識別碼：: Tasks_GetTaskActions

取得任務的動作清單。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678

傳回

身體: TaskActionsResponse

取得工作流程

作業識別碼：: GetWorkflows

取得可用工作流程的清單。

參數

名稱	機碼	必要	類型	Description
工作流程類型	type		string	工作流程的類型。可上陣或擁有。

傳回

身體: WorkflowLabelsResponse[WorkflowLabel]

啟動工作流程

作業識別碼：: StartWorkflow

建立並啟動新的工作流程執行個體。

參數

名稱	機碼	必要	類型	Description
工作流程識別碼	id	True	integer	指定要啟動執行個體的工作流程 ID。
工作流程執行個體詳細資料	instance	True	dynamic	傳送工作流程執行個體物件以啟動工作流程。

傳回

response: integer

喚醒工作

作業識別碼：: Tasks_PostWakeAction

喚醒睡眠任務。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678

傳回

response: object

完成伺服器事件

作業識別碼：: ServerEvent_Finish

將完成回應傳送至等待回應的非同步伺服器工作

參數

名稱	機碼	必要	類型	Description
伺服器事件序號	serialNumber	True	string	伺服器事件的序號。例如：1234_5678
XML 欄位名稱	name		string	XML 欄位的名稱。
XML 欄位值	value		string	XML 欄位的值。
項目參考	ItemReferences		object	工作流程執行個體的 [項目參考] 欄位。
資料欄位	DataFields		object	工作流程執行個體的資料欄位。

指派任務

作業識別碼：: Tasks_PostAssignAction

將任務指派給目前使用者。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678

傳回

response: object

獲取任務

作業識別碼：: Tasks_GetTask

依序號取得任務。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678

傳回

身體: Task

獲取工作流程

作業識別碼：: GetWorkflow

依識別碼取得工作流程定義。

參數

名稱	機碼	必要	類型	Description
工作流程識別碼	id	True	integer	工作流程的ID。

傳回

身體: WorkflowDataResponse

發布任務

作業識別碼：: Tasks_PostReleaseAction

釋放任務。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678

睡眠任務

作業識別碼：: Tasks_PostSleepAction

將任務休眠一段時間，可以是秒數，也可以是直到某個日期。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678
睡眠時間	SleepFor		integer	使任務休眠的秒數。
睡到	SleepUntil		date-time	喚醒工作的日期和時間。格式：yyyy-MM-ddTHH：mm：ss：fffZ UTC

重新導向工作

作業識別碼：: Tasks_PostRedirectAction

將任務傳送給另一個人。

參數

名稱	機碼	必要	類型	Description
序號	serialNumber	True	string	任務的序號。例如：1234_5678
重新導向資訊	RedirectTo	True	string	任務重新導向的人員。

定義

ServerEventData回應

名稱	路徑	類型	Description
伺服器事件序號	serialNumber	string	伺服器事件的序號。例如：1234_5678
伺服器事件工作流程識別碼	workflowID	integer	與伺服器事件相關聯的工作流程識別碼。
伺服器事件工作流程名稱	workflowName	string	與伺服器事件相關聯的工作流程名稱。
伺服器事件工作流程顯示名稱	workflowDisplayName	string	與伺服器事件相關聯之工作流程的顯示名稱。
伺服器事件工作流程類別	workflowCategory	string	與伺服器事件相關聯的工作流程類別。
伺服器事件工作流程執行個體識別碼	workflowInstanceID	integer	與伺服器事件相關聯之工作流程的執行個體識別碼。
伺服器事件工作流程對開本	workflowInstanceFolio	string	與伺服器事件相關聯的工作流程實例對開本。
伺服器事件活動實例識別碼	activityInstanceID	integer	伺服器事件的活動實例識別碼。
伺服器事件活動目的地識別碼	activityInstanceDestinationID	integer	伺服器事件的活動實例目的地 ID。
伺服器事件活動名稱	activityName	string	伺服器事件的活動名稱。
伺服器事件名稱	eventName	string	伺服器事件的事件名稱。
伺服器事件描述	eventDescription	string	伺服器事件的事件描述。
祖	originator	User
事件實例	eventInstance	EventInstanceWrapper
伺服器事件活動資料欄位	dataFields	object	活動的資料欄位。
伺服器事件活動 XML 欄位	xmlFields	array of UserDefinedXmlField	活動的 XML 欄位。
伺服器事件項目參考	itemReferences	object	工作流程實例的項目參考。
伺服器事件工作流程資料欄位字串	workflowInstanceDataFieldsString	string	工作流程執行個體資料欄位的字串表示。
伺服器事件項目參考字串	itemReferencesString	string	字串，代表工作流程實例的項目參考。
檢視流程URL	viewFlowURL	string

事件執行個體

名稱	路徑	類型	Description
事件實例開始日期	StartDate	date-time	事件執行個體開始的日期和時間。
事件實例預期持續時間	ExpectedDuration	integer	事件執行個體的預期持續時間。
事件實例優先順序	Priority	integer	事件實例的優先順序。
事件實例中繼資料	MetaData	string	事件執行個體的中繼資料。
事件實例描述	Description	string	事件實例的描述。
事件實例名稱	Name	string	事件實例的名稱。
事件實例識別碼	ID	integer	事件執行個體的識別碼。

UserDefinedXml欄位

名稱	路徑	類型	Description
XML 欄位名稱	name	string	XML 欄位的名稱。
XML 欄位值	value	string	XML 欄位的值。

Tasks回應

名稱	路徑	類型	Description
任務計數	itemCount	integer	傳回的工作計數。
任務	tasks	array of TaskLite	一或多個任務。

任務精簡版

名稱	路徑	類型	Description
任務序號	serialNumber	string	任務的序號。例如：1234_5678
工作狀態	status	string	任務的狀態。例如：開啟、已完成、睡眠、已分配、可用
任務開始日期	taskStartDate	date-time	任務的開始日期。
任務睡眠持續時間	sleepUntil	date-time	工作喚醒的日期和時間。
任務優先順序	priority	integer	任務的優先順序。
工作表單 URL	formURL	string	任務的表單URL。
工作檢視流程 URL	viewFlowURL	string	工作的檢視流程 URL。
工作工作流程識別碼	workflowID	integer	與任務相關聯的工作流程識別碼。
任務工作流程名稱	workflowName	string	與任務相關聯的工作流程名稱。
任務工作流程顯示名稱	workflowDisplayName	string	與任務相關聯之工作流程的顯示名稱。
任務工作流程類別	workflowCategory	string	與任務相關聯的工作流程類別。
任務工作流程執行個體 ID	workflowInstanceID	integer	與任務相關聯之工作流程的執行個體ID。
「任務工作流程對開本」	workflowInstanceFolio	string	與任務相關聯之工作流程實例的對開本。
任務實例 ID	activityInstanceID	integer	任務的活動執行個體ID。
任務活動目的地ID	activityInstanceDestinationID	integer	任務的活動執行個體目的地ID。
任務活動名稱	activityName	string	任務的活動名稱。
任務事件名稱	eventName	string	任務的事件名稱。
任務事件描述	eventDescription	string	任務的事件描述。
祖	originator	User
行為	actions	TaskActionsResponse
任務說明	instruction	string	與工作相關聯的指示。

User

名稱	路徑	類型	Description
使用者名	username	string	人員的使用者名稱。
用戶 FQN	fqn	string	人員的完整姓名。例如： bob@denallix.com，K2：Denallix\Bob
用戶電子郵件	email	string	此人的電子郵件地址。
使用者管理員	manager	string	該人的經理。
使用者顯示名稱	displayName	string	人員的顯示名稱。

TaskActions回應

名稱	路徑	類型	Description
不可批次處理的動作	nonBatchableActions	array of string	未指派任務而無法採取的動作清單。
可批次處理動作	batchableActions	array of string	無需指派任務即可採取的動作清單。
系統動作	systemActions	array of string	系統動作清單。

任務

名稱	路徑	類型	Description
任務序號	serialNumber	string	任務的序號。例如：1234_5678
工作狀態	status	string	任務的狀態。例如：開啟、已完成、睡眠、已分配、可用
任務開始日期	taskStartDate	date-time	任務的開始日期。
任務睡眠持續時間	sleepUntil	date-time	工作喚醒的日期和時間。
任務優先順序	priority	integer	任務的優先順序。
工作表單 URL	formURL	string	任務的表單URL。
工作檢視流程 URL	viewFlowURL	string	工作的檢視流程 URL。
工作工作流程識別碼	workflowID	integer	與任務相關聯的工作流程識別碼。
任務工作流程名稱	workflowName	string	與任務相關聯的工作流程名稱。
任務工作流程顯示名稱	workflowDisplayName	string	與任務相關聯之工作流程的顯示名稱。
任務工作流程類別	workflowCategory	string	與任務相關聯的工作流程類別。
任務工作流程執行個體 ID	workflowInstanceID	integer	與任務相關聯之工作流程的執行個體ID。
「任務工作流程對開本」	workflowInstanceFolio	string	與任務相關聯之工作流程實例的對開本。
任務實例 ID	activityInstanceID	integer	任務的活動執行個體ID。
任務目的地ID	activityInstanceDestinationID	integer	任務的活動執行個體目的地ID。
任務活動名稱	activityName	string	任務的活動名稱。
任務事件名稱	eventName	string	任務的事件名稱。
任務事件描述	eventDescription	string	任務的事件描述。
祖	originator	User
行為	actions	TaskActionsResponse
任務工作流程資料欄位	workflowInstanceDataFields	object	工作流程執行個體的資料欄位。
任務活動資料欄位	activityDataFields	object	活動的資料欄位。
任務工作流程 XML 欄位	workflowInstanceXmlFields	array of UserDefinedXmlField	工作流程執行個體的 XML 欄位。
任務項目參照	itemReferences	object	工作流程實例的項目參考。
指令	instruction	string
任務工作流程資料欄位字串	workflowInstanceDataFieldsString	string	工作流程執行個體資料欄位的字串表示。
工作項目參照字串	itemReferencesString	string	字串，代表工作流程實例的項目參考。

WorkflowLabels回應[WorkflowLabel]

名稱	路徑	類型	Description
項目數量	itemCount	integer	工作流程數目。
Workflows	workflows	array of WorkflowLabel	工作流程清單。

工作流程標籤

名稱	路徑	類型	Description
工作流程識別碼	id	integer	工作流程的ID。
工作流程預設版本	defaultVersionId	integer	預設工作流程版本。
工作流程名稱	name	string	工作流程名稱。
工作流程資料夾	folder	string	工作流程資料夾。
工作流程系統名稱	systemName	string	工作流程系統名稱。

WorkflowData回應

名稱	路徑	類型	Description
工作流程資訊	workflowInfo	WorkflowDefinition
工作流程結構描述	workflowSchema	string	工作流程的結構描述。

工作流程定義

名稱	路徑	類型	Description
工作流程名稱	name	string	工作流程的名稱。
工作流程說明	description	string	工作流程的說明。
工作流程資料夾	folder	string	工作流程的資料夾（類別）。
工作流程系統名稱	systemName	string	工作流程的系統名稱。
工作流程預期持續時間	expectedDuration	integer	工作流程的預期持續時間。

事件實例包裝函式

名稱	路徑	類型	Description
事件執行個體	EventInstance	EventInstance
事件實例描述	Description	string	事件實例的描述。
事件實例預期持續時間	ExpectedDuration	integer	事件執行個體的預期持續時間。
事件實例識別碼	ID	integer	事件執行個體的識別碼。
事件實例中繼資料	MetaData	string	事件執行個體的中繼資料。
事件實例名稱	Name	string	事件實例的名稱。
事件實例優先順序	Priority	integer	事件實例的優先順序。
事件實例開始日期	StartDate	date-time	事件執行個體開始的日期和時間。

整數

這是基本資料類型「整數」。

物件

這是類型 'object'。

共用方式為

K2 工作流程 （預覽版）