Universal Connector Schemas API

ENTWURF — Nur für interne Entwicklerteams

Diese API-Referenz ist für interne Entwicklerteams bestimmt.

Übersicht

Was es ist: Die Universal Connector Schemas API verwaltet benutzerdefinierte Datenerfassungs-Schemas. Schemas definieren die Struktur der Daten, die Universal Connectors von externen Systemen mithilfe von sandboxed Python-Skripten erfassen.

Warum es wichtig ist: Entwickler, die benutzerdefinierte Collectors erstellen, müssen Schemas definieren, die die Entitätstypen, Felder und Beziehungen beschreiben, die der Collector entdecken wird.

Endpunkte

Methode	Pfad	Beschreibung	Authentifizierung erforderlich
GET	/internal/v1/connector/universal/schemas	Alle Schemas auflisten	JWT + API-Token
GET	/internal/v1/connector/universal/schemas/:id	Schema-Details abrufen	JWT + API-Token
GET	/internal/v1/connector/universal/schemas/:id/history	Schema-Änderungsverlauf abrufen	JWT + API-Token
POST	/internal/v1/connector/universal/schemas	Ein neues Schema erstellen	JWT + API-Token
PUT	/internal/v1/connector/universal/schemas/:id	Ein Schema aktualisieren	JWT + API-Token
DELETE	/internal/v1/connector/universal/schemas/:cid/:id	Ein Schema löschen	JWT + API-Token
DELETE	/internal/v1/connector/universal/schemas/:cid/:id/erase	Schema und Daten löschen	JWT + API-Token
GET	/internal/v1/connector/universal/generate/schema-id/:connector/:id	Schema-ID generieren	JWT + API-Token
GET	/internal/v1/connector/universal/generate/schema-uuid/:connector/:id	Schema-UUID generieren	JWT + API-Token
GET	/internal/v1/connector/universal/model/schemas	Modell-Schema-Definitionen abrufen	JWT + API-Token

Dokumentation & Werkzeuge

Methode	Pfad	Beschreibung	Authentifizierung erforderlich
GET	/internal/v1/connector/universal/docs	Connector-Dokumentation auflisten	JWT + API-Token
GET	/internal/v1/connector/universal/docs/:id	Bestimmte Dokumentation abrufen	JWT + API-Token
GET	/internal/v1/connector/universal/tools/:connectorid	Connector-Werkzeuge auflisten	JWT + API-Token
POST	/internal/v1/connector/universal/action/:connectorid/:actionId	Connector-Aktion ausführen	JWT + API-Token

---

POST /internal/v1/connector/universal/schemas

Ein neues Universal Connector Schema erstellen.

Anfrage:

POST /internal/v1/connector/universal/schemas
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Custom REST API",
  "connectorId": "connector-uuid",
  "entityType": "account",
  "fields": [
    { "name": "userId", "type": "string", "primary": true },
    { "name": "username", "type": "string" },
    { "name": "email", "type": "string" },
    { "name": "role", "type": "string" },
    { "name": "active", "type": "boolean" }
  ]
}

Antwort (201):

{
  "id": "schema-uuid-001",
  "name": "Custom REST API",
  "status": "created",
  "version": 1
}

---

GET /internal/v1/connector/universal/schemas/:id/history

Den Änderungsverlauf für ein Schema abrufen. Verwenden Sie dies, um Änderungen im Laufe der Zeit nachzuverfolgen.

Anfrage:

GET /internal/v1/connector/universal/schemas/schema-uuid-001/history
Authorization: Bearer <token>

Antwort (200):

{
  "history": [
    {
      "version": 2,
      "changedAt": "2026-02-12T10:00:00Z",
      "changedBy": "admin@example.com",
      "changes": ["Added field: department"]
    },
    {
      "version": 1,
      "changedAt": "2026-02-01T10:00:00Z",
      "changedBy": "admin@example.com",
      "changes": ["Initial creation"]
    }
  ]
}

---

DELETE /internal/v1/connector/universal/schemas/:cid/:id/erase

Ein Schema löschen und alle damit erfassten Daten entfernen. Dies ist eine destruktive Operation.

Pfadparameter:

Parameter	Typ	Beschreibung
cid	string	Connector-ID
id	string	Schema-ID

Anfrage:

DELETE /internal/v1/connector/universal/schemas/connector-uuid/schema-uuid-001/erase
Authorization: Bearer <token>

Antwort (204): Kein Inhalt.

DANGER

Diese Operation löscht das Schema und alle zugehörigen erfassten Daten dauerhaft. Dies kann nicht rückgängig gemacht werden.