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étodos
Serão apresentados 4 métodos, os quais foram implementados na API de Riscos, são eles:
1.1 - GET
1.1.1 - Get All (Recuperar todos os riscos)
| 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/framework/v1/sod/risks |
| 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": 5,
"companyId": 0,
"name": "Risco-alto",
"alertId": 5
},
{
"id": 6,
"companyId": 1,
"name": "Risco-medio",
"alertId": 3
},
{
"id": 7,
"companyId": 1,
"name": "Risco-medio-baixo",
"alertId": 2
},
{
"id": 9,
"companyId": 1,
"name": "Risco-baixo",
"alertId": 2
},
{
"id": 10,
"companyId": 1,
"name": "Risco-medio-alto",
"alertId": 4
},
{
"id": 12,
"companyId": 1,
"name": "Risco-baixissmo",
"alertId": 0
}
]
} |
|
|
|
|
1.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 |
|---|
| icon | false |
|---|
| title | 1.1.1.2 Order (Asc) |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/glb/v1/framework?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": 5,
"companyId": 0,
"name": "Risco-alto",
"alertId": 5
},
{
"id": 10,
"companyId": 1,
"name": "Risco-medio-alto",
"alertId": 4
},
{
"id": 6,
"companyId": 1,
"name": "Risco-medio",
"alertId": 3
},
{
"id": 7,
"companyId": 1,
"name": "Risco-medio-baixo",
"alertId": 2
},
{
"id": 9,
"companyId": 1,
"name": "Risco-baixo",
"alertId": 1
},
{
"id": 12,
"companyId": 1,
"name": "Risco-baixissmo",
"alertId": 0
}
]
} |
|
|
|
|
1.1.2 - GetOne (Recuperar risco pelo Identificador)
| Informações |
|---|
| icon | false |
|---|
| title | 1.1.2 GetOne |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod/risks/{id} |
| Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"id": 20,
"companyId": 1,
"name": "Risk-Teste",
"alertId": 0
} |
|
|
1.2 - POST
1.2.1 - Post (Inserir um risco)
| Informações |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod/risks |
| 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 |
|---|
| {
"companyId": 1,
"name": "Risk-Teste",
"alertId": 0
} |
|
|
| 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": 20,
"companyId": 1,
"name": "Risk-Teste",
"alertId": 0
} |
|
|
|
|
1.3 - PUT
1.3.1 - Put (Atualizar um risco)
| Informações |
|---|
|
| 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 |
|---|
| {
"companyId": 1,
"alertId": 2,
"name": "Risco-Alterado"
} |
|
|
| 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": 20,
"companyId": 1,
"alertId": 2,
"name": "Risco-Alterado"
} |
|
|
|
|
1.4 - DELETE
1.4.1 - Delete (Deletar um risco)
| Informações |
|---|
| icon | false |
|---|
| title | 1.4.1 Delete |
|---|
|
| Expandir |
|---|
| title | Clique aqui para expandir... |
|---|
| | Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod/risks/{id} | Informações |
|---|
| icon | false |
|---|
| title | Resultado esperado |
|---|
| Será retornado o respondeCode = 204 e a resposta em branco. |
|
|
|
