UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UIP-AH-Automatisierungen, Ideenflows, Geschäftsfälle, Phasen, Fragebögen, Pipelines

Syntax und Optionen für den Lebenszyklus der Automation Hub-Idee bis zur Bereitstellung – Einreichen und Lesen von Automatisierungsideen, Phasenübergängen, Kosten-Nutzen-Analysen, Bewertungskatalog und Pipelineansicht nach Nutzen.

Eine Automatisierung (Automation Hub ruft den zugrunde liegenden Datensatz als „Prozess“) auf, ist der Kerndatensatz in Automation Hub – eine eingereichte Idee, die über ein konfigurierbares Phasenschema (Idee, Bewertung, Analyse, Lösungsentwurf, Entwicklung, Tests, Live, …) durchlaufen wird Ideenflow. Jede Phase hat eine Kosten-Nutzen-Analyse (Geschäftsfall) und eine Bewertung (eine Reihe von Fragen aus dem Fragebogenkatalog ) erfasst die Antworten, die eine Einreichung unterstützen. Die Pipelineansicht zeigt Automatisierungen zuzüglich ihrer Ausführungs- und Nutzenzahlen, bewertet. Freigegebene Konzepte (Projektion/--all-fields, seiten- vs. nicht-seitige Listen, ID-Erkennung) finden Sie unter uip ah die hier für jedes Verb gelten.

UIP-AH-Automatisierungen​

Arbeiten mit Automatisierungsideen – der Kerndatensatz des Automation Hub.

Zusammenfassung​

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-Automatisierungenliste​

Listen Sie Automatisierungsideen für den Mandanten auf.

Optionen​
LongWertBeschreibung
--search <text>stringFreitextsuche, wie auf dem Bildschirm Erkunden.
--sort-by <field>stringFeld, nach dem sortiert werden soll, z. B process_updated_epoch).
--sort-order <direction>asc|descSortierrichtung.
--category-id <id...>wiederholbarNur Automatisierungen in diesen Kategorien.
--application-id <id...>wiederholbarNur Automatisierungen, die diese Anwendungen verwenden.
--business-unit <name>stringNur Automatisierungen in dieser Geschäftseinheit.
--phase-id <id...>wiederholbarNur Automatisierungen in diesen Phasen.
--status-id <id...>wiederholbarNur Automatisierungen in diesen Phasenstatus.
--tags <tag...>wiederholbarNur Automatisierungen, die diese Tags tragen.
--owner-id <id>IntegerNur Automatisierungen, die dieser Benutzer-ID gehören.
--submitter-id <id>IntegerNur Automatisierungen, die von dieser Benutzer-ID eingereicht wurden.
--updated-by-id <id>IntegerNur von dieser Benutzer-ID zuletzt aktualisierte Automatisierungen.
--submission-type <type>stringNur dieser Übermittlungstyp.
--start-date <date> / --end-date <date>YYYY-MM-DDErstellt am oder nach/vor diesem Datum.
--plain-textMarkierenKonvertieren Sie Rich-Text-Felder in Nur-Text.
--high-level-assessmentMarkierenDaten für einfache Bewertung einschließen.
--advanced-informationMarkierenFügen Sie detaillierte und benutzerdefinierte Antworten auf Fragen ein.
--limit <n> / --offset <n>IntegerPaginieren. Der Standardwert ist --limit 20.
--all-fieldsMarkierenGeben Sie die unformatierte Nutzlast anstelle der prognostizierten Felder zurück.
Beispiel​
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
Datenform (--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 wird aus dem process_tags -Array des echten Datensatzes (oder seinem __display -Z Dataset) in ein einfaches String-Array abgeleitet. PhaseKey ist der Wert, den uip ah phases set --phase annimmt.

UIP-AH-Automatisierungen abrufen​

Rufen Sie eine Automatisierungsidee nach ID ab.

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongBeschreibung
--plain-textKonvertieren Sie Rich-Text-Felder in Nur-Text.
--all-fieldsGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah automations get 20 --plain-text
uip ah automations get 20 --plain-text
Datenform (--output json)​
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

Abrufen des UIP-AH-Automatisierungsschemas​

Rufen Sie ein Bewertungsschema ab – das Dokument create/update verbrauchen. Mit einer Automatisierungs-ID wird das ausgefüllte Formular dieser Automatisierung zurückgegeben; Ohne eine wird eine leere Vorlage für --source-type zurückgegeben.

Argumente​
NameErforderlichZweck
[automation-id]neinVorhandene Automatisierungs-ID, um das ausgefüllte Schema zu lesen. Für eine leere Vorlage auslassen.
Optionen​
LongWertBeschreibung
--source-type <type>COE|ED|CD|PM|TMErforderlich für eine leere Vorlage (keine Automatisierungs-ID angegeben).
--idea-flow-id <id>IntegerIdeenflow-ID für einen benutzerdefinierten Flow.
--category-id <id>IntegerKategorie-ID, um die aktive Bewertung auszuwählen.
--destination <path>PfadSchreiben Sie die Schema-JSON in diese Datei anstelle des Ausgabeumschlags.

Entweder eine Automatisierungs-ID oder --source-type ist erforderlich – das Übergeben von beiden schlägt auf Clientseite vor einer Anforderung fehl.

Beispiel​
uip ah automations schema get --source-type COE --destination ./idea.json
uip ah automations schema get --source-type COE --destination ./idea.json
Datenform (--output json)​
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }

