uip ah アプリケーション、コンポーネント、ドキュメント、メディア、ストア リスト、ストア レビュー

Automation Hub のアプリケーション リスト、再利用可能なコンポーネント、添付ファイルのドキュメント/メディア、および Automation Store マーケットプレース (公開済みのリストとレビュー) の構文とオプション。

アプリケーション インベントリは、オートメーションにタグ付けされる対象です (他の場所のフィルターで参照する--application-id)。コンポーネント は再利用可能な構成要素であり、任意で 1 つのオートメーションに制限できます。ドキュメントとメディアとは、オートメーションに添付されたファイル (PDD、スクリーンショット、デモ ビデオ) のことです。Automation Store は Automation Hub の内部マーケットプレイスです。ストア リストは公開済みの自動化であり、ストア レビューはそれらに残されたレビューです。すべての動詞に適用される共通の概念 (プロジェクション/--all-fields、ページ付きリストとページなしリスト) については、uip ahをご覧ください。

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 アプリケーションのリスト

オプション

長押し	値 (Value)	説明
--search <text>	string	フリーテキスト検索。
--category-id <id...>	繰り返し可能	これらのカテゴリのアプリケーションのみ
--limit <n> / --offset <n>	integer	ページング。既定 --limit 20です。
--all-fields	フラグ	未加工のペイロードを返します。

例

uip ah applications list

データシェイプ(--output 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 する必要があるためです。

オプション

長押し	値 (Value)	Required	説明
--file <json-file>	パス	○	更新するアプリケーションの JSON 配列です。各要素には application_id と categoryIds が必要です。 applications list --all-fieldsの形を取ります。

例

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

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

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

UIP AH アプリケーションの削除

引数

名前	Required	目的
<application-id>	○	アプリケーション ID

オプション

長押し	説明
-y, --yes	この元に戻せない操作を確認します。必須 — CLI はプロンプトを表示しません。

例

uip ah applications delete 7 --yes

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

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

UIP AH コンポーネント

テナント全体またはオートメーションごとの再利用可能なコンポーネントを読み取ります。読み取り専用です。このサーフェスには作成/更新/削除はありません。

UIP AH コンポーネントのリスト

オプション

長押し	値 (Value)	説明
--automation-id <id>	integer	このオートメーションにアタッチされたコンポーネントへのスコープです。このオートメーションは、他のフィルターを受け取らない独立したエンドポイントです。
--type <type>	string	この部品の種類のみ--automation-idと組み合わせることはできません。
--category-id <id...>	繰り返し可能	これらのカテゴリのみ。--automation-idと組み合わせることはできません。
--application-id <id...>	繰り返し可能	これらのアプリケーションを使用するコンポーネントのみ。--automation-idと組み合わせることはできません。
--limit <n> / --offset <n>	integer	ページング。既定 --limit 20です。
--all-fields	フラグ	未加工のペイロードを返します。

--type/--category-id/--application-id と --automation-id が組み合わさった場合、クライアント側では失敗します。オートメーションごとのリストは別のエンドポイントであり、フィルターは使用されません。

例

uip ah components list

uip ah components list --automation-id 20

データシェイプ(--output 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 ドキュメントのリスト

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	説明
--limit <n> / --offset <n>	ページング。既定 --limit 20です。
--all-fields	未加工のペイロードを返します。

例

uip ah documents list 20

データシェイプ(--output 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 でリンクします (ちょうど 2 つのうちの 1 つ)。

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--title <text>	string	○	ドキュメントのタイトル。
--description <text>	string	○	ドキュメントの説明。
--document-type-id <id>	integer	○	ドキュメントの種類 ID
--file <path>	パス	条件付き	アップロードするローカル ドキュメント ファイルです。必要なのは --file/--embed-link のうちの 1 つのみです。サーバー側の MIME タイプ許可リストがない — 認識されない拡張機能は application/octet-streamとしてアップロードされます。
--embed-link <url>	url	条件付き	すでにホストされているドキュメントへのリンク必要なのは --file/--embed-link のうちの 1 つのみです。
--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

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

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

--embed-linkでは、Data は FileId/Fileではなく EmbedLink を運びます。

UIP AHドキュメントのダウンロード

引数

名前	Required	目的
<file-id>	○	ファイル ID — documents list <automation-id>のFileIdです。

オプション

長押し	値 (Value)	Required	説明
--destination <path>	パス	○	ファイルの書き込み先のローカル パスです。

例

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

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

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

UIP AH メディア

メディア (スクリーンショット、ビデオ) をオートメーションに添付します。documents とは別です。専用のアップロード エンドポイントであり、リストや削除はありません。

UIP AH メディアの作成

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--file <path>	パス	○	アップロードするローカル メディア ファイル — jpg、 jpeg、 png、 gif、または mp4 のみ。その他の拡張機能はクライアント側で拒否されます。
--submitter <email>	メール アドレス	×	提出する Automation Hub ユーザーのメール アドレス。既定値は呼び出し元です。

例

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

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

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

uip ah ストア リスト

Automation Store に公開された自動化を読み取ります。読み取り専用です。

uip ah のストア リスト

オプション

長押し	値 (Value)	説明
--search <text>	string	フリーテキスト検索。
--category-id <id...>	繰り返し可能	これらのカテゴリのみ。
--application-id <id...>	繰り返し可能	これらのアプリケーションを使用しているコンポーネントのみ。
--business-unit <name>	string	この事業部門のみ。
--plain-text	フラグ	リッチ テキストのフィールドをプレーン テキストに変換する
--limit <n> / --offset <n>	integer	ページング。既定 --limit 20です。
--all-fields	フラグ	未加工のペイロードを返します。

例

uip ah store-listings list

データシェイプ(--output 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 ストア - レビュー一覧

引数

名前	Required	目的
<automation-id>	○	自動化 ID — ストアに公開されている必要があります。

オプション

長押し	説明
--limit <n> / --offset <n>	ページング。既定 --limit 20です。
--all-fields	未加工のペイロードを返します。

例

uip ah store-reviews list 20

データシェイプ(--output 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
• 自動化、アイデア フロー、ビジネス ケース、フェーズ、アンケート、パイプライン
• カテゴリ、タグ、共同作業者、ロール、ユーザー

参照

• ツール (プラグイン)
• グローバル オプション
• 終了コード