Linha RM

Atalhos

Páginas filhas
  • API de Perfil

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)

1.1.1 GetAll

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Exemplo de Resultado

Resultado (JSON)
{
    "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)

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 ...

Padrão scim:

SortBy: define o campo que será ordenado.

SortOrder: 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)

1.1.2 Order (Asc)

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Tipo de Ordenação: Ascendente

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

Exemplo de Resultado

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

1.1.2 Order (Desc)

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Tipo de Ordenação: Descendente

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

Exemplo de Resultado

Resultado (JSON)
{
    "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)

1.1.3 Filter

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Valor: DBA_G

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

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "id": "DBA_G"
        }
    ]
}

1.1.4 - Paginação

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

Padrão scim:

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

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

Exemplo 1: ?startIndex=2&count=2

1.1.4 Paginacao

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

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

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": true,
    "items": [
        {
            "id": "DBA_0"
        },
        {
            "id": "DBA_0"
        }
    ]
}

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

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 ...

Padrão scim:

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

Exemplo 1: ?attributes=campo1

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

1.1.5 Fields

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: id

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

Exemplo de Resultado

Resultado (JSON)
{
    "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)

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.

Padrão scim:

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

Exemplo 1: ?attributes=campo1&sortBy=campo2&sortOrder=descending

1.1.6 GetOne

Configuração

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: id

Valor Campo Order: id

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

Exemplo de Resultado

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


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

Parâmetros

Expand: Parâmetros responsáveis por receber o código da aplicação(sistema) e status de ativação

Exemplo: ?application=Id&isActive=1 - Nesse exemplo, serão retornados os perfis da aplicação(sistema) "Id" que estão ativos.


1.1.7 Filter by Application and Activation

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/roles?application={{códigoAplicação}&isActive={{0|1}}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo application: G

Valor Campo isActive: 1

Url Utilizada: http://localhost:8051/api/framework/v1/roles?application=G&isActive=1

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "id": "DBA_G",
            "name": "Administrador DB (RM BIS)"
        },
        {
            "id": "DP_G",
            "name": "Departamento Pessoal (RM BIS)"
        },
        {
            "id": "Perfil1_G",
            "name": "Perfil mestre (RM BIS)"
        }
    ]
}