Saltar al contenido principal
PUT
/
v1
/
organizations
/
{organization_id}
/
flows
/
{flow_id}
Actualizar un flujo
curl --request PUT \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "en-EN": "Flujo diario de copia actualizado",
    "es-ES": "Proceso de copia diaria actualizado"
  },
  "description": {
    "en-EN": "Proceso automatizado de copia diaria actualizado",
    "es-ES": "Proceso automatizado de copia actualizado"
  },
  "detection_only": false,
  "cooldown_minutes": 120,
  "enabled": true,
  "init_text": {
    "en-EN": "Iniciando proceso de copia actualizado...",
    "es-ES": "Iniciando proceso de copia actualizado..."
  },
  "ok_text": {
    "en-EN": "Copia completada correctamente"
  },
  "ko_text": {
    "en-EN": "La copia fallo. Por favor, revisa los registros."
  },
  "target": {
    "type": "workspaces",
    "ids": [
      "507f1f77bcf86cd799439012",
      "507f1f77bcf86cd799439013"
    ]
  },
  "microservice_id": "507f1f77bcf86cd799439014",
  "conditions": [
    {
      "condition_type_id": "507f1f77bcf86cd799439015",
      "operator": "gte",
      "compare_to": "90",
      "period": null,
      "check_every": 600
    }
  ]
}
'
import requests

url = "https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}"

payload = {
    "name": {
        "en-EN": "Flujo diario de copia actualizado",
        "es-ES": "Proceso de copia diaria actualizado"
    },
    "description": {
        "en-EN": "Proceso automatizado de copia diaria actualizado",
        "es-ES": "Proceso automatizado de copia actualizado"
    },
    "detection_only": False,
    "cooldown_minutes": 120,
    "enabled": True,
    "init_text": {
        "en-EN": "Iniciando proceso de copia actualizado...",
        "es-ES": "Iniciando proceso de copia actualizado..."
    },
    "ok_text": { "en-EN": "Copia completada correctamente" },
    "ko_text": { "en-EN": "La copia fallo. Por favor, revisa los registros." },
    "target": {
        "type": "workspaces",
        "ids": ["507f1f77bcf86cd799439012", "507f1f77bcf86cd799439013"]
    },
    "microservice_id": "507f1f77bcf86cd799439014",
    "conditions": [
        {
            "condition_type_id": "507f1f77bcf86cd799439015",
            "operator": "gte",
            "compare_to": "90",
            "period": None,
            "check_every": 600
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {
      'en-EN': 'Flujo diario de copia actualizado',
      'es-ES': 'Proceso de copia diaria actualizado'
    },
    description: {
      'en-EN': 'Proceso automatizado de copia diaria actualizado',
      'es-ES': 'Proceso automatizado de copia actualizado'
    },
    detection_only: false,
    cooldown_minutes: 120,
    enabled: true,
    init_text: {
      'en-EN': 'Iniciando proceso de copia actualizado...',
      'es-ES': 'Iniciando proceso de copia actualizado...'
    },
    ok_text: {'en-EN': 'Copia completada correctamente'},
    ko_text: {'en-EN': 'La copia fallo. Por favor, revisa los registros.'},
    target: {
      type: 'workspaces',
      ids: ['507f1f77bcf86cd799439012', '507f1f77bcf86cd799439013']
    },
    microservice_id: '507f1f77bcf86cd799439014',
    conditions: [
      {
        condition_type_id: '507f1f77bcf86cd799439015',
        operator: 'gte',
        compare_to: '90',
        period: null,
        check_every: 600
      }
    ]
  })
};

