uip ah 自动化、概念流、业务用例、阶段、问卷调查、管道

Automation Hub 概念到交付生命周期的语法和选项 — 提交和读取自动化概念、阶段转换、成本收益分析、评估目录以及收益排名管道视图。

An automation (Automation Hub calls the underlying record a "process") is the core record in Automation Hub — a submitted idea that moves through configurable phases (Idea, Assessment, Analysis, Solution Design, Development, Testing, Live, …) via an idea flow. 每个阶段都有成本收益分析（业务用例）和评估（问卷目录中的一组问题），以捕获为提交内容提供的答案。管道视图显示了自动化及其执行数字和收益，并对其进行了排名。请参阅uip ah了解适用于每个动词的共同概念（投影/ --all-fields 、分页与不分页列表、ID 发现）。

uip ah 自动化

使用自动化概念 — 核心 Automation Hub 记录。

大纲

uip ah automations list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--category-id <id...>] [--application-id <id...>] [--business-unit <name>] [--phase-id <id...>] [--status-id <id...>] [--tags <tag...>] [--owner-id <id>] [--submitter-id <id>] [--updated-by-id <id>] [--submission-type <type>] [--start-date <date>] [--end-date <date>] [--plain-text] [--high-level-assessment] [--advanced-information] [--limit <n>] [--offset <n>] [--all-fields]
uip ah automations get <automation-id> [--plain-text] [--all-fields]
uip ah automations schema get [automation-id] [--source-type <type>] [--idea-flow-id <id>] [--category-id <id>] [--destination <path>]
uip ah automations create --source-type <type> --file <json-file> [--from-schema] [--idea-flow-id <id>]
uip ah automations update <automation-id> --file <json-file>

uip ah 自动化列表

列出租户的自动化概念。

选项

长	值	描述
--search <text>	字符串	自由文本搜索，例如在“探索”屏幕中。
--sort-by <field>	字符串	要排序的字段，例如process_updated_epoch。
--sort-order <direction>	asc|desc	排序方向
--category-id <id...>	可重复	仅显示这些类别中的自动化。
--application-id <id...>	可重复	仅适用于使用这些应用程序的自动化。
--business-unit <name>	字符串	仅此业务单元中的自动化。
--phase-id <id...>	可重复	仅这些阶段中的自动化。
--status-id <id...>	可重复	仅处于这些阶段状态的自动化。
--tags <tag...>	可重复	仅带有这些标签的自动化。
--owner-id <id>	整数	仅限此用户 ID 拥有的自动化。
--submitter-id <id>	整数	仅此用户 ID 提交的自动化。
--updated-by-id <id>	整数	仅此用户 ID 最后更新的自动化。
--submission-type <type>	字符串	仅限此提交类型。
--start-date <date> / --end-date <date>	YYYY-MM-DD	在此日期或之后/之前创建。
--plain-text	标记	将富文本字段转换为纯文本。
--high-level-assessment	标记	包含高级评估数据。
--advanced-information	标记	包括详细问题和自定义问题的答案。
--limit <n> / --offset <n>	整数	分页。默认 --limit 20。
--all-fields	标记	返回原始有效负载，而不是投影字段。

示例

uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc

数据形状（--输出 json）

