UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

UIP AH 自動化、アイデア フロー、ビジネス ケース、フェーズ、アンケート、パイプライン

Automation Hub のアイデアから納品までのライフサイクルの構文とオプション — 自動化のアイデアの提出と読み取り、段階遷移、費用便益分析、評価カタログ、および利益ランク付けパイプライン ビュー。

オートメーション (Automation Hub では、基になるレコードを「プロセス」と呼びます) は Automation Hub のコア レコードです。提出されたアイデアは、アイデア フローを介して構成可能なフェーズ (アイデア、評価、分析、ソリューション設計、開発、テスト、本稼働など) を通過します。各フェーズには 費用便益分析 (ビジネス ケース) があり、 評価 ( アンケート カタログからの一連の質問) は、提出物に必要な回答をキャプチャします。パイプライン ビューには、自動化に加えて、その実行数と利益の数値がランク付けされて表示されます。すべての動詞に適用される共通の概念 (プロジェクション/--all-fields、ページ付きリストとページなしリスト、ID 検出) については、uip ahをご覧ください。

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 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 オートメーションのリスト​

テナント上の自動化のアイデアのリストを表示します。

オプション​
長押し値 (Value)説明
--search <text>string[探索] 画面と同等のフリーテキスト検索。
--sort-by <field>string並べ替えの基準にするフィールド (例:process_updated_epochです。
--sort-order <direction>asc|desc並べ替え方向です。
--category-id <id...>繰り返し可能これらのカテゴリのオートメーションのみ。
--application-id <id...>繰り返し可能これらのアプリケーションを使用するオートメーションのみ。
--business-unit <name>stringこの事業部門内のオートメーションのみ。
--phase-id <id...>繰り返し可能これらのフェーズにあるオートメーションのみ
--status-id <id...>繰り返し可能これらのフェーズのステータスにあるオートメーションのみ。
--tags <tag...>繰り返し可能これらのタグを付けるオートメーションのみ
--owner-id <id>integerこのユーザー ID が所有するオートメーションのみ。
--submitter-id <id>integerこのユーザー ID によって送信された自動化のみ
--updated-by-id <id>integerこのユーザー ID によって最後に更新されたオートメーションのみ。
--submission-type <type>stringこの提出の種類のみ。
--start-date <date> / --end-date <date>YYYY-MM-DDこの日付以降/以前に作成されます。
--plain-textフラグリッチ テキストのフィールドをプレーン テキストに変換する
--high-level-assessmentフラグ概要評価データを含める
--advanced-informationフラグ詳細なカスタムの質問回答を含めます。
--limit <n> / --offset <n>integerページング。既定 --limit 20です。
--all-fieldsフラグ予測されたフィールドではなく生のペイロードを返します。
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
データシェイプ(--output 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 }
}
{
  "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 オートメーションの Get​

1 つの自動化のアイデアを ID で取得します。

引数​
名前Required目的
<automation-id>○オートメーション ID
オプション​
長押し説明
--plain-textリッチ テキストのフィールドをプレーン テキストに変換する
--all-fields未加工のペイロードを返します。
uip ah automations get 20 --plain-text
uip ah automations get 20 --plain-text
データシェイプ(--output json)​
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

UIP AH オートメーションのスキーマの取得​

評価スキーマを取得します — create/update 使用するドキュメントです。オートメーション ID を指定すると、そのオートメーションに入力されたフォームが返されます。指定しない場合、 --source-type空のテンプレートが返されます。

引数​
名前Required目的
[automation-id]×入力されたスキーマを読み取るための既存のオートメーション ID。空のテンプレートの場合は省略します。
オプション​
長押し値 (Value)説明
--source-type <type>COE|ED|CD|PM|TM空のテンプレート (オートメーション ID が指定されていない) の場合は必須です。
--idea-flow-id <id>integerアイデア フロー ID (カスタマイズされたフローの場合)。
--category-id <id>integerカテゴリ ID: アクティブな評価を選択します。
--destination <path>パス出力エンベロープではなくこのファイルにスキーマ JSON を書き込みます。

オートメーション ID または --source-type のいずれかが必要です。どちらも渡すと、クライアント側で要求の前に失敗しません。

uip ah automations schema get --source-type COE --destination ./idea.json
uip ah automations schema get --source-type COE --destination ./idea.json
データシェイプ(--output json)​
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.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経由でアイデア フローがカスタマイズされたテナントに必要です。

オプション​
長押し値 (Value)Required説明
--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>integer×--from-schema のターゲット アイデア フロー — テナントの--source-typeをカスタマイズされたフローに置き換えます。--from-schemaが必要です。--source-typeと競合します。

--from-schemaのない--idea-flow-idはクライアント側で失敗します (固定形状のエンドポイントにはアイデア フローの概念がありません)。JSON にすでに user_inputs キーが含まれている--fileは、自動的にラップが解除されます。回答マップにすぎないファイルはそのまま使用されます。

uip ah automations create --source-type ED --file ./idea.json
uip ah automations create --source-type ED --file ./idea.json
データシェイプ(--output json)​
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

UIP AH オートメーションの更新​

オートメーションの評価の回答をファイルから更新する — automations schema get <automation-id> 書き出すのと同じドキュメント。

引数​
名前Required目的
<automation-id>○オートメーション ID
オプション​
長押し値 (Value)Required説明
--file <json-file>パス○適用する回答 user_inputs を含む JSON
uip ah automations update 20 --file ./20.json
uip ah automations update 20 --file ./20.json
データシェイプ(--output json)​
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

UIP AH のアイデア フロー​

設定されているアイデア フローと、フローで許可されるフェーズとステータスのペアを確認します。

UIP AH のアイデア フロー リスト​

オプション​
長押し説明
--limit <n> / --offset <n>ページング、クライアント側 (ページなしエンドポイント) で適用されます。
--all-fields未加工のペイロードを返します。
uip ah idea-flows list
uip ah idea-flows list
データシェイプ(--output json)​
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}

