UIP またはプロセス

uip or processes は、パッケージの実行可能なフォルダーへのバインド (Orchestrator の内部では「リリース」) を管理します。プロセスは、uip or jobs startが目標とするものです。パッケージは、基になる.nupkg成果物です (uip or packagesを参照)。

概要

uip or processes <verb> [options]

動詞

動詞	目的
list	フォルダー内のプロセスのリストを取得します。
get	引数スキーマと保持期間を含むキーで 1 つのプロセスを取得する
create	パッケージを新しいプロセスとしてフォルダーにバインドします。
update-version	1 つ以上のプロセスを最新の (または特定の) パッケージ バージョンにバンプします。
edit	プロセスの設定を編集する (選択したフィールドの PATCH セマンティクス)。
rollback	プロセスを以前のパッケージ バージョンにロールバックします。

uip またはプロセス リスト

フォルダー内のプロセスのリストを取得します。--folder-path または --folder-keyが必要です。プロセス キー (GUID)、名前、バージョン、および基本メタデータを返します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	—	パスによるターゲット フォルダー
—	--folder-key	GUID	—	キーによるターゲット フォルダー。
-n	--name	text	—	プロセス名に一致する値を含む。
—	--process-type	ENUM	—	Process、 Agent、 Flow、 TestAutomationProcess、 WebApp、 Api、 MCPServer、 BusinessRules、 CaseManagement、 Function。
—	--all-fields	フラグ	無効	完全な API ペイロードを返します。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え。

例

uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --folder-path "Shared" \
    --output-filter 'Data[].{key:Key, name:Name, v:ProcessVersion}'

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

