Saltar al contingut principal
PUT
/
v1
/
organizations
/
{organization_id}
/
flows
/
{flow_id}
Actualitzar un flux
curl --request PUT \
  --url https://api.flexxible.net/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.flexxible.net/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.flexxible.net/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.flexxible.net/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.flexxible.net/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.flexxible.net/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.flexxible.net/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>"
  }
}

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}$
​
flow_id
string
requerit

L'identificador únic del flux a actualitzar

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

Cos

application/json
​
name
object
requerit

Nom del flux. Es requereix almenys una clau d'idioma; cada valor entre 1 i 512 caràcters.

​
description
object
requerit

Descripció del flux. Es requereix almenys una clau d'idioma; cada valor entre 1 i 512 caràcters.

​
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
​
enabled
boolean
requerit

Indica si el flux està habilitat. PUT espera una definició completa; aquest camp és obligatori.

​
init_text
object | null
requerit

Missatge de text inicial. Obligatori en PUT. Envia null per netejar; en cas contrari, objecte amb almenys una clau d'idioma; cada valor entre 1 i 512 caràcters.

​
ok_text
object | null
requerit

Missatge de text d'èxit. Obligatori en PUT. Envia null per netejar; en cas contrari, objecte amb almenys una clau d'idioma; cada valor entre 1 i 512 caràcters.

​
ko_text
object | null
requerit

Missatge de text d'error. Obligatori en PUT. Envia null per netejar; en cas contrari, objecte amb almenys una clau d'idioma; cada valor entre 1 i 512 caràcters.

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

Resposta

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

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