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-Anwendungen, Komponenten, Dokumente, Medien, Speicherauflistungen, Speicherbewertungen

Syntax und Optionen für den Automation Hub-Anwendungsbestand, wiederverwendbare Komponenten, angehängte Dokumente/Medien und den Automation Store Marketplace (veröffentlichte Auflistungen und Bewertungen).

Der Anwendungsbestand ist das, gegen das Automatisierungen mit Tags versehen sind (--application-id Filter an anderer Stelle verweisen darauf). Komponenten sind wiederverwendbare Bausteine, die optional auf eine Automatisierung beschränkt sind. Dokumente und Medien sind Dateien, die an eine Automatisierung angehängt sind – ein PDD, ein Screenshot, ein Demovideo. Der Automation Store ist der interne Marketplace von Automation Hub: Speicherauflistungen sind veröffentlichte Automatisierungen, Speicherbewertungen sind die darauf verbleibenden Bewertungen. Siehe uip ah für gemeinsam genutzte Konzepte (Projektion/--all-fields, seiten vs. nicht Seitenlisten), die hier für jedes Verb gelten.

UIP-AH-Anwendungen​

Verwalten Sie den Anwendungsbestand, für den Automatisierungen mit Tags versehen sind.

Zusammenfassung​

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

Optionen​
LongWertBeschreibung
--search <text>stringFreitextsuche.
--category-id <id...>wiederholbarNur Anwendungen in diesen Kategorien.
--limit <n> / --offset <n>IntegerPaginieren. Der Standardwert ist --limit 20.
--all-fieldsMarkierenGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah applications list
uip ah applications list
Datenform (--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 }
}
{
  "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 }
}

Aktualisierung der UIP-AH-Anwendungen​

Aktualisieren Sie vorhandene Anwendungen im Bestand mithilfe einer Datei. Dadurch werden bereits vorhandene Einträge bearbeitet – es kann keins hinzugefügt werden, da der Dienst ein application_id für jedes Element benötigt.

Optionen​
LongWertErforderlichBeschreibung
--file <json-file>PfadjaJSON-Array der zu aktualisierenden Anwendungen. Jedes Element benötigt application_id und categoryIds – nehmen Sie die Form von applications list --all-fields an.
Beispiel​
uip ah applications update --file ./applications.json
uip ah applications update --file ./applications.json
Datenform (--output json)​
{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }
{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }

UIP-AH-Anwendungen löschen​

Argumente​
NameErforderlichZweck
<application-id>jaAnwendungs-ID.
Optionen​
LongBeschreibung
-y, --yesBestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.
Beispiel​
uip ah applications delete 7 --yes
uip ah applications delete 7 --yes
Datenform (--output json)​
{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }
{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }

UIP-AH-Komponenten​

Lesen Sie wiederverwendbare Komponenten, mandantenweit oder pro Automatisierung. Schreibgeschützt – Auf dieser Oberfläche gibt es kein Erstellen/Aktualisieren/Löschen.

UIP-AH-Komponentenliste​

Optionen​
LongWertBeschreibung
--automation-id <id>IntegerScope auf die Komponenten, die an diese Automatisierung angehängt sind – ein separater Endpunkt, der keine anderen Filter verwendet.
--type <type>stringNur dieser Komponententyp. Kann nicht mit --automation-id kombiniert werden.
--category-id <id...>wiederholbarNur diese Kategorien. Kann nicht mit --automation-id kombiniert werden.
--application-id <id...>wiederholbarNur Komponenten, die diese Anwendungen verwenden. Kann nicht mit --automation-id kombiniert werden.
--limit <n> / --offset <n>IntegerPaginieren. Der Standardwert ist --limit 20.
--all-fieldsMarkierenGibt die unformatierte Nutzlast zurück.

--type/--category-id/--application-id in Kombination mit --automation-id schlägt auf Clientseite fehl – die Liste pro Automatisierung ist ein anderer Endpunkt, der keine Filter verwendet.

