API de Baixo Nível
Documentation for API Endpoints
All URIs are relative to /v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CasosApi | associar_caminho_remoto | PATCH /casos/{uuid}/attach | Associa um caminho remoto e credenciais (AuthNode) a um caso |
| CasosApi | associar_cortes_to_caso | PUT /casos/{uuid}/cortes | Associa um conjunto de cortes a um caso |
| CasosApi | change_files_decomp | PUT /casos/{uuid}/change-files/decomp | Registra trocas de arquivos do DECOMP para um caso |
| CasosApi | change_files_newave | PUT /casos/{uuid}/change-files/newave | Registra trocas de arquivos do NEWAVE para um caso |
| CasosApi | change_processors_decomp | PUT /casos/{uuid}/change-processors/decomp | Registra numero de processadores do DECOMP para um caso |
| CasosApi | change_processors_newave | PUT /casos/{uuid}/change-processors/newave | Registra numero de processadores do NEWAVE para um caso |
| CasosApi | change_versions_decomp | PUT /casos/{uuid}/change-versions/decomp | Registra trocas de versão do DECOMP para um caso |
| CasosApi | change_versions_gevazp | PUT /casos/{uuid}/change-versions/gevazp | Registra trocas de versão do GEVAZP para um caso |
| CasosApi | change_versions_newave | PUT /casos/{uuid}/change-versions/newave | Registra trocas de versão do NEWAVE para um caso |
| CasosApi | clonar_caso | POST /casos/{uuid}/clone | Clona um caso existente |
| CasosApi | configure_dadger | POST /casos/{uuid}/config/dadger | Configura a geração do DADGER e a seleção de registros de um caso |
| CasosApi | configure_execution_models | POST /casos/{uuid}/config/execucao-modelos | Configura a execução dos modelos, versões, revisão de parada e viabilização do DECOMP |
| CasosApi | configure_execution_with_partida | POST /casos/{uuid}/config/execucao-partida | Configura a execução com partida de um caso |
| CasosApi | configure_initial_data | POST /casos/{uuid}/config/initial_info | Configura os dados iniciais para execução do caso |
| CasosApi | create_caso | POST /casos/attach | Cria um novo caso associado a um node remoto |
| CasosApi | create_empty_caso | POST /casos | Cria um caso vazio |
| CasosApi | delete_caso | DELETE /casos/{uuid} | Deleta um caso |
| CasosApi | delete_files | DELETE /casos/{uuid}/files | Remove múltiplos arquivos de um caso |
| CasosApi | download_inputs | GET /casos/{uuid}/download | Faz o download dos arquivos de entrada de um caso |
| CasosApi | download_inputs_file | GET /casos/{uuid}/download/inputs | Faz o download dos arquivos de entrada do pldpro |
| CasosApi | download_specific_file | GET /casos/{uuid}/download/inputs/filename | Faz o download de um arquivo específico de entrada de um caso |
| CasosApi | escrever_cortes_path | POST /casos/{uuid}/cortes-path | Escreve o caminho dos cortes no arquivo de entrada do caso |
| CasosApi | filter_casos | GET /casos | Lista ou filtra casos |
| CasosApi | get_caso | GET /casos/{uuid} | Obtém informações de um caso |
| CasosApi | get_casos_files | GET /casos/{uuid}/files | Lista a árvore de arquivos de um caso |
| CasosApi | status_caso | GET /casos/{uuid}/status | Obtém o status de um caso |
| CasosApi | upload_cenarios_dessem | POST /casos/{uuid}/files/upload/cenarios-dessem | Faz upload dos arquivos de cenários DESSEM |
| CasosApi | upload_deck_partida | POST /casos/{uuid}/upload/deck-partida | Faz upload dos arquivos de partida |
| CasosApi | upload_deck_partida_semanal | POST /casos/{uuid}/upload/deck-partida-semanal | Faz upload dos arquivos de partida semanal |
| CasosApi | upload_ena_ree | POST /casos/{uuid}/files/upload/ena-ree | Faz upload do arquivo de ENA por REE |
| CasosApi | upload_file_entrada | POST /casos/{uuid}/files/upload/entrada | Faz upload do arquivo entrada.txt |
| CasosApi | upload_files | POST /casos/{uuid}/files/upload | Faz upload de arquivos para um caso |
| CasosApi | upload_prevs_files | POST /casos/{uuid}/files/upload/prevs | Faz upload de arquivos PREVS para o caso |
| CasosApi | upload_regras_ana | POST /casos/{uuid}/files/upload/regras-ana | Faz upload do arquivo regras-ana |
| CasosApi | upload_volume_final_decomp | POST /casos/{uuid}/files/upload/volume-final-dc | Faz upload do arquivo volfdc para o caso |
| CasosApi | upload_volume_partida_decomp | POST /casos/{uuid}/files/upload/volume-partida-dc | Faz upload do arquivo volume-partida-dc |
| DataApi | execute_data_strategy | POST /data/{data_type}/select/{item_name}/to/{caso_uuid}/strategy/{strategy_name} | Aplicar uma estratégia de dados a um caso |
| DataApi | get_available_data_items | GET /data/{data_type}/available | Listar itens disponíveis para um tipo de dado |
| DataApi | get_available_data_items_by_volume | GET /data/{auth_node_uuid}/{data_type}/available | Listar itens disponíveis para um tipo de dado em um volume |
| DataApi | get_available_data_types | GET /data | Listar tipos de dados disponíveis |
| DataApi | get_available_types_by_volume | GET /data/{auth_node_uuid} | Listar tipos de dados disponíveis em um volume |
| DataApi | list_data_strategies | GET /data/strategies | Listar estratégias de carregamento de dados |
| DataApi | list_volume_data_strategies | GET /data/volume/strategies | Listar estratégias de volume |
| ExecucoesApi | get_caso_execution_console_logs | GET /casos/{uuid}/execution/logs/console | Obtém a saída de console da execução do caso |
| ExecucoesApi | get_caso_execution_logs | GET /casos/{uuid}/execution/logs | Obtém o log da execução do caso |
| ExecucoesApi | get_caso_execution_status | GET /casos/{uuid}/execution/status | Consulta o status atual de uma execução |
| ExecucoesApi | list_executions_by_auth_node | GET /nodes/auth/{uuid}/execution | Lista o status das execuções associadas a um AuthNode |
| ExecucoesApi | start_caso_execution | POST /casos/{uuid}/execution | Inicia a execução de um caso |
| ExecucoesApi | stop_caso_execution | DELETE /casos/{uuid}/execution | Interrompe a execução de um caso |
| LicenasApi | check_valid_license | GET /licenses/check | Busca a licença do tenant por modelo |
| LicenasApi | create_license | POST /licenses | Faz upload de um arquivo de licença |
| LicenasApi | get_all_licenses_by_tenant | GET /licenses | Lista todas as licenças do tenant |
| LicenasApi | get_all_valid_licenses_by_tenant | GET /licenses/available | Lista as licenças válidas do tenant |
| LicenasApi | get_license_by_model | GET /licenses/by-model/{modelType} | Busca a licença do tenant por modelo na URL |
| NodesApi | check_auth_node_health | GET /nodes/auth/{uuid}/health | Verifica a saúde e conectividade de um AuthNode |
| NodesApi | create_auth_node_for_node | POST /nodes/{uuid}/auth | Cria um novo AuthNode para um node |
| NodesApi | create_auth_node_pub_key | POST /nodes/{uuid}/auth/pub-key | Cria/registra a chave pública de um AuthNode e faz o download do arquivo ZIP |
| NodesApi | create_node | POST /nodes | Cria um novo node |
| NodesApi | delete_auth_node | DELETE /nodes/auth/{uuid} | Remove um AuthNode e suas credenciais associadas |
| NodesApi | delete_node | DELETE /nodes/{uuid} | Remove um node do sistema |
| NodesApi | download_auth_node_user_public_key | GET /nodes/{node}/auth/{usuario}/pub-key | Faz o download da chave pública do usuário em um node |
| NodesApi | get_all_nodes | GET /nodes | Lista todos os nodes |
| NodesApi | get_auth_node | GET /nodes/auth/{uuid} | Obtém os detalhes de um AuthNode |
| NodesApi | get_auth_node_for_user_in_node | GET /nodes/{uuid}/auth/from-user | Recupera as credenciais (AuthNode) de um usuário em um node |
| NodesApi | get_auth_node_public_key | GET /nodes/auth/{uuid}/pub-key | Obtém a chave pública SSH do AuthNode |
| NodesApi | get_casos_node | GET /nodes/{uuid}/casos | Lista os casos associados a um node |
| NodesApi | get_node | GET /nodes/{uuid} | Obtém os detalhes de um node |
| NodesApi | get_node_from_name | GET /nodes/from-name | Retorna um Node |
| NodesApi | get_versoes_container | GET /nodes/auth/{uuid}/versions | Lista as versões disponíveis do PLDPro para um AuthNode |
| NodesApi | list_auth_nodes_by_node | GET /nodes/{uuid}/auth | Lista as credenciais (AuthNodes) associadas a um node |
| NodesApi | update_auth_node_credentials | PUT /nodes/auth/{uuid}/credentials | Atualiza as credenciais (senha) do AuthNode e recria as chaves |
| ReservasApi | create_reservation_catalog | POST /reservation-catalogs | Cria um registro no catálogo de reservas |
| ReservasApi | delete_reservation_catalog | DELETE /reservation-catalogs/{reservationId} | Remove um registro do catálogo pela reservationId |
| ReservasApi | get_all_reservation_catalogs | GET /reservation-catalogs | Lista os registros do catálogo de reservas |
| ReservasApi | get_reservation_catalog_by_reservation_id | GET /reservation-catalogs/{reservationId} | Busca um registro do catálogo pela reservationId |
| ReservasApi | get_reservation_catalog_capacity | GET /reservation-catalogs/{reservationId}/capacity | Consulta a capacidade atual de uma reserva |
| ReservasApi | update_reservation_catalog | PUT /reservation-catalogs/{reservationId} | Atualiza um registro do catálogo pela reservationId |
| VolumesApi | create_volume | POST /volumes | Cria um novo volume |
| VolumesApi | delete_volume | DELETE /volumes/{uuid} | Remove um volume pelo UUID |
| VolumesApi | get_all_volumes | GET /volumes | Lista todos os volumes |
| VolumesApi | get_volume_by_uuid | GET /volumes/{uuid} | Busca um volume pelo UUID |
Documentation For Models
- AuthNodeRequest
- AuthNodeRequestPubKey
- AuthNodeResponse
- CasoInitialDataRequest
- CasoRequest
- CasoResponse
- CasoUpdateRequest
- ConfiguracaoDadgerRequest
- ConfiguracaoDadgerResponse
- ConfiguracaoExecucaoModelosRequest
- ConfiguracaoExecucaoModelosResponse
- ConfiguracaoExecucaoPartidaRequest
- ConfiguracaoExecucaoPartidaResponse
- CortesRequest
- CredentialsUpdateRequest
- DataStrategyInfo
- ErrorResponse
- ExecucaoResponse
- ExecucaoStartRequest
- ExecucaoStartRequestOptionsExecutaModelo
- ExecutionMode
- FileNode
- FileUploadResponse
- HostCheckResult
- HostCheckStatus
- LicenseRequest
- LicenseResponse
- LicenseTypeEnum
- ModelTypeEnum
- ModeloPartida
- NodeRequest
- NodeResponse
- NumeroProcessadoresRequest
- NumeroProcessadoresResponse
- PaginatedCasoResponse
- PartidaConfig
- PartidaSemanalConfig
- RegistroDadger
- ReservationCapacityResponse
- ReservationCatalogRequest
- ReservationCatalogResponse
- StatusEnum
- StatusExecucao
- TipoAlteracaoEnum
- TipoApagaRegrasEnum
- TipoEncadeamentoSemanal
- TrocaVersaoItemRequest
- TrocaVersaoRequest
- TrocaVersaoResponse
- TypeNodeExecutionEnum
- UploadTrocasArquivosResponse
- ValoresAcopla
- VolumeRequest
- VolumeResponse
Documentation For Authorization
Authentication schemes defined for the API:
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header
TenantIdAuth
- Type: API key
- API key parameter name: X-Tenant-ID
- Location: HTTP header