Skip to main content
POST
Criar um fluxo

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Accept-Language
enum<string>
padrão:es-ES

Código de idioma para campos de texto que suportam vários idiomas. Ao criar ou atualizar recursos, isso especifica o idioma dos valores de texto fornecidos. Ao recuperar recursos, isso determina qual variante de idioma dos campos de texto multilíngues será retornada. Valores aceitos: 'en-EN' (inglês), 'es-ES' (espanhol), 'pt-BR' (português), 'ca-ES' (catalão), 'eu-ES' (basco). O valor padrão é 'es-ES' se não for fornecido.

Opções disponíveis:
en-EN,
es-ES,
pt-BR,
ca-ES,
eu-ES

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da organização

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

Corpo

application/json
name
object
obrigatório

Nome do fluxo. É necessário pelo menos uma chave de idioma; cada valor deve ter entre 1 e 512 caracteres.

description
object
obrigatório

Descrição do fluxo. É necessário pelo menos uma chave de idioma; cada valor deve ter entre 1 e 512 caracteres.

type
enum<string>
obrigatório
Opções disponíveis:
session,
workspace
detection_only
boolean
obrigatório
cooldown_minutes
number
obrigatório

Tempo de espera em minutos. Deve estar entre 10 e 1440.

Intervalo obrigatório: 10 <= x <= 1440
target
object
obrigatório
microservice_id
string
obrigatório
Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
conditions
object[]
obrigatório
enabled
boolean
padrão:false

Se for verdadeiro, o fluxo é habilitado após a sua criação (requer condições, microserviço e objetivo válidos). Se omitido ou falso, um fluxo desabilitado é criado.

init_text
object

Mensagem de texto inicial. Omitido se não for necessário. Quando fornecido, é necessário pelo menos uma chave de idioma; cada valor deve ter entre 1 e 512 caracteres.

ok_text
object

Mensagem de texto de sucesso. Omitido se não for necessário. Quando fornecido, é necessário pelo menos uma chave de idioma; cada valor deve ter entre 1 e 512 caracteres.

ko_text
object

Mensagem de texto de erro. Omitido se não for necessário. Quando fornecido, é necessário pelo menos uma chave de idioma; cada valor deve ter entre 1 e 512 caracteres.

Resposta

Fluxo criado corretamente. A resposta contém o recurso criado.

Detalhe do fluxo como retornado pelo GET flow por id. A organização é implícita pela rota /v2/organizations/{organization_id}/flows/{flow_id}. Os workspaces/grupos de destino são normalizados em target.ids (cadeias hexadecimais de ObjectId de MongoDB).

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

Resolvido para Accept-Language quando é multilíngue

description
string
obrigatório

Resolvido para Accept-Language quando é multilíngue

type
enum<string>
obrigatório
Opções disponíveis:
session,
workspace
version
number
obrigatório
detection_only
boolean
obrigatório
cooldown_minutes
number
obrigatório

Tempo de espera em minutos

enabled
boolean
obrigatório
target
object
obrigatório

Destino de execução: type seleciona o escopo; ids lista valores de _id de Workspace, _id de grupo de Workspace ou _id de Grupo de relatório (vazio quando type é ALL_WORKSPACES)

conditions
object[]

Omitido ou vazio quando o fluxo não tem condições

trigger
string | null
microservice_id
string | null

ID do microserviço vinculado quando presente

init_text
string | null

Resolvido para Accept-Language quando é multilíngue

ok_text
string | null

Resolvido para Accept-Language quando é multilíngue

ko_text
string | null

Resolvido para Accept-Language quando é multilíngue

execution_metrics
object | null

Presente quando métricas foram calculadas para este fluxo