Skip to main content
POST
Crea un flux

Autoritzacions

Authorization
string
header
requerit

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Capçaleres

Accept-Language
enum<string>
predeterminat:es-ES

Codi de idioma per a camps de text que admeten diversos idiomes. Al crear o actualitzar recursos, això especifica el idioma dels valors de text proporcionats. Al recuperar recursos, això determina quina variant de idioma dels camps de text multilingües es retorna. Valors acceptats: 'en-EN' (anglès), 'es-ES' (espanyol), 'pt-BR' (portuguès), 'ca-ES' (català), 'eu-ES' (euskera). El valor predeterminat és 'es-ES' si no es proporciona.

Opcions disponibles:
en-EN,
es-ES,
pt-BR,
ca-ES,
eu-ES

Paràmetres de ruta

organization_id
string
requerit

El identificador únic de l'organització

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Cos

application/json
name
object
requerit

Nom del flux. Es requereix com a mínim una clau de idioma; cada valor ha de tenir entre 1 i 512 caràcters.

description
object
requerit

Descripció del flux. Es requereix com a mínim una clau de idioma; cada valor ha de tenir entre 1 i 512 caràcters.

type
enum<string>
requerit
Opcions disponibles:
session,
workspace
detection_only
boolean
requerit
cooldown_minutes
number
requerit

Temps d'espera en minuts. Ha d'estar entre 10 i 1440.

Rang requerit: 10 <= x <= 1440
target
object
requerit
microservice_id
string
requerit
Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
conditions
object[]
requerit
enabled
boolean
predeterminat:false

Si és cert, el flux queda habilitat després de la seva creació (requereix condicions, microservei i objectiu vàlids). Si se s'omete o és fals, es crea un flux deshabilitat.

init_text
object

Missatge de text inicial. Se s'omete si no és necessari. Quan es proporciona, es requereix com a mínim una clau de idioma; cada valor ha de tenir entre 1 i 512 caràcters.

ok_text
object

Missatge de text d'èxit. Se s'omete si no és necessari. Quan es proporciona, es requereix com a mínim una clau de idioma; cada valor ha de tenir entre 1 i 512 caràcters.

ko_text
object

Missatge de text d'error. Se s'omete si no és necessari. Quan es proporciona, es requereix com a mínim una clau de idioma; cada valor ha de tenir entre 1 i 512 caràcters.

Resposta

Flux creat correctament. La resposta conté el recurs creat.

Detall del flux tal com el retorna GET flow by id. L'organització està implícita per la ruta /v1/organizations/{organization_id}/flows/{flow_id}. Els workspaces/grups de destinació es normalitzen en target.ids (cadenes hexadecimals de ObjectId de MongoDB).

id
string
requerit
Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
created_at
string<date-time>
requerit
name
string
requerit

Resol per Accept-Language quan és multilingüe

description
string
requerit

Resol per Accept-Language quan és multilingüe

type
enum<string>
requerit
Opcions disponibles:
session,
workspace
version
number
requerit
detection_only
boolean
requerit
cooldown_minutes
number
requerit

Temps d'espera en minuts

enabled
boolean
requerit
target
object
requerit

Destí d'execució: el tipus selecciona l'abast; ids enumera valors de _id de Workspace, _id de grup de Workspace o _id de Grup de reporte (buit quan el tipus és ALL_WORKSPACES)

conditions
object[]

Omitit o buit quan el flux no té condicions

trigger
string | null
microservice_id
string | null

ID del microservei vinculat quan està present

init_text
string | null

Resol per Accept-Language quan és multilingüe

ok_text
string | null

Resol per Accept-Language quan és multilingüe

ko_text
string | null

Resol per Accept-Language quan és multilingüe

execution_metrics
object | null

Present quan es van calcular mètriques per a aquest flux