uip ah 应用程序、组件、文档、媒体、商店列表、商店评论

Automation Hub 应用程序清单、可重用组件、附加文档/媒体和 Automation Store 市场（已发布的列表和评论）的语法和选项。

应用程序清单是标记自动化的对象（其他地方的--application-id筛选器会引用它）。组件是可重用的构建块，可以选择将其范围限定在一个自动化范围内。文档和媒体文件是附加到自动化的文件 - PDD、屏幕截图、演示视频。The Automation Store is Automation Hub 的内部市场：商店列表是已发布的自动化，商店评论是用户对其留下的评论。请参阅uip ah ，了解适用于每个动词的共同概念（投影/ --all-fields 、分页与不分页列表）。

uip ah 应用程序

管理自动化所标记的应用程序清单。

大纲

uip ah applications list [--search <text>] [--category-id <id...>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah applications update --file <json-file>
uip ah applications delete <application-id> [-y, --yes]

uip ah 应用程序列表

选项

长	值	描述
--search <text>	字符串	自由文本搜索。
--category-id <id...>	可重复	仅限这些类别中的应用程序。
--limit <n> / --offset <n>	整数	分页。默认 --limit 20。
--all-fields	标记	返回原始有效负载。

示例

uip ah applications list

数据形状（--输出 json）

{
  "Code": "AhApplicationsList",
  "Data": [
    { "Id": 1, "Name": "SAP", "Version": "S/4HANA", "Language": null, "Code": "SAP", "IsActive": 1, "AddedByEndUser": 0, "CategoryIds": [4], "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

uip ah 应用程序更新

从文件更新清单中的现有应用程序。这将编辑已存在的条目 — 它无法添加条目，因为该服务要求每个元素都有 application_id。

选项

长	值	必填	描述
--file <json-file>	路径	是	要更新的应用程序的 JSON 数组。每个元素都需要 application_id 和 categoryIds — 采用 applications list --all-fields 中的形状。

示例

uip ah applications update --file ./applications.json

数据形状（--输出 json）

{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }

uip ah 应用程序删除

参数

名称	必填	用途
<application-id>	是	应用程序 ID。

选项

长	描述
-y, --yes	确认此不可逆操作。必需 — CLI 从不提示。

示例

uip ah applications delete 7 --yes

数据形状（--输出 json）

{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }

uip ah 组件

读取租户范围内或每个自动化的可重用组件。只读 — 无法在此表面上创建/更新/删除。

uip ah 组件列表

选项

长	值	描述
--automation-id <id>	整数	附加到此自动化的组件的作用域 — 不使用其他筛选条件的单独端点。
--type <type>	字符串	仅限此组件类型。无法与 --automation-id 结合使用。
--category-id <id...>	可重复	仅限以下类别。无法与 --automation-id 结合使用。
--application-id <id...>	可重复	仅限使用这些应用程序的组件。无法与 --automation-id 结合使用。
--limit <n> / --offset <n>	整数	分页。默认 --limit 20。
--all-fields	标记	返回原始有效负载。

--type/--category-id/--application-id 与 --automation-id 结合使用会在客户端失败 — 每个自动化列表是一个不同的端点，不接受筛选器。

示例

uip ah components list

uip ah components list --automation-id 20

数据形状（--输出 json）

{
  "Code": "AhComponentsList",
  "Data": [
    { "Id": 3, "Name": "Invoice parser", "Slug": "invoice-parser", "Description": "...", "TypeId": 1, "ReviewCount": 4, "ReviewAverage": 4.5, "DownloadCount": 12, "StatusId": 1, "PhaseId": 3, "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

uip ah 文档

管理附加到自动化的文档。

uip ah 文档列表

参数

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

选项

长	描述
--limit <n> / --offset <n>	分页。默认 --limit 20。
--all-fields	返回原始有效负载。

示例

uip ah documents list 20

数据形状（--输出 json）

{
  "Code": "AhDocumentsList",
  "Data": [
    { "Id": 11, "AutomationId": 20, "Title": "PDD", "Description": "...", "TypeId": 1, "FileId": 42, "FileType": "docx", "EmbedLink": null, "IsActive": 1, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

FileId 是 documents download 采用的内容。

uip ah 文档创建

将文档附加到自动化 — 使用 --file 上传文件的字节，或使用 --embed-link 链接到该文件（前往两者之一）。

参数

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

选项

长	值	必填	描述
--title <text>	字符串	是	文档标题。
--description <text>	字符串	是	文档说明。
--document-type-id <id>	整数	是	文档类型 ID。
--file <path>	路径	有条件地	要上传的本地文档文件。--file/--embed-link 中的一个为必填项。无服务器端 MIME 类型允许列表 — 无法识别的扩展程序上传为 application/octet-stream。
--embed-link <url>	url	有条件地	链接到已托管的文档。--file/--embed-link 中的一个为必填项。
--submitter <email>	电子邮件	否	提交 Automation Hub 用户的电子邮件。默认为调用者。

示例

uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --file ./pdd.docx

uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --embed-link https://acme.sharepoint.com/pdd.docx

数据形状（--输出 json）

{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }

使用 --embed-link 时，Data 包含 EmbedLink，而不是 FileId/File。

uip ah 文档下载

参数

名称	必填	用途
<file-id>	是	文件 ID — FileId 中的 documents list <automation-id>。

选项

长	值	必填	描述
--destination <path>	路径	是	要写入文件的本地路径。

示例

uip ah documents download 42 --destination ./pdd.pdf

数据形状（--输出 json）

{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }

UIP ah 媒体文件

为自动化添加媒体文件（屏幕截图、视频）。独立于 documents — 有自己的上传端点，并且没有列出或删除。

uip ah 媒体文件创建

参数

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

选项

长	值	必填	描述
--file <path>	路径	是	要上传的本地媒体文件 — 仅限 jpg、jpeg、png、gif 或 mp4；任何其他扩展程序都会被客户端拒绝。
--submitter <email>	电子邮件	否	提交 Automation Hub 用户的电子邮件。默认为调用者。

示例

uip ah media create 20 --file ./screen.png

数据形状（--输出 json）

{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }

uip ah 存储列表

阅读发布到自动化商店的自动化。只读。

uip ah 存储列表列表

选项

长	值	描述
--search <text>	字符串	自由文本搜索。
--category-id <id...>	可重复	仅限以下类别。
--application-id <id...>	可重复	仅限使用这些应用程序的列表。
--business-unit <name>	字符串	仅限此业务单元。
--plain-text	标记	将富文本字段转换为纯文本。
--limit <n> / --offset <n>	整数	分页。默认 --limit 20。
--all-fields	标记	返回原始有效负载。

示例

uip ah store-listings list

数据形状（--输出 json）

{
  "Code": "AhStoreListingsList",
  "Data": [
    { "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "ReviewCount": 4, "ReviewScore": 4.2, "DownloadCount": 4, "VoteCount": 9, "IsPublished": 1, "BusinessUnit": "EMEA", "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

uip ah 存储评论

阅读 Automation Store 有关自动化的评论。其自己的资源组，而不是 store-listings 下的动词。只读。

uip ah 存储评论列表

参数

名称	必填	用途
<automation-id>	是	自动化 ID — 必须发布到商店。

选项

长	描述
--limit <n> / --offset <n>	分页。默认 --limit 20。
--all-fields	返回原始有效负载。

示例

uip ah store-reviews list 20

数据形状（--输出 json）

{
  "Code": "AhStoreReviewsList",
  "Data": [
    { "Id": 5, "AutomationId": 20, "Score": 5, "Title": "Great automation", "Description": "...", "UserId": 3, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

相关内容

• uip ah — 概述、概念、 audit-logs 、 auth-info 。
• 自动化、概念流程、业务用例、阶段、问卷调查、管道
• 类别、标签、协作者、角色、用户

另请参阅

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