Pre Processing

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

Pre-Processing-Profil erstellen

POST /api/external/v1/pre-processing/profiles

Scope: pre-processing:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Bei unveränderter URL behält ein Header ohne Wert sein Secret. Ein aus der Liste entfernter Header wird gelöscht. Bei neuer URL gespeicherte Authentifizierung ausdrücklich entfernen oder ersetzen.

Request-Body · application/json

FelderBeispiel

Feld	Typ	Pflicht	Beschreibung
profile	object	Ja	Profilname, Standardeinstellungen und Zuordnungen.
configuration	object	Ja	Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.

profile — Felder

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Anzeigename. Regeln: höchstens 120 Zeichen
defaultProfile	boolean	Nein	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Ja	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments. Regeln: Muster ALL\|SELECTED\|UNASSIGNED
assignments	Liste von object	Ja	Diesem Profil zugeordnete Agents oder Flows. Ohne explizite Zuordnung eine leere Liste senden. Regeln: höchstens 1000 Einträge; keine doppelten Einträge
transferFromProfileIds	Liste von string (uuid)	Nein	IDs der Quellprofile für eine ausdrückliche Übernahme von Zuordnungen. Vorher die aktuellen Zuordnungen lesen. Regeln: höchstens 1000 Einträge; keine doppelten Einträge

assignments — Felder

Feld	Typ	Pflicht	Beschreibung
ownerType	string	Ja	Typ der diesem Profil zugeordneten Ressource. Regeln: mindestens 1 Zeichen; Muster AGENT\|FLOW
ownerId	string (uuid)	Ja	ID des zugeordneten Agents oder Flows dieses Workspaces.

configuration — Felder

Feld	Typ	Pflicht	Beschreibung
enabled	boolean	Nein	Aktiviert diese ausgehende Abfrage oder diesen Webhook.
url	string (uri)	Nein	Ziel-URL. Bei einer Änderung gespeicherte Authentifizierung entfernen oder ersetzen. Regeln: höchstens 4096 Zeichen Beispiel: "https://example.com/webhook"
timeoutMs	integer (int64)	Nein	Zeitlimit des ausgehenden Aufrufs, in Millisekunden. Regeln: 1–60000 Beispiel: 5000
queryParameters	Liste von object	Nein	Query-Parameter des ausgehenden Aufrufs. Unterstützte Template-Variablen stehen im zugehörigen Variablenkatalog. Regeln: höchstens 100 Einträge
headers	Liste von object	Nein	HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen. Regeln: höchstens 100 Einträge
responseMode	string	Nein	Verarbeitung der Abfrageantwort: vollständig behalten, Felder zuordnen oder Skript ausführen. Regeln: höchstens 64 Zeichen
responseMappings	Liste von object	Nein	Ordnet Antwortwerte benannten Ausgabefeldern zu. Regeln: höchstens 100 Einträge
responseScript	string	Nein	Skript zur Umformung der externen Antwort. Regeln: höchstens 64000 Zeichen
greetingTemplate	string	Nein	Begrüßungsvorlage mit dem Kontext aus dem Pre Processing. Regeln: höchstens 64000 Zeichen
clearAuthentication	boolean	Nein	true entfernt die gespeicherte OAuth-Verknüpfung. Auslassen oder false behält sie. Regeln: nur schreibbar

queryParameters — Felder

Feld	Typ	Pflicht	Beschreibung
key	string	Nein	Name der Variablen oder des Parameters.
value	string	Nein	Wert oder Vorlage für diesen Parameter.

headers — Felder

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Name des HTTP-Headers, etwa Authorization. Regeln: höchstens 128 Zeichen
value	string	Nein	Neuer Headerwert. Auslassen behält den gespeicherten Wert bei unverändertem Ziel. Regeln: höchstens 8192 Zeichen; nur schreibbar

responseMappings — Felder

Feld	Typ	Pflicht	Beschreibung
responsePath	string	Nein	Pfad zum Wert in der externen Antwort.
outputKey	string	Nein	Name der Kontextvariablen für den zugeordneten Wert.

{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "enabled": false,
    "responseMode": "WHOLE_RESPONSE",
    "headers": []
  }
}

Antwort 201

Erstellt.

