pldpro_sdk.api_client.CasesApi

All URIs are relative to http://localhost:8086

Method	HTTP request	Description
associar_caminho_remoto	PATCH /api/v1/cases/{uuid}/attach	Associa um caminho remoto e credenciais (AuthNode) a um caso
associar_cortes_to_caso	PUT /api/v1/cases/{casoUuid}/cortes	Associa um conjunto de cortes a um caso
change_files_decomp	PUT /api/v1/cases/{uuid}/change-files/decomp	Registra trocas de arquivos do DECOMP para um caso
change_files_newave	PUT /api/v1/cases/{uuid}/change-files/newave	Registra trocas de arquivos do NEWAVE para um caso
change_processors_decomp	PUT /api/v1/cases/{uuid}/change-processors/decomp	Registra numero de processadores do DECOMP para um caso
change_processors_newave	PUT /api/v1/cases/{uuid}/change-processors/newave	Registra numero de processadores do NEWAVE para um caso
change_versions_decomp	PUT /api/v1/cases/{uuid}/change-versions/decomp	Registra trocas de versão do DECOMP para um caso
change_versions_gevazp	PUT /api/v1/cases/{uuid}/change-versions/gevazp	Registra trocas de versão do GEVAZP para um caso
change_versions_newave	PUT /api/v1/cases/{uuid}/change-versions/newave	Registra trocas de versão do NEWAVE para um caso
clonar_caso	POST /api/v1/cases/{uuid}/clone	Clona um caso existente
configure_consistency	POST /api/v1/cases/{uuid}/config/consistencia	Configura a rodada de consistência de um caso
configure_dadger	POST /api/v1/cases/{uuid}/config/dadger	Configura a geração do DADGER e a seleção de registros de um caso
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
configure_execution_with_partida	POST /api/v1/cases/{uuid}/config/execucao-partida	Configura a execução com partida de um caso
configure_initial_data	POST /api/v1/cases/{uuid}/config/initial_info	Configura os dados iniciais para execução do caso
create_caso	POST /api/v1/cases/attach	Cria um novo caso associado a um node remoto
create_empty_caso	POST /api/v1/cases	Cria um caso vazio
delete_caso	DELETE /api/v1/cases/{uuid}	Deleta um caso
delete_files	DELETE /api/v1/cases/{uuid}/files	Remove múltiplos arquivos de um caso
delete_files1	DELETE /api/v1/cases/{uuid}/files/{filename}
download_inputs	GET /api/v1/cases/{uuid}/download	Faz o download dos arquivos de entrada de um caso
download_inputs_file	GET /api/v1/cases/{uuid}/download/inputs	Faz o download dos arquivos de entrada do pldpro
download_specific_file	GET /api/v1/cases/{uuid}/download/inputs/filename	Faz o download de um arquivo específico de entrada de um caso
escrever_cortes_path	POST /api/v1/cases/{uuid}/cortes-path	Escreve o caminho dos cortes no arquivo de entrada do caso
filter_casos	GET /api/v1/cases	Lista ou filtra casos
get_caso	GET /api/v1/cases/{uuid}	Obtém informações de um caso
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
get_caso_execution_logs	GET /api/v1/cases/{uuid}/execution/logs	Obtém o log da execução do caso
get_caso_execution_status	GET /api/v1/cases/{uuid}/execution/status	Consulta o status atual de uma execução
get_casos_files	GET /api/v1/cases/{uuid}/files	Lista a árvore de arquivos de um caso
start_caso_execution	POST /api/v1/cases/{uuid}/execution	Inicia a execução de um caso
status_caso	GET /api/v1/cases/{uuid}/status	Obtém o status de um caso
stop_caso_execution	DELETE /api/v1/cases/{uuid}/execution	Interrompe a execução de um caso
upload_cenarios_dessem	POST /api/v1/cases/{uuid}/files/upload/cenarios-dessem	Faz upload dos arquivos de cenários DESSEM
upload_deck_partida	POST /api/v1/cases/{uuid}/upload/deck-partida	Faz upload dos arquivos de partida
upload_deck_partida_semanal	POST /api/v1/cases/{uuid}/upload/deck-partida-semanal	Faz upload dos arquivos de partida semanal
upload_ena_ree	POST /api/v1/cases/{uuid}/files/upload/ena-ree	Faz upload do arquivo de ENA por REE
upload_file_entrada	POST /api/v1/cases/{uuid}/files/upload/entrada	Faz upload do arquivo entrada.txt
upload_files	POST /api/v1/cases/{uuid}/files/upload	Faz upload de arquivos para um caso
upload_prevs_files	POST /api/v1/cases/{uuid}/files/upload/prevs	Faz upload de arquivos PREVS para o caso
upload_regras_ana	POST /api/v1/cases/{uuid}/files/upload/regras-ana	Faz upload do arquivo regras-ana
upload_volume_final_decomp	POST /api/v1/cases/{uuid}/files/upload/volume-final-dc	Faz upload do arquivo volfdc para o caso
upload_volume_partida_decomp	POST /api/v1/cases/{uuid}/files/upload/volume-partida-dc	Faz upload do arquivo volume-partida-dc

associar_caminho_remoto

CaseResponse associar_caminho_remoto(uuid, case_update_request)

Associa um caminho remoto e credenciais (AuthNode) a um caso

