Pular para o conteúdo principal

Criar operações

POST 
/v2/organizations/:organization_id/operations

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

Tipos de operação disponíveis atualmente: execute_microservice, delete_workspaces, force_update_custom_fields, shutdown_workspaces, restart_workspaces, suspend_workspaces, power_off_workspaces, force_restart_workspaces, wake_on_lan_workspaces, send_popup, send_flexxible_notification, disconnect_sessions, logoff_sessions, force_logoff_sessions, collect_agent_logs, change_reporting_group, windows_service_action e close_notification, get_installed_patches, get_pending_patches e get_plug_and_play_devices.

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

Execução parcial

As operações são criadas apenas para os objetivos elegíveis. Objetivos não elegíveis não bloqueiam a solicitação: são retornados em not_supported_devices, agrupados por motivo. Se todos os objetivos forem omitidos, a resposta ainda será 201 com data vazio. Falhas de autorização de organização e validações globais na solicitação retornam 4xx e não criam nenhuma operação.

Objetivos suportados por tipo

  • Somente sessions: disconnect_sessions, logoff_sessions e force_logoff_sessions.
  • workspaces ou sessions: execute_microservice, send_popup e send_flexxible_notification.
  • Somente workspaces: o restante dos tipos.
  • windows_service_action suporta exatamente um objetivo por solicitação.

Conteúdo do payload por tipo

payload é um objeto cujo conteúdo depende de type. Campos não suportados para o tipo enviado são rejeitados com 400. Consulte os exemplos de solicitação para ver cada forma completa.

  • execute_microservice: microservice_id (requerido) e parameters (opcional).
  • shutdown_workspaces e restart_workspaces: scheduled_at (opcional).
  • wake_on_lan_workspaces: intermediate_workspace_id (requerido). Deve ser um Workspace conectado que atuará como intermediário.
  • send_popup: message (requerido).
  • send_flexxible_notification: message, start_date, end_date, level_type (informative, maintenance ou issue), blink, ask_for_acknowledgement, disable_minimize, timezone (requeridos); tooltip e link (opcionais).
  • collect_agent_logs: start_time (requerido); end_time e filter_files (opcionais).
  • change_reporting_group: reporting_group_id (requerido). Solicitação é rejeitada quando ultrapassa 100 Workspaces não aptos.
  • windows_service_action: action (start, stop ou restart) e services_name (requeridos). Serviço FlexxAgent service não pode ser parado ou reiniciado.
  • delete_workspaces, force_update_custom_fields, suspend_workspaces, power_off_workspaces, force_restart_workspaces, disconnect_sessions, logoff_sessions e force_logoff_sessions: não suportam payload.

Compatibilidade de parâmetros para execute_microservice

payload.parameters aplica-se apenas para execuções de microserviços PowerShell no Windows e é suportado somente 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 parse implementado no script do microserviço.

Nesse contexto, tipos de dados recomendados para os parâmetros:

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

Solicitação​

Respostas​

Operações criadas com sucesso.