> ## Documentation Index
> Fetch the complete documentation index at: https://docsnewgen.flexxible.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v2.json post /v2/organizations/{organization_id}/operations
openapi: 3.0.3
info:
  title: API Publica Portal
  version: 2.0.0
  description: API pública REST para portal
servers:
  - url: https://api.flexxible.net
    description: Portal API (production)
security:
  - bearerAuth: []
tags:
  - name: Atividade digital
    description: Criação de grupos de processos principais por organização
  - name: Roles
    description: Endpoint de creacion de roles de organizacion
  - name: Usuarios
    description: Endpoint de creacion de usuarios de organizacion
  - name: Grupos de workspaces
    description: Endpoints de gestión de grupos de workspaces
  - name: Workspaces
    description: Endpoint de eliminacion de workspaces de la organizacion
  - name: Aplicaciones instaladas
    description: Endpoint de detalle de aplicación instalada de la organización
  - name: Autenticación
    description: Endpoints de autenticación y contexto de sesión
  - name: Microservicios
    description: Detalle de microservicios por organizacion
  - name: Operaciones
    description: Consulta de detalle de operaciones por organización
  - name: Organización
    description: Operaciones de organización
  - name: Objetivos de política de parches
    description: Endpoints de gestión de objetivos de política de parches
  - name: Configuraciones de producto
    description: Endpoints de gestión de configuraciones de producto
  - name: Grupos de reporte
    description: Operaciones sobre grupos de reporte
  - name: Sesiones
    description: Endpoint de detalle de sesion de la organizacion
  - name: Tenants
    description: Endpoints de gestión de tenants
paths:
  /v2/organizations/{organization_id}/operations:
    post:
      tags:
        - Operações
      summary: Criar operações
      description: >-
        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.
      operationId: createOperations
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationV2Request'
      responses:
        '201':
          description: Operações criadas com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOperationV2Response'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CreateOperationV2Request:
      type: object
      required:
        - type
        - target
      properties:
        type:
          type: string
          enum:
            - execute_microservice
            - delete_workspaces
            - shutdown_workspaces
            - restart_workspaces
            - suspend_workspaces
        target:
          type: object
          required:
            - type
            - ids
          properties:
            type:
              type: string
              enum:
                - workspaces
                - sessions
            ids:
              type: array
              minItems: 1
              maxItems: 20000
              items:
                type: string
                minLength: 1
                maxLength: 64
          additionalProperties: false
        expiration_in_seconds:
          type: integer
          maximum: 84600
          minimum: 600
        payload:
          type: object
          additionalProperties: true
      additionalProperties: false
    CreateOperationV2Response:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/GetOperationByIdResponseV1'
    GetOperationByIdResponseV1:
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador da execução da operação.
        name:
          type: string
          description: Nome da operação.
        organization_id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador da organização proprietária da operação.
        description:
          type: string
          description: >-
            Descrição da operação. Retorna uma cadeia vazia quando não existe na
            origem.
        status:
          type: string
          enum:
            - finished
            - unknown
            - error
            - pending
            - in-progress
            - timeout
            - cancelled
            - scheduled
          description: Estado atual da operação.
        created_at:
          type: string
          format: date-time
          description: Marcação temporal de criação.
        started_at:
          type: string
          format: date-time
          nullable: true
          description: Marcação temporal de início.
        ended_at:
          type: string
          format: date-time
          nullable: true
          description: Marcação temporal de finalização.
        microservice_id:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do microsserviço relacionado, quando existir.
        flow_id:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do fluxo relacionado, quando existir.
        remote_support:
          $ref: '#/components/schemas/GetOperationByIdRemoteSupportV1'
      required:
        - id
        - organization_id
        - name
        - description
        - status
        - created_at
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
    GetOperationByIdRemoteSupportV1:
      type: object
      nullable: true
      properties:
        start_date:
          type: string
          format: date-time
          nullable: true
          description: Data de início do suporte remoto.
        end_date:
          type: string
          format: date-time
          nullable: true
          description: Data de término do suporte remoto.
        type:
          type: string
          nullable: true
          description: Tipo de sessão de suporte remoto.
  responses:
    BadRequest:
      description: Solicitação incorreta
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    UnprocessableEntity:
      description: Entidade não processável
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Solicitações em excesso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````