Versões comparadas

Chave

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

...

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...


Padrão Skin:

sortBySortBy: define o campo que será ordenado.

sortOrderSortOrder: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente.

Exemplo 1: ?sortBy=campo1&sortOrder=ascending (Ascendente)

Exemplo 2: ?sortBy=campo1&sortOrder=descending (Descendente)

...

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20


Padrão Skin:

StartIndex: valor inicial do índice do registro que será retornado.

Count: quantidade máxima de registros que serão apresentados.

Exemplo 1: ?startIndex=7&count=8

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/rm/glb/v1/users?page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8099

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8099/api/rm/glb/v1/users?page=1&pageSize=1

Informações
iconfalse
titleExemplo Postman

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "id": "00001",
            "meta": {
                "resourceType": "User",
                "created": "2014-07-07T15:32:15",
                "lastModified": "2018-10-05T09:34:53"
            },
            "externalId": "00001",
            "name": {
                "formatted": "ITAMAR MENDES DA SILVEIRA"
            },
            "userName": "00001",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": true
                }
            ],
            "active": false
        }
    ]
}

...

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...


Padrão Skin:

attributesAttributes: define quais campos serão apresentados no resultado.

Exemplo 1: ?attributes=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

...