Wiki source code of Paginação

Last modified by WBS Tecnologia on 2020/12/28 20:17
Show last authors
1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
5 = Páginação em Consultas =
6
7 Neste artigo iremos demonstrar a paginação em consultados que permite recuperar informações em páginas/blocos.
8 )))
9 )))
10
11 (% class="row" %)
12 (((
13 (% class="col-xs-12 col-sm-8" %)
14 (((
15 = Batch API =
16
17 Algumas APIs da Plataforma suportam operações que podem ser feitas em lote, ou seja, a mesma operação várias vezes utilizando um Payload maior. A operação em lote pode ser tanto para o envio de várias informações em lote, ou para a leitura de várias informações. Exemplo, você pode utilizar este recurso para salvar vários produtos de uma vez ou para recuperar vários cadastros de uma vez
18
19 == Leitura Páginada ==
20
21 Geralmente todas as APIs na Plataforma que suportam o recurso em lote, obrigam a utilização do recurso de paginação para quando é realizado a consulta dos registros. Para isso é necessário obter os dados de paginação, isso pode ser feito chamando a rota normalmente se configuração nenhuma, Exemplo:
22
23 (% class="box infomessage" %)
24 (((
25 Rota: /Catalogo/Produtos/Produto/Todos
26 )))
27
28 * Parâmetros: 
29 ** Somente o Corpo
30 * Requer Autenticação: **Não**
31 * Método: **POST**
32 * Tipo de Retorno**:  Void | TObjeto**
33 * Headers:
34 ** API_TOKEN: Token de Segurança
35 ** ACCEPT: application/json
36
37 A Resposta será:
38
39 {{code language="json" layout="LINENUMBERS"}}
40 { "TamanhoMaximoPagina": 128, "Quantidade": 11, "Tipo": "Produto" }
41 {{/code}}
42
43 (% class="wikigeneratedid" %)
44 == ==
45
46 |**Campo**|**Descrição**
47 |TamanhoMaximoPagina|Quantidade Máxima de Registro que podem ser resgatados
48 |Quantidade|Quantidade de Registros Atualmente no Cadastro
49 |Tipo|Tipo de Registro
50
51 (% class="wikigeneratedid" id="HSub-paragraph" %)
52 Agora pode realizar a consulta com a paginação, para isso iremos informar a quantidade de registros que queremos e de que ponto irá começar, Exemplo:
53
54 (% class="wikigeneratedid" %)
55 **Se temos 11 Registros e queremos buscar os 5 primeiros, realizamos a seguinte operação:**
56
57 * Parâmetros na URI:
58 * Nenhum Corpo: Vazio
59 * Método: GET
60 * Headers:
61 ** API_TOKEN: Token recuperado pela Autenticação
62 ** Accept: application/json
63 ** paginacao.tamanho: 5
64 ** paginacao.comecarem: 0
65
66 (% class="wikigeneratedid" %)
67 A Resposta será os 5 primeiros registros
68
69 (% class="wikigeneratedid" %)
70 **Se temos 11 Registros e queremos buscar os 5 da segunda página, realizamos a seguinte operação:**
71
72 * Parâmetros na URI:
73 * Nenhum Corpo: Vazio
74 * Método: GET
75 * Headers:
76 ** API_TOKEN: Token recuperado pela Autenticação
77 ** Accept: application/json
78 ** paginacao.tamanho: 5
79 ** paginacao.comecarem: 5
80
81 (% class="wikigeneratedid" %)
82 A Resposta será 5 registros, depois que a rotina pular os 5 primeiros registros.
83
84 (% class="wikigeneratedid" %)
85 Importante:
86
87 * Operação em Lote podem causar Timeout se caso o cliente esteja configurado com os valores padrões de Timeout.
88 * Payload muito grandes ou paginações muito grandes podem ocasionar quebra de informação, timeout ou erros de requisição como Bad Request.
89 )))
90
91
92 (% class="col-xs-12 col-sm-4" %)
93 (((
94 {{box title="**Contents**"}}
95 {{toc/}}
96 {{/box}}
97
98
99 )))
100 )))
WBS Tecnologia (C) 2024
1.2