Operações

Criar operações

Cria uma ou várias operações com base no escopo e objetivos enviados.

Tipos de operação atualmente disponíveis: execute_microservice, delete_workspaces, shutdown_workspaces e restart_workspaces.

Retorna os recursos de operação criados com o mesmo contrato canônico de consulta por id.

Compatibilidade de parâmetros para execute_microservice

payload.parameters só se aplica a execuções de microsserviços PowerShell no Windows e é suportado apenas em dispositivos com o novo agente instalado.

Os valores enviados em payload.parameters são transmitidos como texto (string). A interpretação de tipos depende da definição de parâmetros e do parser implementado no script do microsserviço.

Para esse contexto, tipos de dados de parâmetros recomendados:

string, integer, double, decimal e datetime.
Para double e decimal, use a notação com ponto decimal (.).
Para datetime, use o formato ISO 8601 (por exemplo: 2026-07-09T10:30:00Z).
Ao ser executado no destino, os valores datetime podem ser representados em hora local.
A execução correta também depende da qualidade e validações do script.

POST

organizations

{organization_id}

operations

Criar operações

curl --request POST \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": {
    "ids": [
      "<string>"
    ]
  },
  "expiration_in_seconds": 42600,
  "payload": {}
}
'

import requests

url = "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

payload = {
    "target": { "ids": ["<string>"] },
    "expiration_in_seconds": 42600,
    "payload": {}
}
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({target: {ids: ['<string>']}, expiration_in_seconds: 42600, payload: {}})
};

fetch('https://api.flexxible.net/v2/organizations/{organization_id}/operations', 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/v2/organizations/{organization_id}/operations",
  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([
    'target' => [
        'ids' => [
                '<string>'
        ]
    ],
    'expiration_in_seconds' => 42600,
    'payload' => [
        
    ]
  ]),
  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/v2/organizations/{organization_id}/operations"

	payload := strings.NewReader("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\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/v2/organizations/{organization_id}/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}"

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

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "description": "<string>",
      "status": "finished",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "microservice_id": "<string>",
      "flow_id": "<string>",
      "remote_support": {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "type": "<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>"
  }
}

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

Parâmetros de caminho

organization_id

string

obrigatório

Maximum string length: 24

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

Corpo

application/json

type

enum<string>

obrigatório

Opções disponíveis:

execute_microservice,

delete_workspaces,

shutdown_workspaces,

restart_workspaces,

suspend_workspaces

target

object

obrigatório

Show child attributes

expiration_in_seconds

integer

Intervalo obrigatório: 600 <= x <= 84600

payload

object

Resposta

Operações criadas com sucesso.

data

object[]

obrigatório

Minimum array length: 1

Show child attributes

⌘I

Criar operações

curl --request POST \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": {
    "ids": [
      "<string>"
    ]
  },
  "expiration_in_seconds": 42600,
  "payload": {}
}
'

import requests

url = "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

payload = {
    "target": { "ids": ["<string>"] },
    "expiration_in_seconds": 42600,
    "payload": {}
}
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({target: {ids: ['<string>']}, expiration_in_seconds: 42600, payload: {}})
};

fetch('https://api.flexxible.net/v2/organizations/{organization_id}/operations', 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/v2/organizations/{organization_id}/operations",
  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([
    'target' => [
        'ids' => [
                '<string>'
        ]
    ],
    'expiration_in_seconds' => 42600,
    'payload' => [
        
    ]
  ]),
  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/v2/organizations/{organization_id}/operations"

	payload := strings.NewReader("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\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/v2/organizations/{organization_id}/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}"

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

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "description": "<string>",
      "status": "finished",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "microservice_id": "<string>",
      "flow_id": "<string>",
      "remote_support": {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "type": "<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>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

API Gen 2

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Criar operações

Autorizações

Parâmetros de caminho

Corpo

Resposta