Header	Typ	Beschreibung
Cache-Control	string	Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store
Location	string	Pfad der erstellten Ressource.
ETag	string	Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get"

application/json

FelderBeispiel

Feld	Typ	Beschreibung
profile	object	Profilname, Standardeinstellungen und Zuordnungen.
configuration	object	Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.

profile — Felder

Feld	Typ	Beschreibung
id	string (uuid)	Ressourcen-ID in deinem Workspace. Beispiel: "00000000-0000-0000-0000-000000000001"
name	string	Anzeigename.
defaultProfile	boolean	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments.
assignments	Liste von object	Diesem Profil zugeordnete Agents oder Flows. Ohne explizite Zuordnung eine leere Liste senden. Regeln: keine doppelten Einträge
version	integer (int64)	Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden.

assignments — Felder

Feld	Typ	Beschreibung
ownerType	string	Typ der diesem Profil zugeordneten Ressource. Regeln: mindestens 1 Zeichen; Muster AGENT\|FLOW
ownerId	string (uuid)	ID des zugeordneten Agents oder Flows dieses Workspaces.

configuration — Felder

Feld	Typ	Beschreibung
enabled	boolean	Aktiviert diese ausgehende Abfrage oder diesen Webhook.
url	string (uri)	Ziel-URL. Bei einer Änderung gespeicherte Authentifizierung entfernen oder ersetzen. Regeln: höchstens 4096 Zeichen Beispiel: "https://example.com/webhook"
timeoutMs	integer (int64)	Zeitlimit des ausgehenden Aufrufs, in Millisekunden. Regeln: 1–60000 Beispiel: 5000
queryParameters	Liste von object	Query-Parameter des ausgehenden Aufrufs. Unterstützte Template-Variablen stehen im zugehörigen Variablenkatalog. Regeln: höchstens 100 Einträge
headers	Liste von object	HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen. Regeln: höchstens 100 Einträge
responseMode	string	Verarbeitung der Abfrageantwort: vollständig behalten, Felder zuordnen oder Skript ausführen. Regeln: höchstens 64 Zeichen
responseMappings	Liste von object	Ordnet Antwortwerte benannten Ausgabefeldern zu. Regeln: höchstens 100 Einträge
responseScript	string	Skript zur Umformung der externen Antwort. Regeln: höchstens 64000 Zeichen
greetingTemplate	string	Begrüßungsvorlage mit dem Kontext aus dem Pre Processing. Regeln: höchstens 64000 Zeichen
oauthConfigured	boolean	Ob eine ausgehende OAuth-Verknüpfung gespeichert ist.

queryParameters — Felder

Feld	Typ	Beschreibung
key	string	Name der Variablen oder des Parameters.
value	string	Wert oder Vorlage für diesen Parameter.

headers — Felder

Feld	Typ	Beschreibung
name	string	Name des HTTP-Headers, etwa Authorization. Regeln: höchstens 128 Zeichen
configured	boolean	Ob ein Headerwert gespeichert ist.

responseMappings — Felder

Feld	Typ	Beschreibung
responsePath	string	Pfad zum Wert in der externen Antwort.
outputKey	string	Name der Kontextvariablen für den zugeordneten Wert.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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.
409	Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.

Pre-Processing-Profile auflisten

GET /api/external/v1/pre-processing/profiles

Scope: pre-processing:read

Parameter

Name	Position	Typ	Pflicht	Beschreibung
page	Query	integer (int32)	Nein	Seitenindex ab 0. Regeln: 0–100000 Standard: 0
size	Query	integer (int32)	Nein	Ergebnisse pro Seite. Regeln: 1–100 Standard: 25

Antwort 200

Erfolgreich.

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

application/json

FelderBeispiel

Feld	Typ	Beschreibung
items	Liste von object	Ergebnisse dieser Seite.
page	integer (int32)	Aktueller Seitenindex, beginnend bei 0.
size	integer (int32)	Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements	integer (int64)	Gesamtzahl der passenden Ergebnisse.
totalPages	integer (int32)	Gesamtzahl der Ergebnisseiten.

items — Felder

Feld	Typ	Beschreibung
id	string (uuid)	Ressourcen-ID in deinem Workspace.
name	string	Anzeigename.
defaultProfile	boolean	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments.
version	integer (int64)	Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden.

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "NuvoCar",
      "defaultProfile": false,
      "scope": "UNASSIGNED",
      "version": 1
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}

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.

