uip or jobs

「uip or jobs」の構文とオプション - プロセスの実行とそのログ UiPath Orchestrator 開始、停止、再実行、検査を行います。

uip or jobs はプロセスの実行を管理します。プロセスからのジョブの開始、停止と再開、中断されたジョブの再開、ログ、トレース、ヒーリング エージェント データ、ステート履歴の検査を行います。すべてのジョブは、グローバルに一意な GUID キーによって識別され、ほとんどの動詞はキーからフォルダーを自動的に解決します。

概要

uip or jobs <verb> [options]

動詞

動詞	目的
list	ジョブのリストを取得します。必要に応じて、フォルダーにスコープを設定し、ステート、プロセス、ソース、または時間範囲でフィルター処理します。
get	入力/出力引数と (保留中のジョブの場合) 診断の理由を含め、キーで 1 つのジョブを取得します。
start	プロセスに対して 1 つ以上のジョブを開始する必要に応じて、完了を待機し、出力をダウンロードします。
stop	1 つまたは複数の実行中/保留中のジョブをソフト停止または強制終了します。
restart	失敗または停止したジョブから新しいジョブを作成します。
resume	中断されたジョブを再開します。必要に応じて、入力引数を更新します。
logs	ジョブのロボット実行ログを取得するレベルでフィルター処理するか、CSV にエクスポートします。
traces	エージェンティック (エージェント タイプ) のジョブの LlmOps 実行トレースを取得します。
healing-data	Healing Agent の回復データ (スクリーンショット、UI データ、ログ) を ZIP 形式でダウンロードします。
history	ジョブの状態遷移を表示します。

uip or jobs list

List jobs in a folder, or across every accessible folder with --all-folders. Returns job key, state, process name, timing, and machine info. Exactly one of a folder selector (--folder-path/--folder-key) or --all-folders is required — the command refuses to run with both or with neither.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-path	パス	—	Scope to a folder by path (for example, Shared). Provide this, --folder-key, or --all-folders.
—	--folder-key	GUID	—	キーによるフォルダーのスコープ。
—	--all-folders	フラグ	無効	List jobs across every accessible folder. Mutually exclusive with the folder selectors.
—	--state	ENUM	—	Pending、 Running、 Successful、 Faulted、 Stopped、 Stopping、 Suspended、 Resumed、 Terminating。
—	--process-name	text	—	プロセス (リリース) 名に contains-match が含まれます。
—	--source	ENUM	—	ジョブのソースの種類でフィルター処理する (例: Manual、 Schedule、 Queue、 Agent)。
—	--created-after	ISO8601認証取得	—	この日時以降に作成されたジョブ。
—	--created-before	ISO8601認証取得	—	この日付/時刻より厳密に前に作成されたジョブ。
—	--started-after	ISO8601認証取得	—	ジョブは、この日時以降に開始されました。
—	--started-before	ISO8601認証取得	—	ジョブは、この日時より厳密に前に開始されました。
—	--ended-after	ISO8601認証取得	—	ジョブは、この日時以降に終了しました。
—	--ended-before	ISO8601認証取得	—	ジョブは、この日時より厳密に前に終了しました。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--sort-by	フィールド	Id desc	OData の並べ替え式。
—	--all-fields	フラグ	無効	選定された概要ではなく、完全な API ペイロードを返します。

例

# The 50 most recent jobs across every accessible folder
uip or jobs list --all-folders

# Running jobs in a specific folder, newest first
uip or jobs list --folder-path "Shared" --state Running

# Pull only job keys and states, script-friendly
uip or jobs list --all-folders --state Faulted --limit 200 \
    --output-filter 'Data[].{key:Key, state:State}'

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