Beispiele​
uip ah components list
uip ah components list
uip ah components list --automation-id 20
uip ah components list --automation-id 20
Datenform (--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 }
}
{
  "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-Dokumente​

Verwalten Sie die an eine Automatisierung angehängten Dokumente.

UIP-AH-Dokumente Liste​

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongBeschreibung
--limit <n> / --offset <n>Paginieren. Der Standardwert ist --limit 20.
--all-fieldsGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah documents list 20
uip ah documents list 20
Datenform (--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 }
}
{
  "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 ist das, was documents download dauert.

UIP-AH-Dokumente erstellen​

Hängen Sie ein Dokument an eine Automatisierung an – laden Sie die Bytes der Datei mit --file hoch oder verknüpfen Sie sie mit --embed-link ( genau eines von beiden).

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongWertErforderlichBeschreibung
--title <text>stringjaDokumenttitel.
--description <text>stringjaDokumentbeschreibung.
--document-type-id <id>IntegerjaID des Dokumenttyps.
--file <path>PfadbedingtLokale Dokumentdatei, die hochgeladen werden soll. Genau eines von --file/--embed-link ist erforderlich. Keine serverseitige MIME-Typ-Zulassungsliste – nicht erkannte Erweiterungen werden als application/octet-stream hochgeladen.
--embed-link <url>urlbedingtLink zu einem bereits gehosteten Dokument. Genau eines von --file/--embed-link ist erforderlich.
--submitter <email>E-MailneinE-Mail-Adresse des einreichenden Automation Hub-Benutzers. Standardeinstellung ist der Aufrufer.
Beispiele​
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 --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
uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --embed-link https://acme.sharepoint.com/pdd.docx
Datenform (--output json)​
{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }
{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }

Mit --embed-link hat Data EmbedLink anstelle von FileId/File.

UIP-AH-Dokumente herunterladen​

Argumente​
NameErforderlichZweck
<file-id>jaDatei-ID – der FileId von documents list <automation-id>.
Optionen​
LongWertErforderlichBeschreibung
--destination <path>PfadjaLokaler Pfad, in den die Datei geschrieben werden soll.
Beispiel​
uip ah documents download 42 --destination ./pdd.pdf
uip ah documents download 42 --destination ./pdd.pdf
Datenform (--output json)​
{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }
{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }

UIP-AH-Medien​

Medien (Screenshots, Video) an eine Automatisierung anhängen. Getrennt von documents – ein eigener Upload-Endpunkt und es gibt keine Liste oder Löschung.

UIP-AH Medien erstellen​

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID.
Optionen​
LongWertErforderlichBeschreibung
--file <path>PfadjaLokale Mediendatei – nur jpg, jpeg, png, gif oder mp4; jede andere Erweiterung wird clientseitig abgelehnt.
--submitter <email>E-MailneinE-Mail-Adresse des einreichenden Automation Hub-Benutzers. Standardeinstellung ist der Aufrufer.
Beispiel​
uip ah media create 20 --file ./screen.png
uip ah media create 20 --file ./screen.png
Datenform (--output json)​
{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }
{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }

UIP-AH-Speicherauflistungen​

Lesen Sie die im Automation Store veröffentlichten Automatisierungen. Schreibgeschützt.

UIP-AH-Speicherauflistungen-Liste​

Optionen​
LongWertBeschreibung
--search <text>stringFreitextsuche.
--category-id <id...>wiederholbarNur diese Kategorien.
--application-id <id...>wiederholbarNur Auflistungen, die diese Anwendungen verwenden.
--business-unit <name>stringNur diese Geschäftseinheit.
--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 store-listings list
uip ah store-listings list
Datenform (--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 }
}
{
  "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-Store-Reviews​

Lesen Sie die Automation Store-Bewertungen für eine Automatisierung. Eine eigene Ressourcengruppe und kein Verb unter store-listings. Schreibgeschützt.

UIP-AH-Store-Reviews-Liste​

Argumente​
NameErforderlichZweck
<automation-id>jaAutomatisierungs-ID – muss im Store veröffentlicht werden.
Optionen​
LongBeschreibung
--limit <n> / --offset <n>Paginieren. Der Standardwert ist --limit 20.
--all-fieldsGibt die unformatierte Nutzlast zurück.
Beispiel​
uip ah store-reviews list 20
uip ah store-reviews list 20
Datenform (--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 }
}
{
  "Code": "AhStoreReviewsList",
  "Data": [
    { "Id": 5, "AutomationId": 20, "Score": 5, "Title": "Great automation", "Description": "...", "UserId": 3, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "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