Pre-Processing-Profil löschen

DELETE /api/external/v1/pre-processing/profiles/{id}

Scope: pre-processing:write

Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden.

Parameter

Name	Position	Typ	Pflicht	Beschreibung
id	Pfad	string (uuid)	Ja	Ressourcen-ID im gebundenen Workspace.
If-Match	Header	string	Ja	ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen. Beispiel: "revision-from-get"

Antwort 204

Gelöscht; kein Response-Body.

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

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.
404	Ressource im gebundenen Workspace nicht verfügbar.
409	Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.

Pre-Processing-Profil abrufen

GET /api/external/v1/pre-processing/profiles/{id}

Scope: pre-processing:read

Parameter

Name	Position	Typ	Pflicht	Beschreibung
id	Pfad	string (uuid)	Ja	Ressourcen-ID im gebundenen Workspace.

Antwort 200

Erfolgreich.

Header	Typ	Beschreibung
Cache-Control	string	Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store
ETag	string	Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get"

application/json

FelderBeispiel

Feld	Typ	Beschreibung
profile	object	Profilname, Standardeinstellungen und Zuordnungen.
configuration	object	Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.

profile — Felder

Feld	Typ	Beschreibung
id	string (uuid)	Ressourcen-ID in deinem Workspace. Beispiel: "00000000-0000-0000-0000-000000000001"
name	string	Anzeigename.
defaultProfile	boolean	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments.
assignments	Liste von object	Diesem Profil zugeordnete Agents oder Flows. Ohne explizite Zuordnung eine leere Liste senden. Regeln: keine doppelten Einträge
version	integer (int64)	Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden.

assignments — Felder

Feld	Typ	Beschreibung
ownerType	string	Typ der diesem Profil zugeordneten Ressource. Regeln: mindestens 1 Zeichen; Muster AGENT\|FLOW
ownerId	string (uuid)	ID des zugeordneten Agents oder Flows dieses Workspaces.

configuration — Felder

Feld	Typ	Beschreibung
enabled	boolean	Aktiviert diese ausgehende Abfrage oder diesen Webhook.
url	string (uri)	Ziel-URL. Bei einer Änderung gespeicherte Authentifizierung entfernen oder ersetzen. Regeln: höchstens 4096 Zeichen Beispiel: "https://example.com/webhook"
timeoutMs	integer (int64)	Zeitlimit des ausgehenden Aufrufs, in Millisekunden. Regeln: 1–60000 Beispiel: 5000
queryParameters	Liste von object	Query-Parameter des ausgehenden Aufrufs. Unterstützte Template-Variablen stehen im zugehörigen Variablenkatalog. Regeln: höchstens 100 Einträge
headers	Liste von object	HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen. Regeln: höchstens 100 Einträge
responseMode	string	Verarbeitung der Abfrageantwort: vollständig behalten, Felder zuordnen oder Skript ausführen. Regeln: höchstens 64 Zeichen
responseMappings	Liste von object	Ordnet Antwortwerte benannten Ausgabefeldern zu. Regeln: höchstens 100 Einträge
responseScript	string	Skript zur Umformung der externen Antwort. Regeln: höchstens 64000 Zeichen
greetingTemplate	string	Begrüßungsvorlage mit dem Kontext aus dem Pre Processing. Regeln: höchstens 64000 Zeichen
oauthConfigured	boolean	Ob eine ausgehende OAuth-Verknüpfung gespeichert ist.

queryParameters — Felder

Feld	Typ	Beschreibung
key	string	Name der Variablen oder des Parameters.
value	string	Wert oder Vorlage für diesen Parameter.

headers — Felder

Feld	Typ	Beschreibung
name	string	Name des HTTP-Headers, etwa Authorization. Regeln: höchstens 128 Zeichen
configured	boolean	Ob ein Headerwert gespeichert ist.

responseMappings — Felder

Feld	Typ	Beschreibung
responsePath	string	Pfad zum Wert in der externen Antwort.
outputKey	string	Name der Kontextvariablen für den zugeordneten Wert.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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.
404	Ressource im gebundenen Workspace nicht verfügbar.
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.

