URL-Struktur des API-Endpunkts

In diesem Abschnitt erfahren Sie, wie Sie API-Anforderungen anhand der URL-Struktur von UiPath®-Endpunkten konstruieren können.

Basis-URL

Die Basis-URL ist der Ausgangspunkt für alle API-Anforderungen. Sie dient als Grundlage für die Erstellung der Endpunkt-URL. Die Basis-URL ist https://{yourDomain}.

Dienstpfad

Der Dienstpfad identifiziert den spezifischen Dienst, mit dem Sie interagieren möchten.

Bei APIs, die auf Organisationsebene arbeiten, kommt der Dienstpfad in der Regel direkt nach der Basis-URL. Diese APIs bieten Funktionalitäten, die in der gesamten Organisation gelten, unabhängig von den spezifischen Mandanten innerhalb dieser Organisation.

/identity_ – Zur Interaktion mit Funktionen zum Erstellen, Aktualisieren oder Löschen von Konten und zum Verwalten von Organisationseinstellungen.

/audit_ – Zur Interaktion mit Funktionalitäten im Zusammenhang mit Prüfungsprotokollen in der Organisation.

/lrm – Zur Interaktion mit Funktionalitäten im Zusammenhang mit der Lizenzzuweisung an Mandanten und Dienste in der Organisation.

/la – Zur Nachverfolgung der Lizenznutzung (Robot Units, bereitgestellte Mandanten und Dienste usw.)

Wenn es um APIs geht, die für einen bestimmten Mandanten innerhalb einer Organisation spezifisch sind, sollte die URL zusätzliche Parameter enthalten, um sowohl die Organisation als auch den Mandanten vor dem Dienstpfad anzugeben. Zum Beispiel:

/{orgName}/{tenantName}/orchestrator_ – Zur Interaktion mit Orchestrator-Ressourcen in einem bestimmten Mandanten und einer bestimmten Organisation.

/{orgName}/{tenantName}/dataservice_ – Zur Interaktion mit Data Service-Ressourcen in einem bestimmten Mandanten und einer bestimmten Organisation.

Weitere Informationen zu Mandanten-API-Ressourcen finden Sie in der jeweiligen Produktdokumentation.

Einstiegspunkt

api – Bezeichnet den Einstiegspunkt zu den Verwaltungsressourcen der API-Plattform, z. B. ​/api​/Group​/

Ressourcenpfad

Der Ressourcenpfad gibt die genaue Ressource oder den auszuführenden Vorgang an. Es können Schlüsselwörter wie Group, RobotAccount oder Setting enthalten sein, je nach Zweck der Anforderung.

Pfadparameter

Pfadparameter werden verwendet, um dynamische Werte an einen API-Endpunkt zu übergeben. Diese Werte helfen bei der Identifizierung bestimmter Ressourcen, die für die API-Anforderung relevant sind. Beispiel: ​/Group​/{partitionGlobalId}​/{groupId}.

partitionGlobalId – Die ID der Organisation.

groupId – Die ID der Gruppe.

Abfrageparameter

Abfrageparameter sind zusätzliche Parameter, die an die URL angehängt werden, um mehr Kontext oder Filter für die angeforderten Daten bereitzustellen. Ihnen geht häufig ein ? -Symbol voraus und werden durch & -Symbole getrennt. Beispielsweise können Sie Abfrageparameter verwenden, um Filterkriterien oder Paginierungsanweisungen anzugeben.

Beispiel

Nimmt man alle Komponenten zusammen, könnte eine URL für eine organisationsspezifische Ressource so aussehen: https://{yourDomain}/{organizationName}/identity_/api/group/{partitionGlobalId}​/{groupId}

Eine URL für eine mandantenspezifische Ressource kann folgendermaßen aussehen: https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Assets.