Anwendungen

Datenfluss aktualisieren

Teilaktualisierung: Nur die im Body vorhandenen Felder werden angewendet.

Erforderlicher Scope applications:edit

patch/applications/{id}/flows/{flowId}

Authentifizierung

Authorizationstringerforderlich

Authorization-Header mit einem API-Schlüssel des Workspace, in der Form „Bearer kbn_live_…“. Der Header X-Api-Key wird gleichwertig akzeptiert.

Pfadparameter

idstring<uuid>erforderlich

Kennung der Anwendung. Sie muss zu dem Workspace gehören, an den der Schlüssel gebunden ist.

flowIdstring<uuid>erforderlich

Kennung des Datenflusses.

Anfragekörperapplication/json

sourceIdstring<uuid>

Anwendung, von der der Fluss ausgeht.

targetIdstring<uuid>

Anwendung, an die der Fluss geliefert wird.

dataIdsstring<uuid>[]

Vom Fluss transportierte Datenobjekte.

commentstring

Freie Notiz.

protocolstring

Transportprotokoll, das den Fluss trägt.

formatstring

Format der ausgetauschten Nutzdaten.

exchangeFrequencystring

Häufigkeit, mit der der Austausch stattfindet.

portTypestring

Art des verwendeten Ports.

portinteger

Verwendeter Netzwerkport.

encryptedboolean

Gibt an, ob der Fluss während der Übertragung verschlüsselt ist.

documentIdsstring<uuid>[]

Zugeordnete Dokumente.

middlewaresobject[]

Vom Fluss durchlaufene Middlewares, in Reihenfolge.

Antwort200 · application/json

Der aktualisierte Datenfluss.

idstring<uuid>erforderlich

Eindeutige Kennung des Datenflusses.

commentstring | null

Freie Notiz zur Beschreibung des Flusses.

protocolstring | null

Transportprotokoll, das den Fluss trägt.

formatstring | null

Format der ausgetauschten Nutzdaten.

exchangeFrequencystring | null

Häufigkeit, mit der der Austausch stattfindet.

portTypestring | null

Art des verwendeten Ports.

portinteger | null

Vom Fluss verwendeter Netzwerkport.

encryptedboolean | null

Gibt an, ob der Fluss während der Übertragung verschlüsselt ist.

sourceobjecterforderlich

Kompakter Verweis auf ein anderes Objekt: Kennung und Anzeigename.

targetobjecterforderlich

Kompakter Verweis auf ein anderes Objekt: Kennung und Anzeigename.

dataCountinteger

Anzahl der vom Fluss transportierten Datenobjekte.

documentCountinteger

Anzahl der dem Fluss zugeordneten Dokumente.

middlewareCountinteger

Anzahl der vom Fluss durchlaufenen Middlewares.