{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip または processes get

GUID キーで 1 つのプロセスを取得します。バージョン、エントリ ポイント、入力/出力引数のスキーマ、プロセスの種類、および設定を返します。フォルダー コンテキストは不要 — キーはフォルダーをまたいで解決されます。

引数

名前	Required	目的
<process-key>	○	プロセス キー (GUID)。[ processes list] で検索します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--all-fields	フラグ	無効	完全な API ペイロードを返します。

例

uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.InputArguments'

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

{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}

uip またはプロセスの作成時

パッケージをプロセスとしてフォルダーにバインドします。--folder-path または --folder-key 個と、3 つの必須パッケージ オプションが必要です。パッケージ キーには [ uip or packages list ] を使用し、利用可能なバージョンには [ uip or packages versions ] を使用します。

オプション

Required

Short	長押し	値 (Value)	既定 (Default)	説明
—	--name	text	—	フォルダー内のプロセス名。
—	--package-key	text	—	パッケージ キー (packages listPackageId) です。
—	--package-version	version	—	パッケージ バージョン (例: 1.0.0

ID とスコープ

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	—	パスによるターゲット フォルダー
—	--folder-key	GUID	—	キーによるターゲット フォルダー。

プロセスの設定

Short	長押し	値 (Value)	既定 (Default)	説明
—	--description	text	—	プロセスの説明。
—	--entry-point	パス	—	エントリ ポイントのワークフロー パス (マルチエントリ ポイント パッケージの場合)
—	--input-arguments	JSON	—	既定の入力引数は JSON です。
—	--job-priority	ENUM	—	Low、 Normal、 Highです。--specific-priorityと相互に排他的です。
—	--specific-priority	1–100	—	優先度の数値。--job-priorityと相互に排他的です。
—	--robot-size	ENUM	—	Cloud ロボットのサイズ: Small、Standard、Medium、Large
—	--tags	CSV	—	コンマ区切りのタグ名。
—	--environment-variables	JSON	—	環境変数 (JSON) (検証済み)
—	--auto-update / --no-auto-update	フラグ	—	最新のパッケージ バージョンへの自動更新を有効化/無効化します。
—	--hidden-for-attended / --visible-for-attended	フラグ	—	有人オートメーションのユーザーに表示しないでほしい相互に排他的です。
—	--auto-create-triggers / --no-auto-create-triggers	フラグ	—	デプロイ時に接続トリガーを自動作成

retention

Short	長押し	値 (Value)	既定 (Default)	説明
—	--retention-period	日(1〜180)	30	ジョブの保持期間。
—	--retention-action	ENUM	Delete	Delete、 Archive、または Noneのいずれかです。
—	--retention-bucket	バケット ID	—	ストレージ バケット ID。--retention-action Archive時に必須です。
—	--stale-retention-period	日	—	古いジョブの保持期間。
—	--stale-retention-action	ENUM	—	Delete、 Archive、または Noneのいずれかです。

例

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Data.Key'

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

{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}

uip または processes update-version

1 つ以上のプロセスを最新のパッケージ バージョンに更新するか、 --package-versionを使用して特定のバージョンに更新します。フォルダーは任意です — 指定しない場合は、最初のプロセス キーから推論されます。

• 1 つのキー + --package-version →なし、最新に更新 (単一の API 呼び出し)。
• 1 つのキー + --package-version → つのバージョンへの更新 (単一の API 呼び出し)。
• 複数のキー + --package-version →なし、最新の状態に一括更新。
• 複数のキー + --package-version →拒否 (検証エラー)

実行中のジョブは影響を受けません。更新されたバージョンを使用するのは新しいジョブのみです。

引数

名前	Required	目的
<process-keys...>	○	1 つ以上のプロセス キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	推論	自動検出をスキップしてこのフォルダーを使用します。
—	--folder-key	GUID	推論	自動検出をスキップしてこのフォルダーを使用します。
—	--package-version	version	—	特定のバージョン。単一のキーでのみ有効です。

例

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Data.Version'

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

シングルキー:

{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}

一括処理は、ProcessKeys、Version、および API からエコーされた Result オブジェクトを含むCode: "ProcessVersionsUpdated"を返します。

uip またはプロセスの編集

プロセスの設定をキーで編集します。現在の値を読み取り、指定された PATCH フィールドを適用して保存します。指定されたフィールドのみが変更されます。CLI で省略された保持フィールドは、現在の状態から保持されます。

引数

名前	Required	目的
<process-key>	○	プロセス キー (GUID)。

オプション

processes create つの必須パッケージ オプションとスコープ フラグ以外はフィールドと同じです。相互排除ルールと検証ルールが一致している create (--job-priority と --specific-priorityの比較、 --hidden-for-attended と --visible-for-attended、保持期間 Archive --retention-bucket)。

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-n	--name	text	—	新しい表示名。
-d	--description	text	—	新しい説明。
—	--entry-point	パス	—	新しいエントリ ポイント パス。
—	--input-arguments	JSON	—	既定の入力引数です。
—	--job-priority	ENUM	—	Low、 Normal、 Highです。
—	--specific-priority	1–100	—	優先度の数値。
—	--auto-update / --no-auto-update	フラグ	—	自動更新を切り替えます。
—	--hidden-for-attended / --visible-for-attended	フラグ	—	有人シナリオの表示。
—	--auto-create-triggers / --no-auto-create-triggers	フラグ	—	接続トリガーによる自動作成
—	--retention-period	日(1〜180)	—	ジョブの保持期間。
—	--retention-action	ENUM	—	Delete、 Archive、 Noneです。
—	--retention-bucket	バケット ID	—	--retention-action Archive時に必須です。
—	--stale-retention-period	日	—	古いジョブの保持期間。
—	--stale-retention-action	ENUM	—	Delete、 Archive、 Noneです。

例

uip or processes edit c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes edit c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

uip or processes edit c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Data.Status'

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

{
  "Code": "ProcessEdited",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}

uip またはプロセスのロールバック

プロセスを以前のパッケージ バージョンにロールバックします。フォルダーは任意です — 指定しない場合は、プロセス キーから推測されます。

引数

名前	Required	目的
<process-key>	○	プロセス キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	推論	自動検出をスキップします。
—	--folder-key	GUID	推論	自動検出をスキップします。

例

uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.Status'

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

{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}

終了コード

「終了コード」を参照してください。標準の検証エラーを超える動詞固有のオーバーライドはありません。

関連コマンド

• uip or packages — processes createを呼び出す前に、パッケージキー ( 、packages list)、 バージョン ( 、packages versions)、およびエントリポイント (packages entry-points) を検索します。
• uip or jobs — 特に jobs startはプロセス キーを受け取ります。
• uip or folders — バインドする前にターゲット フォルダーを作成または検索します。

参照

• グローバル オプション。
• セッション。