...
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étodos
...
Serão apresentados 4 métodos, os quais foram implementados na API de Usuários, são eles:
...
| Informações |
|---|
| icon | false |
|---|
| title | 1.5.1 Patch |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{id} |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Entrada |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"name":
{
"givenName": {{givenName_formatted}}
},
"emails": [
{
"value": {{email_formatted}},
"primary": true
}
],
"active": {{active}}
}
|
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"id": "Teste_01",
"meta": {
"resourceType": "User",
"created": "2018-12-05T15:03:07.28",
"lastModified": "2018-12-05T15:03:08.5546578"
},
"externalId": "IDTeste_01External",
"name": {
"formatted": "NOME SOCIAL DO TESTE_01",
"givenName": "Igor",
"familyName": "Automatizado"
},
"userName": "Teste_01",
"emails": [
{
"value": "[email protected]",
"primary": true
}
],
"active": true
} |
|
|
|
|
Referências (Links)
...
Roles (Manipulação de Perfis) A partir da versão 12.1.2306
...
| Informações |
|---|
| title | Associação de Perfis (Roles) |
|---|
|
Para adicionar e remover perfis á um usuário é necessário realizar as operações de Post/Delete nas rotas de perfis conforme abaixo
| Expandir |
|---|
| title | Víncular perfil ao usuário (Post) |
|---|
| | Informações |
|---|
| Método HTTP: Post Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{user}/roles
| Expandir |
|---|
| | Informações |
|---|
| icon | false |
|---|
| title | Request Body |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| title | Json |
|---|
| linenumbers | true |
|---|
| {
"roles": [
{
"company": "0",
"value": "DBA_G"
}
]
} |
|
| Informações |
|---|
| HttpStatus: 200 | Bloco de código |
|---|
| language | js |
|---|
| title | Json |
|---|
| linenumbers | true |
|---|
| {
"id": "apiteste",
"roles": [
{
"company": "1",
"value": "DBA_G"
},
{
"company": "6",
"value": "DBA_G"
},
{
"company": "7",
"value": "DBA_G"
}
]
} |
|
| Aviso |
|---|
| Ao enviar o codigo da coligada (Company) como 0 o sistema irá adicionar o perfil para todas as coligadas que o usuário possuir permissão. Como no exemplo da resposta, o perfil DBA_G foi associado para as coligadas 1,6 e 7. |
|
| Expandir |
|---|
| | Expandir |
|---|
| title | Usuário já possui algum perfil associado |
|---|
| | Informações |
|---|
| icon | false |
|---|
| title | Request Body |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| title | Json |
|---|
| linenumbers | true |
|---|
| {
"roles": [
{
"company": "0",
"value": "DBA_G"
}
]
} |
|
HttpStatus: 400 | Informações |
|---|
| {
"Code": "FE019",
"Message": "Usuário APITESTE já está associado ao perfil 'CodColigada:'1'|Sistema:'G'|CodPerfil:'DBA'|IdPerfil:DBA_G'!",
"DetailMessage": "",
"HelpUrl": "",
"Details": null
} |
|
| Expandir |
|---|
| title | Usuário sem permissão |
|---|
| | Informações |
|---|
| icon | false |
|---|
| title | Request Body |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| title | Json |
|---|
| linenumbers | true |
|---|
| {
"roles": [
{
"company": "0",
"value": "DBA_S"
}
]
} |
|
HttpStatus: 401 | Informações |
|---|
| {
"Code": "FE005",
"Message": "O Usuário informado não tem permissão para associar perfis na coligada 1 sistema S!",
"DetailMessage": "",
"HelpUrl": "",
"Details": null
}
|
|
|
|
|
| Expandir |
|---|
| title | Remover perfil do usuário (Delete) |
|---|
| | Informações |
|---|
| Método HTTP: Delete Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{user}/roles/company/{company}/role/{role} | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Configuração |
|---|
| Url Utilizada: http://localhost:8051/api/framework/v1/users/apiteste/roles/company/0/role/DBA_S | Variável | Descrição | Valor |
|---|
| domínio | endereço do serviço de webservice | localhost | | porta | porta do serviço | 8051 | | user | código do usuário | apiteste | | company | código da coligada que será utilizada | 0 | | role | Identificador(IDPERFIL) do perfil que será atribuído | DBA_S |
|
| Informações |
|---|
| icon | false |
|---|
| title | Response (Sucesso ou Erro) |
|---|
| HttpStatus: 204 Response Body: Vazio |
| Aviso |
|---|
| Por padrão, nas mensagens de DELETE, a resposta deve ser enviada com HTTP Code 204 (No content) e sem corpo no retorno, mesmo se não obtiver sucesso. |
|
|
|
