UIP-AH-Kategorien, Tags, Mitarbeitende, Rollen, Benutzer

Syntax und Optionen für die Automation Hub-Kategorie-Taxonomie, Freitext-Tags, Mitarbeitende pro Automatisierung, den zuweisbaren Rollenkatalog und Benutzerkonten.

Kategorien sind eine hierarchische Taxonomie, in der Automatisierungen platziert werden; Tags sind Freitext-Beschriftungen. Mitarbeitende sind die Personen, die an einer Automatisierung arbeiten, die jeweils eine oder mehrere Rollen innehaben – der Katalog zuweisbaren Rollen von Automation Hub gewährt auch uip ah users create Zugriff. Siehe uip ah für gemeinsam genutzte Konzepte (Projektion/--all-fields, seiten vs. nicht Seitenlisten), die hier für jedes Verb gelten.

UIP-AH-Kategorien

Lesen Sie die Kategoriehierarchie und platzieren Sie Automatisierungen darin.

Zusammenfassung

uip ah categories get [--all-fields]
uip ah categories update --file <json-file> [-y, --yes]
uip ah categories set <automation-id> --category-id <id>

Abrufen von UIP-AH-Kategorien

Rufen Sie die Kategoriehierarchie als eine Struktur mit ihren Ebenennamen ab. get, nicht list: Der Endpunkt gibt ein geschachteltes Dokument zurück, keine Seitensammlung – es gibt kein --limit/--offset.

Optionen

Long	Beschreibung
--all-fields	Geben Sie die unformatierte Nutzlast anstelle von Levels/Categories zurück.

Beispiel

uip ah categories get

Datenform (--output json)

{
  "Code": "AhCategoriesGet",
  "Data": { "Levels": [{ "Id": 1, "Name": "Business Unit" }], "Categories": [{ "Id": 4, "Name": "Finance" }] }
}

Aktualisierung der UIP-AH-Kategorien

Ersetzen Sie die gesamte Kategoriestruktur aus einer Datei. Der Automation Hub hat kein Erstellen/Löschen pro Kategorie – die Struktur wird als ein Dokument synchronisiert.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file <json-file>	Pfad	ja	JSON mit der vollständigen zu synchronisierenden Kategoriestruktur in der Form, die categories get zurückgibt.
-y, --yes	Markieren	ja	Bestätigen Sie, dass dies die gesamte Mandantenkategoriestruktur ersetzt. Erforderlich – die CLI fordert nie auf.

Eine leere oder klar formatierte Datei wird clientseitig abgelehnt, bevor die Anforderung gesendet wird.

Beispiel

uip ah categories update --file ./categories.json --yes

Datenform (--output json)

{ "Code": "AhCategoriesUpdate", "Data": { "Status": "Synced" } }

UIP-AH-Kategorien festgelegt

Weisen Sie einer Kategorie eine Automatisierung zu.

Argumente

Name	Erforderlich	Zweck
<automation-id>	ja	Automatisierungs-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--category-id <id>	Integer	ja	Zuzuweisende Kategorie-ID.

Beispiel

uip ah categories set 20 --category-id 4

Datenform (--output json)

{ "Code": "AhCategoriesSet", "Data": { "AutomationId": 20, "CategoryId": 4 } }

UIP-AH-Tags

Legen Sie die Tags für eine Automatisierung fest.

UIP-AH-Tags festgelegt

Ersetzen Sie die Tags einer Automatisierung durch den angegebenen Satz – dadurch wird die gesamte Tag-Liste ersetzt, anstatt sie zusammenzuführen (übereinstimmen mit den Ersatzsemantiken von uip config set).

Argumente

Name	Erforderlich	Zweck
<automation-id>	ja	Automatisierungs-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--tags <tag...>	wiederholbar	ja	Der vollständige Tag-Set für diese Automatisierung.

Beispiel

uip ah tags set 20 --tags finance "quick win"

Datenform (--output json)

{ "Code": "AhTagsSet", "Data": { "AutomationId": 20, "Tags": ["finance", "quick win"] } }

UIP-AH-Mitarbeitende

Verwalten Sie, wer an einer Automatisierung mitarbeiten soll. Eine eigene Ressourcengruppe und kein Verb auf automations, sodass die Standard-CRUD-Verben dafür verfügbar bleiben.

Zusammenfassung

