Árvore de páginas

Versões comparadas

Chave

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

...

             TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não.

             Exemplos: (supondo que existam 32 registros na base):

             GET /processes -> Retorna a página padrão (1) com tamanho padrão (10) (registro do 1 ao 10, hasNext = true)

                GET /processes?page=1 -> Retorna a página 1 com tamanho padrão (10) (registro de 1 ao 10, hasNext = true)

                GET /processes?pageSize=3 -> Retorna a página padrão (1) com tamanho 3 (registro de 1 ao 3, hasNext = true)

                GET /processes?page=2&pageSize=4 -> Retorna a página (2) com tamanho (4) (registro do 5 ao 8, hasNext = true)

                GET /processes?page=4&pageSize=10 -> Retorna a página (4) com tamanho (10) (registro do 31 ao 40 -> irá retornar só o 31 e o 32, hasNext = false)

                etc.   

  • fields

            Informa quais campos devem ser retornados na requisição.

            Se o fields não for informado, trazer todos os campos disponíveis.

            Exemplos:

            GET /processess?fields=processId,client -> Retorna somente os campos ID do processo e Cliente.

              GET /processes -> Retorna todos os campos disponíveis.

  • Filtros

            Deve suportar filtrar os resultados de acordo com alguns parâmetros:

                - searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do processo (número do processo, Nome das Partes, detalhamento do Processo (este campo não é exibido no App).

Exemplos: party.name, processes[n].instance[a].processNumber)

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!

...

04. Documentos de Referência