{
  "Code": "AhAutomationsList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "Phase": "Analysis",
      "PhaseStatus": "In Progress", "SubmissionType": "ED", "BusinessUnit": "EMEA",
      "Department": "Finance", "AutomationScore": 78, "Priority": 1, "IsPublished": 0,
      "CreatedEpoch": 1735689600000, "UpdatedEpoch": 1738368000000,
      "PhaseKey": "ANALYSIS", "Tags": ["finance"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

Tags 从真实记录的 process_tags 数组（或其 __display 对应数组）派生为纯字符串数组。PhaseKey 是 uip ah phases set --phase 取的值。

uip ah 自动化获取

按 ID 获取一个自动化概念。

参数

名称	必填	用途
<automation-id>	是	自动化 ID。

选项

长	描述
--plain-text	将富文本字段转换为纯文本。
--all-fields	返回原始有效负载。

示例

uip ah automations get 20 --plain-text

数据形状（--输出 json）

{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

uip ah 自动化架构获取

获取评估架构 — 消耗的文档 create/update。使用自动化 ID，它会返回该自动化的已填写表单；如果没有，它会为 --source-type 返回一个空白模板。

参数

名称	必填	用途
[automation-id]	否	现有自动化 ID，以读取其填充架构。若为空白模板，请省略。

选项

长	值	描述
--source-type <type>	COE|ED|CD|PM|TM	空白模板为必填项（未提供自动化 ID）。
--idea-flow-id <id>	整数	概念流 ID，适用于自定义流程。
--category-id <id>	整数	类别 ID，以选择活动评估。
--destination <path>	路径	将架构 JSON 写入此文件，而非输出信封。

自动化 ID 或 --source-type 为必填项——在发出任何请求之前，两者都不传递会导致客户端失败。

示例

uip ah automations schema get --source-type COE --destination ./idea.json

数据形状（--输出 json）

{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }

当省略 --destination 时，Data.Schema 会而不是 Destination 携带架构文档。

uip ah 自动化创建

提交新的自动化概念。--source-type选取固定形状的提交表单（ED →/automationidea 、COE →/coe-automationidea 、PM →/processmining-idea ）； 改为通过--from-schema 提交已填充的schema get 文档/idea-from-schema — 对于CD /TM 来源类型以及任何通过--idea-flow-id 具有自定义概念流程的租户而言是必要项。

选项

长	值	必填	描述
--source-type <type>	COE|ED|CD|PM|TM	有条件地	除非提供了 --idea-flow-id，否则为必填项。
--file <json-file>	路径	是	请求正文 — 固定形状的 JSON，或使用 user_inputs 填充的 --from-schema 文档。
--from-schema	标记	否	使用 automations schema get 中的文档通过架构端点提交。
--idea-flow-id <id>	整数	否	--from-schema 的目标概念流程 — 将租户的 --source-type 替换为自定义流程。需要 --from-schema。与 --source-type 冲突。

没有 --idea-flow-id 的 --from-schema 会在客户端出现故障（固定形状端点没有概念流的概念）。其 JSON 已包含 --file 键的 user_inputs 将自动解包；按原样使用只有答案映射的文件。

示例

uip ah automations create --source-type ED --file ./idea.json

数据形状（--输出 json）

{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

uip ah 自动化更新

从文件更新自动化的评估答案 — 同一文档automations schema get <automation-id>写入。

参数

名称	必填	用途
<automation-id>	是	自动化 ID。

选项

长	值	必填	描述
--file <json-file>	路径	是	带有要应用的 user_inputs 答案的 JSON。

示例

uip ah automations update 20 --file ./20.json

数据形状（--输出 json）

{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

uip ah 概念流

探索已配置的概念流程及其允许的阶段/状态对。

UIP ah 概念流程列表

选项

长	描述
--limit <n> / --offset <n>	分页，客户端应用（未分页端点）。
--all-fields	返回原始有效负载。

示例

uip ah idea-flows list

数据形状（--输出 json）

{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}

Phases折叠原始响应的每阶段一个列的形状（IDEA 、ASSESSMENT 、QUALIFICATION 、ANALYSIS 、SOLUTION_DESIGN 、DEVELOPMENT 、TESTING 、TECHNICAL_REVIEW 、LIVE ）转换为单个对象，仅包括流实际使用的阶段。

uip ah 业务案例

读取自动化的成本收益分析（Automation Hub 自己的术语为 CBA），并设置其项目计划基线。

uip ah 业务用例 Get

参数

名称	必填	用途
<automation-id>	是	自动化 ID。

选项

长	描述
--all-fields	返回原始有效负载。

示例

uip ah business-cases get 20

数据形状（--输出 json）

{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }

uip ah 业务用例设置基线

从阶段日期文件中冻结自动化的项目计划基线。将 BaselineIsSet 反转为 1。

参数

名称	必填	用途
<automation-id>	是	自动化 ID。

选项

长	值	必填	描述
--file <json-file>	路径	是	{ "phases": [{ "phase": "Analysis", "start_date": "09/01/2026", "end_date": "09/15/2026" }] }。阶段名称来自business-cases get的“基线”部分（分析、解决方案设计、开发、测试、发布日期）；日期为 MM/DD/YYYY；除“启动日期”以外的每个阶段都需要 end_date。

裸阶段数组在 { "phases": [...] } 中自动换行；在发送请求之前，任何其他不是 { "phases": [...] } 的内容都将被拒绝。

示例

uip ah business-cases set-baseline 20 --file ./baseline.json

数据形状（--输出 json）

{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

uip ah 阶段

在管道中移动自动化。

uip ah 阶段设置

参数

名称	必填	用途
<automation-id>	是	自动化 ID。

选项

长	值	描述
--phase <variable>	字符串	目标阶段变量，例如TECHNICAL_REVIEW。优于旧版表单；与 --status 配对。
--status <variable>	字符串	目标状态变量，例如AWAITING_REVIEW。需要与 --phase 一起使用。
--phase-status-id <id>	整数	旧版数字阶段状态 ID — --phase/--status 的替代方案，不能与它们结合使用。
--submitter-id <id>	整数	提交者用户 ID。仅适用于 --phase-status-id；拒绝结果为 --phase/--status。

仅需提供一种样式：--phase 与 --status 或单独的 --phase-status-id。查找使用 uip ah idea-flows list 的有效阶段/状态对。

示例

uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW

uip ah phases set 20 --phase-status-id 118

数据形状（--输出 json）

{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

使用 --phase-status-id 时，Data 包含 PhaseStatusId，而不是 Phase/Status。

uip ah 问卷调查

阅读评估问题目录。

uip ah 问卷调查列表

选项

长	值	必填	描述
--assessment <name>	high-level|detailed|citizen-development	是	要读取的评估。
--section <key>	字符串	否	仅此部分，例如q1-overview。
--active-only / --no-active-only	标记	否	仅活跃问题（服务器默认设置）/也包括非活跃问题。
--mandatory-only	标记	否	仅必答问题。
--limit <n> / --offset <n>	整数	否	分页，客户端应用（未分页端点）。
--all-fields	标记	否	返回原始有效负载。

示例

uip ah questionnaires list --assessment high-level

数据形状（--输出 json）

{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}

UIP ah 管道

阅读“自动化管道 — 自动化”及其阶段数据和收益数据。与 automations list 分开：端点添加每阶段收益列，并在内部拼写其排序方向 order（相同的 --sort-order 标志）。

uip ah 管道列表

选项

长	值	描述
--search <text>	字符串	自由文本搜索。
--sort-by <field>	字符串	要排序的字段。
--sort-order <direction>	asc|desc	排序方向
--category-id <id...>	可重复	仅限以下类别。
--application-id <id...>	可重复	仅适用于使用这些应用程序的自动化。
--business-unit <name> / --department <name>	字符串	作用域筛选器。
--phase-id <id...> / --status-id <id...>	可重复	仅限这些阶段/阶段状态。
--tags <tag...>	可重复	仅带有这些标签的自动化。
--priority <priority...>	可重复	仅此优先级。
--submission-type <type>	字符串	仅限此提交类型。
--plain-text	标记	将富文本字段转换为纯文本。
--limit <n> / --offset <n>	整数	分页。默认 --limit 20。
--all-fields	标记	返回原始有效负载。

示例

uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10

数据形状（--输出 json）

{
  "Code": "AhPipelinesList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Phase": "Analysis", "PhaseStatus": "In Progress",
      "PhaseOrder": 3, "Priority": 1, "AutomationScore": 78, "EstimatedBenefitFtes": 1.5,
      "EstimatedBenefitPerYear": 42000, "EaseOfImplementation": "Medium",
      "BusinessUnit": "EMEA", "Department": "Finance", "UpdatedEpoch": 1738368000000
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

相关内容

• uip ah — 概述、概念、 audit-logs 、 auth-info 。
• 应用程序、组件、文档、媒体、商店列表、商店评论
• 类别、标签、协作者、角色、用户

另请参阅

• 工具（插件）
• 全局选项
• 退出代码