Verbindung¶

Verwende einen API-Schlüssel oder REST-OAuth-Access-Token. Scopes und deine aktuellen Workspace-Rechte gelten gemeinsam. Die Beispiele verwenden fiktive Daten.

Verbundenen Workspace prüfen¶

GET /api/external/v1/connection

Scope: connection:verify

Antwort 200

Erfolgreich.

Header	Typ	Beschreibung
`Cache-Control`	`string`	Die Antwort darf nicht zwischengespeichert werden. Beispiel: `no-store`

application/json

FelderBeispiel

Feld	Typ	Beschreibung
`connected`	`boolean`	Ob der Zugang mit dem Workspace verbunden ist.
`tenantId`	`string` (uuid)	ID des mit dem Zugang verbundenen Workspaces.
`tenantName`	`string`	Name des mit dem Zugang verbundenen Workspaces.
`scopes`	Liste von `string`	Für diesen Zugang freigegebene Scopes.

{
  "connected": true,
  "tenantId": "00000000-0000-0000-0000-000000000001",
  "tenantName": "Example workspace",
  "scopes": []
}

Fehlerantworten

Status	Bedeutung
`400`	Ungültige Eingabe, Auswahl oder Zeitgrenzen.
`401`	Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
`403`	Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
`429`	Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
`503`	Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld	Typ	Beschreibung
`status`	`integer`	HTTP-Statuscode.
`error`	`string`	Beschreibung des Fehlers.
`details`	`any`	Weitere Fehlerdetails, sofern vorhanden. Regeln: `null` erlaubt
`code`	`string`	Maschinenlesbarer Fehlercode.
`params`	`object`	Zusätzliche Werte zum Fehlercode.
`fieldErrors`	`object`	Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.