Wenn --destination weggelassen wird, überträgt Data.Schema das Schemadokument inline anstelle von Destination.

UIP-AH-Automatisierungen erstellen​

Eine neue Automatisierungsidee einreichen. --source-type wählt das Einreichungsformular mit fester Form aus (ED→/automationidea, COE→/coe-automationidea, PM→/processmining-idea); --from-schema übermittelt ein ausgefülltes schema get -Dokument stattdessen über /idea-from-schema – erforderlich für CD/TM -Quelltypen und für jeden Mandanten mit benutzerdefinierten Ideenflows über --idea-flow-id.

Optionen​
LongWertErforderlichBeschreibung
--source-type <type>COE|ED|CD|PM|TMbedingtErforderlich, es sei denn, stattdessen wird --idea-flow-id angegeben.
--file <json-file>PfadjaAnforderungstext – die JSON mit fester Form oder das ausgefüllte user_inputs -Dokument mit --from-schema.
--from-schemaMarkierenneinÜbermitteln Sie den Schemaendpunkt mit dem Dokument von automations schema get.
--idea-flow-id <id>IntegerneinZielideenflow für --from-schema – ersetzt --source-type für Mandanten mit benutzerdefinierten Flows. Erfordert --from-schema. Konflikte mit --source-type.

--idea-flow-id ohne --from-schema schlägt clientseitig fehl (die Endpunkte mit fester Form haben keine Vorstellung von einem Ideenflow). Für einen --file, dessen JSON bereits einen user_inputs -Schlüssel enthält, wird dieser automatisch entpackt; Eine Datei, die nur die Antwortübersicht ist, wird so verwendet, wie sie ist.

Beispiel​
uip ah automations create --source-type ED --file ./idea.json
uip ah automations create --source-type ED --file ./idea.json
Datenform (--output json)​
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

Aktualisierung von UIP-AH-Automatisierungen​

Aktualisieren Sie die Bewertungsantworten einer Automatisierung aus einer Datei – das gleiche Dokument wird von automations schema get <automation-id> ausgeschrieben.

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongWertErforderlichBeschreibung
--file <json-file>PfadjaJSON mit den user_inputs anzuwendenden Antworten.
Beispiel​
uip ah automations update 20 --file ./20.json
uip ah automations update 20 --file ./20.json
Datenform (--output json)​
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

UIP-AH-Ideenflows​

Entdecken Sie die konfigurierten Ideenflows und die Phasen-/Statuspaare, die sie zulassen.

uip-ah-Ideenflow-Liste​

Optionen​
LongBeschreibung
--limit <n> / --offset <n>Paginierung, clientseitig angewendet (Endpunkt ohne Seite).
--all-fieldsGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah idea-flows list
uip ah idea-flows list
Datenform (--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 reduziert die Form der unformatierten Antwort – eine Spalte pro Phase (IDEA, ASSESSMENT, QUALIFICATION, ANALYSIS, SOLUTION_DESIGN, DEVELOPMENT, TESTING, TECHNICAL_REVIEW, LIVE). }) in ein einzelnes Objekt, wobei nur die Phasen, die der Flow tatsächlich verwendet, enthalten sind.

uip-ah-Geschäftsfälle​

Lesen Sie die Kosten-Nutzen-Analyse einer Automatisierung (der eigene Begriff von Automation Hub ist CBA) und legen Sie die Basis für den Projektplan fest.