fetch('https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}', 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.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'en-EN' => 'Flujo diario de copia actualizado',
        'es-ES' => 'Proceso de copia diaria actualizado'
    ],
    'description' => [
        'en-EN' => 'Proceso automatizado de copia diaria actualizado',
        'es-ES' => 'Proceso automatizado de copia actualizado'
    ],
    'detection_only' => false,
    'cooldown_minutes' => 120,
    'enabled' => true,
    'init_text' => [
        'en-EN' => 'Iniciando proceso de copia actualizado...',
        'es-ES' => 'Iniciando proceso de copia actualizado...'
    ],
    'ok_text' => [
        'en-EN' => 'Copia completada correctamente'
    ],
    'ko_text' => [
        'en-EN' => 'La copia fallo. Por favor, revisa los registros.'
    ],
    'target' => [
        'type' => 'workspaces',
        'ids' => [
                '507f1f77bcf86cd799439012',
                '507f1f77bcf86cd799439013'
        ]
    ],
    'microservice_id' => '507f1f77bcf86cd799439014',
    'conditions' => [
        [
                'condition_type_id' => '507f1f77bcf86cd799439015',
                'operator' => 'gte',
                'compare_to' => '90',
                'period' => null,
                'check_every' => 600
        ]
    ]
  ]),
  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.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}"

	payload := strings.NewReader("{\n  \"name\": {\n    \"en-EN\": \"Flujo diario de copia actualizado\",\n    \"es-ES\": \"Proceso de copia diaria actualizado\"\n  },\n  \"description\": {\n    \"en-EN\": \"Proceso automatizado de copia diaria actualizado\",\n    \"es-ES\": \"Proceso automatizado de copia actualizado\"\n  },\n  \"detection_only\": false,\n  \"cooldown_minutes\": 120,\n  \"enabled\": true,\n  \"init_text\": {\n    \"en-EN\": \"Iniciando proceso de copia actualizado...\",\n    \"es-ES\": \"Iniciando proceso de copia actualizado...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"La copia fallo. Por favor, revisa 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\": \"gte\",\n      \"compare_to\": \"90\",\n      \"period\": null,\n      \"check_every\": 600\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"en-EN\": \"Flujo diario de copia actualizado\",\n    \"es-ES\": \"Proceso de copia diaria actualizado\"\n  },\n  \"description\": {\n    \"en-EN\": \"Proceso automatizado de copia diaria actualizado\",\n    \"es-ES\": \"Proceso automatizado de copia actualizado\"\n  },\n  \"detection_only\": false,\n  \"cooldown_minutes\": 120,\n  \"enabled\": true,\n  \"init_text\": {\n    \"en-EN\": \"Iniciando proceso de copia actualizado...\",\n    \"es-ES\": \"Iniciando proceso de copia actualizado...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"La copia fallo. Por favor, revisa 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\": \"gte\",\n      \"compare_to\": \"90\",\n      \"period\": null,\n      \"check_every\": 600\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows/{flow_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"en-EN\": \"Flujo diario de copia actualizado\",\n    \"es-ES\": \"Proceso de copia diaria actualizado\"\n  },\n  \"description\": {\n    \"en-EN\": \"Proceso automatizado de copia diaria actualizado\",\n    \"es-ES\": \"Proceso automatizado de copia actualizado\"\n  },\n  \"detection_only\": false,\n  \"cooldown_minutes\": 120,\n  \"enabled\": true,\n  \"init_text\": {\n    \"en-EN\": \"Iniciando proceso de copia actualizado...\",\n    \"es-ES\": \"Iniciando proceso de copia actualizado...\"\n  },\n  \"ok_text\": {\n    \"en-EN\": \"Copia completada correctamente\"\n  },\n  \"ko_text\": {\n    \"en-EN\": \"La copia fallo. Por favor, revisa 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\": \"gte\",\n      \"compare_to\": \"90\",\n      \"period\": null,\n      \"check_every\": 600\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "version": 123,
  "detection_only": true,
  "cooldown_minutes": 123,
  "enabled": true,
  "target": {
    "ids": [
      "<string>"
    ]
  },
  "conditions": [
    {
      "condition_type_id": "<string>",
      "metric": "<string>",
      "operator": "<string>",
      "compare_to": "<string>",
      "check_every": 123,
      "period": 123
    }
  ],
  "trigger": "<string>",
  "microservice_id": "<string>",
  "init_text": "<string>",
  "ok_text": "<string>",
  "ko_text": "<string>",
  "execution_metrics": {
    "targeted_workspaces": 123,
    "evaluations_per_day": 123,
    "possible_executions_per_day": 123,
    "total_possible_executions_per_day": 123
  }
}
{
  "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>"
  }
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
Accept-Language
enum<string>
predeterminado:es-ES

