Árvore de páginas

Versões comparadas

Chave

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

...

Parâmetros aceitos:

  • language

            Indica - Indica o idioma que os labels deverão ser retornados. Todos os labels que puderem ser traduzidos devem ser traduzidos. Os seguintes idiomas poderão ser selecionados pelo app: "en"=Inglês, "pt"="Português", "es"="Espanhol. Qualquer valor diferente dos citados (ou a omissão do parâmetro) deve considerar como padrão o "pt".           

   

  • order 
     Diz Diz como os resultados podem ser ordenados. Pode receber um ou mais campos, com ou sem o sinal de negativo (indicando se é crescente ou não) 

              Exemplos Exemplos:

             GET /processes?order=processId -> Orderna pelo ID do processo de forma crescente.

...

             Campos aceitos no order: companyName, folderDescription, area, subarea, processNumber, entryDate, distributionDate


  • page e pageSize

 

                            Utilizados para fazer paginação.

                A              A primeira página é a 1

                Se              Se não for enviado um page, considerar a página 1.

                Se              Se não for passado um pageSize, considerar o tamanho de página como 10.

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

                Exemplos              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,detailing -> Retorna somente os campos ID do processo, Cliente e Detalhamento

...

.

             

...

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


  • Filtros

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

...