Atualiza o caso identificado pelo UUID, vinculando um diretório remoto e o AuthNode (credenciais remotas) especificados no corpo da requisição.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.models.case_update_request import CaseUpdateRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    case_update_request = {"uuidAuthHost":"a3b41c8b-0d1e-4ffg-8h94-78cd5f33fa3e","pathRemote":"/home/usuario/casos/caso123"} # CaseUpdateRequest | 

    try:
        # Associa um caminho remoto e credenciais (AuthNode) a um caso
        api_response = api_instance.associar_caminho_remoto(uuid, case_update_request)
        print("The response of CasesApi->associar_caminho_remoto:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->associar_caminho_remoto: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
case_update_request	CaseUpdateRequest

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caminho remoto associado com sucesso.	-
400	Erro ao associar caminho remoto e AuthNode ao caso.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

associar_cortes_to_caso

CaseResponse associar_cortes_to_caso(caso_uuid, cortes_request)

Associa um conjunto de cortes a um caso

Atualiza o caso identificado pelo UUID, associando um conjunto de cortes disponível em todos os AuthNodes informados ao caso.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.models.cortes_request import CortesRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    caso_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    cortes_request = {"cortesName":"nw202601_resultado_ccee","uuidAuthNode":["8f14e45f-e29b-41d4-a716-446655440000","9a25f56a-f39c-42e5-b827-557766551111"]} # CortesRequest | 

    try:
        # Associa um conjunto de cortes a um caso
        api_response = api_instance.associar_cortes_to_caso(caso_uuid, cortes_request)
        print("The response of CasesApi->associar_cortes_to_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->associar_cortes_to_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
caso_uuid	UUID	Identificador único do caso
cortes_request	CortesRequest

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Cortes associados ao caso com sucesso.	-
400	Erro ao associar os cortes ao caso.	-
404	Caso ou AuthNode não encontrado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_files_decomp

UploadFilesChangesResponse change_files_decomp(uuid, metadata)

Registra trocas de arquivos do DECOMP para um caso

Registra, em uma única operação, as trocas de arquivos do DECOMP associadas a um caso.

Este endpoint recebe: - uma part metadata contendo um JSON serializado compatível com UploadTrocasArquivosRequest - uma ou mais parts multipart contendo os arquivos físicos

Regras importantes: - cada item de metadata.items[*] representa uma troca de arquivo - items[*].fileKey deve ser exatamente a chave da part multipart do arquivo correspondente - essa chave não precisa coincidir com o nome físico original do arquivo enviado - não é permitido enviar item sem arquivo correspondente - não é permitido enviar arquivo sem vínculo com item do metadata - não é permitido registro duplicado para a mesma competência (mês/ano), nomeArquivo e extensao - a ordem de envio não influencia a escrita final no entrada.txt; a API ordena cronologicamente por ano e mês

Regras de nome final: 1. Se extensao já for rvX: <nomeArquivo>-<mes>-<ano>.<extensao> Exemplo: dadger-3-2026.rv1

1. Se extensao for uma extensão física e revisao vier informada: <nomeArquivo>-<mes>-<ano>-rv<revisao>.<extensao> Exemplo: indice-5-2026-rv2.csv

2. Se extensao for uma extensão física e revisao não vier informada: <nomeArquivo>-<mes>-<ano>.<extensao>

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.upload_files_changes_response import UploadFilesChangesResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    metadata = 'metadata_example' # str | Metadados das trocas como JSON em texto.

    try:
        # Registra trocas de arquivos do DECOMP para um caso
        api_response = api_instance.change_files_decomp(uuid, metadata)
        print("The response of CasesApi->change_files_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_files_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
metadata	str	Metadados das trocas como JSON em texto.

Return type

UploadFilesChangesResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trocas de arquivos do DECOMP atualizadas com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_files_newave

UploadFilesChangesResponse change_files_newave(uuid, metadata)

Registra trocas de arquivos do NEWAVE para um caso

Registra, em uma única operação, as trocas de arquivos do NEWAVE associadas a um caso.

Este endpoint recebe: - uma part metadata contendo um JSON serializado compatível com UploadTrocasArquivosRequest - uma ou mais parts multipart contendo os arquivos físicos

Regras importantes: - cada item de metadata.items[*] representa uma troca de arquivo - items[*].fileKey deve ser exatamente o nome da part multipart do arquivo correspondente - não é permitido enviar item sem arquivo correspondente - não é permitido enviar arquivo sem vínculo com item do metadata - não é permitido registro duplicado para a mesma competência (mês/ano), nomeArquivo e extensao - a ordem de envio não influencia a escrita final no entrada.txt; a API ordena cronologicamente por ano e mês - o nome físico do arquivo enviado pelo cliente é livre; a API renomeia internamente - para NEWAVE, o campo revisao não deve ser informado

Nome final gerado pela API: <nomeArquivo>-<mes>-<ano>.<extensao>

Exemplo: clast-6-2026.dat

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.upload_files_changes_response import UploadFilesChangesResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    metadata = 'metadata_example' # str | Metadados das trocas como JSON em texto.

    try:
        # Registra trocas de arquivos do NEWAVE para um caso
        api_response = api_instance.change_files_newave(uuid, metadata)
        print("The response of CasesApi->change_files_newave:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_files_newave: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
metadata	str	Metadados das trocas como JSON em texto.

Return type

UploadFilesChangesResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trocas de arquivos do NEWAVE atualizadas com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_processors_decomp

ProcessorCountResponse change_processors_decomp(uuid, processor_count_request)

Registra numero de processadores do DECOMP para um caso

Registra, em uma unica operacao, o numero de processadores do DECOMP associado a um caso.

Regras importantes: - o payload deve informar quantidadeProcessadores - o valor deve ser inteiro, nao nulo e nao negativo - o valor deve respeitar o limite do formato para o DECOMP - a escrita atualiza NUMPROCSDC e DCNUMPROCSRE com o mesmo valor - a atualizacao ocorre no entrada.txt local do caso

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.processor_count_request import ProcessorCountRequest
from pldpro_sdk.api_client.models.processor_count_response import ProcessorCountResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    processor_count_request = {quantidadeProcessadores=8} # ProcessorCountRequest | 

    try:
        # Registra numero de processadores do DECOMP para um caso
        api_response = api_instance.change_processors_decomp(uuid, processor_count_request)
        print("The response of CasesApi->change_processors_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_processors_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
processor_count_request	ProcessorCountRequest

Return type

ProcessorCountResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Numero de processadores do DECOMP atualizado com sucesso	-
400	Requisicao invalida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_processors_newave

ProcessorCountResponse change_processors_newave(uuid, processor_count_request)

Registra numero de processadores do NEWAVE para um caso

Registra, em uma unica operacao, o numero de processadores do NEWAVE associado a um caso.

Regras importantes: - o payload deve informar quantidadeProcessadores - o valor deve ser inteiro, nao nulo e nao negativo - o valor deve respeitar o limite do formato para o NEWAVE - a escrita atualiza NUMPROCSNW e NWNUMPROCSRE com o mesmo valor - a atualizacao ocorre no entrada.txt local do caso

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.processor_count_request import ProcessorCountRequest
from pldpro_sdk.api_client.models.processor_count_response import ProcessorCountResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    processor_count_request = {"quantidadeProcessadores":8} # ProcessorCountRequest | 

    try:
        # Registra numero de processadores do NEWAVE para um caso
        api_response = api_instance.change_processors_newave(uuid, processor_count_request)
        print("The response of CasesApi->change_processors_newave:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_processors_newave: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
processor_count_request	ProcessorCountRequest

Return type

ProcessorCountResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Numero de processadores do NEWAVE atualizado com sucesso	-
400	Requisicao invalida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_versions_decomp

VersionChangeResponse change_versions_decomp(uuid, version_change_request)

Registra trocas de versão do DECOMP para um caso

Registra, em uma única operação, as trocas de versão do DECOMP associadas a um caso.

Regras importantes: - cada item de items[*] representa uma troca de versão - cada item deve informar mes, ano e versao - não é permitido registro duplicado para a mesma competência (mês/ano) - a ordem de envio não influencia a escrita final no entrada.txt; a API ordena cronologicamente por ano e mês - quando items vier vazio, o card TROCAVRSDC é gerado com indicativo n

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.version_change_request import VersionChangeRequest
from pldpro_sdk.api_client.models.version_change_response import VersionChangeResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    version_change_request = {items=[{mes=1, ano=2025, versao=newave_v1}, {mes=3, ano=2025, versao=newave_v2}]} # VersionChangeRequest | 

    try:
        # Registra trocas de versão do DECOMP para um caso
        api_response = api_instance.change_versions_decomp(uuid, version_change_request)
        print("The response of CasesApi->change_versions_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_versions_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
version_change_request	VersionChangeRequest

Return type

VersionChangeResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trocas de versão do DECOMP atualizadas com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_versions_gevazp

VersionChangeResponse change_versions_gevazp(uuid, version_change_request)

Registra trocas de versão do GEVAZP para um caso

Registra, em uma única operação, as trocas de versão do GEVAZP associadas a um caso.

Regras importantes: - cada item de items[*] representa uma troca de versão - cada item deve informar mes, ano e versao - não é permitido registro duplicado para a mesma competência (mês/ano) - a ordem de envio não influencia a escrita final no entrada.txt; a API ordena cronologicamente por ano e mês - quando items vier vazio, o card TROCAVRSGV é gerado com indicativo n

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.version_change_request import VersionChangeRequest
from pldpro_sdk.api_client.models.version_change_response import VersionChangeResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    version_change_request = {items=[{mes=1, ano=2025, versao=newave_v1}, {mes=3, ano=2025, versao=newave_v2}]} # VersionChangeRequest | 

    try:
        # Registra trocas de versão do GEVAZP para um caso
        api_response = api_instance.change_versions_gevazp(uuid, version_change_request)
        print("The response of CasesApi->change_versions_gevazp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_versions_gevazp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
version_change_request	VersionChangeRequest

Return type

VersionChangeResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trocas de versão do GEVAZP atualizadas com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_versions_newave

VersionChangeResponse change_versions_newave(uuid, version_change_request)

Registra trocas de versão do NEWAVE para um caso

Registra, em uma única operação, as trocas de versão do NEWAVE associadas a um caso.

Regras importantes: - cada item de items[*] representa uma troca de versão - cada item deve informar mes, ano e versao - não é permitido registro duplicado para a mesma competência (mês/ano) - a ordem de envio não influencia a escrita final no entrada.txt; a API ordena cronologicamente por ano e mês - quando items vier vazio, o card TROCAVRSNWV é gerado com indicativo n

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.version_change_request import VersionChangeRequest
from pldpro_sdk.api_client.models.version_change_response import VersionChangeResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    version_change_request = {"items":[{"mes":1,"ano":2025,"versao":"newave_v1"},{"mes":3,"ano":2025,"versao":"newave_v2"}]} # VersionChangeRequest | 

    try:
        # Registra trocas de versão do NEWAVE para um caso
        api_response = api_instance.change_versions_newave(uuid, version_change_request)
        print("The response of CasesApi->change_versions_newave:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->change_versions_newave: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
version_change_request	VersionChangeRequest

Return type

VersionChangeResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trocas de versão do NEWAVE atualizadas com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

clonar_caso

CaseResponse clonar_caso(uuid)

Clona um caso existente

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Clona um caso existente
        api_response = api_instance.clonar_caso(uuid)
        print("The response of CasesApi->clonar_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->clonar_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caso clonado com sucesso	-
400	Erro ao clonar caso	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_consistency

ConsistencyConfigResponse configure_consistency(uuid, consistency_config_request)

Configura a rodada de consistência de um caso

Registra a configuração da rodada de consistêcia e reflete os valores nos cards CONSIST e FLGENCADCONSIST do entrada.txt local do caso.

Regras importantes: - rodaConsistencia é obrigatório - quando rodaConsistencia=true, o card CONSIST é escrito com valor 1 - quando rodaConsistencia=false, o card CONSIST é mantido comentado - encadeiaVolumes é opcional e assume true quando não informado - encadeiaVolumes=false exige rodaConsistencia=true - a avaliação de elegibilidade dos NÓS será integrada em etapa futura

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.consistency_config_request import ConsistencyConfigRequest
from pldpro_sdk.api_client.models.consistency_config_response import ConsistencyConfigResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    consistency_config_request = {"rodaConsistencia":true,"encadeiaVolumes":true} # ConsistencyConfigRequest | 

    try:
        # Configura a rodada de consistência de um caso
        api_response = api_instance.configure_consistency(uuid, consistency_config_request)
        print("The response of CasesApi->configure_consistency:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->configure_consistency: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
consistency_config_request	ConsistencyConfigRequest

Return type

ConsistencyConfigResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Configuração de consistência atualizada com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_dadger

DadgerConfigResponse configure_dadger(uuid, dadger_config_request)

Configura a geração do DADGER e a seleção de registros de um caso

Registra, em uma única operação, a configuração de geração do DADGER e a seleção de registros que devem ser modificados no entrada.txt local do caso.

Regras importantes: - gerarDadger é obrigatório - quando gerarDadger=true, tipoGeracaoDadger deve ser informado com os valores 1, 2 ou 3 - quando aplicável, as datas de início devem informar mês e ano válidos - registrosDadgerModificados aceita apenas os enums suportados do DADGER - quando gerarDadger=false, os demais cards são comentados na escrita

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.dadger_config_request import DadgerConfigRequest
from pldpro_sdk.api_client.models.dadger_config_response import DadgerConfigResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    dadger_config_request = {"gerarDadger":true,"tipoGeracaoDadger":3,"pararAposGerarDadger":false,"mesInicioDadgerCompleto":1,"anoInicioDadgerCompleto":2025,"mesInicioSelecaoDadger":3,"anoInicioSelecaoDadger":2025,"registrosDadgerModificados":["DP","VE","HE"]} # DadgerConfigRequest | 

    try:
        # Configura a geração do DADGER e a seleção de registros de um caso
        api_response = api_instance.configure_dadger(uuid, dadger_config_request)
        print("The response of CasesApi->configure_dadger:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->configure_dadger: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
dadger_config_request	DadgerConfigRequest

Return type

DadgerConfigResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Configuração do DADGER atualizada com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_execution_models

ExecutionModelsConfigResponse configure_execution_models(uuid, execution_models_config_request)

Configura a execução dos modelos, versões, revisão de parada e viabilização do DECOMP

Registra, em uma unica operação, a configuração de execução dos modelos NEWAVE, GEVAZP, DECOMP e DESSEM, suas versões associadas, a revisão de parada semanal e a viabilização do DECOMP refletidas no entrada.txt local do caso.

Regras importantes: - o payload e plano e aceita envio conjunto ou parcial - quando um modelo estiver com execução habilitada, sua versão final deve permanecer consistente - revisaoParada é opcional e, quando informado, deve respeitar o limite do formato já existente - a viabilizaçãoo do DECOMP exige execução final do DECOMP habilitada e número de tentativas válido - o resultado final não depende da ordem de envio das chamadas

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.execution_models_config_request import ExecutionModelsConfigRequest
from pldpro_sdk.api_client.models.execution_models_config_response import ExecutionModelsConfigResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    execution_models_config_request = {"executaNewave":true,"versaoNewave":29.1,"executaGevazp":true,"versaoGevazp":4.2,"executaDecomp":true,"versaoDecomp":31.17,"executaDessem":true,"revisaoParada":3,"viabilizaDecomp":true,"numeroTentativasViabilizaDecomp":5} # ExecutionModelsConfigRequest | 

    try:
        # Configura a execução dos modelos, versões, revisão de parada e viabilização do DECOMP
        api_response = api_instance.configure_execution_models(uuid, execution_models_config_request)
        print("The response of CasesApi->configure_execution_models:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->configure_execution_models: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
execution_models_config_request	ExecutionModelsConfigRequest

Return type

ExecutionModelsConfigResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Configuração de execução dos modelos atualizada com sucesso	-
400	Requisicao invalida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_execution_with_partida

ExecutionPartidaConfigResponse configure_execution_with_partida(uuid, execution_partida_config_request)

Configura a execução com partida de um caso

Registra, em uma única operação, a configuração de execução com partida refletida nos cards EXECUTAPARTIDA, PARTMES e MODELOPPQ do entrada.txt local do caso.

Regras importantes: - executaPartida é obrigatório e aceita apenas s ou n - partidaMensal é obrigatório e aceita apenas 0 ou 1 - modeloPartida é opcional, mas quando informado aceita apenas GV, NW ou DC - quando executaPartida=n, o MODELOPPQ não é persistido como valor ativo

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.execution_partida_config_request import ExecutionPartidaConfigRequest
from pldpro_sdk.api_client.models.execution_partida_config_response import ExecutionPartidaConfigResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    execution_partida_config_request = {"executaPartida":"s","partidaMensal":1} # ExecutionPartidaConfigRequest | 

    try:
        # Configura a execução com partida de um caso
        api_response = api_instance.configure_execution_with_partida(uuid, execution_partida_config_request)
        print("The response of CasesApi->configure_execution_with_partida:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->configure_execution_with_partida: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
execution_partida_config_request	ExecutionPartidaConfigRequest

Return type

ExecutionPartidaConfigResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Configuração de execução com partida atualizada com sucesso	-
400	Requisição inválida	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_initial_data

object configure_initial_data(uuid, case_initial_data_request)

Configura os dados iniciais para execução do caso

Grava os valores de configuraçõs iniciais de execução do caso no arquivo entrada, como período, horizonte, revisões e nome do caso.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_initial_data_request import CaseInitialDataRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    case_initial_data_request = {"anoInicial":2025,"mesInicial":1,"anoFinal":2026,"mesFinal":12,"tipoEncadeamentoSemanal":"SEMANAL","mesFinalSemanal":12,"anoFinalSemanal":2025,"revisaoFinalSemanal":2,"revisaoInicial":0,"horizonteAnosNw":[2025,2026,2027],"nomeCaso":"Nome do caso","executaPartida":"s","decompPartidaSemanal":1,"acopla":[{"mesInicial":1,"anoInicial":2025,"mesFinal":12,"anoFinal":2025},{"mesInicial":1,"anoInicial":2026,"mesFinal":12,"anoFinal":2026}],"maquinaVirtualDinamica":1,"scriptRodaModelo":"roda-modelo.sh"} # CaseInitialDataRequest | 

    try:
        # Configura os dados iniciais para execução do caso
        api_response = api_instance.configure_initial_data(uuid, case_initial_data_request)
        print("The response of CasesApi->configure_initial_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->configure_initial_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso.
case_initial_data_request	CaseInitialDataRequest

Return type

object

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: /, application/json

HTTP response details

Status code	Description	Response headers
204	Configuração registrada com sucesso.	-
400	Erro ao registrar configuração.	-
404	Caso não encontrado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_caso

CaseResponse create_caso(case_request)

Cria um novo caso associado a um node remoto

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_request import CaseRequest
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    case_request = {"nome":"Caso de Teste","pathRemote":"/remote/path/caso","uuidAuthNode":"550e8400-e29b-41d4-a716-446655440000"} # CaseRequest | 

    try:
        # Cria um novo caso associado a um node remoto
        api_response = api_instance.create_caso(case_request)
        print("The response of CasesApi->create_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->create_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
case_request	CaseRequest

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caso criado com sucesso	-
400	Erro ao criar caso	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_empty_caso

CaseResponse create_empty_caso(body)

Cria um caso vazio

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    body = Nome do caso # str | 

    try:
        # Cria um caso vazio
        api_response = api_instance.create_empty_caso(body)
        print("The response of CasesApi->create_empty_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->create_empty_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: text/plain
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caso criado com sucesso	-
400	Erro ao criar caso vazio	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_caso

object delete_caso(uuid)

Deleta um caso

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Deleta um caso
        api_response = api_instance.delete_caso(uuid)
        print("The response of CasesApi->delete_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->delete_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

object

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /, application/json

HTTP response details

Status code	Description	Response headers
200	Caso deletado com sucesso	-
400	Erro ao deletar caso	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_files

delete_files(uuid, files)

Remove múltiplos arquivos de um caso

Exclui um ou mais arquivos remotos associados ao caso identificado pelo UUID, onde o caminho é sempre relativo à pasta raiz do caso dentro do diretório remoto.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    files = ['[file.txt, /newave/file2.txt, /decomp/file3.txt]'] # List[str] | Lista de caminhos de arquivos a serem deletados. Envie o parâmetro várias vezes para deletar múltiplos arquivos.

    try:
        # Remove múltiplos arquivos de um caso
        api_instance.delete_files(uuid, files)
    except Exception as e:
        print("Exception when calling CasesApi->delete_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
files	List[str]	Lista de caminhos de arquivos a serem deletados. Envie o parâmetro várias vezes para deletar múltiplos arquivos.

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	Arquivos deletados com sucesso.	-
400	Erro ao deletar arquivos.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_files1

object delete_files1(uuid, filename)

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    filename = 'filename_example' # str | 

    try:
        api_response = api_instance.delete_files1(uuid, filename)
        print("The response of CasesApi->delete_files1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->delete_files1: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID
filename	str

Return type

object

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_inputs

bytes download_inputs(uuid)

Faz o download dos arquivos de entrada de um caso

Gera um arquivo .zip contendo todos os arquivos de entrada do caso especificado pelo UUID.

O download inclui tanto arquivos locais quanto remotos, conforme a configuração do caso.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso

    try:
        # Faz o download dos arquivos de entrada de um caso
        api_response = api_instance.download_inputs(uuid)
        print("The response of CasesApi->download_inputs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->download_inputs: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

bytes

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/zip, application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo ZIP contendo os arquivos de entrada do caso.	-
404	Arquivo ZIP não encontrado.	-
400	Erro ao gerar o arquivo de download.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_inputs_file

bytes download_inputs_file(uuid)

Faz o download dos arquivos de entrada do pldpro

Gera e baixa um .zip contendo apenas o arquivo de entrada, pertencente ao caso identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso

    try:
        # Faz o download dos arquivos de entrada do pldpro
        api_response = api_instance.download_inputs_file(uuid)
        print("The response of CasesApi->download_inputs_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->download_inputs_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

bytes

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/zip, application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo ZIP contendo o arquivo solicitado.	-
404	Arquivo solicitado não encontrado.	-
400	Erro ao gerar o download do arquivo solicitado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_specific_file

bytes download_specific_file(uuid, filename)

Faz o download de um arquivo específico de entrada de um caso

Gera e baixa um arquivo .zip contendo apenas o arquivo de entrada solicitado, pertencente ao caso identificado pelo UUID.

O arquivo é localizado a partir do caminho relativo informado em filename, dentro da estrutura de diretórios do caso.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    filename = 'newave/dadger.dat' # str | Caminho relativo do arquivo de entrada a ser baixado dentro do diretório do caso. Exemplo: `newave/dadger.dat`. 

    try:
        # Faz o download de um arquivo específico de entrada de um caso
        api_response = api_instance.download_specific_file(uuid, filename)
        print("The response of CasesApi->download_specific_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->download_specific_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso.
filename	str	Caminho relativo do arquivo de entrada a ser baixado dentro do diretório do caso. Exemplo: `newave/dadger.dat`.

Return type

bytes

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/zip, application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo ZIP contendo o arquivo solicitado.	-
404	Arquivo solicitado não encontrado para o caso informado.	-
400	Erro ao gerar o download do arquivo solicitado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

escrever_cortes_path

str escrever_cortes_path(uuid, body)

Escreve o caminho dos cortes no arquivo de entrada do caso

Atualiza o caso identificado pelo UUID, escrevendo o caminho dos cortes no arquivo de entrada remoto. Caso o entrada.txt não esteja na pasta do caso retornará um erro.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    body = /home/usuario/cortes/ciclo7/cortes.dat # str | 

    try:
        # Escreve o caminho dos cortes no arquivo de entrada do caso
        api_response = api_instance.escrever_cortes_path(uuid, body)
        print("The response of CasesApi->escrever_cortes_path:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->escrever_cortes_path: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
body	str

Return type

str

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	Caminho dos cortes escrito com sucesso no arquivo de entrada.	-
400	Erro ao escrever o caminho dos cortes.	-
404	Caso não encontrado.	-
0	Erro inesperado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filter_casos

PaginatedCasoResponse filter_casos(uuid=uuid, host_uuid=host_uuid, nome=nome, path_remote=path_remote, has_local_path=has_local_path, created_from=created_from, created_to=created_to, page=page, size=size, sort=sort)

Lista ou filtra casos

Retorna uma página de casos do tenant atual, com filtros opcionais.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.paginated_caso_response import PaginatedCasoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador do caso. (optional)
    host_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador do host remoto associado ao caso. (optional)
    nome = 'nome_example' # str | Nome do caso, ou parte dele. (optional)
    path_remote = 'path_remote_example' # str | Trecho do caminho remoto associado ao caso. (optional)
    has_local_path = True # bool | Informa se o caso deve possuir caminho local. (optional)
    created_from = '2013-10-20T19:20:30+01:00' # datetime | Data e hora inicial de criação do caso, no formato ISO-8601. (optional)
    created_to = '2013-10-20T19:20:30+01:00' # datetime | Data e hora final de criação do caso, no formato ISO-8601. (optional)
    page = 0 # int | Página desejada, iniciando em zero. (optional) (default to 0)
    size = 20 # int | Quantidade de itens por página. (optional) (default to 20)
    sort = ["createdAt,DESC"] # List[str] | Ordenação no formato propriedade,direção. (optional) (default to ["createdAt,DESC"])

    try:
        # Lista ou filtra casos
        api_response = api_instance.filter_casos(uuid=uuid, host_uuid=host_uuid, nome=nome, path_remote=path_remote, has_local_path=has_local_path, created_from=created_from, created_to=created_to, page=page, size=size, sort=sort)
        print("The response of CasesApi->filter_casos:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->filter_casos: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador do caso.	[optional]
host_uuid	UUID	Identificador do host remoto associado ao caso.	[optional]
nome	str	Nome do caso, ou parte dele.	[optional]
path_remote	str	Trecho do caminho remoto associado ao caso.	[optional]
has_local_path	bool	Informa se o caso deve possuir caminho local.	[optional]
created_from	datetime	Data e hora inicial de criação do caso, no formato ISO-8601.	[optional]
created_to	datetime	Data e hora final de criação do caso, no formato ISO-8601.	[optional]
page	int	Página desejada, iniciando em zero.	[optional][default to 0]
size	int	Quantidade de itens por página.	[optional][default to 20]
sort	List[str]	Ordenação no formato propriedade,direção.	[optional][default to ["createdAt,DESC"]]

Return type

PaginatedCasoResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lista de casos paginada retornada com sucesso.	-
400	Erro ao filtrar casos	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_caso

CaseResponse get_caso(uuid)

Obtém informações de um caso

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.case_response import CaseResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Obtém informações de um caso
        api_response = api_instance.get_caso(uuid)
        print("The response of CasesApi->get_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->get_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

CaseResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Caso retornado com sucesso	-
400	Erro ao obter caso	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_caso_execution_console_logs

str get_caso_execution_console_logs(uuid)

Obtém a saída de console da execução do caso

Retorna o conteúdo textual da saída de console (stdout) gerada pela execução associada ao caso identificado pelo UUID.

Caso a saída ainda não exista, é retornada uma string vazia.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso cuja saída de console será consultada.

    try:
        # Obtém a saída de console da execução do caso
        api_response = api_instance.get_caso_execution_console_logs(uuid)
        print("The response of CasesApi->get_caso_execution_console_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->get_caso_execution_console_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso cuja saída de console será consultada.

Return type

str

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	Saída de console retornada com sucesso.	-
400	Erro ao obter a saída de console da execução.	-
404	Caso não encontrado ou saída de console inexistente.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_caso_execution_logs

str get_caso_execution_logs(uuid)

Obtém o log da execução do caso

Retorna o conteúdo textual do log gerado durante a execução associada ao caso identificado pelo UUID informado.

Caso o log ainda não exista, é retornada uma string vazia.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso cuja execução será consultada.

    try:
        # Obtém o log da execução do caso
        api_response = api_instance.get_caso_execution_logs(uuid)
        print("The response of CasesApi->get_caso_execution_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->get_caso_execution_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso cuja execução será consultada.

Return type

str

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	Log retornado com sucesso.	-
400	Erro ao obter o log da execução.	-
404	Caso não encontrado ou log inexistente.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_caso_execution_status

ExecutionResponse get_caso_execution_status(uuid)

Consulta o status atual de uma execução

Retorna as informações completas da execução associada ao UUID informado, incluindo status, modo de execução, timestamps e dados do caso (incluindo o AuthNode associado).

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.execution_response import ExecutionResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único da execução.

    try:
        # Consulta o status atual de uma execução
        api_response = api_instance.get_caso_execution_status(uuid)
        print("The response of CasesApi->get_caso_execution_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->get_caso_execution_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único da execução.

Return type

ExecutionResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Status da execução retornado com sucesso.	-
400	Erro ao consultar o status da execução.	-
404	Execução não encontrada ou ainda não iniciada.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_casos_files

FileNode get_casos_files(uuid)

Lista a árvore de arquivos de um caso

Retorna a estrutura hierárquica de diretórios e arquivos associados a um caso, separados entre armazenamento local e remoto.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_node import FileNode
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso

    try:
        # Lista a árvore de arquivos de um caso
        api_response = api_instance.get_casos_files(uuid)
        print("The response of CasesApi->get_casos_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->get_casos_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

FileNode

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Estrutura de arquivos retornada com sucesso.	-
400	Erro ao listar arquivos do caso.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_caso_execution

ExecutionResponse start_caso_execution(uuid, execution_start_request)

Inicia a execução de um caso

Inicia a execução do caso identificado pelo UUID informado.

• O campo version é obrigatório para a execução.
• O campo tipoScript controla qual script deve ser gerado pela API, sendo as opções COMPLETE,PLDPRO_ONLY e GERA_DECK_ONLY.
• O campo optionsExecutaModelo permite informar opções adicionais para a execução do modelo, como o tipo de execução e parâmetros de infraestrutura.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.execution_response import ExecutionResponse
from pldpro_sdk.api_client.models.execution_start_request import ExecutionStartRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso a ser executado.
    execution_start_request = {"version":"6.12.3","tipoScript":"COMPLETE","listaUUIDAuthNodes":["550e8400-e29b-41d4-a716-446655440000","d7b8fdf5-9f4f-4f35-a1b5-6b8b5f45a111"],"optionsExecutaModelo":{"localExecution":"CLOUD","projectId":"meu-projeto-gcp","reservationId":"reserva-123","machineType":"c3dhm360","optionModeloCore":[{"modelType":"DECOMP","coresPerNode":128}],"jobEmail":"xlibs@cepel.br","configDir":"/nfsshare/xlibs/config"}} # ExecutionStartRequest | Parâmetros opcionais de execução.

    try:
        # Inicia a execução de um caso
        api_response = api_instance.start_caso_execution(uuid, execution_start_request)
        print("The response of CasesApi->start_caso_execution:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->start_caso_execution: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso a ser executado.
execution_start_request	ExecutionStartRequest	Parâmetros opcionais de execução.

Return type

ExecutionResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Execução iniciada com sucesso.	-
400	Erro ao iniciar a execução do caso.	-
404	Caso não encontrado.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

status_caso

str status_caso(uuid)

Obtém o status de um caso

Retorna o status de execução do caso identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Obtém o status de um caso
        api_response = api_instance.status_caso(uuid)
        print("The response of CasesApi->status_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->status_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

str

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Status retornado com sucesso	-
400	Erro ao obter status	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stop_caso_execution

str stop_caso_execution(uuid)

Interrompe a execução de um caso

Interrompe a execução em andamento do caso identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único da execução cuja deve ser interrompida.

    try:
        # Interrompe a execução de um caso
        api_response = api_instance.stop_caso_execution(uuid)
        print("The response of CasesApi->stop_caso_execution:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->stop_caso_execution: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único da execução cuja deve ser interrompida.

Return type

str

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	Execução interrompida com sucesso.	-
400	Erro ao tentar interromper a execução.	-
404	Caso não encontrado ou sem execução associada.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_cenarios_dessem

FileUploadResponse upload_cenarios_dessem(uuid, file)

Faz upload dos arquivos de cenários DESSEM

Realiza o upload de um ou mais arquivos de cenários DESSEM para o caso especificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # List[bytes] | 

    try:
        # Faz upload dos arquivos de cenários DESSEM
        api_response = api_instance.upload_cenarios_dessem(uuid, file)
        print("The response of CasesApi->upload_cenarios_dessem:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_cenarios_dessem: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	List[bytes]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivos de cenários DESSEM enviados com sucesso.	-
400	Erro ao enviar arquivos de cenários DESSEM.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_deck_partida

FileUploadResponse upload_deck_partida(uuid, partida_config, file=file)

Faz upload dos arquivos de partida

Realiza o upload de um arquivo zip para o diretório deck-partida do caso especificado pelo UUID.
Além dos arquivos, o cliente deve enviar também o objeto partida-config contendo o JSON com tipo de encadeamento, mês, ano e revisão finais do encadeamento semanal.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    partida_config = 'partida_config_example' # str | Configuração do deck de partida como JSON em texto.
    file = None # List[object] |  (optional)

    try:
        # Faz upload dos arquivos de partida
        api_response = api_instance.upload_deck_partida(uuid, partida_config, file=file)
        print("The response of CasesApi->upload_deck_partida:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_deck_partida: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso.
partida_config	str	Configuração do deck de partida como JSON em texto.
file	List[object]		[optional]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Upload realizado com sucesso e comandos de partida aplicados.	-
400	Erro no upload ou na validação dos arquivos de partida.	-
500	Erro interno no processamento da partida semanal.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_deck_partida_semanal

FileUploadResponse upload_deck_partida_semanal(uuid, partida_semanal_config, file=file)

Faz upload dos arquivos de partida semanal

Realiza o upload de um arquivo zip para o diretório deck-partida-semanal do caso identificado pelo UUID.
Este endpoint também recebe o objeto partida-semanal-config, contendo o JSON que informa a execução de DECOMP, GEVAZP e o arquivo de previsões do GEVAZP.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    partida_semanal_config = 'partida_semanal_config_example' # str | Configuração da partida semanal como JSON em texto.
    file = None # List[object] |  (optional)

    try:
        # Faz upload dos arquivos de partida semanal
        api_response = api_instance.upload_deck_partida_semanal(uuid, partida_semanal_config, file=file)
        print("The response of CasesApi->upload_deck_partida_semanal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_deck_partida_semanal: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso.
partida_semanal_config	str	Configuração da partida semanal como JSON em texto.
file	List[object]		[optional]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Upload realizado com sucesso e configurações aplicadas.	-
400	Erro no upload ou na validação do deck de partida semanal.	-
500	Erro interno durante o processamento da partida semanal.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_ena_ree

FileUploadResponse upload_ena_ree(uuid, data_prevs, file)

Faz upload do arquivo de ENA por REE

Realiza o upload do arquivo de ENA por REE para o caso especificado pelo UUID. A data deve obrigatoriamente estar no formato YYYY-MM-DD.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    data_prevs = '2013-10-20' # date | Data de referência do PREVS no formato YYYY-MM-DD.
    file = None # bytes | Arquivo de ENA por REE.

    try:
        # Faz upload do arquivo de ENA por REE
        api_response = api_instance.upload_ena_ree(uuid, data_prevs, file)
        print("The response of CasesApi->upload_ena_ree:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_ena_ree: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
data_prevs	date	Data de referência do PREVS no formato YYYY-MM-DD.
file	bytes	Arquivo de ENA por REE.

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo ENA/REE enviado com sucesso.	-
400	Erro ao enviar arquivo ENA/REE.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_file_entrada

FileUploadResponse upload_file_entrada(uuid, file)

Faz upload do arquivo entrada.txt

Realiza o upload do arquivo entrada.txt para o caso especificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | 

    try:
        # Faz upload do arquivo entrada.txt
        api_response = api_instance.upload_file_entrada(uuid, file)
        print("The response of CasesApi->upload_file_entrada:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_file_entrada: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo enviado com sucesso.	-
400	Erro ao enviar arquivo para o caso.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_files

FileUploadResponse upload_files(uuid, file)

Faz upload de arquivos para um caso

Realiza o upload de um ou mais arquivos (em formato multipart) para o caso especificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # List[bytes] | 

    try:
        # Faz upload de arquivos para um caso
        api_response = api_instance.upload_files(uuid, file)
        print("The response of CasesApi->upload_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	List[bytes]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivos enviados com sucesso.	-
400	Erro ao enviar arquivos para o caso.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_prevs_files

FileUploadResponse upload_prevs_files(uuid, multipart_files, encadeamento=encadeamento)

Faz upload de arquivos PREVS para o caso

Realiza o upload de um ou mais arquivos (multipart/form-data) para a pasta prevs do caso identificado por uuid.

O destino do arquivo depende do campo prevs: - CONVERSOR: armazena o(s) arquivo(s) na raiz do projeto/caso, para leitura do conversor. - DEFAULT: armazena no esqueleto do PLDPro (ex.: dentro da estrutura do gevaz), de acordo com o encadeamento.

Se houver a existência de um arquivo .xslx a API vai entender que o caso é do tipo CONVERSOR, caso contrário será DEFAULT

Campo opcional: - encadeamento: (SEMANAL | MENSAL) — aplicável quando o caso for DEFAULT. Se não informado, o padrão é SEMANAL.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    multipart_files = None # bytes | Arquivo PREVS a ser enviado.
    encadeamento = 'encadeamento_example' # str | Encadeamento usado para definir o destino do arquivo. (optional)

    try:
        # Faz upload de arquivos PREVS para o caso
        api_response = api_instance.upload_prevs_files(uuid, multipart_files, encadeamento=encadeamento)
        print("The response of CasesApi->upload_prevs_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_prevs_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
multipart_files	bytes	Arquivo PREVS a ser enviado.
encadeamento	str	Encadeamento usado para definir o destino do arquivo.	[optional]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivos enviados com sucesso	-
400	Erro de validação ou dados inválidos na requisição	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_regras_ana

FileUploadResponse upload_regras_ana(uuid, file, apaga_regras=apaga_regras)

Faz upload do arquivo regras-ana

Realiza o upload do arquivo regras-ana para o caso especificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo regras-ana.
    apaga_regras = 'apaga_regras_example' # str | Informa se as regras existentes devem ser apagadas antes do upload. (optional)

    try:
        # Faz upload do arquivo regras-ana
        api_response = api_instance.upload_regras_ana(uuid, file, apaga_regras=apaga_regras)
        print("The response of CasesApi->upload_regras_ana:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_regras_ana: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo regras-ana.
apaga_regras	str	Informa se as regras existentes devem ser apagadas antes do upload.	[optional]

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo regras-ana enviado com sucesso.	-
400	Erro ao enviar arquivo regras-ana.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_volume_final_decomp

FileUploadResponse upload_volume_final_decomp(uuid, tipo_alteracao, file)

Faz upload do arquivo volfdc para o caso

Realiza o upload do arquivo volfdc para o caso especificado pelo UUID. O campo tipoAlteracao deve conter um dos valores permitidos: usih, ree, subm.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    tipo_alteracao = 'tipo_alteracao_example' # str | Tipo de alteração aplicado ao volume final.
    file = None # bytes | Arquivo volfdc.

    try:
        # Faz upload do arquivo volfdc para o caso
        api_response = api_instance.upload_volume_final_decomp(uuid, tipo_alteracao, file)
        print("The response of CasesApi->upload_volume_final_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_volume_final_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
tipo_alteracao	str	Tipo de alteração aplicado ao volume final.
file	bytes	Arquivo volfdc.

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo volfdc enviado com sucesso.	-
400	Erro ao enviar arquivo volfdc.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_volume_partida_decomp

FileUploadResponse upload_volume_partida_decomp(uuid, data_volume_partida, file)

Faz upload do arquivo volume-partida-dc

Realiza o upload do arquivo de volume de partida do DECOMP para o caso especificado pelo UUID. A data deve obrigatoriamente estar no formato YYYY-MM-DD.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.file_upload_response import FileUploadResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['1_tenant'] = 'Bearer'

# Configure API key authorization: 4_roles
configuration.api_key['4_roles'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['4_roles'] = 'Bearer'

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: 2_user
configuration.api_key['2_user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['2_user'] = 'Bearer'

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure API key authorization: 3_user_id
configuration.api_key['3_user_id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['3_user_id'] = 'Bearer'

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.CasesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    data_volume_partida = '2013-10-20' # date | Data do volume de partida no formato YYYY-MM-DD.
    file = None # bytes | Arquivo de volume de partida do DECOMP.

    try:
        # Faz upload do arquivo volume-partida-dc
        api_response = api_instance.upload_volume_partida_decomp(uuid, data_volume_partida, file)
        print("The response of CasesApi->upload_volume_partida_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasesApi->upload_volume_partida_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
data_volume_partida	date	Data do volume de partida no formato YYYY-MM-DD.
file	bytes	Arquivo de volume de partida do DECOMP.

Return type

FileUploadResponse

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Arquivo volume-partida-dc enviado com sucesso.	-
400	Erro ao enviar arquivo volume-partida-dc.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]