Llistar fluxos

GET

organizations

{organization_id}

flows

Llistar fluxos

curl --request GET \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_next": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "session",
      "detection_only": true,
      "cooldown_minutes": 123,
      "enabled": true
    }
  ]
}

{
  "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 d'idioma per a camps de text que admeten múltiples idiomes. En crear o actualitzar recursos, especifica l'idioma dels valors de text proporcionats. En recuperar recursos, determina quina variant d'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). Usa 'es-ES' per defecte 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}$

Paràmetres de consulta

page

integer

predeterminat:1

Número de pàgina (predeterminat: 1)

sort

string

Camp d'ordenació amb sufix d'ordre opcional (:asc o :desc), p. ex., "name", "name:asc", "cooldown_minutes:desc". Usa ordre ascendent per defecte si no es proporciona sufix. Camps d'ordenació vàlids: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text

fields

string

Llista separada per comes de camps que s'inclouran en cada element de flux. Camps seleccionables: id, name, description, type, detection_only, cooldown_minutes, enabled. El camp id sempre s'inclou.

Maximum string length: 2048

filters

string

Filtra fluxos per un o més criteris. Proporciona un objecte JSON amb condicions de filtre. Pots filtrar per: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text. Usa operadors de comparació (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) i combina múltiples condicions amb operadors lògics (and, or). Longitud màxima: 5120 caràcters.

Maximum string length: 5120

Pattern: ^.*$

per_page

integer

predeterminat:100

Número d'elements per pàgina

Rang requerit: 1 <= x <= 100

Resposta

Llista paginada de fluxos recuperada correctament. La resposta inclou metadats de paginació i l'arranjament de dades de fluxos.

has_next

boolean

requerit

data

object[]

requerit

Show child attributes

⌘I

Llistar fluxos

curl --request GET \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_next": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "session",
      "detection_only": true,
      "cooldown_minutes": 123,
      "enabled": true
    }
  ]
}

{
  "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>"
  }
}

API Gen 2

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Autoritzacions

Capçaleres

Paràmetres de ruta

Paràmetres de consulta

Resposta