Pular para o conteúdo principal
POST
/
v1
/
organizations
/
{organization_id}
/
flows
Criar um fluxo
curl --request POST \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "en-EN": "Daily Backup Flow",
    "es-ES": "Proceso de copia diaria"
  },
  "description": {
    "en-EN": "Automated daily backup process",
    "es-ES": "Proceso automatizado de copia de seguridad diaria"
  },
  "type": "workspace",
  "detection_only": false,
  "cooldown_minutes": 60,
  "enabled": false,
  "init_text": {
    "en-EN": "Starting backup process...",
    "es-ES": "Iniciando proceso de copia..."
  },
  "ok_text": {
    "en-EN": "Backup completed successfully",
    "es-ES": "Copia completada correctamente"
  },
  "ko_text": {
    "en-EN": "Backup failed. Please check logs.",
    "es-ES": "Copia fallida. Revise los registros."
  },
  "target": {
    "type": "workspaces",
    "ids": [
      "507f1f77bcf86cd799439012",
      "507f1f77bcf86cd799439013"
    ]
  },
  "microservice_id": "507f1f77bcf86cd799439014",
  "conditions": [
    {
      "condition_type_id": "507f1f77bcf86cd799439015",
      "operator": "gt",
      "compare_to": "80",
      "check_every": 300
    }
  ]
}
'
import requests

url = "https://api.flexxible.net/v1/organizations/{organization_id}/flows"

payload = {
    "name": {
        "en-EN": "Daily Backup Flow",
        "es-ES": "Proceso de copia diaria"
    },
    "description": {
        "en-EN": "Automated daily backup process",
        "es-ES": "Proceso automatizado de copia de seguridad diaria"
    },
    "type": "workspace",
    "detection_only": False,
    "cooldown_minutes": 60,
    "enabled": False,
    "init_text": {
        "en-EN": "Starting backup process...",
        "es-ES": "Iniciando proceso de copia..."
    },
    "ok_text": {
        "en-EN": "Backup completed successfully",
        "es-ES": "Copia completada correctamente"
    },
    "ko_text": {
        "en-EN": "Backup failed. Please check logs.",
        "es-ES": "Copia fallida. Revise los registros."
    },
    "target": {
        "type": "workspaces",
        "ids": ["507f1f77bcf86cd799439012", "507f1f77bcf86cd799439013"]
    },
    "microservice_id": "507f1f77bcf86cd799439014",
    "conditions": [
        {
            "condition_type_id": "507f1f77bcf86cd799439015",
            "operator": "gt",
            "compare_to": "80",
            "check_every": 300
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {'en-EN': 'Daily Backup Flow', 'es-ES': 'Proceso de copia diaria'},
    description: {
      'en-EN': 'Automated daily backup process',
      'es-ES': 'Proceso automatizado de copia de seguridad diaria'
    },
    type: 'workspace',
    detection_only: false,
    cooldown_minutes: 60,
    enabled: false,
    init_text: {
      'en-EN': 'Starting backup process...',
      'es-ES': 'Iniciando proceso de copia...'
    },
    ok_text: {
      'en-EN': 'Backup completed successfully',
      'es-ES': 'Copia completada correctamente'
    },
    ko_text: {
      'en-EN': 'Backup failed. Please check logs.',
      'es-ES': 'Copia fallida. Revise los registros.'
    },
    target: {
      type: 'workspaces',
      ids: ['507f1f77bcf86cd799439012', '507f1f77bcf86cd799439013']
    },
    microservice_id: '507f1f77bcf86cd799439014',
    conditions: [
      {
        condition_type_id: '507f1f77bcf86cd799439015',
        operator: 'gt',
        compare_to: '80',
        check_every: 300
      }
    ]
  })
};