uip ah collaborators list --automation-id <id> [--limit <n>] [--offset <n>] [--all-fields]
uip ah collaborators create <automation-id> --user-id <id...> --role-id <id...>
uip ah collaborators delete <automation-id> --user-id <id...> --role-id <id...> [-y, --yes]

UIP-AH-Mitarbeitendenliste

Optionen

Long	Wert	Erforderlich	Beschreibung
--automation-id <id>	Integer	ja	Zu lesende Automatisierung (ein Abfrageparameter an diesem Endpunkt, keine Positionalparameter).
--limit <n> / --offset <n>	Integer	nein	Paginierung, clientseitig angewendet (Endpunkt ohne Seite).
--all-fields	Markieren	nein	Gibt die unformatierte Nutzlast zurück.

Beispiel

uip ah collaborators list --automation-id 20

Datenform (--output json)

{
  "Code": "AhCollaboratorsList",
  "Data": [
    { "Id": 1, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "IsActive": 1 }
  ]
}

uip ah Mitarbeitende erstellen

Fügen Sie Mitarbeitende zu einer Automatisierung hinzu.

Argumente

Name	Erforderlich	Zweck
<automation-id>	ja	Automatisierungs-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--user-id <id...>	wiederholbar	ja	Benutzer-IDs, die hinzugefügt werden sollen.
--role-id <id...>	wiederholbar	ja	Rollen-IDs, die jedem hinzugefügten Benutzer gewährt werden sollen (gilt auf alle – eine Rollenaufteilung pro Benutzer erfordert einen Aufruf pro Benutzer). Nur aktive Rollen vom Typ process werden akzeptiert; der Endpunkt weist jede andere Art zurück.

Mindestens ein --role-id ist erforderlich – der Endpunkt weist einen Mitarbeitendeneintrag ohne Rolle zurück.

Beispiel

uip ah collaborators create 20 --user-id 3 --role-id 3

Datenform (--output json)

{ "Code": "AhCollaboratorsCreate", "Data": { "AutomationId": 20, "UserIds": [3] } }

uip ah Mitarbeitende löschen

Entfernen Sie Mitarbeitendenrollen von Benutzern an einer Automatisierung. Der Endpunkt löscht Rollenzuweisungen anstelle des Mitarbeitendendatensatzes, daher ist --role-id erforderlich – entfernen Sie alle Rollen, die ein Benutzer innehat, und er beendet seine Rolle als Mitarbeitender.

Argumente

Name	Erforderlich	Zweck
<automation-id>	ja	Automatisierungs-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--user-id <id...>	wiederholbar	ja	Benutzer-IDs, von denen Rollen entfernt werden sollen.
--role-id <id...>	wiederholbar	ja	Rollen-IDs, die von jedem Benutzer entfernt werden sollen.
-y, --yes	Markieren	ja	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.

Beispiel

uip ah collaborators delete 20 --user-id 3 --role-id 3 --yes

Datenform (--output json)

{ "Code": "AhCollaboratorsDelete", "Data": { "AutomationId": 20, "UserIds": [3], "RoleIds": [3] } }

UIP-AH-Rollen

Entdecken Sie die Automation Hub-Rollen, die zugewiesen werden können. Schreibgeschützt.

UIP-AH-Rollenliste

Optionen

Long	Beschreibung
--limit <n> / --offset <n>	Paginierung, clientseitig angewendet (Endpunkt ohne Seite).
--all-fields	Gibt die unformatierte Nutzlast zurück.

Beispiel

uip ah roles list

Datenform (--output json)

{
  "Code": "AhRolesList",
  "Data": [
    { "Id": 2, "Name": "System Admin", "Slug": "ah-system-admin", "Type": "service", "Description": "...", "IsActive": 1, "IsDefault": 0 }
  ]
}

Slug ist der Wert, den uip ah users create --role annimmt; Id/Type sind das, was collaborators create --role-id filtert (dort werden nur Type: "process" -Rollen akzeptiert).

uip-ah-Benutzer

Verwalten Sie Automation Hub-Benutzer und deren Rollen.

Zusammenfassung