Phases では、生の応答の 1 列のフェーズごとに 1 列の形状 (IDEA、 ASSESSMENT、 QUALIFICATION、 ANALYSIS、 SOLUTION_DESIGN、 DEVELOPMENT、 TESTING、 TECHNICAL_REVIEW、 LIVE) を 1 つのオブジェクトにまとめます。フローが実際に使用するフェーズのみを含めます。

uip ah business-cases​

オートメーションの費用便益分析 (Automation Hub 独自の用語は CBA) を読み、プロジェクト計画のベースラインを設定します。

uip ah business-cases get​

引数​
名前Required目的
<automation-id>○オートメーション ID
オプション​
長押し説明
--all-fields未加工のペイロードを返します。
uip ah business-cases get 20
uip ah business-cases get 20
データシェイプ(--output json)​
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }

uip ah business-cases set-baseline​

フェーズの日付が含まれるファイルから、自動化のプロジェクト計画のベースラインをフリーズします。反転 BaselineIsSet を 1に切り替えます。

引数​
名前Required目的
<automation-id>○オートメーション ID
オプション​
長押し値 (Value)Required説明
--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
uip ah business-cases set-baseline 20 --file ./baseline.json
データシェイプ(--output json)​
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

UIP AH フェーズ​

パイプラインを通じてオートメーションを移動する。

UIP AH フェーズ設定​

引数​
名前Required目的
<automation-id>○オートメーション ID
オプション​
長押し値 (Value)説明
--phase <variable>stringターゲット フェーズ変数 (例:TECHNICAL_REVIEWです。従来の形式よりも優先されます。とペア--status
--status <variable>string対象のステータス変数 (例:AWAITING_REVIEWです。--phaseとともに必要です。
--phase-status-id <id>integerレガシ数値のフェーズ ステータス ID — --phase/--statusの代替手段であり、これらと組み合わせることはできません。
--submitter-id <id>integer提出者のユーザー ID。が --phase-status-idでのみ適用されます。 --phase/--statusで却下されました。

必要なスタイルは 1 つだけです。--statusで--phaseするか、--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 TECHNICAL_REVIEW --status AWAITING_REVIEW
uip ah phases set 20 --phase-status-id 118
uip ah phases set 20 --phase-status-id 118
データシェイプ(--output json)​
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

--phase-status-idでは、Data は Phase/Statusではなく PhaseStatusId を運びます。

UIP AH アンケート​

評価の質問カタログをお読みください。

UIP AH アンケート一覧​

オプション​
長押し値 (Value)Required説明
--assessment <name>high-level|detailed|citizen-development○読み取る評価。
--section <key>string×このセクションのみ (例:q1-overviewです。
--active-only / --no-active-onlyフラグ×アクティブな質問のみ (サーバーのデフォルト) / 非アクティブな質問も含まれます。
--mandatory-onlyフラグ×必須の質問のみ。
--limit <n> / --offset <n>integer×ページング、クライアント側 (ページなしエンドポイント) で適用されます。
--all-fieldsフラグ×未加工のペイロードを返します。
uip ah questionnaires list --assessment high-level
uip ah questionnaires list --assessment high-level
データシェイプ(--output json)​
{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}
{
  "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 パイプラインのリスト​

オプション​
長押し値 (Value)説明
--search <text>stringフリーテキスト検索。
--sort-by <field>string並べ替えの基準にするフィールドです。
--sort-order <direction>asc|desc並べ替え方向です。
--category-id <id...>繰り返し可能これらのカテゴリのみ。
--application-id <id...>繰り返し可能これらのアプリケーションを使用するオートメーションのみ。
--business-unit <name> / --department <name>stringスコープ フィルター
--phase-id <id...> / --status-id <id...>繰り返し可能これらのフェーズ/フェーズ ステータスのみ。
--tags <tag...>繰り返し可能これらのタグを付けるオートメーションのみ
--priority <priority...>繰り返し可能これらの優先順位のみ。
--submission-type <type>stringこの提出の種類のみ。
--plain-textフラグリッチ テキストのフィールドをプレーン テキストに変換する
--limit <n> / --offset <n>integerページング。既定 --limit 20です。
--all-fieldsフラグ未加工のペイロードを返します。
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
データシェイプ(--output 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 }
}
{
  "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 }
}

参照​

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得