orchestrator
2025.10
true
Anleitung für die Orchestrator-API
- Erste Schritte
- Authentication
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anforderungen für persönliche Arbeitsbereiche
- Prozessabfragen
- Anforderungen von Warteschlangenelementen
- Queue retention policy requests
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
- Plattformverwaltungs-APIs
- Informationen zu diesem Leitfaden
- Verfügbare Ressourcen
- URL-Struktur des API-Endpunkts
- Aufzählungsliste
Wichtig :
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.
Verfügbare Ressourcen
Übersicht über die von UiPath verfügbar gemachten APIs, einschließlich Orchestrator, Test Manager, Data Service und Platform Management
UiPath® stellt die folgenden APIs bereit:
- Orchestrator-API
- Test Manager API
- Datendienst-API
- Plattformverwaltung API
- Prüfung – Abrufen und Herunterladen von Prüfungsprotokollen in der Organisation.
- Lizenzierung – Abrufen und Zuweisen von Lizenzen.
- Identität – Erstellen, Aktualisieren oder Löschen von Konten und Verwalten von Organisationseinstellungen.
- Marketplace-API
- AI Center-API
- Document Understanding-API
- UiPath Academy-API
Dieser Leitfaden befasst sich mit dem Zugriff auf Ressourcen im Rahmen der Plattform (Platform Management) für die Organisation. Informationen über produktbasierte APIs finden Sie in der jeweiligen Produktdokumentation.
Hinweis:
Die Plattformverwaltungs-APIs werden funktionell erweitert, was zu grundlegenden Änderungen an den Endpunkten führen kann. Aus diesem Grund werden die aktuellen APIs in unserer Referenzdokumentation als Vorschau gekennzeichnet.
Audit
GET /audit_/api/auditlogs– Ruft die Prüfungsprotokolle Ihrer Organisation ab.GET /audit_/api/auditlogs/download– Lädt die Prüfungsprotokolle Ihrer Organisation herunter.
„Gruppieren“ (Group)
GET identity_/api/Group/{partitionGlobalId}– Ruft alle lokalen und integrierten Gruppen von der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).GET /identity_/api/Group/{partitionGlobalId}/{groupId}– Ruft die angegebene lokale oder integrierte Gruppe in der angegebenen Partitions-ID ab.POST /identity_/api/Group– Erstellt eine neue lokale Gruppe.PUT /identity_/api/Group/{groupId}– Aktualisiert die Informationen einer lokalen Gruppe.DELETE /identity_/api/Group/{partitionGlobalId}– Löscht alle lokalen Gruppen aus der angegebenen Partitions-ID (entweder Organisation oder Mandant).DELETE /identity_/api/Group/{partitionGlobalId}/{groupId}– Löscht die angegebene lokale Gruppe.
Robot-Konto
GET /identity_/api/RobotAccount/{partitionGlobalId}– Ruft alle Roboterkonten in der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}– Ruft das angegebene Roboterkonto in der angegebenen Partitions-ID ab.POST /identity_/api/RobotAccount– Erstellt ein neues Roboterkonto.PUT /identity_/api/RobotAccount/{robotAccountId}– Aktualisiert die angegebenen Roboterkontoinformationen.DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}– Löscht das angegebene Roboterkonto.DELETE /identity_/api/RobotAccount/{partitionGlobalId}– Löscht alle Roboterkonten in der angegebenen Partitions-ID.
Nachrichtenvorlagen
GET /identity_/api/MessageTemplate– Ruft eine Nachrichtenvorlage mit dem bereitgestellten Filter ab.GET /identity_/api/MessageTemplate/{templateId}– Ruft die angegebene Nachrichtenvorlage ab.PUT /identity_/api/MessageTemplate/{templateId}– Aktualisiert die angegebene Nachrichtenvorlage.
Einstellung
GET /identity_/api/Setting– Ruft Anwendungseinstellungen basierend auf einer Liste von Schlüsseln für einen bestimmten Mandanten ab.PUT /identity_/api/Setting– Aktualisiert oder erstellt neue Einstellungen in einem bestimmten Mandanten.
Benutzer
GET /identity_/api/User/{userId}– Ruft Informationen über den angegebenen Benutzer ab.POST /identity_/api/User/{userId}/changepassword– Aktualisiert das Kennwort für den angegebenen Benutzer.PUT /identity_/api/User/{userId}– Aktualisiert die angegebenen Benutzerinformationen.DELETE /identity_/api/User– Löscht alle Benutzer.DELETE /identity_/api/User/{userId}– Löscht den angegebenen Benutzer.
Lizenzzuteilung
GET /lease_/api/account/{accountId}/user-license/group/{groupId}– Ruft eine Liste aller verfügbaren Benutzerlizenzen zum Erstellen oder Bearbeiten einer Gruppe ab.PUT /lease_/api/account/{accountId}/user-license/group/{groupId}– Weist eine Gruppenregel zu oder aktualisiert sie.
Lizenzressourcenverwaltung
PUT /lrm/api/host/{hostAccountId}/organization/{organizationId}/license**-**Weist einer Organisation Lizenzen vom Host zu.PUT /lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}– Weist Lizenzen einem Dienst zu.