UIP 或流程

“uip 或流程”的语法和选项，用于管理包到 Orchestrator 中可运行流程的文件夹绑定。

uip or processes管理包到文件夹的可运行绑定，Orchestrator 内部将其称为“版本”。uip or jobs start所针对的是流程；包是基础.nupkg工件（请参阅uip or packages ）。

大纲

uip or processes <verb> [options]

动词

动词	用途
list	列出文件夹中的流程。
get	按密钥获取一个流程，包括参数架构和保留期。
create	将包作为新流程绑定到文件夹。
update-version	将一个或多个流程升级到最新（或特定）包版本。
edit	编辑流程设置（选定字段的 PATCH 语义）。
rollback	将流程回滚到之前的包版本。

uip 或进程列表

列出文件夹中的流程。需要--folder-path或--folder-key 。返回流程密钥 (GUID)、名称、版本和基本元数据。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
—	--folder-path	路径	—	路径中的目标文件夹。
—	--folder-key	GUID	—	密钥目标文件夹。
-n	--name	text	—	流程名称的包含匹配项。
—	--process-type	枚举	—	Process、 Agent 、 Flow 、 TestAutomationProcess 、 WebApp 、 Api 、 MCPServer 、 BusinessRules 、 CaseManagement 、 Function 。
—	--all-fields	标记	关闭	返回完整的 API 有效负载。
-l	--limit	数字	50	页面大小。
—	--offset	数字	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}'

数据形状（--输出 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 密钥获取一个流程。返回版本、入口点、输入/输出参数架构、流程类型和配置。无需文件夹上下文 — 密钥已跨文件夹解析。

参数

名称	必填	用途
<process-key>	是	流程密钥 (GUID)。使用processes list查找。

选项

短	长	值	默认	描述
-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'

数据形状（--输出 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以及三个必需的包选项。使用uip or packages list作为包密钥，对可用版本使用uip or packages versions 。

选项

必填

短	长	值	默认	描述
—	--name	text	—	文件夹中的流程名称。
—	--package-key	text	—	包密钥（ PackageId中的packages list ）。
—	--package-version	版本	—	包版本（例如1.0.0 ）。

身份和作用域

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
—	--folder-path	路径	—	路径中的目标文件夹。
—	--folder-key	GUID	—	密钥目标文件夹。

流程设置

短	长	值	默认	描述
—	--description	text	—	流程说明。
—	--entry-point	路径	—	入口点工作流路径（适用于多入口点包）。
—	--input-arguments	JSON	—	JSON 格式的默认输入参数。
—	--job-priority	枚举	—	Low、 Normal 、 High 、与--specific-priority互斥。
—	--specific-priority	1–100	—	数字优先级。与--job-priority互斥。
—	--robot-size	枚举	—	Cloud Robot 大小： Small 、 Standard 、 Medium 、 Large 。
—	--tags	CSV	—	以逗号分隔的标签名称。
—	--environment-variables	JSON	—	JSON 格式的环境变量（已验证）。
—	--auto-update / --no-auto-update	标记	—	启用/禁用自动更新到最新包版本。
—	--hidden-for-attended / --visible-for-attended	标记	—	对 Attended User 隐藏或显示。互斥。
—	--auto-create-triggers / --no-auto-create-triggers	标记	—	在部署时自动创建已连接的触发器。

保留

短	长	值	默认	描述
—	--retention-period	天 (1–180)	30	作业保留期。
—	--retention-action	枚举	Delete	Delete、 Archive或None 。
—	--retention-bucket	存储桶 ID	—	存储桶 ID。当--retention-action Archive时为必填项。
—	--stale-retention-period	天	—	过时的作业保留期。
—	--stale-retention-action	枚举	—	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'

数据形状（--输出 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 或流程更新版本

将一个或多个流程更新到最新的包版本，或使用--package-version更新特定版本。文件夹是可选项 — 如果未提供，则系统会从第一个流程密钥中推断出来。

• 一键 + 无--package-version → 更新到最新版本（单次 API 调用）。
• 一键 + --package-version → 更新到该版本（单次 API 调用）。
• 多个密钥 + 无--package-version → 批量更新到最新版本。
• 多个密钥 + --package-version → 已拒绝（验证错误）。

正在运行的作业不受影响；只有新作业会使用更新后的版本。

参数

名称	必填	用途
<process-keys...>	是	一个或多个流程密钥 (GUID)。

选项

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
—	--folder-path	路径	已推断	跳过自动检测并使用此文件夹。
—	--folder-key	GUID	已推断	跳过自动检测并使用此文件夹。
—	--package-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'

数据形状（--输出 json）

单键：

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

批量返回带有Code: "ProcessVersionsUpdated" ProcessKeys Version和从 API 回显的Result对象。

UIP 或 Processes 编辑

按密钥编辑流程设置。读取当前值，应用提供的 PATCH 字段，然后保存。仅更改提供的字段；保留 CLI 中省略的保留字段的当前状态。

参数

名称	必填	用途
<process-key>	是	流程密钥 (GUID)。

选项

与processes create相同的字段，但三个必填包选项和作用域标志除外。相互排除和验证规则与create相符（ --job-priority与--specific-priority 、 --hidden-for-attended与--visible-for-attended 、 Archive保留需要--retention-bucket ）。

短	长	值	默认	描述
-t	--tenant	name	会话默认值	覆盖租户。
-n	--name	text	—	新显示名称。
-d	--description	text	—	新说明。
—	--entry-point	路径	—	新的入口点路径。
—	--input-arguments	JSON	—	默认输入参数。
—	--job-priority	枚举	—	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	枚举	—	Delete、 Archive 、 None 、
—	--retention-bucket	存储桶 ID	—	当--retention-action Archive时为必填项。
—	--stale-retention-period	天	—	过时的作业保留期。
—	--stale-retention-action	枚举	—	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'

数据形状（--输出 json）

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

uip 或流程回滚

将流程回滚到之前的包版本。文件夹是可选项 — 如果未提供，则从流程密钥中推断出来。

参数

名称	必填	用途
<process-key>	是	流程密钥 (GUID)。

选项

短	长	值	默认	描述
-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'

数据形状（--输出 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 — 在绑定前创建或找到目标文件夹。

另请参阅

• 全局选项。
• 会话。