Pre-Processing-Profil ändern

PUT /api/external/v1/pre-processing/profiles/{id}

Scope: pre-processing:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden. Vollständige bearbeitbare Konfiguration senden. Ausgelassene Einstellungen können zurückgesetzt werden. Bei unveränderter URL behält ein Header ohne Wert sein Secret. Ein aus der Liste entfernter Header wird gelöscht. Bei neuer URL gespeicherte Authentifizierung ausdrücklich entfernen oder ersetzen.

Parameter

Name	Position	Typ	Pflicht	Beschreibung
id	Pfad	string (uuid)	Ja	Ressourcen-ID im gebundenen Workspace.
If-Match	Header	string	Ja	ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen. Beispiel: "revision-from-get"

Request-Body · application/json

FelderBeispiel

Feld	Typ	Pflicht	Beschreibung
profile	object	Ja	Profilname, Standardeinstellungen und Zuordnungen.
configuration	object	Ja	Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.

profile — Felder

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Anzeigename. Regeln: höchstens 120 Zeichen
defaultProfile	boolean	Nein	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Ja	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments. Regeln: Muster ALL\|SELECTED\|UNASSIGNED
assignments	Liste von object	Ja	Diesem Profil zugeordnete Agents oder Flows. Ohne explizite Zuordnung eine leere Liste senden. Regeln: höchstens 1000 Einträge; keine doppelten Einträge
transferFromProfileIds	Liste von string (uuid)	Nein	IDs der Quellprofile für eine ausdrückliche Übernahme von Zuordnungen. Vorher die aktuellen Zuordnungen lesen. Regeln: höchstens 1000 Einträge; keine doppelten Einträge

assignments — Felder

Feld	Typ	Pflicht	Beschreibung
ownerType	string	Ja	Typ der diesem Profil zugeordneten Ressource. Regeln: mindestens 1 Zeichen; Muster AGENT\|FLOW
ownerId	string (uuid)	Ja	ID des zugeordneten Agents oder Flows dieses Workspaces.

configuration — Felder

Feld	Typ	Pflicht	Beschreibung
enabled	boolean	Nein	Aktiviert diese ausgehende Abfrage oder diesen Webhook.
url	string (uri)	Nein	Ziel-URL. Bei einer Änderung gespeicherte Authentifizierung entfernen oder ersetzen. Regeln: höchstens 4096 Zeichen Beispiel: "https://example.com/webhook"
timeoutMs	integer (int64)	Nein	Zeitlimit des ausgehenden Aufrufs, in Millisekunden. Regeln: 1–60000 Beispiel: 5000
queryParameters	Liste von object	Nein	Query-Parameter des ausgehenden Aufrufs. Unterstützte Template-Variablen stehen im zugehörigen Variablenkatalog. Regeln: höchstens 100 Einträge
headers	Liste von object	Nein	HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen. Regeln: höchstens 100 Einträge
responseMode	string	Nein	Verarbeitung der Abfrageantwort: vollständig behalten, Felder zuordnen oder Skript ausführen. Regeln: höchstens 64 Zeichen
responseMappings	Liste von object	Nein	Ordnet Antwortwerte benannten Ausgabefeldern zu. Regeln: höchstens 100 Einträge
responseScript	string	Nein	Skript zur Umformung der externen Antwort. Regeln: höchstens 64000 Zeichen
greetingTemplate	string	Nein	Begrüßungsvorlage mit dem Kontext aus dem Pre Processing. Regeln: höchstens 64000 Zeichen
clearAuthentication	boolean	Nein	true entfernt die gespeicherte OAuth-Verknüpfung. Auslassen oder false behält sie. Regeln: nur schreibbar

queryParameters — Felder

Feld	Typ	Pflicht	Beschreibung
key	string	Nein	Name der Variablen oder des Parameters.
value	string	Nein	Wert oder Vorlage für diesen Parameter.

headers — Felder

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Name des HTTP-Headers, etwa Authorization. Regeln: höchstens 128 Zeichen
value	string	Nein	Neuer Headerwert. Auslassen behält den gespeicherten Wert bei unverändertem Ziel. Regeln: höchstens 8192 Zeichen; nur schreibbar

responseMappings — Felder

