K2 Workflow (プレビュー)
K2 Workflow API サービスを使用して、ワークフローやタスクをリモートで操作します。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure China の地域 - 米国国防総省 (DoD) |
| Power Automate | Standard | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | 標準 | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| 連絡先 | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| コネクタ メタデータ | |
|---|---|
| 公開元 | K2 |
| Web サイト | https://www.k2.com |
| プライバシー ポリシー | https://www.k2.com/legal/privacy-policy |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| K2 URL | 文字列 | K2 URL (例: https://[K2ID].onk2.com)。 | 真 |
| ユーザー名 | securestring | この API のユーザー名 | 真 |
| パスワード | securestring | この API のパスワード | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アクション タスク |
ワークフロー アクションを実行します。 |
| サーバー イベントを取得する |
シリアル番号でサーバー イベントを取得します。 |
| サーバー イベントを終了する |
応答待ちの非同期サーバー タスクに完了応答を送信します |
| スリープ解除 |
タスクのスリープ状態を解除します。 |
| タスク アクションを取得する |
タスクのアクションの一覧を取得します。 |
| タスクをスリープ状態にする |
秒数または日付指定で、タスクを一定期間スリープ状態にします。 |
| タスクを割り当てる |
現在のユーザーにタスクを割り当てます。 |
| タスクを取得する |
シリアル番号でタスクを取得します。 |
| タスクを取得する |
接続されているユーザーが使用できるタスクの一覧を取得します。 |
| タスクを解放する |
タスクを解放します。 |
| リダイレクト タスク |
他のユーザーにタスクを送信します。 |
| ワークフローを取得する |
ID でワークフロー定義を取得します。 |
| ワークフローを取得する |
使用可能なワークフローの一覧を取得します。 |
| ワークフローを開始する |
新しいワークフロー インスタンスを作成して開始します。 |
アクション タスク
ワークフロー アクションを実行します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
|
カスタム操作
|
customAction | True | string |
ワークフローによって定義されたタスク アクション。 |
|
XML フィールド名
|
name | string |
XML フィールドの名前。 |
|
|
XML フィールド値
|
value | string |
XML フィールドの値。 |
|
|
項目参照
|
ItemReferences | object |
ワークフロー インスタンスの項目参照フィールド。 |
|
|
データ フィールド
|
DataFields | object |
ワークフロー インスタンスのデータ フィールド。 |
サーバー イベントを取得する
シリアル番号でサーバー イベントを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サーバー イベントのシリアル番号
|
serialNumber | True | string |
サーバー イベントのシリアル番号。 例: 1234_5678。 |
戻り値
サーバー イベントを終了する
応答待ちの非同期サーバー タスクに完了応答を送信します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サーバー イベントのシリアル番号
|
serialNumber | True | string |
サーバー イベントのシリアル番号。 例: 1234_5678 |
|
XML フィールド名
|
name | string |
XML フィールドの名前。 |
|
|
XML フィールド値
|
value | string |
XML フィールドの値。 |
|
|
項目参照
|
ItemReferences | object |
ワークフロー インスタンスの項目参照フィールド。 |
|
|
データ フィールド
|
DataFields | object |
ワークフロー インスタンスのデータ フィールド。 |
スリープ解除
タスクのスリープ状態を解除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
戻り値
- 応答
- object
タスク アクションを取得する
タスクのアクションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
戻り値
- 本文
- TaskActionsResponse
タスクをスリープ状態にする
秒数または日付指定で、タスクを一定期間スリープ状態にします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
|
スリープ期間
|
SleepFor | integer |
タスクをスリープ状態にする秒数。 |
|
|
スリープ期限
|
SleepUntil | date-time |
タスクをスリープ解除する日時。 形式: yyyy-MM-ddTHH:mm:ss:fffZ UTC |
タスクを割り当てる
現在のユーザーにタスクを割り当てます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
戻り値
- 応答
- object
タスクを取得する
シリアル番号でタスクを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
戻り値
- 本文
- Task
タスクを取得する
接続されているユーザーが使用できるタスクの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
All、Allocated、Sleeping、SharedFrom、SharedTo
|
state | string |
接続されているユーザーにタスクの一覧を返します。 |
戻り値
- 本文
- TasksResponse
タスクを解放する
タスクを解放します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
リダイレクト タスク
他のユーザーにタスクを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シリアル番号
|
serialNumber | True | string |
タスクのシリアル番号。 例: 1234_5678 |
|
リダイレクトの情報
|
RedirectTo | True | string |
タスクのリダイレクト先のユーザー。 |
ワークフローを取得する
ID でワークフロー定義を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
id | True | integer |
ワークフローの ID。 |
戻り値
- 本文
- WorkflowDataResponse
ワークフローを取得する
使用可能なワークフローの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフローの種類
|
type | string |
ワークフローの種類。 開始可能または所有済み。 |
戻り値
ワークフローを開始する
新しいワークフロー インスタンスを作成して開始します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
id | True | integer |
インスタンスを開始するワークフロー ID を指定します。 |
|
ワークフロー インスタンスの詳細
|
instance | True | dynamic |
ワークフロー インスタンス オブジェクトを送信してワークフローを開始します。 |
戻り値
- 応答
- integer
定義
ServerEventDataResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サーバー イベントのシリアル番号
|
serialNumber | string |
サーバー イベントのシリアル番号。 例: 1234_5678 |
|
サーバー イベント ワークフロー ID
|
workflowID | integer |
サーバー イベントに関連付けられているワークフローの ID。 |
|
サーバー イベント ワークフロー名
|
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 | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
サーバー イベント活動のデータ フィールド
|
dataFields | object |
活動のデータ フィールド。 |
|
サーバー イベント活動の XML フィールド
|
xmlFields | array of UserDefinedXmlField |
活動の XML フィールド。 |
|
サーバー イベント項目の参照
|
itemReferences | object |
ワークフロー インスタンスの項目の参照。 |
|
サーバー イベント ワークフローのデータ フィールド文字列
|
workflowInstanceDataFieldsString | string |
ワークフロー インスタンスのデータ フィールドの文字列表現。 |
|
サーバー イベント項目の参照文字列
|
itemReferencesString | string |
ワークフロー インスタンスの項目参照を表す文字列。 |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント インスタンスの開始日
|
StartDate | date-time |
イベント インスタンスが開始した日時。 |
|
イベント インスタンスの予想期間
|
ExpectedDuration | integer |
イベント インスタンスの予想期間。 |
|
イベント インスタンスの優先度
|
Priority | integer |
イベント インスタンスの優先度。 |
|
イベント インスタンス メタデータ
|
MetaData | string |
イベント インスタンスのメタデータ。 |
|
イベント インスタンスの説明
|
Description | string |
イベント インスタンスの説明。 |
|
イベント インスタンス名
|
Name | string |
イベント インスタンスの名前。 |
|
イベント インスタンス ID
|
ID | integer |
イベント インスタンスの ID。 |
UserDefinedXmlField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
XML フィールド名
|
name | string |
XML フィールドの名前。 |
|
XML フィールド値
|
value | string |
XML フィールドの値。 |
TasksResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タスク数
|
itemCount | integer |
返されたタスクの数。 |
|
タスク
|
tasks | array of TaskLite |
1 つ以上のタスク。 |
TaskLite
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タスクのシリアル番号
|
serialNumber | string |
タスクのシリアル番号。 例: 1234_5678 |
|
タスクの進捗状況
|
status | string |
タスクの状態。 例: オープン、完了、スリープ、割り当て済み、利用可能 |
|
タスクの開始日
|
taskStartDate | date-time |
タスクの開始日。 |
|
タスクのスリープ期間
|
sleepUntil | date-time |
タスクがスリープ解除される日時。 |
|
タスクの優先度
|
priority | integer |
タスクの優先度。 |
|
タスク フォーム URL
|
formURL | string |
タスクのフォーム URL。 |
|
タスク ビュー フロー URL
|
viewFlowURL | string |
タスクのビュー フロー URL。 |
|
タスク ワークフロー ID
|
workflowID | integer |
タスクに関連付けられているワークフローの ID。 |
|
タスク ワークフロー名
|
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 |
タスクに関連付けられている指示。 |
ユーザー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー名
|
username | string |
ユーザーのユーザー名。 |
|
ユーザー FQN
|
fqn | string |
ユーザーの完全修飾名。 例: bob@denallix.com、K2:Denallix\Bob |
|
ユーザー メール
|
string |
ユーザーの電子メール アドレス。 |
|
|
ユーザー管理者
|
manager | string |
ユーザーの管理者。 |
|
ユーザーの表示名
|
displayName | string |
ユーザーの表示名。 |
TaskActionsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バッチ処理不可能なアクション
|
nonBatchableActions | array of string |
タスクを割り当てないと実行できないアクションの一覧。 |
|
バッチ処理可能なアクション
|
batchableActions | array of string |
タスクを割り当てずに実行できるアクションの一覧。 |
|
システム アクション
|
systemActions | array of string |
システム アクションの一覧。 |
タスク
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タスクのシリアル番号
|
serialNumber | string |
タスクのシリアル番号。 例: 1234_5678 |
|
タスクの進捗状況
|
status | string |
タスクの状態。 例: オープン、完了、スリープ、割り当て済み、利用可能 |
|
タスクの開始日
|
taskStartDate | date-time |
タスクの開始日。 |
|
タスクのスリープ期間
|
sleepUntil | date-time |
タスクがスリープ解除される日時。 |
|
タスクの優先度
|
priority | integer |
タスクの優先度。 |
|
タスク フォーム URL
|
formURL | string |
タスクのフォーム URL。 |
|
タスク ビュー フロー URL
|
viewFlowURL | string |
タスクのビュー フロー URL。 |
|
タスク ワークフロー ID
|
workflowID | integer |
タスクに関連付けられているワークフローの ID。 |
|
タスク ワークフロー名
|
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 |
ワークフロー インスタンスの項目参照を表す文字列。 |
WorkflowLabelsResponse[WorkflowLabel]
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
項目数
|
itemCount | integer |
ワークフローの数。 |
|
ワークフロー
|
workflows | array of WorkflowLabel |
ワークフローの一覧。 |
WorkflowLabel
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークフロー ID
|
id | integer |
ワークフローの ID。 |
|
ワークフローの既定のバージョン
|
defaultVersionId | integer |
既定のワークフロー バージョン。 |
|
ワークフロー名
|
name | string |
ワークフロー名。 |
|
ワークフロー フォルダー
|
folder | string |
ワークフロー フォルダー。 |
|
ワークフロー システム名
|
systemName | string |
ワークフロー システム名。 |
WorkflowDataResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
ワークフロー スキーマ
|
workflowSchema | string |
ワークフローのスキーマ。 |
WorkflowDefinition
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークフロー名
|
name | string |
ワークフローの名前です。 |
|
ワークフローの説明
|
description | string |
ワークフローの説明。 |
|
ワークフロー フォルダー
|
folder | string |
ワークフローのフォルダー (カテゴリ)。 |
|
ワークフロー システム名
|
systemName | string |
ワークフローのシステム名。 |
|
ワークフローの予想期間
|
expectedDuration | integer |
ワークフローの予想期間。 |
EventInstanceWrapper
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
イベント インスタンスの説明
|
Description | string |
イベント インスタンスの説明。 |
|
イベント インスタンスの予想期間
|
ExpectedDuration | integer |
イベント インスタンスの予想期間。 |
|
イベント インスタンス ID
|
ID | integer |
イベント インスタンスの ID。 |
|
イベント インスタンス メタデータ
|
MetaData | string |
イベント インスタンスのメタデータ。 |
|
イベント インスタンス名
|
Name | string |
イベント インスタンスの名前。 |
|
イベント インスタンスの優先度
|
Priority | integer |
イベント インスタンスの優先度。 |
|
イベント インスタンスの開始日
|
StartDate | date-time |
イベント インスタンスが開始した日時。 |
integer
これは基本的なデータ型 '整数' です。
オブジェクト
’オブジェクト’ という種類です。