Histórico da Página

...

pi-get-v1
Requisito	Nenhum.
Descrição	Retorna os dados detalhados de um único registro de NBS com base na chave informada.
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT	pathParams: Deve conter o ID do registro (`codNbs`).
	oOutput	JsonObject	OUTPUT	Objeto contendo os dados do registro (vide estrutura `CadNbs`).
	RowErrors	Temp-table	OUTPUT	Informações sobre erros ocorridos (ex: Registro não encontrado).
Retorno	Retorna os dados detalhados de um único registro de NBS com base na chave informada.

pi-create-v1

Requisito

Nenhum.

Descrição

Cria um novo registro na tabela de NBS.

Parâmetros Tipo Input/Output Descrição

oInput

JsonObject

INPUT

Payload contendo os dados:

• codNbs: Código do NBS (Obrigatório, chave única).

• descNbs: Descrição do NBS.

Bloco de código

title	Exemplo

{
  "codNbs": "1.0101.20.10",
  "descNbs": "Análise e desenvolvimento de sistemas"
}

oOutput JsonObject OUTPUT Retorna o registro criado.

RowErrors Temp-table OUTPUT Erros de validação (ex: registro duplicado).

pi-update-v1
Requisito	Nenhum.
Descrição	Altera um registro existente na tabela de NBS.
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT	pathParams: ID do registro (`codNbs`). Payload: Campos a serem alterados (ex: `descNbs`).
	oOutput	JsonObject	OUTPUT	Retorna o registro atualizado.

pi-delete-v1
Requisito	Nenhum.
Descrição	Exclui um registro existente na tabela de NBS.
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT	pathParams: Informar o `codNbs` do registro a ser eliminado.
	RowErrors	Temp-table	OUTPUT	Retorna erros caso o registro não possa ser excluído.

pi-delete-list-v1

Requisito

Nenhum.

Descrição

Exclui uma lista de registros (lote).

Parâmetros Tipo Input/Output Descrição

oInput

JsonObject

INPUT

Payload: Array de objetos contendo a chave codNbs para exclusão.

Bloco de código

title	Exemplo

[
  { "codNbs": "1.0101.20" },
  { "codNbs": "1.0101.21" }
]

aDeletedIdList JsonArray OUTPUT Lista dos IDs que foram excluídos com sucesso.

pi-import-v1
Requisito	Nenhum.
Descrição	Realiza a importação de um arquivo CSV para a tabela de NBS. Regras de validação aplicadas linha a linha: Código ou descrição não podem ser vazios. Tamanho do código deve ser de 9 caracteres (contando pontuação). O código deve ser numérico (removendo pontuação). Verifica duplicidade de chave.
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT	Payload: Deve conter o array `multiPartFile`. O conteúdo do arquivo deve vir em Base64 no atributo `content`.
	oOutput	JsonObject	OUTPUT	Se houver linhas com erro, retorna um arquivo CSV (`ErrosImportacaoNBS.csv`) listando as linhas rejeitadas e o motivo. Se sucesso total, retorna "OK".

pi-export-v1
Requisito	Nenhum.
Descrição	Gera um arquivo CSV contendo todos os registros da tabela `cad-nbs`.
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT	Parâmetros gerais (vazio para exportação total).
	oOutput	JsonObject	OUTPUT	Retorna objeto com: • `FN_File`: Nome do arquivo (`ModeloCadastroNbs.csv`). • `DN_File`: Conteúdo do arquivo em Base64.

pi-download-v1
Requisito	Nenhum.
Descrição	Disponibiliza o download de um modelo (template) vazio de arquivo CSV para ser utilizado na importação.
	Parâmetros	Tipo	Input/Output	Descrição
	oOutput	JsonObject	OUTPUT	Retorna o arquivo de modelo em Base64.

...

Árvore de páginas