Linha RM

Atalhos

Páginas filhas
  • API do Conector

Versões comparadas

Versão antiga 1

changes.mady.by.user Eduardo Junqueira de Matos

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Guilherme Caram Meireles

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Sumário

...


Índice
excludeSumá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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

1.1 - GET

...

1.1.1 - Get All (Recuperar todos os

...

conectores)

...

Informações
iconfalse
title1.1.1 GetAll
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/sodfilerepo/conflictsconnectors

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "id": 5,
            "companyId": 03,
            "name": "Riscogdrive-teste-altoaltered",
            "alertIdcompanyId": 5
        }0,
        {
            "id"description": 6,
"Teste Google           "companyId": 1Drive altered",
            "nametype": "Risco-medio"1,
            "alertIdstatus": 3true
        },
        {
            "id": 7],
            "companyId"total": 1,
            "name": "Risco-medio-baixo",
            "alertId": 2
        },
        {
            "id": 9,
            "companyId": 1,
            
}

1.1.2 - GetOne (Recuperar conector pelo Identificador)

...

Informações
iconfalse
title1.1.2 GetOne
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/filerepo/connectors/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 3

Url Utilizada: http://localhost:8051/api/framework/v1/filerepo/connectors/3

Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": 3,
    "name": "
Risco
gdrive-
baixo
teste",
"alertId
"description":
2 
"Teste
}
Google Drive",
{ "id
"type":
10
"GoogleDrive",
"companyId
"companyID": 1,
"name
	"global":
"Risco-medio-alto"
false,

    "
alertId
systemCode":
4 }, { "id
"",
	"multiSystem":
12
true,

    
"
companyId
status":
1
true,
"name
	"credentials": "
Risco-baixissmo
data:application/json;base64,eqrwefasdfas...",
"alertId
	"filesNumber": 0

}
] }

1.2 - POST
...
1.2.1 - 
...
Post (Inserir um conector)
...
 Informações
iconfalse
title1.2.1 .2 GetOnePost
 Expandir
 Informações
iconfalse
titleConfiguração
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod/conflicts/{id}filerepo/connectors
 Informações
iconfalse
titleExemplo de Configuração
Domínio: localhost
Porta: 8051Id: 20 8051
Url Utilizada: http://localhost:8051/api/framework/v1/sod/conflicts/20filerepo/connectors
 Informações
iconfalse
titleExemplo de Entrada
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Name": "gdrive-teste",
    "Description": "Teste Google Drive",
    "
id
Type": 
20
"GoogleDrive",
    "
companyId
CompanyID": 1,
	"Global": false,
    "SystemCode": "",
	"MultiSystem": true,
    "Status": 1,
	"Credentials": "data:application/json;base64,eqrwefasdfas..."
}
 Informações
iconfalse
titleExemplo de Resultado Positivo
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": 3,
    "name": "
Risk-Teste",
    "alertId
gdrive-teste",
    "description": "Teste Google Drive",
    "type": "GoogleDrive",
    "companyID": 1,
	"global": false,
    "systemCode": "",
	"multiSystem": true,
    "status": true,
	"Credentials": "data:application/json;base64,eqrwefasdfas...",
	"filesNumber": 0
}
1.
...
3 - 
...
PUT
...
1.
...
3.1 - 
...
Put (
...
Atualizar um 
...
conector)
...
 Informações
iconfalse
title1.23.1 PostPut
 Expandir
 Informações
iconfalse
titleConfiguração
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod/conflictsfilerepo/connectors/{id}
 Informações
iconfalse
titleExemplo de Configuração
Domínio: localhost
Porta: 8051
Id: 3
Url Utilizada: http://localhost:8051/api/framework/v1/sodfilerepo/connectors/conflicts3
 Informações
iconfalse
titleExemplo de Entrada
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyIdName": 1 "gdrive-teste Alterado",
    "nameDescription": "Risk-Teste"Teste Google Drive Alterado",
    "Type": 1,
    "alertIdCompanyID": 0,
    "Status": 1
}
 Informações
iconfalse
titleExemplo de Resultado Positivo
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": 203,
    "name": "gdrive-teste-altered",
    "companyId": 10,
    "namedescription": "Risk-TesteTeste Google Drive altered",
    "alertId"type": 1,
    "status": 0true
}
1.
...
4 - 
...
PATCH
...
1.
...
4.1 - 
...
Patch (Altera algumas propriedades de um conector)
...
 Informações
iconfalse
title1.34.1 PostPatch
 Expandir
titleClique aqui para expandir...
 Informações
iconfalse
titleConfiguração
Máscara de Url: http http://{domínio}:{porta}/api/framework/v1/usersfilerepo/connectors/{id}
 Informações
iconfalse
titleExemplo de Configuração
Domínio: localhost
Porta: 8051 8051
Id: 20 3
Url Utilizada: http://localhost:8051/api/framework/v1/sodfilerepo/conflictsconnectors/203
 Informações
iconfalse
titleExemplo de Entrada
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "
companyId
Description": 
1,
    "alertId": 2,
    "name": "Risco-
"Teste Google Drive Alterado"
}
 Informações
iconfalse
titleExemplo de Resultado Positivo
 Expandir
titleVer resultado JSON...
 Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id":
 20
 3,
    "name": "gdrive-teste-altered",
    "companyId": 
1
0,
    "
alertId
description": 
2
"Teste Google Drive Alterado",
    "
name
type": 1,
 
"Risco-Alterado"
   "status": true
}
1.
...
5 - DELETE
...
1.
...
5.1 - Delete (Deletar um 
...
conector)
...
 Informações
iconfalse
title1.45.1 Delete
 Expandir
titleClique aqui para expandir...
 Informações
iconfalse
titleConfiguração
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sodfilerepo/conflictsconnectors/{id}
 Informações
iconfalse
titleExemplo de Configuração
Domínio: localhost
Porta: 8051
Id: 20 3
Url Utilizada: http://localhost:8051/api/framework/v1/sodfilerepo/conflictsconnectors/203
 Informações
iconfalse
titleResultado esperado
Será retornado o respondeCode = 204 e a resposta em branco.