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}.

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. Zum 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 ? voraus und werden durch das Zeichen & 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}/identity/api/group/{partitionGlobalId}​/{groupId}

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