Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 5

changes.mady.by.user Ederson Tonial

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Ederson Tonial

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Manipulação de Dados
EndpointEventoEntradaObservação
findById

findById

Dados do registro

Executado depois de buscar um registro específico.

findAll

findAll

Dados dos registros

Executado depois de buscar os registros.

create

beforeCreate

Payload

Executado antes de criar um registro.

create

afterCreate

Payload

Executado depois da criação de um registro.

update

beforeUpdate

Payload

Executado antes da alteração de um registro.

update

afterUpdate

Payload

Executado depois da alteração de um registro.

delete

beforeDelete

Payload

Executado antes da eliminação de um registro.

delete

afterDelete

Payload

Executado depois da eliminação de um registro.

generateData

beforeGenerateData

JsonVar: Objeto contendo:

  • pathParams: O PathParams da requisição;
  • queryParams: O QueryParams da requisição;
  • payload: Objeto de Payload da requisição.

Executado antes de acionar a funcionalidade de "Gerar dados" no topo da página.

generateData

afterGenerateData

JsonVar: Objeto contendo:

  • pathParams: O PathParams da requisição;
  • queryParams: O QueryParams da requisição;
  • payload: Objeto de Payload da requisição;
  • root: Objeto devolvido pela API-REST, conforme o tipo de retorno (Object = oOutput / Array = aResult).

Executado depois de acionar a funcionalidade de "Gerar dados" no topo da página.

API REST - cdp/api/v1/planilha.p

Pode ser

...

implementada uma UPC para captar

...

os eventos de geração de planilha.

Informações
titleImportante

Tomar cuidado ao manipular os dados via UPC com o endpoint de geração de planilha, pois o mesmo é genérico e é executado por várias telas HTML. No payload da requisição é possível identificar qual é a tela por meio dos atributos: programApiQuery e title.

Bloco de código
languagejava
titleExemplo
{
  programApiQuery: "cdp/rules/cClassTribRules.r",
  title: "Listagem cadastro cClasstrib",
  procedureQuery: "executeQuery",
  visibleFields: [...]
}

...

beforeGenerate

...

Dados do requisição (input)

...

Executado antes da geração da planilha.

...

afterGenerate

...

Dados do requisição (input)

Dados do retorno (output)

...

Detalhes dos endpoints que permitem customização estão nessa documentação.


03. JSON de metadata
Âncora
3
3

...