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)
...
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} |
|
Padrão scim: O padrão scim não adota o expandable. Por isso, ao adotar esse padrão, para retornar um registro com todas as propriedades expandables expandidas, é necessário utilizar uma propriedade do padrão scim (sortBy/sortOrder ou startIndex/count). Exemplos: /api/framework/glb/v1/roles |
| /?sortBy=Id&sortOrder=descending - O retorno dessa chamada exibirá todas as propriedades expandidas. |
1.1 - GET
1.1.1 - Get All (Recuperar todos os perfis cadastrados na coligada)
| 1.1.1 GetAll | | Expandir |
---|
Informações |
---|
icon | false |
---|
title | Configuração |
---|
| Máscara de Url: http://{domínio}:{porta}/framework/glb/v1/roles |
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 |
---|
|
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) |
Informações |
---|
|
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/framework/v1/roles?order={campo} |
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/framework/v1/roles?order=[-]{campo} |
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/framework/v1/roles?{campo}={valor} |
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 |
---|
|
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 |
Informações |
---|
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/framework/v1/roles?page={valor1}&pageSize={valor2} |
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 |
---|
) | linenumbers | true |
---|
| {
"hasNext": true,
"items": [
{
"id": "DBA_0"
},
{
"id": "DBA_0"
}
]
} |
|
|
|
|
1.1.5 - Fields (Retorno de campos específicos no resultado)
...
Informações |
---|
|
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 ... |
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/framework/v1/roles?fields={campo} |
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"
},
{
{
"hasNextid": true,"Perfil1_G"
"items": [ },
{
"id": "DBA_0PerfilApi"
},
{
"id": "DBATeste_0Api"
}
]
} |
|
|
|
|
1.1.
...
6 - Fields &Order (
...
Retornar os campos específicos
...
em ordem)
...
...
Informações |
---|
|
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: ?fields=campo1Múltiplos campos de ordenação: ?fieldsattributes=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/framework/v1/roles?fieldsfilelds={{campo}}&Order={{campo}} |
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 |
---|
|
Expand: Parâmetro responsável pela especialização e ordenação de campos em um resultado. Parâmetros responsáveis por receber o código da aplicação(sistema) e status de ativação Exemplo: ?fieldsapplication=idId&orderisActive=-id1 - Nesse exemplo, serão retornados o campo "id" de perfis e em ordem descendenteos perfis da aplicação(sistema) "Id" que estão ativos.
|
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/framework/v1/roles?fileldsapplication={{campo}códigoAplicação}&OrderisActive={{campo0|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)"
}
]
} |
|
|
|
|