{
  "Code": "JobList",
  "Data": [
    {
      "Key": "b2c3d4e5-0000-0000-0000-000000000001",
      "State": "Running",
      "ProcessName": "InvoiceProcessing",
      "ReleaseKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "Source": "Manual",
      "Type": "Unattended",
      "Priority": "Normal",
      "Machine": "prod-worker-01",
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "StartTime": "2025-04-15T10:30:00Z",
      "EndTime": "",
      "CreationTime": "2025-04-15T10:29:55Z"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip or jobs get

GUID キーで 1 つのジョブを取得します。エラーが発生した場合は、ステート、入力/出力引数、タイミング、マシン情報、エラーの詳細を返します。ジョブのステートが Pendingの場合、出力には PendingReasons (ジョブが開始されていない理由 (ロボットの可用性、キャパシティなど) に関する API の診断レポート) も含まれます。フォルダーのコンテキストは不要です。

ジョブにOutputFileがある場合は、output-<job-key>.datに従って自動的に現在のディレクトリ (または --output-dir) にダウンロードされます。スキップするには --no-download を渡します。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID)。[ uip or jobs list] で検索します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--output-dir	パス	現在のディレクトリ	ダウンロードした OutputFileのディレクトリです。
—	--no-download	フラグ	無効	OutputFileの自動ダウンロードはスキップします。
—	--all-fields	フラグ	無効	完全な API ペイロードを返します。

例

uip or jobs get b2c3d4e5-0000-0000-0000-000000000001

# Skip the output-file download (useful in read-only containers)
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 --no-download

# Extract just output arguments
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.OutputArguments'

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

{
  "Code": "JobGet",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "ReleaseName": "InvoiceProcessing",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:32:11Z",
    "InputArguments": "{\"invoicePath\":\"/data/inv.pdf\"}",
    "OutputArguments": "{\"result\":\"Processed\"}",
    "HostMachineName": "prod-worker-01",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

uip or jobs start

プロセスに対して 1 つ以上のジョブを開始します。<process-key>は、uip or processes list によって返される GUID です (packages listではありません)。フォルダーは任意です — --folder-path も --folder-key も指定されていない場合は、プロセスから推測されます。

開始する前に、 uip or packages entry-points を使用して、パッケージ バージョンの入力/出力引数スキーマを確認します。

引数

名前	Required	目的
<process-key>	○	uip or processes listのプロセス (リリース) キー (GUID)。

オプション

ID とテナント

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-path	パス	推論	フォルダー パス省略された場合はプロセスから推測されます。
—	--folder-key	GUID	推論	フォルダー キー省略された場合はプロセスから推測されます。

実行戦略

Short	長押し	値 (Value)	既定 (Default)	説明
—	--strategy	ENUM	ModernJobsCount	ModernJobsCount、 All、 Specific、 JobsCount。
—	--jobs-count	Number	1	作成するジョブの数 (カウントベースのストラテジの場合)。
—	--runtime-type	ENUM	フォルダー構成	Unattended、 Headless、 Serverless、 NonProduction、 Development、 TestAutomation。
—	--job-priority	ENUM	—	Low、 Normal、 Highです。
—	--reference	text	—	ジョブに格納される自由形式の参照文字列。
—	--run-as-me	フラグ	無効	呼び出し元の ID で実行します。
—	--healing-agent	フラグ	無効	Enable Healing Agent (Autopilot for Robots) for this run, to recover from selector failures and similar runtime errors. Tenant-level Autopilot must already be enabled.
—	--user-keys	CSV	—	実行に使用するユーザー GUID (NonAttended ロボットに解決される)。
—	--machine-keys	CSV	—	対象のマシン GUID

入力と添付ファイル

Short	長押し	値 (Value)	既定 (Default)	説明
—	--input-arguments	JSON	—	インライン JSON ペイロード。10,000 文字を超える InputFile に自動オフロードします。--input-fileと相互に排他的です。
—	--input-file	パス	—	ジョブの InputFileとしてファイルをアップロードします。--input-argumentsと相互に排他的です。
—	--attachment	[name=]path	—	ファイルをアップロードして添付します。再現。ファイル名から自動名--attachment ./doc.pdf--attachment invoice=./report.pdf は明示的な名前を設定します。
—	--attachment-id	GUID	—	既存の添付ファイルを ID で添付します。再現。attachments list --job-keyでIDを検索します。
—	--environment-variables	text	—	Environment variables as newline-separated KEY=VALUE pairs (not JSON). Validated before submission.

完了を待機しています。

Short	長押し	値 (Value)	既定 (Default)	説明
—	--wait-for-completion	フラグ	無効	ジョブが Successful、 Faulted、または Stoppedに達するまでポーリングします。
—	--timeout	秒	300	最大待機時間 ( --wait-for-completion時間が必要)。
—	--poll-interval	秒	5	ポーリング間隔 ( --wait-for-completionが必要です)。
—	--output-dir	パス	現在のディレクトリ	保存場所 ( OutputFile が必要 ( [ --wait-for-completionが必要])
—	--no-download	フラグ	無効	ダウンロード OutputFile スキップします ( --wait-for-completionが必要です)。

注:

--user-keys 、各ユーザー GUID がターゲット フォルダー内の NonAttended ロボットに解決されます。Attended ロボットと AttendedStudioWeb ロボットの種類は除外され、CLI で開始されたジョブには Unattended ロボットが必要です。このフォルダーにユーザーの Unattended ロボットが存在しない場合、コマンドは失敗します。

例

# Minimal — start one job for a process
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001

# Start with input arguments and wait for completion
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-arguments '{"invoicePath":"/data/inv.pdf"}' \
    --wait-for-completion --timeout 600

# Upload a file as input and attach a supporting document
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-file ./payload.json \
    --attachment invoice=./report.pdf

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

--wait-for-completionなし:

{
  "Code": "JobStarted",
  "Data": {
    "Jobs": [
      {
        "Key": "b2c3d4e5-0000-0000-0000-000000000099",
        "State": "Pending",
        "ProcessName": "InvoiceProcessing",
        "Source": "Manual",
        "Type": "Unattended",
        "Priority": "Normal",
        "Machine": "",
        "StartTime": "",
        "EndTime": "",
        "CreationTime": "2025-04-15T10:29:55Z"
      }
    ]
  }
}

--wait-for-completionでは、CodeはJobCompleted (障害発生時にはJobFaulted) され、Data は jobs get と同じ図形にDurationフィールドを加えたものになります。ジョブが失敗すると、プロセスはコード 1で終了します。

動詞固有の終了コードのオーバーライド

• --wait-for-completion + ジョブが次の値で終了 Faulted: コマンドが結果の観察に成功した場合でも、 1 終了します。
• --wait-for-completion + タイムアウトに達しました: 現在のジョブ キーを Instructions にして1を終了し、jobs getを使用してポーリングできるようにします。

uip or jobs stop

1 つ以上の実行中または保留中のジョブを停止します。単一のキーでは、 --strategy (SoftStop または Kill) を尊重します。複数のキーがある場合は、常に一括 API を介して強制停止 (強制終了) します — その場合、 --strategy は無視されます。フォルダーのコンテキストは不要最初のジョブ キーから解決します。

引数

名前	Required	目的
<job-keys...>	○	1 つ以上のジョブ キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--strategy	ENUM	SoftStop	SoftStop (優雅)または Kill (即時)。単一キーのストップにのみ適用されます。

例

uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001
uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001 --strategy Kill
uip or jobs stop key-1 key-2 key-3   # bulk force-stop

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

シングルキー:

{
  "Code": "JobStopped",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "Strategy": "SoftStop",
    "Status": "Stop requested"
  }
}

複数のキーは、JobKeys、Strategy: "Kill (force stop)"、および Status 文字列を含むCode: "JobsStopped"を返します。

uip or jobs restart

失敗または停止したジョブから新しいジョブを作成します。フォルダーはジョブ キーから解決されます。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID) を使用して再起動します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明

例

uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001
uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001 --output-filter 'Data.Key'

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

{
  "Code": "JobRestarted",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000050",
    "State": "Pending",
    "ProcessName": "InvoiceProcessing",
    "Status": "Restart requested"
  }
}

uip or jobs resume

中断したジョブを再開します。ジョブは、長期実行のワークフローで [ Suspend ] アクティビティを使用すると中断されます。必要に応じて、新しい --input-arguments を渡して、更新されたデータを続行します。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID) を再開します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--input-arguments	JSON	—	置換入力引数。