Código de idioma para campos de texto que admiten varios idiomas. Al crear o actualizar recursos, esto especifica el idioma de los valores de texto proporcionados. Al recuperar recursos, esto determina qué variante de idioma de los campos de texto multilingües se devuelve. Valores aceptados: 'en-EN' (inglés), 'es-ES' (español), 'pt-BR' (portugués), 'ca-ES' (catalán), 'eu-ES' (euskera). El valor predeterminado es 'es-ES' si no se proporciona.

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

Parámetros de ruta

​
organization_id
string
requerido

El identificador único de la organización

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

El identificador único del flujo a actualizar

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

Cuerpo

application/json
​
name
object
requerido

Nombre del flujo. Se requiere al menos una clave de idioma; cada valor entre 1 y 512 caracteres.

​
description
object
requerido

Descripción del flujo. Se requiere al menos una clave de idioma; cada valor entre 1 y 512 caracteres.

​
detection_only
boolean
requerido
​
cooldown_minutes
number
requerido

Tiempo de espera en minutos. Debe estar entre 10 y 1440.

Rango requerido: 10 <= x <= 1440
​
enabled
boolean
requerido

Indica si el flujo está habilitado. PUT espera una definición completa; este campo es obligatorio.

​
init_text
object | null
requerido

Mensaje de texto inicial. Obligatorio en PUT. Envia null para limpiar; en caso contrario, objeto con al menos una clave de idioma; cada valor entre 1 y 512 caracteres.

​
ok_text
object | null
requerido

Mensaje de texto de éxito. Obligatorio en PUT. Envia null para limpiar; en caso contrario, objeto con al menos una clave de idioma; cada valor entre 1 y 512 caracteres.

​
ko_text
object | null
requerido

Mensaje de texto de error. Obligatorio en PUT. Envia null para limpiar; en caso contrario, objeto con al menos una clave de idioma; cada valor entre 1 y 512 caracteres.

​
target
object
requerido
​
microservice_id
string
requerido
Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
​
conditions
object[]
requerido

Respuesta

Flujo actualizado correctamente. La respuesta contiene el recurso actualizado.

Detalle del flujo tal como lo devuelve GET flow by id. La organización está implícita por la ruta /v1/organizations/{organization_id}/flows/{flow_id}. Los workspaces/grupos de destino se normalizan en target.ids (cadenas hexadecimales de ObjectId de MongoDB).

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

Resuelto para Accept-Language cuando es multilingüe

​
description
string
requerido

Resuelto para Accept-Language cuando es multilingüe

​
type
enum<string>
requerido
Opciones disponibles:
session,
workspace
​
version
number
requerido
​
detection_only
boolean
requerido
​
cooldown_minutes
number
requerido

Tiempo de espera en minutos

​
enabled
boolean
requerido
​
target
object
requerido

Destino de ejecución: type selecciona el alcance; ids enumera valores de _id de Workspace, _id de grupo de Workspace o _id de Grupo de reporte (vacío cuando type es ALL_WORKSPACES)

​
conditions
object[]

Omitido o vacío cuando el flujo no tiene condiciones

​
trigger
string | null
​
microservice_id
string | null

ID del microservicio vinculado cuando está presente

​
init_text
string | null

Resuelto para Accept-Language cuando es multilingüe

​
ok_text
string | null

Resuelto para Accept-Language cuando es multilingüe

​
ko_text
string | null

Resuelto para Accept-Language cuando es multilingüe

​
execution_metrics
object | null

Presente cuando se calcularon métricas para este flujo