UIP タスク

「uip タスク」ツールを使用して、Action Center のタスク、カタログ、コメント、ラベル、メタデータ、タスク データを管理するためのコマンドです。

uip tasks は、 Action Center のタスク (RPA プロセスとエージェントが人間が完了するために作成する人間参加型の作業項目 (フォームの入力、承認、ドキュメントの検証/分類、データのラベル付け) を管理します。このツールでは、タスクのリスト表示と検査、タスクの割り当てまたは再割り当て、アクションとデータ ペイロードによるタスクの完了、タスクにアタッチされた補助リソース (カタログ (グループ化/保持設定)、コメント、ラベル (タグ)、メタデータ (タイトル/優先度/カタログのリンク)、タスク独自のフォーム/ビジネス データ) の管理が可能です。tasks はコマンド プレフィックスです。基になるパッケージは @uipath/tasks-toolです。

概念

• フォルダーのスコープ — 特定のタスクまたはカタログで動作するすべての動詞は、 --folder-id <id>、 --folder-path <path>、または --folder-key <key> を受け入れます (相互に排他的で、Commander の競合を介して解析時に強制されます)。対話型ターミナルで何も渡されない場合、CLI はフォルダー ピッカーを表示します。非対話型の実行 (CI、コーディング エージェント) では、要求するとすぐに失敗します。uip tasks list と uip tasks get は 2 つの例外です — フォルダーはオプションであり、指定された場合は単に結果/検索を絞り込むだけです。
• タスクの種類 — 複数の動詞 (get --task-type、 complete --type) は、 ExternalTask、 AppTask、 DocumentValidationTask、 DocumentClassificationTask、 DataLabelingTask、 QuickFormTaskFormTaskのいずれかを取ります。認識されない値がクライアント側で失敗し、エラーで指定された完全なリストが表示されます。
• ページネーション — リスト スタイルの動詞 (list、 catalogs list、 comments list、 users) を 100 項目のページ サイズで内部的に表示し、使い果たすか --limit に達するまでnextCursorをたどり、どちらにしても 1 つのフラット配列を返します。これは、自分で管理するためのカーソル フラグはありません。
• カタログは、任意のタスクのグループ化/保持設定です 。 metadata --catalog-id タスクを 1 つのタスクにリンクします。 catalogs create/updateの保持フィールド (--retention-action、 --retention-period、 --retention-bucket-id) は、カタログ データの経時的な処理を制御します。catalogs create の--encryptedは不変です。catalogs updateで変更する方法はありません。

概要

uip tasks list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [--as-admin] [-l, --limit <n>]
uip tasks get <id> [--task-type <type>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks assign <task-id> (--user-id <id> | --user <email>)
uip tasks reassign <task-id> (--user-id <id> | --user <email>)
uip tasks unassign <task-id>
uip tasks complete <task-id> --type <type> [--data <json>] [--action <action>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks users [folder-id] [--folder-path <path> | --folder-key <key>] [-l, --limit <n>]

uip tasks catalogs list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [-l, --limit <n>]
uip tasks catalogs get <id> [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs create --name <name> [--description <text>] [--encrypted] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs update <id> [--name <name>] [--description <text>] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]

uip tasks comments list <task-id> [-l, --limit <n>] [folder options]
uip tasks comments add <task-id> --text <text> [folder options]

uip tasks labels <task-id> --labels <json> [folder options]
uip tasks metadata <task-id> [--title <text>] [--priority <level>] [--catalog-id <id> | --unset-catalog] [--note <text>] [folder options]

uip tasks data get <task-id> [folder options]
uip tasks data save <task-id> --data <json> [folder options]

UIP タスクのリスト

複数のフォルダー (または、スコープを設定している場合は 1 つのフォルダー) にまたがるタスクのリストを取得します。

オプション

長押し	値 (Value)	説明
--folder-id <id>	integer	フォルダー ID でフィルター処理する
--folder-path <path>	string	フォルダー パスでフィルター処理します ( --folder-idの代替手段)。
--folder-key <key>	GUID	フォルダー キーでフィルター処理します ( --folder-idの代替手段)。
--as-admin	フラグ	管理者としてタスクのリストを取得します (自身に割り当てられている/利用可能なタスクよりも広く可視化されます)。
-l, --limit <number>	integer	返す最大アイテム数。省略すると、すべて (内部でのページング) を取得します。

例

uip tasks list --folder-path "Shared/Finance" --limit 20

データシェイプ(--output json)

{ "Code": "TaskList", "Data": [ { "id": 1, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } ] }

UIP タスクの取得

タスクの詳細を ID で取得します。

引数

名前	Required	目的
<id>	○	タスク ID。tasks list を使用して検索します。

オプション

長押し	値 (Value)	説明
--task-type <type>	7 種類のタスクのいずれか	タスクの種類。成功した場合はフォルダー オプションが必要です。成功 しなかった場合はすぐに失敗します。
--folder-id <id> / --folder-path <path> / --folder-key <key>		フォルダー スコープ--task-typeが設定されている場合にのみ必須です。

例

uip tasks get 123 --task-type FormTask --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskDetails", "Data": { "id": 123, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } }

UIP タスクの割り当て/再割り当て

タスクをユーザーに割り当てるか、別のタスクに再割り当てします。同じオプションの形状で、成功時の Code は同じです。

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	Required	説明
--user-id <id>	integer	この 2 つのうちの 1 つ	担当者の数値のユーザー ID。
--user <email>	string	この 2 つのうちの 1 つ	担当者のユーザー名またはメール アドレスです ( --user-idの代替手段)。

どちらも渡すと、明示的な「担当者が見つからません。」エラーが発生して失敗します。

例

uip tasks assign 123 --user [e-mail]
uip tasks reassign 123 --user-id 7

データシェイプ(--output json)

{ "Code": "TaskAssigned", "Data": { "id": 123, "assignedTo": "[e-mail]" } }

Code は reassignに対してTaskReassignedです。

UIP タスクの割り当て解除

担当者をタスクから削除するタスク ID 以外のオプションはありません。

引数

名前	Required	目的
<task-id>	○	タスク ID。

例

uip tasks unassign 123

データシェイプ(--output json)

{ "Code": "TaskUnassigned", "Data": { "id": 123 } }

UIP タスクの完了

アクションと任意のデータ ペイロードを使用してタスクを完了します。

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	Required	説明
--type <type>	7 種類のタスクのいずれか	○	タスクの種類 — 列挙型に対してクライアント側で検証されます。
--data <json>	JSON	×	JSON 文字列としてのタスク データ ペイロード。
--action <action>	string	条件付き	アクション名。実際には FormTask や AppTask に必要です (クライアント側では強制されません。これらの種類では不足しているアクションは拒否されます)。
フォルダーのオプション		×	フォルダーは完了する前に解決されます (省略されている場合は対話的に解決されます。

例

uip tasks complete 123 --type FormTask --action Approve --data '{"comment":"Looks good"}'

データシェイプ(--output json)

{ "Code": "TaskCompleted", "Data": { "id": 123, "status": "Completed" } }

UIP タスク ユーザー

フォルダー内のタスク権限を持つユーザーのリストを取得 — assign/reassignの --user-id/--user値のソースです。

引数

名前	Required	目的
[folder-id]	×	位置引数としてのフォルダー ID。--folder-path/--folder-key と相互に排他的です。両方を渡すと明示的に失敗します。

オプション

長押し	値 (Value)	説明
--folder-path <path>	string	フォルダー パス (positional 引数の代替手段)。
--folder-key <key>	GUID	フォルダー キー (positional 引数の代替手段)
-l, --limit <number>	integer	返す最大アイテム数。

例

uip tasks users 42
uip tasks users --folder-path "Shared/Finance" --limit 10

データシェイプ(--output json)

{
  "Code": "TaskUserList",
  "Data": [
    { "id": 1, "name": "Alice", "surname": "Smith", "userName": "alice", "emailAddress": "[e-mail]", "displayName": "Alice Smith" }
  ]
}

UIP タスク カタログ

タスク カタログの管理 — タスクの名前付きのグループです。任意の暗号化と保持ポリシーを使用できます。

UIP タスク カタログのリスト

オプション

長押し	値 (Value)	説明
フォルダーのオプション		カタログのリストを取得するフォルダーです (省略すると、フォルダーは 概念に従って解決されます)。
-l, --limit <number>	integer	返す最大アイテム数。

例

uip tasks catalogs list --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCatalogList", "Data": [ { "id": 5, "name": "Invoices", "encrypted": false } ] }

UIP タスク カタログの取得

引数

名前	Required	目的
<id>	○	タスク カタログ ID。

例

uip tasks catalogs get 5 --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCatalogDetails", "Data": { "id": 5, "name": "Invoices", "encrypted": false } }

UIP タスク カタログの作成

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	カタログ名。
--description <text>	string	×	カタログの説明。
--encrypted	フラグ	×	このカタログ内のタスク データを暗号化します。変更不可 — 後 catalogs update で変更することはできません。
--retention-action <action>	Delete | Archive	×	保持期間の上限でどうなるかその他の値はクライアント側では失敗します。
--retention-period <days>	integer	×	保持期間 (日数)。
--retention-bucket-id <id>	integer	×	ストレージ バケット ID。 --retention-action Archiveときに使用されます。

例

uip tasks catalogs create --name Invoices --retention-action Archive --retention-period 90 --retention-bucket-id 3 --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCatalogCreated", "Data": { "id": 5, "name": "Invoices" } }

UIP タスク カタログの更新

結合 — 渡したフラグのみが変更されます。少なくとも --name/--description/--retention-action/--retention-period/--retention-bucket-id のいずれかが必要です。「なし」での呼び出しは、ファイル/ネットワーク アクセスの前に失敗します。--encrypted はここで変更できません。

引数

名前	Required	目的
<id>	○	タスク カタログ ID。

オプション

create から --encryptedを引いた値と同じセットです。

例

uip tasks catalogs update 5 --name "Invoices v2" --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCatalogUpdated", "Data": { "id": 5, "name": "Invoices v2" } }

UIP タスクのコメント

UIP タスクのコメント リスト

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	説明
-l, --limit <number>	integer	返す最大アイテム数。
フォルダーのオプション		タスクが存在するフォルダー。

例

uip tasks comments list 123 --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCommentList", "Data": [ { "id": 1, "text": "Looks good", "createdBy": "alice" } ] }

UIP タスク コメント 追加

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	Required	説明
--text <text>	string	○	コメントのテキスト。空の文字列は拒否されます。
フォルダーのオプション		×	タスクが存在するフォルダー。

例

uip tasks comments add 123 --text "Escalating to finance" --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskCommentCreated", "Data": { "id": 2, "text": "Escalating to finance" } }

UIP タスクのラベル

1 回の呼び出しでタスクのラベル (タグ) を設定またはクリアする — これは完全な置換であり、結合ではありません。保持するすべてのラベルを渡します。

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	Required	説明
--labels <json>	JSON 配列	○	設定するラベル (例:[{"name":"region","displayName":"Region","displayValue":"EMEA"}]です。すべてのラベルをクリアするには、 [] を渡します。JSON 配列である必要があります。配列以外の値はクライアント側では失敗します。
フォルダーのオプション		×	タスクが存在するフォルダー。

例

uip tasks labels 123 --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskLabelsSaved", "Data": { "taskId": 123, "labels": [{ "name": "region", "displayName": "Region", "displayValue": "EMEA" }] } }

UIP タスクのメタデータ

タスクのタイトル、優先度、カタログのリンクを編集し、編集内容のメモを記録します。マージ — 渡したフラグのみが変更されます。少なくとも 1 つは必須です。

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	説明
--title <title>	string	新しいタイトル。
--priority <priority>	Low | Medium | High | Critical	新しい優先度。設定外の値はクライアント側で失敗し、有効なセットに名前が付けられます。
--catalog-id <id>	integer	タスク カタログを関連付けます。--unset-catalogと相互に排他的です。
--unset-catalog	フラグ	タスクのカタログの関連付けを削除します。--catalog-idと相互に排他的です。
--note <text>	string	編集とともにコメントを録音しました。

例

uip tasks metadata 123 --priority High --note "Escalated per manager request" --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskMetadataEdited", "Data": { "taskId": 123 } }

UIP タスクのデータ

タスクの基になるフォーム/ビジネス データ オブジェクトを読み書きします。

UI Tasks データの取得

引数

名前	Required	目的
<task-id>	○	タスク ID。

例

uip tasks data get 123 --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskData", "Data": { "invoiceNumber": "INV-001", "amount": 250.0 } }

UIP タスクのデータ保存

引数

名前	Required	目的
<task-id>	○	タスク ID。

オプション

長押し	値 (Value)	Required	説明
--data <json>	JSON オブジェクト	○	保存するタスクのデータです。JSON オブジェクト (配列やスカラーではない) である必要があります。それ以外のものはクライアント側では失敗します。

例

uip tasks data save 123 --data '{"invoiceNumber":"INV-001","amount":250.0}' --folder-id 42

データシェイプ(--output json)

{ "Code": "TaskDataSaved", "Data": { "taskId": 123 } }

参照

• 概念: UiPath CLI の構成方法 — ホスト + ツール モデルの中でツールが適合する場所。
• セッション — テナント コンテキストの解決方法。
• uip or folders — このページでフォルダーのスコープ設定オプションのフォルダー ID/パス/キーを確認できます。
• uip login — すべての Action Center 呼び出しに使用されるセッションです。
• グローバル オプション
• 終了コード