API de Baixo Nível
Documentation for API Endpoints
All URIs are relative to http://localhost:8086
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthNodesApi | check_auth_node_health | GET /api/v1/nodes/auth/{uuid}/health | Verifica a saúde e a conectividade de um AuthNode |
| AuthNodesApi | create_auth_node | POST /api/v2/auth-nodes | Cria um AuthNode |
| AuthNodesApi | create_managed_ssh_auth_node_access | POST /api/v2/auth-nodes/managed-ssh-access | Cria acesso SSH gerenciado |
| AuthNodesApi | delete_auth_node | DELETE /api/v2/auth-nodes/{uuid} | Remove um AuthNode |
| AuthNodesApi | delete_auth_node_key | DELETE /api/v2/auth-nodes/{authNodeId}/key | Remove a chave privada de um AuthNode |
| AuthNodesApi | delete_auth_node_password | DELETE /api/v2/auth-nodes/{authNodeId}/pass | Remove a senha de um AuthNode |
| AuthNodesApi | delete_auth_node_token | DELETE /api/v2/auth-nodes/{authNodeId}/token | Remove o token de um AuthNode |
| AuthNodesApi | get_auth_node_by_uuid | GET /api/v2/auth-nodes/{uuid} | Busca um AuthNode por UUID |
| AuthNodesApi | get_managed_ssh_auth_node_public_key | GET /api/v2/auth-nodes/{uuid}/managed-ssh-access/public-key | Consulta a chave pública SSH gerenciada |
| AuthNodesApi | get_versoes_container | GET /api/v1/nodes/auth/{uuid}/versions | Lista as versões disponíveis do PLDPro para um AuthNode |
| AuthNodesApi | list_auth_nodes | GET /api/v2/auth-nodes | Lista AuthNodes |
| AuthNodesApi | list_current_user_auth_nodes | GET /api/v2/auth-nodes/me | Lista AuthNodes do usuário autenticado |
| AuthNodesApi | list_executions_by_auth_node | GET /api/v1/nodes/auth/{uuid}/execution | Lista o status das execuções associadas a um AuthNode |
| AuthNodesApi | list_user_auth_nodes | GET /api/v2/auth-nodes/user/{user_uuid} | Lista AuthNodes de um usuário |
| AuthNodesApi | provision_managed_ssh_auth_node_public_key | POST /api/v2/auth-nodes/{uuid}/managed-ssh-access/provision | Instala a chave pública SSH gerenciada |
| AuthNodesApi | rotate_managed_ssh_auth_node_key_pair | PUT /api/v2/auth-nodes/{uuid}/managed-ssh-access/key-pair | Rotaciona o par de chaves SSH gerenciado |
| AuthNodesApi | update_auth_node | PUT /api/v2/auth-nodes/{uuid} | Atualiza um AuthNode |
| AuthNodesApi | update_auth_nodes_batch | PUT /api/v2/auth-nodes/list | Atualiza AuthNodes em lote |
| AuthNodesApi | update_current_user_auth_node_access | POST /api/v2/auth-nodes/me/access | Atualiza o acesso AuthNode do usuário autenticado |
| CasesApi | associar_caminho_remoto | PATCH /api/v1/cases/{uuid}/attach | Associa um caminho remoto e credenciais (AuthNode) a um caso |
| CasesApi | associar_cortes_to_caso | PUT /api/v1/cases/{casoUuid}/cortes | Associa um conjunto de cortes a um caso |
| CasesApi | change_files_decomp | PUT /api/v1/cases/{uuid}/change-files/decomp | Registra trocas de arquivos do DECOMP para um caso |
| CasesApi | change_files_newave | PUT /api/v1/cases/{uuid}/change-files/newave | Registra trocas de arquivos do NEWAVE para um caso |
| CasesApi | change_processors_decomp | PUT /api/v1/cases/{uuid}/change-processors/decomp | Registra numero de processadores do DECOMP para um caso |
| CasesApi | change_processors_newave | PUT /api/v1/cases/{uuid}/change-processors/newave | Registra numero de processadores do NEWAVE para um caso |
| CasesApi | change_versions_decomp | PUT /api/v1/cases/{uuid}/change-versions/decomp | Registra trocas de versão do DECOMP para um caso |
| CasesApi | change_versions_gevazp | PUT /api/v1/cases/{uuid}/change-versions/gevazp | Registra trocas de versão do GEVAZP para um caso |
| CasesApi | change_versions_newave | PUT /api/v1/cases/{uuid}/change-versions/newave | Registra trocas de versão do NEWAVE para um caso |
| CasesApi | clonar_caso | POST /api/v1/cases/{uuid}/clone | Clona um caso existente |
| CasesApi | configure_consistency | POST /api/v1/cases/{uuid}/config/consistencia | Configura a rodada de consistência de um caso |
| CasesApi | configure_dadger | POST /api/v1/cases/{uuid}/config/dadger | Configura a geração do DADGER e a seleção de registros de um caso |
| CasesApi | configure_execution_models | POST /api/v1/cases/{uuid}/config/execucao-modelos | Configura a execução dos modelos, versões, revisão de parada e viabilização do DECOMP |
| CasesApi | configure_execution_with_partida | POST /api/v1/cases/{uuid}/config/execucao-partida | Configura a execução com partida de um caso |
| CasesApi | configure_initial_data | POST /api/v1/cases/{uuid}/config/initial_info | Configura os dados iniciais para execução do caso |
| CasesApi | create_caso | POST /api/v1/cases/attach | Cria um novo caso associado a um node remoto |
| CasesApi | create_empty_caso | POST /api/v1/cases | Cria um caso vazio |
| CasesApi | delete_caso | DELETE /api/v1/cases/{uuid} | Deleta um caso |
| CasesApi | delete_files | DELETE /api/v1/cases/{uuid}/files | Remove múltiplos arquivos de um caso |
| CasesApi | delete_files1 | DELETE /api/v1/cases/{uuid}/files/{filename} | |
| CasesApi | download_inputs | GET /api/v1/cases/{uuid}/download | Faz o download dos arquivos de entrada de um caso |
| CasesApi | download_inputs_file | GET /api/v1/cases/{uuid}/download/inputs | Faz o download dos arquivos de entrada do pldpro |
| CasesApi | download_specific_file | GET /api/v1/cases/{uuid}/download/inputs/filename | Faz o download de um arquivo específico de entrada de um caso |
| CasesApi | escrever_cortes_path | POST /api/v1/cases/{uuid}/cortes-path | Escreve o caminho dos cortes no arquivo de entrada do caso |
| CasesApi | filter_casos | GET /api/v1/cases | Lista ou filtra casos |
| CasesApi | get_caso | GET /api/v1/cases/{uuid} | Obtém informações de um caso |
| CasesApi | get_caso_execution_console_logs | GET /api/v1/cases/{uuid}/execution/logs/console | Obtém a saída de console da execução do caso |
| CasesApi | get_caso_execution_logs | GET /api/v1/cases/{uuid}/execution/logs | Obtém o log da execução do caso |
| CasesApi | get_caso_execution_status | GET /api/v1/cases/{uuid}/execution/status | Consulta o status atual de uma execução |
| CasesApi | get_casos_files | GET /api/v1/cases/{uuid}/files | Lista a árvore de arquivos de um caso |
| CasesApi | start_caso_execution | POST /api/v1/cases/{uuid}/execution | Inicia a execução de um caso |
| CasesApi | status_caso | GET /api/v1/cases/{uuid}/status | Obtém o status de um caso |
| CasesApi | stop_caso_execution | DELETE /api/v1/cases/{uuid}/execution | Interrompe a execução de um caso |
| CasesApi | upload_cenarios_dessem | POST /api/v1/cases/{uuid}/files/upload/cenarios-dessem | Faz upload dos arquivos de cenários DESSEM |
| CasesApi | upload_deck_partida | POST /api/v1/cases/{uuid}/upload/deck-partida | Faz upload dos arquivos de partida |
| CasesApi | upload_deck_partida_semanal | POST /api/v1/cases/{uuid}/upload/deck-partida-semanal | Faz upload dos arquivos de partida semanal |
| CasesApi | upload_ena_ree | POST /api/v1/cases/{uuid}/files/upload/ena-ree | Faz upload do arquivo de ENA por REE |
| CasesApi | upload_file_entrada | POST /api/v1/cases/{uuid}/files/upload/entrada | Faz upload do arquivo entrada.txt |
| CasesApi | upload_files | POST /api/v1/cases/{uuid}/files/upload | Faz upload de arquivos para um caso |
| CasesApi | upload_prevs_files | POST /api/v1/cases/{uuid}/files/upload/prevs | Faz upload de arquivos PREVS para o caso |
| CasesApi | upload_regras_ana | POST /api/v1/cases/{uuid}/files/upload/regras-ana | Faz upload do arquivo regras-ana |
| CasesApi | upload_volume_final_decomp | POST /api/v1/cases/{uuid}/files/upload/volume-final-dc | Faz upload do arquivo volfdc para o caso |
| CasesApi | upload_volume_partida_decomp | POST /api/v1/cases/{uuid}/files/upload/volume-partida-dc | Faz upload do arquivo volume-partida-dc |
| DataApi | execute_data_strategy | POST /api/v1/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 /api/v1/data/{data_type}/available | Listar itens disponíveis para um tipo de dado |
| DataApi | get_available_data_items_by_volume | GET /api/v1/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 /api/v1/data | Listar tipos de dados disponíveis |
| DataApi | get_available_types_by_volume | GET /api/v1/data/{auth_node_uuid} | Listar tipos de dados disponíveis em um volume |
| DataApi | list_data_strategies | GET /api/v1/data/strategies | Listar estratégias de carregamento de dados |
| DataApi | list_volume_data_strategies | GET /api/v1/data/volume/strategies | Listar estratégias de volume |
| LicencesApi | check_valid_license | GET /api/v1/licenses/check | Busca a licença do tenant por modelo |
| LicencesApi | create_license | POST /api/v1/licenses | Faz upload de um arquivo de licença |
| LicencesApi | get_all_licenses_by_tenant | GET /api/v1/licenses | Lista todas as licenças do tenant |
| LicencesApi | get_all_valid_licenses_by_tenant | GET /api/v1/licenses/available | Lista as licenças válidas do tenant |
| LicencesApi | get_license_by_model | GET /api/v1/licenses/by-model/{modelType} | Busca a licença do tenant por modelo na URL |
| NodesApi | add_volume_path_to_node | PATCH /api/v1/nodes/{uuid}/add-volume-path | Adiciona um caminho de volume PLDPRO a um Node. |
| NodesApi | create_node | POST /api/v2/nodes | Cria um Node |
| NodesApi | delete_node | DELETE /api/v2/nodes/{uuid} | Remove um Node |
| NodesApi | get_casos_node | GET /api/v1/nodes/{uuid}/cases | Lista os casos associados a um node |
| NodesApi | get_node_by_uuid | GET /api/v2/nodes/{uuid} | Busca um Node por UUID |
| NodesApi | get_node_from_name | GET /api/v1/nodes/from-name | Retorna um Node |
| NodesApi | list_current_user_authorized_nodes | GET /api/v2/nodes/me/auth | Lista Nodes com acesso AuthNode do usuário autenticado |
| NodesApi | list_current_user_nodes | GET /api/v2/nodes/me | Lista Nodes do usuário autenticado |
| NodesApi | list_nodes | GET /api/v2/nodes | Lista Nodes |
| NodesApi | register_full_node | POST /api/v2/nodes/full-register | Registra um Node com sua configuração completa |
| NodesApi | update_node | PUT /api/v2/nodes/{uuid} | Atualiza um Node |
| NodesApi | update_nodes_batch | PUT /api/v2/nodes/list | Atualiza Nodes em lote |
| ReservationCatalogApi | create_reservation_catalog | POST /api/v1/reservation-catalogs | Cria um registro no catálogo de reservas |
| ReservationCatalogApi | delete_reservation_catalog | DELETE /api/v1/reservation-catalogs/{reservationId} | Remove um registro do catálogo pela reservationId |
| ReservationCatalogApi | get_all_reservation_catalogs | GET /api/v1/reservation-catalogs | Lista os registros do catálogo de reservas |
| ReservationCatalogApi | get_reservation_catalog_by_reservation_id | GET /api/v1/reservation-catalogs/{reservationId} | Busca um registro do catálogo pela reservationId |
| ReservationCatalogApi | get_reservation_catalog_capacity | GET /api/v1/reservation-catalogs/{reservationId}/capacity | Consulta a capacidade atual de uma reserva |
| ReservationCatalogApi | update_reservation_catalog | PUT /api/v1/reservation-catalogs/{reservationId} | Atualiza um registro do catálogo pela reservationId |
| ReservationUsageApi | create_reservation_usage | POST /api/v1/reservation-usages | Cria um registro de consumo de reserva |
| ReservationUsageApi | delete_reservation_usage | DELETE /api/v1/reservation-usages/{id} | Remove um consumo de reserva pelo id |
| ReservationUsageApi | get_all_reservation_usages | GET /api/v1/reservation-usages | Lista os consumos de reserva |
| ReservationUsageApi | get_reservation_usage_by_id | GET /api/v1/reservation-usages/{id} | Busca um consumo de reserva pelo id |
| ReservationUsageApi | update_reservation_usage | PUT /api/v1/reservation-usages/{id} | Atualiza um consumo de reserva pelo id |
| TenantsApi | create_tenant | POST /api/v1/tenants | Criar um tenant |
| VolumesApi | create_volume | POST /api/v1/volumes | Cria um novo volume |
| VolumesApi | delete_volume | DELETE /api/v1/volumes/{uuid} | Remove um volume pelo UUID |
| VolumesApi | get_all_volumes | GET /api/v1/volumes | Lista todos os volumes |
| VolumesApi | get_volume_by_uuid | GET /api/v1/volumes/{uuid} | Busca um volume pelo UUID |
Documentation For Models
- AuthNodeKeyRequestDTO
- AuthNodeKeyResponseDTO
- AuthNodePassRequestDTO
- AuthNodePassResponseDTO
- AuthNodeRequestDTO
- AuthNodeResponse
- AuthNodeResponseDTO
- AuthNodeSshAccessRequestDTO
- AuthNodeSshAccessResponseDTO
- AuthNodeSshKeyRotationRequestDTO
- AuthNodeSshPublicKeyResponseDTO
- AuthNodeTokenRequestDTO
- AuthNodeTokenResponseDTO
- AuthNodeUpdateDTO
- AuthNodeUserUpdateDTO
- CaseInitialDataRequest
- CaseRequest
- CaseResponse
- CaseUpdateRequest
- ConsistencyConfigRequest
- ConsistencyConfigResponse
- CortesRequest
- DadgerConfigRequest
- DadgerConfigResponse
- DataStrategyInfo
- ExecutionModelsConfigRequest
- ExecutionModelsConfigResponse
- ExecutionPartidaConfigRequest
- ExecutionPartidaConfigResponse
- ExecutionResponse
- ExecutionStartRequest
- ExecutionStatus
- FileNode
- FileUploadResponse
- FullNodeRegistrationDTO
- HostCheckResult
- LicenseResponse
- NodeRequestDTO
- NodeResponse
- NodeResponseDTO
- NodeStatusInfoDTO
- NodeUpdateDTO
- OptionModeloCore
- OptionsExecutaModelo
- OwnerDTO
- PaginatedCasoResponse
- ProcessorCountRequest
- ProcessorCountResponse
- ReservationCapacityResponse
- ReservationCatalogRequest
- ReservationCatalogResponse
- ReservationUsageRequest
- ReservationUsageResponse
- TenantRequest
- TenantResponse
- UpdateCortesPathRequest
- UploadFilesChangesResponse
- ValoresAcopla
- VersionChangeItemRequest
- VersionChangeRequest
- VersionChangeResponse
- VolumeRequest
- VolumeResponse
Documentation For Authorization
Authentication schemes defined for the API:
security_auth
- Type: Bearer authentication (JWT)
1_tenant
- Type: API key
- API key parameter name: X-Tenant-ID
- Location: HTTP header
2_user
- Type: API key
- API key parameter name: X-Dev-User
- Location: HTTP header
3_user_id
- Type: API key
- API key parameter name: X-Dev-User-Id
- Location: HTTP header
4_roles
- Type: API key
- API key parameter name: X-Dev-Roles
- Location: HTTP header
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header
Author
cepel@cepel.br