Feld	Typ	Pflicht	Beschreibung
responsePath	string	Nein	Pfad zum Wert in der externen Antwort.
outputKey	string	Nein	Name der Kontextvariablen für den zugeordneten Wert.

{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "enabled": false,
    "responseMode": "WHOLE_RESPONSE",
    "headers": []
  }
}

Antwort 200

Erfolgreich.

Header	Typ	Beschreibung
Cache-Control	string	Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store
ETag	string	Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get"

application/json

FelderBeispiel

Feld	Typ	Beschreibung
profile	object	Profilname, Standardeinstellungen und Zuordnungen.
configuration	object	Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.

profile — Felder

Feld	Typ	Beschreibung
id	string (uuid)	Ressourcen-ID in deinem Workspace. Beispiel: "00000000-0000-0000-0000-000000000001"
name	string	Anzeigename.
defaultProfile	boolean	Kennzeichnet ein Standardprofil. Auslassen oder null bedeutet false.
scope	string	Geltungsbereich des Profils. Explizite Agent- oder Flow-Zuordnungen stehen in assignments.
assignments	Liste von object	Diesem Profil zugeordnete Agents oder Flows. Ohne explizite Zuordnung eine leere Liste senden. Regeln: keine doppelten Einträge
version	integer (int64)	Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden.

assignments — Felder

Feld	Typ	Beschreibung
ownerType	string	Typ der diesem Profil zugeordneten Ressource. Regeln: mindestens 1 Zeichen; Muster AGENT\|FLOW
ownerId	string (uuid)	ID des zugeordneten Agents oder Flows dieses Workspaces.

configuration — Felder

Feld	Typ	Beschreibung
enabled	boolean	Aktiviert diese ausgehende Abfrage oder diesen Webhook.
url	string (uri)	Ziel-URL. Bei einer Änderung gespeicherte Authentifizierung entfernen oder ersetzen. Regeln: höchstens 4096 Zeichen Beispiel: "https://example.com/webhook"
timeoutMs	integer (int64)	Zeitlimit des ausgehenden Aufrufs, in Millisekunden. Regeln: 1–60000 Beispiel: 5000
queryParameters	Liste von object	Query-Parameter des ausgehenden Aufrufs. Unterstützte Template-Variablen stehen im zugehörigen Variablenkatalog. Regeln: höchstens 100 Einträge
headers	Liste von object	HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen. Regeln: höchstens 100 Einträge
responseMode	string	Verarbeitung der Abfrageantwort: vollständig behalten, Felder zuordnen oder Skript ausführen. Regeln: höchstens 64 Zeichen
responseMappings	Liste von object	Ordnet Antwortwerte benannten Ausgabefeldern zu. Regeln: höchstens 100 Einträge
responseScript	string	Skript zur Umformung der externen Antwort. Regeln: höchstens 64000 Zeichen
greetingTemplate	string	Begrüßungsvorlage mit dem Kontext aus dem Pre Processing. Regeln: höchstens 64000 Zeichen
oauthConfigured	boolean	Ob eine ausgehende OAuth-Verknüpfung gespeichert ist.

queryParameters — Felder

Feld	Typ	Beschreibung
key	string	Name der Variablen oder des Parameters.
value	string	Wert oder Vorlage für diesen Parameter.

headers — Felder

Feld	Typ	Beschreibung
name	string	Name des HTTP-Headers, etwa Authorization. Regeln: höchstens 128 Zeichen
configured	boolean	Ob ein Headerwert gespeichert ist.

responseMappings — Felder

Feld	Typ	Beschreibung
responsePath	string	Pfad zum Wert in der externen Antwort.
outputKey	string	Name der Kontextvariablen für den zugeordneten Wert.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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.
404	Ressource im gebundenen Workspace nicht verfügbar.
409	Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.

Pre-Processing-Variablen lesen

GET /api/external/v1/pre-processing/variables

Scope: pre-processing:read

Listet unterstützte Variablennamen und Beschreibungen ohne Anrufdaten auf.

Antwort 200

Erfolgreich.

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

application/json

FelderBeispiel

Feld	Typ	Beschreibung
key	string	Name der Variablen oder des Parameters.
description	string	Bedeutung dieser Variablen.

[]

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.