Sumário

...

Objetivo

...

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

Para mais informações sobre consumo de Licença, Veja Aqui.

1 - Método

...

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

1.1 - GET

...

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

...

{
    "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)

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

{
    "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/glbframework/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/glbframework/v1/roles?id=DBA_G Informações icon false title Exemplo Postmande Resultado Image Removed Expandir Informações icon false title Exemplo de Resultado title Ver 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

...

{

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

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

...

{
    "hasNext": false,
    "items": [
        {
            "id": "Api_coligada"
        },
        {
            "id": "DBA_G"
        },
        {
            "hasNextid": true "DP_G"
        },
      "items": [  {
            "id": "Perfil1_G"
        },
        {
            "id": "DBA_0PerfilApi"
        },
        {
            "id": "DBATeste_0Api"
        }
    ]
}

1.1.

...

6 - Fields &Order (

...

Retornar os campos específicos

...

em ordem)

...

...

Informações
title Parâmetros
FieldsExpand: parâmetro 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. Padrão scim: Attributes: , ou seja, o usuário define quais campos serão apresentados no resultado. Exemplo 1: ?fieldsattributes=campo1Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...&sortBy=campo2&sortOrder=descending

Informações
icon false title 1.1.5 Fields6 GetOne
Expandir Informações icon false title Configuração Máscara de Url: http://{domínio}:{porta}/api/glbframework/v1/roles?fieldsfilelds={{campo}}&Order={{campo}} Image Removed Informações icon false title Exemplo de Configuração Domínio: localhost Porta: 8051 Valor Campo Fields: id Valor Campo OrderCampos: id Url Utilizada: http://localhost:8051/api/glbframework/v1/roles?fields=id Informações icon false title Exemplo Postman &order=-id 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_coligada" }, { "id": "DBA_GPerfilApi" }, { "id": "DPPerfil1_G" }, { "id": "Perfil1DP_G" }, { "id": "PerfilApiDBA_G" }, { "id": "TesteApi_Apicoligada" } ] }

1.1.

...

7 - Filter by Application and Activation (Retornar os perfis ativos/inativos de uma aplicação(sistema) )

...

Informações
icon false title 1.1.6 GetOne7 Filter by Application and Activation
Expandir Informações icon false title Configuração Máscara de Url: http http://{domínio}:{porta}/api/glbframework/v1/roles?fileldsapplication={{campo}códigoAplicação}&OrderisActive={{campo0|1}} Image Removed Informações icon false title Exemplo de Configuração Domínio: localhost Porta: 8051 Valor Campo Fieldsapplication:id G Valor Campo OrderisActive:id 1 Url Utilizada: http://localhost:8051/api/glbframework/v1/roles?fieldsapplication=idG&order=-id Informações icon false title Exemplo Postman isActive=1 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" }, "hasNext": false, "items": [ { "id": "PerfilApiDBA_G", }, "name": "Administrador DB (RM {BIS)" }, "id": "Perfil1_G" { }, {"id": "DP_G", "idname": "DP_GDepartamento Pessoal (RM BIS)" }, { "id": "DBAPerfil1_G" }, { "id"name": "Api_coligadaPerfil mestre (RM BIS)" } ] }