例

uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001
uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001 \
    --input-arguments '{"approved":true}'

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

{
  "Code": "JobResumed",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Resumed",
    "ProcessName": "ApprovalFlow",
    "Status": "Resume requested"
  }
}

uip or jobs logs

ジョブのロボット実行ログを取得します。ログは新しい順に返されます。--level を使用すると、重大度でフィルター処理できます。--exportを使用すると、ログはサーバー側で CSV にエクスポートされ、準備ができ次第ダウンロードされます。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID)。API 呼び出しの前に UUID として検証されます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--level	ENUM	—	Fatal、 Error、 Warning、 Info、 Trace。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--export	フラグ	無効	サーバー側のエクスポート API を使用して CSV にエクスポートします。
-o	--output	パス	robot-logs-<job-key>.csv	出力 CSV パス。--exportの場合のみ。

例

uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --level Error --limit 100
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --export -o ./run.csv
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 \
    --level Error --output-filter 'Data[].Message'

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

インライン モード:

{
  "Code": "JobLogs",
  "Data": [
    {
      "Level": "Error",
      "TimeStamp": "2025-04-15T10:31:02Z",
      "Message": "Selector not found: ctrl[name='submit']"
    }
  ]
}

--export、JobKey、FileName、Size、および ExportIdのCode: "JobLogsExported"を出力します。

