UIP 評価スケジュール

「uip eval schedule」の構文とオプション。「uip eval schedule」では、Orchestrator プロセスの定期的な評価実行スケジュールを作成、表示、更新、一時停止、再開、削除します。

Orchestrator プロセスの定期的な評価実行を管理するuip eval schedule、特定の評価セットをタイマーでプロセスに対して実行し、その一覧表示、検査、更新、一時停止、再開、削除を行います。これは、1 回限りの実行に相当するスケジュールされた実行です。execute-and-evaluate (一度同期的に実行) や run (過去の実行を検査する) を含む、eval サブシステム全体の概要については、uip eval をご覧ください。評価セットに実際に含まれる内容については、「 uip eval eval-set」をご覧ください。

各スケジュールは 1 つのプロセス (--process-key) に属し、5 つのフィールドからなる UTC cron 式で 1 つの評価セット (--eval-set-id) を実行します。

概要

uip eval schedule create  --process-key <guid> --eval-set-id <guid> --cron <expr> [--workload-id <guid>] [--folder-key <guid>] [--tenant <tenant>]
uip eval schedule list    --process-key <guid> [--tenant <tenant>]
uip eval schedule get     <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule update  <schedule-id> --process-key <guid> [--eval-set-id <guid>] [--cron <expr>] [--tenant <tenant>]
uip eval schedule pause   <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule resume  <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule delete  <schedule-id> --process-key <guid> [--tenant <tenant>]

動詞

動詞	目的
create	プロセスの新しい定期的なスケジュールを作成します。
list	プロセスのすべてのスケジュールを一覧表示する。
get	ID で 1 つのスケジュールを取得します。
update	スケジュールの評価セットや cron 式を変更します。
pause	アクティブなスケジュールを一時停止します。
resume	一時停止したスケジュールを再開します。
delete	スケジュールを削除します。

UIP 評価スケジュールの作成

定期的な UTC cron トリガーでプロセスに対して評価セットを実行するスケジュールを作成します。

--workload-idまたは--folder-keyを省略すると、コマンドは最初に評価セットを検索し (GET .../evalSets/<eval-set-id>)、そこから両方を入力します。明示的に渡すだけで、その解決を上書きできます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー (デプロイ GUID) — Orchestrator のリリースを識別します。
—	--workload-id	GUID	評価セットから解決済み	ワークロード ID
—	--eval-set-id	GUID	—	必須。各トリガーで実行されるように設定された評価。
—	--cron	cron 式	—	必須。5 つのフィールドからなる cron 式。UTC で評価されます (たとえば、毎日午前 9 時 UTC に "0 9 * * *" )。
—	--folder-key	GUID	評価セットから解決済み	Orchestrator のフォルダー キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。プレーン オプション。非推奨ではありません。

例

# Daily at 9 AM UTC
uip eval schedule create --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 \
  --eval-set-id f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04 --cron "0 9 * * *"

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

{
  "Code": "EvalScheduleCreated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

UpdatedAt は、スケジュールが少なくとも 1 回変更された場合にのみ存在します (新しい create 応答では存在しません)。

UIP 評価スケジュール リスト

プロセスに登録されているすべてのスケジュールのリストを表示します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule list --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

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

{
  "Code": "EvalScheduleList",
  "Data": [
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
      "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
      "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
      "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
      "CronExpression": "0 9 * * *",
      "Status": "active",
      "CreatedAt": "2025-04-15T10:29:55Z"
    }
  ]
}

UIP 評価スケジュールの取得

ID で 1 つのスケジュールを取得します。

引数

名前	Required	目的
<schedule-id>	○	スケジュールの GUID を create または listから設定します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule get b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

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

{
  "Code": "EvalScheduleDetails",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

UIP 評価スケジュールの更新

スケジュールの評価セットや cron 式を変更します。少なくとも --eval-set-id/--cron の 1 つが必要です — どちらもネットワーク呼び出しの前にクライアント側で失敗しません。

引数

名前	Required	目的
<schedule-id>	○	更新のスケジュールを設定。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--eval-set-id	GUID	—	新しい評価セット。この --cron またはの少なくとも 1 つが必要です。
—	--cron	cron 式	—	新しい 5 フィールドの cron 式 (UTC)。この --eval-set-id またはの少なくとも 1 つが必要です。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule update b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --cron "0 */6 * * *"

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

{
  "Code": "EvalScheduleUpdated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 */6 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z",
    "UpdatedAt": "2025-04-16T08:00:00Z"
  }
}

--eval-set-id と --cron の両方を省略すると、次のエラーで失敗します。

{
  "Result": "Failure",
  "Message": "At least one of --eval-set-id or --cron must be provided.",
  "Instructions": "Provide the field(s) you want to update."
}

UIP 評価スケジュールの一時停止

アクティブなスケジュールを一時停止します。 resumeまで以降の実行はトリガーされません。

引数

名前	Required	目的
<schedule-id>	○	一時停止するスケジュールを設定。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule pause b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

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

{
  "Code": "EvalSchedulePaused",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "paused",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

UIP 評価スケジュールの再開

一時停止したスケジュールを再開します。

引数

名前	Required	目的
<schedule-id>	○	再開のスケジュールを設定。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule resume b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

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

{
  "Code": "EvalScheduleResumed",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

UIP 評価スケジュールの削除

スケジュールを完全に削除する

引数

名前	Required	目的
<schedule-id>	○	削除のスケジュールを設定。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--process-key	GUID	—	必須。プロセス キー。
—	--tenant	name	セッションの既定値	UiPath のテナント名です。

例

uip eval schedule delete b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

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

{
  "Code": "EvalScheduleDeleted",
  "Data": { "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001" }
}

関連コマンド

• uip eval — 概要、execute-and-evaluate、run
• uip eval evaluator — スケジュールの評価セットで使用できる評価器を定義します。
• uip eval eval-set/evaluation — スケジュールが実際に実行される対象を定義します。

参照

• uip orの概要—すべてのuip or動詞に共通する規則。
• グローバル オプション
• 終了コード