UIP-AH-Geschäftsfälle erhalten​

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongBeschreibung
--all-fieldsGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah business-cases get 20
uip ah business-cases get 20
Datenform (--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-Geschäftsfälle Set-Baseline​

Sichern Sie die Projektplan-Basislinie für eine Automatisierung aus einer Datei mit Phasendaten. Schaltet BaselineIsSet zu 1 um.

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongWertErforderlichBeschreibung
--file <json-file>Pfadja{ "phases": [{ "phase": "Analysis", "start_date": "09/01/2026", "end_date": "09/15/2026" }] }. Phasennamen stammen aus dem Abschnitt „Basis“ von business-cases get (Analyse, Lösungsentwurf, Entwicklung, Tests, Startdatum); Datumsangaben sind MM/DD/YYYY; Jede Phase mit Ausnahme des Startdatums benötigt ein end_date.

Ein Bare-Phasen-Array wird automatisch in { "phases": [...] } gepackt; Alles andere, was nicht bereits { "phases": [...] } ist, wird clientseitig abgelehnt, bevor die Anforderung gesendet wird.

Beispiel​
uip ah business-cases set-baseline 20 --file ./baseline.json
uip ah business-cases set-baseline 20 --file ./baseline.json
Datenform (--output json)​
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

UIP-AH-Phasen​

Verschieben einer Automatisierung durch die Pipeline.

UIP-AH-Phasen festgelegt​

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongWertBeschreibung
--phase <variable>stringZielphasenvariable, z. B. TECHNICAL_REVIEW). Bevorzugt gegenüber dem Legacy-Formular; koppeln Sie es mit --status.
--status <variable>stringZielstatusvariable, z. B. AWAITING_REVIEW). Erforderlich zusammen mit --phase.
--phase-status-id <id>IntegerNumerische Phasenstatus-ID der Legacy-Version – Alternative zu --phase/--status, nicht mit ihnen kombinierbar.
--submitter-id <id>IntegerBenutzer-ID des Einreichers. Gilt nur mit --phase-status-id; mit --phase/--status abgelehnt.

Genau ein Stil ist erforderlich: --phase mit --status oder --phase-status-id nur. Finden Sie gültige Phasen-/Statuspaare mit uip ah idea-flows list.

Beispiele​
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
Datenform (--output json)​
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

Mit --phase-status-id hat Data PhaseStatusId anstelle von Phase/Status.

UIP-AH-Fragebögen​

Lesen Sie den Bewertungsfragenkatalog.

UIP-AH-Fragebogenliste​

Optionen​
LongWertErforderlichBeschreibung
--assessment <name>high-level|detailed|citizen-developmentjaBewertung zu lesen.
--section <key>stringneinNur dieser Abschnitt, z. B. q1-overview).
--active-only / --no-active-onlyMarkierenneinNur aktive Fragen (der Serverstandard)/enthalten auch inaktive Fragen.
--mandatory-onlyMarkierenneinNur Pflichtfragen.
--limit <n> / --offset <n>IntegerneinPaginierung, clientseitig angewendet (Endpunkt ohne Seite).
--all-fieldsMarkierenneinGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah questionnaires list --assessment high-level
uip ah questionnaires list --assessment high-level
Datenform (--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-Pipelines​

Lesen Sie die Automatisierungspipeline – Automatisierungen mit ihren Phasen- und Nutzenzahlen. Getrennt von automations list: Der Endpunkt fügt Nutzenspalten pro Phase hinzu und schreibt seine Sortierrichtung intern order (gleiches --sort-order -Flag).

Liste der UIP-AH-Pipelines​

Optionen​
LongWertBeschreibung
--search <text>stringFreitextsuche.
--sort-by <field>stringFeld, nach dem sortiert werden soll.
--sort-order <direction>asc|descSortierrichtung.
--category-id <id...>wiederholbarNur diese Kategorien.
--application-id <id...>wiederholbarNur Automatisierungen, die diese Anwendungen verwenden.
--business-unit <name> / --department <name>stringScope-Filter.
--phase-id <id...> / --status-id <id...>wiederholbarNur diese Phasen/Phasenstatus.
--tags <tag...>wiederholbarNur Automatisierungen, die diese Tags tragen.
--priority <priority...>wiederholbarNur diese Prioritäten.
--submission-type <type>stringNur dieser Übermittlungstyp.
--plain-textMarkierenKonvertieren Sie Rich-Text-Felder in Nur-Text.
--limit <n> / --offset <n>IntegerPaginieren. Der Standardwert ist --limit 20.
--all-fieldsMarkierenGibt die unformatierte Nutzlast zurück.
Beispiel​
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
Datenform (--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 }
}

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben