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. Beispiel: ​/Group​/{partitionGlobalId}​/{groupId}.

partitionGlobalId – Die ID der Organisation.

groupId – Die ID der Gruppe.

Abfrageparameter

Query parameters are additional parameters attached to the URL to provide more context or filters for the requested data. These are often preceded by a ? symbol and separated by & symbols. For instance, you might use query parameters to specify filtering criteria or pagination instructions.

Beispiel

Putting all components together, a URL for a organization-specific resource might look like this, https://{yourDomain}/identity/api/group/{partitionGlobalId}​/{groupId}.

A URL for tenant-specific resource can look like this: https://{yourDomain}/odata/Assets.