uip ah users list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--department <name>] [--business-unit <name>] [--location <name>] [--job-title <title>] [--invite-status <status>] [--role <slug>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah users create --email <email> [write options...] --role-id <id...>
uip ah users update --email <email> [write options...]

UIP-AH-Benutzerliste

Optionen

Long	Wert	Beschreibung
--search <text>	string	Freitextsuche.
--sort-by <field>	string	Feld, nach dem sortiert werden soll, z. B user_email).
--sort-order <direction>	asc|desc	Sortierrichtung.
--department <name> / --business-unit <name> / --location <name> / --job-title <title>	string	Scope-Filter.
--invite-status <status>	string	Nur dieser Einladungsstatus.
--role <slug>	string	Nur Benutzer, die diese Rollen-Slug innehaben.
--limit <n> / --offset <n>	Integer	Paginieren. Der Standardwert ist --limit 20.
--all-fields	Markieren	Gibt die unformatierte Nutzlast zurück.

Beispiel

uip ah users list --department Finance --limit 20

Datenform (--output json)

{
  "Code": "AhUsersList",
  "Data": [
    { "Id": 3, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "Location": "Boston", "IsAdmin": 0, "IsActive": 1, "InviteStatus": 2, "AutomationCount": 3 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

uip ah Benutzer erstellen

Fügen Sie einen vorhandenen Automation Cloud-Benutzer zum Automation Hub hinzu. Dies importiert einen Benutzer, der sich bereits in der Organisation befindet – es kann keinen neuen einladen, und schlägt mit einem expliziten Anweisungsfehler fehl, wenn die Adresse der Automation Cloud unbekannt ist.

Optionen

Long	Wert	Erforderlich	Beschreibung
--email <email>	E-Mail	ja	E-Mail-Adresse des Benutzers.
--first-name <name> / --last-name <name>	string	bedingt	Erforderlich für den Dienst beim Schreiben (siehe unten).
--job-title <title> / --department <name> / --business-unit <name> / --location <name>	string	bedingt	Erforderlich für den Dienst beim Schreiben.
--invite-status <status>	Integer	nein	Numerischer Automation Hub-Einladungsstatuscode. Standardmäßig 2 beim Erstellen.
--active	Markieren	nein	Markieren Sie den Benutzer als aktiv. Standard beim Erstellen. Konflikte mit --inactive.
--inactive	Markieren	nein	Markieren Sie den Benutzer inaktiv. Konflikte mit --active.
--role-id <id...>	wiederholbar	nein	Zuzuweisende Rollen-IDs (uip ah roles list für die IDs).

Automation Hub erfordert neun Felder, um bei jedem Schreibvorgang einen Wert zu enthalten (email, first-name, last-name, business-unit, department, location, job-title, invite-status, active/inactive) – Auf create hat keines ein gespeichertes Fallback, sodass jedes ausgelassene Feld auf Clientseite nicht genau benennen, welche Flags übergeben werden sollen.

Beispiel

uip ah users create --email [e-mail] --first-name Jane --last-name Doe \
  --job-title Analyst --department Finance --business-unit EMEA --location Boston --role-id 3

Datenform (--output json)

{ "Code": "AhUsersCreate", "Data": { "Email": "[e-mail]", "Status": "Created" } }

UIP-AH-Benutzeraktualisierung

Aktualisieren Sie einen Benutzer, der von --email gefunden wurde. Der Automation Hub ersetzt beim Schreiben den gesamten Benutzerdatensatz, sodass Felder, die Sie nicht übergeben, aus dem gespeicherten Datensatz übernommen werden – mit der Ausnahme, dass der Dienst den Schreibvorgang weiterhin ablehnt, wenn eines der neun Pflichtfelder sowohl auf dem Flag als auch im gespeicherten Datensatz leer ist .

Optionen

Die gleichen Flags wie create, aber nur --email ist erforderlich – der Rest füllt Lücken aus dem vorhandenen Datensatz.

Beispiel

uip ah users update --email [e-mail] --job-title 'Senior Analyst'

Datenform (--output json)

{ "Code": "AhUsersUpdate", "Data": { "Email": "[e-mail]", "Status": "Updated" } }

Zugehörig

• uip ah – Übersicht, Konzepte, audit-logs, auth-info.
• Automatisierungen, Ideenflows, Geschäftsfälle, Phasen, Fragebögen, Pipelines
• Anwendungen, Komponenten, Dokumente, Medien, Speicherauflistungen, Speicherbewertungen

Siehe auch

• Tools (Plugins)
• Globale Optionen
• Exitcodes