Einführung in die Automation Hub API

Automation Hub Open API-Funktionen in Automation Cloud, die den programmgesteuerten Zugriff auf Mandantendaten und die vollständige Liste der unterstützten API-Anforderungen abdecken.

Die Open API- Funktion ermöglicht es UiPath Automation Hub Benutzern, programmatisch auf ihre Mandantendaten zuzugreifen und sie zu bearbeiten. Basierend auf dem erhaltenen Feedback sowie der Plattformstruktur haben wir uns auf die Bereitstellung von API-Anforderungen konzentriert, wie in den folgenden Beispielen:

Hinweis:

• Die gesamte Liste der API-Aufrufe finden Sie in der Swagger- und Postman -Dokumentation.
• Einige kurze Beispiele zur Verwendung von API-Aufrufen finden Sie unter Beispiele für API-Aufrufe. Für eine ausführliche Erfahrung oder zum Testen bestimmter API-Antworten verwenden Sie die Swagger- oder Postman-Umgebung, die in API-Referenzen beschrieben ist .

Benutzerdefinierte Bewertungen

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

Automatisierungsideen

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

Hinweis:

Die Endpunkte POST /automationidea, POST /coe-automationidea und POST /processmining-idea sind Legacy-Endpunkte, die nur verwendet werden können, wenn Ideenflowbewertungen und Workflows nicht angepasst wurden. Für alle neuen Integrationen und benutzerdefinierte Ideenflows wird empfohlen, GET /idea-schema zu verwenden, um die Struktur des Einreichungsformulars abzurufen, gefolgt von POST /idea-from-schema um die Idee einzureichen.

Automatisierungspipeline

• GET/automationpipeline

Benutzer

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

Anwendungsbestand

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

Categories

• GET/hierarchy
• PUT/categories

Komponenten

• GET/components

Automatisierungsspeicher

• GET/automation-store
• GET/automation-store/{automationId}/reviews

Die API-Aufrufe spiegeln Aktionen wider, die ein Benutzer auf der Automation Hub-Schnittstelle ausführen kann.

Um Aufrufe mit den folgenden Variablen zu starten, greifen Sie über die Automation Hub-Plattform > Administratorkonsole > Plattformeinrichtung > Open API auf die OpenAPI-Optionen zu und generieren Sie Ihr Token.

Variable	Wert
Token	Das von der Automation Hub-Benutzeroberfläche generierte Token.
URL	https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/openapi
URL der verzögerten Veröffentlichung	https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/openapi
Abrufen der API-Struktur aller Ideen für Organisationen mit verzögerter Veröffentlichung	https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/openapi
App-Schlüssel	Der von der Automation Hub-Benutzeroberfläche generierte App-Schlüssel.

Hinweis:

{orgName} und {tenantName} sind Variablen, die auf den Namen Ihrer Organisation und den Namen Ihres Mandanten verweisen.

Der nächste Schritt besteht darin, die verfügbaren APIs zu verwenden.

API-Referenzen

Auf die Automation Hub API Swagger -Definition kann direkt zugegriffen werden, indem die Authentifizierungsdetails im Autorisierungsschlüssel im Anforderungsaufruf mit dem Namen Header hinzugefügt werden.

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Dieses Handbuch bietet einschlägige und leicht zu befolgende Beispiele, um die Swagger-Dokumentation zu unterstützen.

Um die Swagger-Dokumentation in Organisationen mit verzögerter Veröffentlichung zu verwenden, verwenden Sie den folgenden Link:

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Wenn Sie lieber mit Postman arbeiten möchten, erstellen Sie eine Postman-Umgebung. Sehen Sie sich anschließend unsere API-Sammlung an, die in Postman verfügbar ist . Die Sammlung kann importiert werden, indem Sie auf die Schaltfläche In Postman ausführen klicken.