uip or jobs traces

エージェンティック ジョブの LlmOps 実行トレース (LLM との対話、ツールの呼び出し、エージェントの意思決定) を取得するエージェントタイプのプロセスでのみ利用可能です。フォルダーはジョブ キーから解決されます。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明

例

uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001
uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.messages'

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

生の API ペイロードは、変更されずに Dataで渡されます。

{
  "Code": "JobTraces",
  "Data": { "...": "raw LlmOps trace payload" }
}

uip or jobs healing-data

healing-agent (Autopilot for Robots) の回復データ (スクリーンショット、UI 要素のデータ、回復ログ) を ZIP 形式でダウンロードします。Healing Agent がアクティブだったジョブでのみ使用できます。このコマンドは、非同期エクスポートをトリガーし、完了するまでエクスポート API をポーリングしてから、結果の ZIP をダウンロードします。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--directory-prefix	prefix	—	エクスポートされたファイルに適用されるパス プレフィックス フィルター。
-o	--output	パス	healing-agent-data-<job-key>.zip	出力 ZIP パス。

例

uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    -o ./recovery.zip
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.FileName'

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

{
  "Code": "JobHealingData",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "FileName": "healing-agent-data-b2c3d4e5-0000-0000-0000-000000000001.zip",
    "Size": 254318,
    "ExportId": 4711
  }
}

注:

サーバー側のエクスポートは、2 秒間隔で最大 30 回 (合計 60 秒) ポーリングされます。そのウィンドウで完了しない場合、コマンドはエクスポート ID で 1 を終了し、再試行できるようにします。

uip or jobs history

ジョブの状態遷移の履歴を取得する (Pending → Running → Successful/Faulted)。フォルダーはジョブ キーから解決されます。

引数

名前	Required	目的
<job-key>	○	ジョブ キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明

例

uip or jobs history b2c3d4e5-0000-0000-0000-000000000001
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data[].{state:State, ts:Timestamp}'
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 --output table

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

{
  "Code": "JobHistory",
  "Data": [
    { "State": "Pending", "Timestamp": "2025-04-15T10:29:55Z", "JobId": 1001 },
    { "State": "Running", "Timestamp": "2025-04-15T10:30:00Z", "JobId": 1001 },
    { "State": "Successful", "Timestamp": "2025-04-15T10:32:11Z", "JobId": 1001 }
  ]
}

終了コード

共有コントラクト の終了コード を参照してください。動詞固有のオーバーライド:

• jobs start --wait-for-completion は、監視対象のジョブがFaulted終了するか、待機がタイムアウトすると、1終了します。
• jobs healing-data は、サーバー側のエクスポートが ~60 秒以内に完了しない場合、 1 終了します。

関連コマンド

• uip or processes — jobs start がターゲットとするプロセス (リリース) バインドを管理します。
• uip or packages — 特に入力/出力引数スキーマの検出packages entry-points。
• uip or attachments — ジョブの添付ファイルのリストを表示してダウンロードします。
• uip or users — ユーザー名を--user-keysのキーに解決します。
• uip or machines — マシン名を--machine-keysのキーに解決します。

参照

• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• セッション — テナントとフォルダーのコンテキストがどのように解決されるか。
• 最初のパイプライン — エンドツーエンドのチュートリアル — jobs start --wait-for-completionを使用したエンドツーエンドのチュートリアル。