Sumário

Índice

exclude	Sumário

Objetivo

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

1 - Método

Foi implementados na API de Coligada somente o método GET.

1.1 - GET

1.1.1 - Get All (Recuperar todos os perfis cadastrados na coligada)

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glb/v1/roles

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "Api_coligada"
        },
        {
            "id": "DBA_G"
        },
        {
            "id": "DP_G"
        },
        {
            "id": "Perfil1_G"
        },
        {
            "id": "PerfilApi"
        },
        {
            "id": "Teste_Api"
        }
    ]
}

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâ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 ...

Informações

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?order={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/roles?order=id

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "Api_coligada"
        },
        {
            "id": "DBA_G"
        },
        {
            "id": "DP_G"
        },
        {
            "id": "Perfil1_G"
        },
        {
            "id": "PerfilApi"
        },
        {
            "id": "Teste_Api"
        }
    ]
}

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?order=[-]{campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/roles?order=-id

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "Teste_Api"
        },
        {
            "id": "PerfilApi"
        },
        {
            "id": "Perfil1_G"
        },
        {
            "id": "DP_G"
        },
        {
            "id": "DBA_G"
        },
        {
            "id": "Api_coligada"
        }
    ]
}

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?{campo}={valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Valor: DBA_G

Url Utilizada: http://localhost:8051/api/glb/v1/roles?id=DBA_G

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "DBA_G"
        }
    ]
}

1.1.4 - Paginação

Informações

title	Parâ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

Informações

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

Url Utilizada: http://localhost:8051/api/glb/v1/roles?page=2&pageSize=2

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "id": "DBA_0"
        },
        {
            "id": "DBA_0"
        }
    ]
}

1.1.5 - Fields (Retorno de campos específicos no resultado)

Informações

title	Parâ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 ...

Informações

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?fields={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: id

Url Utilizada: http://localhost:8051/api/glb/v1/roles?fields=id

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "Api_coligada"
        },
        {
            "id": "DBA_G"
        },
        {
            "id": "DP_G"
        },
        {
            "id": "Perfil1_G"
        },
        {
            "id": "PerfilApi"
        },
        {
            "id": "Teste_Api"
        }
    ]
}

1.1.6 - Fields &Order (Retornar os campos específicos em ordem)

Informações

title	Parâmetros

Expand: Parâmetro responsável pela especialização e ordenação de campos em um resultado.

Exemplo: ?fields=id&order=-id - Nesse exemplo, serão retornados o campo "id" de perfis e em ordem descendente.

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?filelds={{campo}}&Order={{campo}}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: id

Valor Campo Order: id

Url Utilizada: http://localhost:8051/api/glb/v1/roles?fields=id&order=-id

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "Teste_Api"
        },
        {
            "id": "PerfilApi"
        },
        {
            "id": "Perfil1_G"
        },
        {
            "id": "DP_G"
        },
        {
            "id": "DBA_G"
        },
        {
            "id": "Api_coligada"
        }
    ]
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

1.1.1 - Get All (Recuperar todos os perfis cadastrados na coligada)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.6 - Fields &Order (Retornar os campos específicos em ordem)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

1.1.1 - Get All (Recuperar todos os perfis cadastrados na coligada)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.6 - Fields &Order (Retornar os campos específicos em ordem)