Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

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 Objetos da Interface (Metadata)
EndpointEventoEntradaObservação
getMetaData

list

Metadados

Estrutura metadados da listagem.

getMetaData

new

Metadados

Estrutura metadados da tela de inclusão.

getMetaData

edit

Metadados

Estrutura metadados da tela de edição.

getMetaData

detail

Metadados

Estrutura metadados da tela de detalhes.

getMetaData

copy

Metadados

Estrutura metadados da tela de cópia/duplicação de registro.

getMetaData

listItems

Metadados

Estrutura metadados da listagem de itens do evento (quando o evento tem itens).

getMetaData

editItems

Metadados

Estrutura metadados da edição do item do evento.



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.

deleteList

beforeDeleteList

Payload

Executado antes da eliminação de um lote de registros.

deleteList

afterDeleteList

Payload

Executado depois da eliminação de um lote de registros.

gerarItens

beforeGerarItens

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 "Gerar itens".

gerarItens

afterGerarItens

JsonVar: Objeto contendo:

  • pathParams: O PathParams da requisição;
  • queryParams: O QueryParams da requisição;
  • payload: Objeto de Payload da requisição;
  • root: Array devolvido pela API-REST.

Executado depois de acionar a funcionalidade "Gerar itens".

enviar

beforeEnviar

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

enviar

afterEnviar

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.

Executado depois de acionar a funcionalidade "Enviar".

consultar

beforeConsultar

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

consultar

afterConsultar

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.

Executado depois de acionar a funcionalidade "Consultar".


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

...

TipoEndpointObservações
Listagem

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/?type=list


Inclusão

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/?type=new


Edição

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/<chave-acesso + '|' + cod-evento + '|' + seq-evento>?type=edit

Utiliza a chave de acesso do DF-e, código do evento e sequência do evento como path param.

Duplicar/Cópia

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/<chave-acesso + '|' + cod-evento + '|' + seq-evento>?type=copy

Utiliza a chave de acesso do DF-e, código do evento e sequência do evento como path param.

Visualização

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/<chave-acesso + '|' + cod-evento + '|' + seq-evento>?type=detail

Utiliza a chave de acesso do DF-e, código do evento e sequência do evento como path param.

Listagem de itens do evento

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/<chave-acesso + '|' + cod-evento + '|' + seq-evento + '|' + cod-estabel + '|' + modulo-orig-info>?type=listItems

Utiliza a chave de acesso do DF-e, código do evento, sequência do evento, estabelecimento e módulo origem da informação como path param.

Edição de item do evento

https://<servidor>:<porta>/api/cdp/v1/eventotributos/metadata/<chave-acesso + '|' + cod-evento + '|' + seq-evento + '|' + cod-estabel + '|' + modulo-orig-info>?type=editItems

Utiliza a chave de acesso do DF-e, código do evento, sequência do evento, estabelecimento e módulo origem da informação como path param.

04. Especificidades de Customização
Âncora
4
4

...

       Não há especificidades

...

na listagem dessa tela, está sendo

...

utilizada a combinação do componente dinâmico

...

po-page-dynamic-search com uma po-table

...

.

...

       Na edição há

...

dois formulários dinâmicos (po-dynamic-form), um formulário só visualização (po-dynamic-view) e um array de fields referentes a metadados de listagem de mensagens:

    1. O array principal de fields contêm todos os campos principais que aparecem no início da tela: Evento / Módulo origem / Sequência / Chave de acesso / Estabelecimento;
    2. Os campos que aparecem no folder "Dados complementares", agrupador "Documento fiscal eletrônico (DFE)" estão no array: fieldsDadosComplementares;
    3. Os campos somente visualização que aparecem no folder "Dados complementares", agrupador "Evento DF-e" estão no array: fieldsDadosEventoDfe;
    4. No array fieldsMessagesList constam as colunas que são visualizadas no folder "Mensagens".

       Os arrays podem ser manipulados por uma UPC e retornados para a tela modificando ou adicionando campos.

05. Observações Gerais 
Âncora
5
5

...