Applications

Créer un flux de données

Déclare un flux de données sur l'application. `sourceId` ou `targetId` doit être l'application du chemin — la requête est rejetée par un 400 sinon.

Scope requis applications:edit

post/applications/{id}/flows

Authentification

Authorizationstringobligatoire

En-tête Authorization portant une clé d'API de l'espace de travail, sous la forme « Bearer kbn_live_… ». L'en-tête X-Api-Key est accepté de façon équivalente.

Paramètres de chemin

idstring<uuid>obligatoire

Identifiant de l'application. Elle doit appartenir à l'espace de travail auquel la clé est liée.

Corps de la requêteapplication/json

sourceIdstring<uuid>

Application émettrice du flux.

targetIdstring<uuid>

Application réceptrice du flux.

dataIdsstring<uuid>[]

Objets de données portés par le flux.

commentstring

Note libre.

protocolstring

Protocole de transport qui porte le flux.

formatstring

Format de la charge utile échangée.

exchangeFrequencystring

Fréquence à laquelle l'échange a lieu.

portTypestring

Type de port utilisé.

portinteger

Port réseau utilisé.

encryptedboolean

Indique si le flux est chiffré en transit.

documentIdsstring<uuid>[]

Documents attachés.

middlewaresobject[]

Middlewares traversés par le flux, dans l'ordre.

Réponse201 · application/json

Le flux a été créé.

idstring<uuid>obligatoire

Identifiant unique du flux de données.

commentstring | null

Note libre décrivant le flux.

protocolstring | null

Protocole de transport qui porte le flux.

formatstring | null

Format de la charge utile échangée.

exchangeFrequencystring | null

Fréquence à laquelle l'échange a lieu.

portTypestring | null

Type de port utilisé.

portinteger | null

Port réseau utilisé par le flux.

encryptedboolean | null

Indique si le flux est chiffré en transit.

sourceobjectobligatoire

Référence compacte vers un autre objet : son identifiant et son nom d'affichage.

targetobjectobligatoire

Référence compacte vers un autre objet : son identifiant et son nom d'affichage.

dataCountinteger

Nombre d'objets de données portés par le flux.

documentCountinteger

Nombre de documents attachés au flux.

middlewareCountinteger

Nombre de middlewares traversés par le flux.