fetch('https://api.flexxible.net/v1/organizations/{organization_id}/flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flexxible.net/v1/organizations/{organization_id}/flows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'en-EN' => 'Daily Backup Flow',
        'es-ES' => 'Proceso de copia diaria'
    ],
    'description' => [
        'en-EN' => 'Automated daily backup process',
        'es-ES' => 'Proceso automatizado de copia de seguridad diaria'
    ],
    'type' => 'workspace',
    'detection_only' => false,
    'cooldown_minutes' => 60,
    'enabled' => false,
    'init_text' => [
        'en-EN' => 'Starting backup process...',
        'es-ES' => 'Iniciando proceso de copia...'
    ],
    'ok_text' => [
        'en-EN' => 'Backup completed successfully',
        'es-ES' => 'Copia completada correctamente'
    ],
    'ko_text' => [
        'en-EN' => 'Backup failed. Please check logs.',
        'es-ES' => 'Copia fallida. Revise los registros.'
    ],
    'target' => [
        'type' => 'workspaces',
        'ids' => [
                '507f1f77bcf86cd799439012',
                '507f1f77bcf86cd799439013'
        ]
    ],
    'microservice_id' => '507f1f77bcf86cd799439014',
    'conditions' => [
        [
                'condition_type_id' => '507f1f77bcf86cd799439015',
                'operator' => 'gt',
                'compare_to' => '80',
                'check_every' => 300
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flexxible.net/v1/organizations/{organization_id}/flows"

	payload := strings.NewReader("{\n  \"name\": {\n    \"en-EN\": \"Daily Backup Flow\",\n    \"es-ES\": \"Proceso de copia diaria\"\n  },\n  \"description\": {\n    \"en-EN\": \"Automated daily backup process\",\n    \"es-ES\": \"Proceso automatizado de copia de seguridad diaria\"\n  },\n  \"type\": \"workspace\",\n  \"detection_only\": false,\n  \"cooldown_minutes\": 60,\n  \"enabled\": false,\n  \"init_text\": {\n    \"en-EN\": \"Starting backup process...\",\n    \"es-ES\": \"Iniciando proceso de copia...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Backup completed successfully\",\n    \"es-ES\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"Backup failed. Please check logs.\",\n    \"es-ES\": \"Copia fallida. Revise los registros.\"\n  },\n  \"target\": {\n    \"type\": \"workspaces\",\n    \"ids\": [\n      \"507f1f77bcf86cd799439012\",\n      \"507f1f77bcf86cd799439013\"\n    ]\n  },\n  \"microservice_id\": \"507f1f77bcf86cd799439014\",\n  \"conditions\": [\n    {\n      \"condition_type_id\": \"507f1f77bcf86cd799439015\",\n      \"operator\": \"gt\",\n      \"compare_to\": \"80\",\n      \"check_every\": 300\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.flexxible.net/v1/organizations/{organization_id}/flows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"en-EN\": \"Daily Backup Flow\",\n    \"es-ES\": \"Proceso de copia diaria\"\n  },\n  \"description\": {\n    \"en-EN\": \"Automated daily backup process\",\n    \"es-ES\": \"Proceso automatizado de copia de seguridad diaria\"\n  },\n  \"type\": \"workspace\",\n  \"detection_only\": false,\n  \"cooldown_minutes\": 60,\n  \"enabled\": false,\n  \"init_text\": {\n    \"en-EN\": \"Starting backup process...\",\n    \"es-ES\": \"Iniciando proceso de copia...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Backup completed successfully\",\n    \"es-ES\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"Backup failed. Please check logs.\",\n    \"es-ES\": \"Copia fallida. Revise los registros.\"\n  },\n  \"target\": {\n    \"type\": \"workspaces\",\n    \"ids\": [\n      \"507f1f77bcf86cd799439012\",\n      \"507f1f77bcf86cd799439013\"\n    ]\n  },\n  \"microservice_id\": \"507f1f77bcf86cd799439014\",\n  \"conditions\": [\n    {\n      \"condition_type_id\": \"507f1f77bcf86cd799439015\",\n      \"operator\": \"gt\",\n      \"compare_to\": \"80\",\n      \"check_every\": 300\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v1/organizations/{organization_id}/flows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"en-EN\": \"Daily Backup Flow\",\n    \"es-ES\": \"Proceso de copia diaria\"\n  },\n  \"description\": {\n    \"en-EN\": \"Automated daily backup process\",\n    \"es-ES\": \"Proceso automatizado de copia de seguridad diaria\"\n  },\n  \"type\": \"workspace\",\n  \"detection_only\": false,\n  \"cooldown_minutes\": 60,\n  \"enabled\": false,\n  \"init_text\": {\n    \"en-EN\": \"Starting backup process...\",\n    \"es-ES\": \"Iniciando proceso de copia...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Backup completed successfully\",\n    \"es-ES\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"Backup failed. Please check logs.\",\n    \"es-ES\": \"Copia fallida. Revise los registros.\"\n  },\n  \"target\": {\n    \"type\": \"workspaces\",\n    \"ids\": [\n      \"507f1f77bcf86cd799439012\",\n      \"507f1f77bcf86cd799439013\"\n    ]\n  },\n  \"microservice_id\": \"507f1f77bcf86cd799439014\",\n  \"conditions\": [\n    {\n      \"condition_type_id\": \"507f1f77bcf86cd799439015\",\n      \"operator\": \"gt\",\n      \"compare_to\": \"80\",\n      \"check_every\": 300\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "507f1f77bcf86cd799439011"
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

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 por GET flow por id. A organização é implícita pelo caminho /v1/organizations/{organization_id}/flows/{flow_id}. Os workspaces/grupos alvo são normalizados em target.ids (cadenas 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