pldpro_sdk.api_client.CasosApi

Authorization

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

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

associar_cortes_to_caso

CasoResponse associar_cortes_to_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_response import CasoResponse
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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    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(uuid, cortes_request)
        print("The response of CasosApi->associar_cortes_to_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->associar_cortes_to_caso: %s\n" % e)

Parameters

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

Return type

Authorization

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

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

change_files_decomp

UploadTrocasArquivosResponse 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

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

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.upload_trocas_arquivos_response import UploadTrocasArquivosResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    metadata = 'metadata_example' # str | JSON serializado de UploadTrocasArquivosRequest

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
metadata	str	JSON serializado de UploadTrocasArquivosRequest

Return type

UploadTrocasArquivosResponse

Authorization

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

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	-

change_files_newave

UploadTrocasArquivosResponse 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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.upload_trocas_arquivos_response import UploadTrocasArquivosResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    metadata = 'metadata_example' # str | JSON serializado de UploadTrocasArquivosRequest

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
metadata	str	JSON serializado de UploadTrocasArquivosRequest

Return type

UploadTrocasArquivosResponse

Authorization

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

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	-

change_processors_decomp

NumeroProcessadoresResponse change_processors_decomp(uuid, numero_processadores_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.numero_processadores_request import NumeroProcessadoresRequest
from pldpro_sdk.api_client.models.numero_processadores_response import NumeroProcessadoresResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    numero_processadores_request = pldpro_sdk.api_client.NumeroProcessadoresRequest() # NumeroProcessadoresRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
numero_processadores_request	NumeroProcessadoresRequest

Return type

NumeroProcessadoresResponse

Authorization

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

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	-

change_processors_newave

NumeroProcessadoresResponse change_processors_newave(uuid, numero_processadores_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.numero_processadores_request import NumeroProcessadoresRequest
from pldpro_sdk.api_client.models.numero_processadores_response import NumeroProcessadoresResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    numero_processadores_request = pldpro_sdk.api_client.NumeroProcessadoresRequest() # NumeroProcessadoresRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
numero_processadores_request	NumeroProcessadoresRequest

Return type

NumeroProcessadoresResponse

Authorization

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

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	-

change_versions_decomp

TrocaVersaoResponse change_versions_decomp(uuid, troca_versao_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.troca_versao_request import TrocaVersaoRequest
from pldpro_sdk.api_client.models.troca_versao_response import TrocaVersaoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    troca_versao_request = pldpro_sdk.api_client.TrocaVersaoRequest() # TrocaVersaoRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
troca_versao_request	TrocaVersaoRequest

Return type

TrocaVersaoResponse

Authorization

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

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	-

change_versions_gevazp

TrocaVersaoResponse change_versions_gevazp(uuid, troca_versao_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.troca_versao_request import TrocaVersaoRequest
from pldpro_sdk.api_client.models.troca_versao_response import TrocaVersaoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    troca_versao_request = pldpro_sdk.api_client.TrocaVersaoRequest() # TrocaVersaoRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
troca_versao_request	TrocaVersaoRequest

Return type

TrocaVersaoResponse

Authorization

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

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	-

change_versions_newave

TrocaVersaoResponse change_versions_newave(uuid, troca_versao_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.troca_versao_request import TrocaVersaoRequest
from pldpro_sdk.api_client.models.troca_versao_response import TrocaVersaoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    troca_versao_request = pldpro_sdk.api_client.TrocaVersaoRequest() # TrocaVersaoRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
troca_versao_request	TrocaVersaoRequest

Return type

TrocaVersaoResponse

Authorization

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

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	-

clonar_caso

CasoResponse clonar_caso(uuid)

Clona um caso existente

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_response import CasoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->clonar_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->clonar_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

Authorization

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

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	-

configure_dadger

ConfiguracaoDadgerResponse configure_dadger(uuid, configuracao_dadger_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.configuracao_dadger_request import ConfiguracaoDadgerRequest
from pldpro_sdk.api_client.models.configuracao_dadger_response import ConfiguracaoDadgerResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    configuracao_dadger_request = {gerarDadger=true, tipoGeracaoDadger=3, pararAposGerarDadger=false, mesInicioDadgerCompleto=1, anoInicioDadgerCompleto=2025, mesInicioSelecaoDadger=3, anoInicioSelecaoDadger=2025, registrosDadgerModificados=[DP, VE, HE]} # ConfiguracaoDadgerRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
configuracao_dadger_request	ConfiguracaoDadgerRequest

Return type

ConfiguracaoDadgerResponse

Authorization

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

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	-

configure_execution_models

ConfiguracaoExecucaoModelosResponse configure_execution_models(uuid, configuracao_execucao_modelos_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.configuracao_execucao_modelos_request import ConfiguracaoExecucaoModelosRequest
from pldpro_sdk.api_client.models.configuracao_execucao_modelos_response import ConfiguracaoExecucaoModelosResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    configuracao_execucao_modelos_request = {executaNewave=true, versaoNewave=29.1, executaGevazp=true, versaoGevazp=4.2, executaDecomp=true, versaoDecomp=31.17, executaDessem=true, revisaoParada=3, viabilizaDecomp=true, numeroTentativasViabilizaDecomp=5} # ConfiguracaoExecucaoModelosRequest | 

    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, configuracao_execucao_modelos_request)
        print("The response of CasosApi->configure_execution_models:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->configure_execution_models: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
configuracao_execucao_modelos_request	ConfiguracaoExecucaoModelosRequest

Return type

ConfiguracaoExecucaoModelosResponse

Authorization

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

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	-

configure_execution_with_partida

ConfiguracaoExecucaoPartidaResponse configure_execution_with_partida(uuid, configuracao_execucao_partida_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.configuracao_execucao_partida_request import ConfiguracaoExecucaoPartidaRequest
from pldpro_sdk.api_client.models.configuracao_execucao_partida_response import ConfiguracaoExecucaoPartidaResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | UUID do caso
    configuracao_execucao_partida_request = {executaPartida=s, partidaMensal=1, modeloPartida=NW} # ConfiguracaoExecucaoPartidaRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	UUID do caso
configuracao_execucao_partida_request	ConfiguracaoExecucaoPartidaRequest

Return type

ConfiguracaoExecucaoPartidaResponse

Authorization

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

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	-

configure_initial_data

configure_initial_data(uuid, caso_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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_initial_data_request import CasoInitialDataRequest
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    caso_initial_data_request = pldpro_sdk.api_client.CasoInitialDataRequest() # CasoInitialDataRequest | 

    try:
        # Configura os dados iniciais para execução do caso
        api_instance.configure_initial_data(uuid, caso_initial_data_request)
    except Exception as e:
        print("Exception when calling CasosApi->configure_initial_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso.
caso_initial_data_request	CasoInitialDataRequest

Return type

void (empty response body)

Authorization

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

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

create_caso

CasoResponse create_caso(caso_request)

Cria um novo caso associado a um node remoto

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_request import CasoRequest
from pldpro_sdk.api_client.models.caso_response import CasoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    caso_request = pldpro_sdk.api_client.CasoRequest() # CasoRequest | 

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

Parameters

Name	Type	Description	Notes
caso_request	CasoRequest

Return type

Authorization

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

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	-

create_empty_caso

CasoResponse create_empty_caso(body)

Cria um caso vazio

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_response import CasoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    body = 'body_example' # str | 

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

Parameters

Name	Type	Description	Notes
body	str

Return type

Authorization

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

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	-

delete_caso

delete_caso(uuid)

Deleta um caso

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Deleta um caso
        api_instance.delete_caso(uuid)
    except Exception as e:
        print("Exception when calling CasosApi->delete_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

void (empty response body)

Authorization

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

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	-

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

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

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

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

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->download_inputs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->download_inputs: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

bytes

Authorization

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

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.	* Content-Disposition - Define o nome do arquivo de saída. * Cache-Control - Indica que a resposta não deve ser armazenada em cache.
404	Arquivo ZIP não encontrado.	-
400	Erro ao gerar o arquivo de download.	-

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->download_inputs_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->download_inputs_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

bytes

Authorization

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

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.	* Content-Disposition - Define o nome do arquivo de saída. * Cache-Control - Indica que a resposta não deve ser armazenada em cache.
404	Arquivo solicitado não encontrado.	-
400	Erro ao gerar o download do arquivo solicitado.	-

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->download_specific_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->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

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

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.	* Content-Disposition - Define o nome do arquivo de saída. * Cache-Control - Indica que a resposta não deve ser armazenada em cache.
404	Arquivo solicitado não encontrado para o caso informado.	-
400	Erro ao gerar o download do arquivo solicitado.	-

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->escrever_cortes_path:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->escrever_cortes_path: %s\n" % e)

Parameters

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

Return type

str

Authorization

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

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

filter_casos

PaginatedCasoResponse filter_casos(nome=nome, created_at=created_at, page=page, size=size, sort=sort)

Lista ou filtra casos

Retorna uma lista paginada de casos com filtros opcionais.

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    nome = 'nome_example' # str | Nome do caso (filtro opcional) (optional)
    created_at = '2013-10-20T19:20:30+01:00' # datetime | Data de criação (filtro opcional) (optional)
    page = 0 # int |  (optional) (default to 0)
    size = 20 # int |  (optional) (default to 20)
    sort = 'createdAt,DESC' # str |  (optional)

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

Parameters

Name	Type	Description	Notes
nome	str	Nome do caso (filtro opcional)	[optional]
created_at	datetime	Data de criação (filtro opcional)	[optional]
page	int		[optional][default to 0]
size	int		[optional][default to 20]
sort	str		[optional]

Return type

PaginatedCasoResponse

Authorization

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

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	-

get_caso

CasoResponse get_caso(uuid)

Obtém informações de um caso

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.caso_response import CasoResponse
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->get_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->get_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

Authorization

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

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	-

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->get_casos_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->get_casos_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso

Return type

FileNode

Authorization

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

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

status_caso

StatusEnum 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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.status_enum import StatusEnum
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(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 CasosApi->status_caso:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->status_caso: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

StatusEnum

Authorization

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

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	-

upload_cenarios_dessem

FileUploadResponse upload_cenarios_dessem(uuid, file=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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # List[bytes] | Lista de arquivos de cenários DESSEM a serem enviados (optional)

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

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	List[bytes]	Lista de arquivos de cenários DESSEM a serem enviados	[optional]

Return type

Authorization

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

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

upload_deck_partida

FileUploadResponse upload_deck_partida(uuid, file, partida_config)

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 as configurações necessárias para preencher os valores de mês final, ano final e revisão para o encadeamento semanal do DECOMP e GEVAZP.

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    file = None # List[bytes] | Lista de arquivos referentes ao deck de partida.
    partida_config = pldpro_sdk.api_client.PartidaConfig() # PartidaConfig | 

    try:
        # Faz upload dos arquivos de partida
        api_response = api_instance.upload_deck_partida(uuid, file, partida_config)
        print("The response of CasosApi->upload_deck_partida:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_deck_partida: %s\n" % e)

Parameters

Name	Type	Description
uuid	UUID	Identificador único do caso.
file	List[bytes]	Lista de arquivos referentes ao deck de partida.
partida_config	PartidaConfig

Return type

Authorization

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

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

upload_deck_partida_semanal

FileUploadResponse upload_deck_partida_semanal(uuid, file, partida_semanal_config)

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 as informações necessárias para configurar corretamente o mês final, ano final, revisão e demais parâmetros específicos da partida semanal.

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso.
    file = None # List[bytes] | Lista de arquivos referentes ao deck de partida semanal.
    partida_semanal_config = pldpro_sdk.api_client.PartidaSemanalConfig() # PartidaSemanalConfig | 

    try:
        # Faz upload dos arquivos de partida semanal
        api_response = api_instance.upload_deck_partida_semanal(uuid, file, partida_semanal_config)
        print("The response of CasosApi->upload_deck_partida_semanal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_deck_partida_semanal: %s\n" % e)

Parameters

Name	Type	Description
uuid	UUID	Identificador único do caso.
file	List[bytes]	Lista de arquivos referentes ao deck de partida semanal.
partida_semanal_config	PartidaSemanalConfig

Return type

Authorization

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

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

upload_ena_ree

FileUploadResponse upload_ena_ree(uuid, file=file, data_prevs=data_prevs)

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo de ENA/REE a ser enviado (optional)
    data_prevs = '2013-10-20' # date | Data de previsão utilizada na configuração do arquivo.   **Formato obrigatório: YYYY-MM-DD**.  (optional)

    try:
        # Faz upload do arquivo de ENA por REE
        api_response = api_instance.upload_ena_ree(uuid, file=file, data_prevs=data_prevs)
        print("The response of CasosApi->upload_ena_ree:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_ena_ree: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo de ENA/REE a ser enviado	[optional]
data_prevs	date	Data de previsão utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD.	[optional]

Return type

Authorization

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

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

upload_file_entrada

FileUploadResponse upload_file_entrada(uuid, file=file)

Faz upload do arquivo entrada.txt

Realiza o upload do arquivo entrada.txt para o caso especificado pelo UUID.

Example

Api Key Authentication (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo entrada.txt a ser enviado (optional)

    try:
        # Faz upload do arquivo entrada.txt
        api_response = api_instance.upload_file_entrada(uuid, file=file)
        print("The response of CasosApi->upload_file_entrada:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_file_entrada: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo entrada.txt a ser enviado	[optional]

Return type

Authorization

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

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

upload_files

FileUploadResponse upload_files(uuid, file=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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # List[bytes] | Lista de arquivos a serem enviados (optional)

    try:
        # Faz upload de arquivos para um caso
        api_response = api_instance.upload_files(uuid, file=file)
        print("The response of CasosApi->upload_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	List[bytes]	Lista de arquivos a serem enviados	[optional]

Return type

Authorization

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

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

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    multipart_files = None # bytes | Lista de arquivos a serem enviados (um ou mais)
    encadeamento = pldpro_sdk.api_client.TipoEncadeamentoSemanal() # TipoEncadeamentoSemanal |  (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 CasosApi->upload_prevs_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_prevs_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
multipart_files	bytes	Lista de arquivos a serem enviados (um ou mais)
encadeamento	TipoEncadeamentoSemanal		[optional]

Return type

Authorization

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

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	-

upload_regras_ana

FileUploadResponse upload_regras_ana(uuid, file=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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo regras-ana a ser enviado (optional)
    apaga_regras = pldpro_sdk.api_client.TipoApagaRegrasEnum() # TipoApagaRegrasEnum |  (optional)

    try:
        # Faz upload do arquivo regras-ana
        api_response = api_instance.upload_regras_ana(uuid, file=file, apaga_regras=apaga_regras)
        print("The response of CasosApi->upload_regras_ana:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_regras_ana: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo regras-ana a ser enviado	[optional]
apaga_regras	TipoApagaRegrasEnum		[optional]

Return type

Authorization

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

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

upload_volume_final_decomp

FileUploadResponse upload_volume_final_decomp(uuid, file=file, tipo_alteracao=tipo_alteracao)

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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

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

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo volfdc a ser enviado (optional)
    tipo_alteracao = pldpro_sdk.api_client.TipoAlteracaoEnum() # TipoAlteracaoEnum |  (optional)

    try:
        # Faz upload do arquivo volfdc para o caso
        api_response = api_instance.upload_volume_final_decomp(uuid, file=file, tipo_alteracao=tipo_alteracao)
        print("The response of CasosApi->upload_volume_final_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_volume_final_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo volfdc a ser enviado	[optional]
tipo_alteracao	TipoAlteracaoEnum		[optional]

Return type

Authorization

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

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

upload_volume_partida_decomp

FileUploadResponse upload_volume_partida_decomp(uuid, file=file, data_volume_partida=data_volume_partida)

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 (TenantIdAuth):
Api Key Authentication (ApiKeyAuth):

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 /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "/v1"
)

# 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: TenantIdAuth
configuration.api_key['TenantIdAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TenantIdAuth'] = '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'

# 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.CasosApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do caso
    file = None # bytes | Arquivo volume-partida-dc a ser enviado (optional)
    data_volume_partida = '2013-10-20' # date | Data correspondente ao arquivo enviado.   **Formato obrigatório: YYYY-MM-DD**.  (optional)

    try:
        # Faz upload do arquivo volume-partida-dc
        api_response = api_instance.upload_volume_partida_decomp(uuid, file=file, data_volume_partida=data_volume_partida)
        print("The response of CasosApi->upload_volume_partida_decomp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CasosApi->upload_volume_partida_decomp: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do caso
file	bytes	Arquivo volume-partida-dc a ser enviado	[optional]
data_volume_partida	date	Data correspondente ao arquivo enviado. Formato obrigatório: YYYY-MM-DD.	[optional]

Return type

Authorization