Sumário

...

Índice

exclude	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:

GET
POST
PUT
PATCH
DELETE

1.1 - GET

...

1.1.1 - Get All (Recuperar todos os

...

conectores)

...

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/sodfilerepo/conflictsconnectors

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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": 53,
            "companyIdname": 0"gdrive-teste-altered",
            "namecompanyId": "Risco-alto"0,
            "alertIddescription": 5
"Teste Google Drive altered",
     },
        {"type": 1,
            "idstatus": 6,
true
        }
    ],
    "companyId": 1,total": 1
}

1.1.2 - GetOne (Recuperar conector 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/filerepo/connectors/{id}

Informações

icon	false
title	Exemplo 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

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

"id": 3,

"name": "

Risco

gdrive-teste-

medio

altered",
    "companyId": 0,

alertId

description":

3

"Teste Google Drive altered",
    "type":

}

1,
    "status": true
}

1.2 - POST

...

1.2.1 - Post (Inserir um conflito)

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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": "gdrive-teste",
    "Description": "Teste Google  Drive",
    "idType": 7"GoogleDrive",
    "CompanyID": 1,
    "SystemCode": "",
    "companyIdStatus": 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

{1,
       "id": 3,
     "name": "Riscogdrive-medio-baixoteste",
    "companyId": 1,
    "description": "Teste Google Drive",
    "alertIdtype": 21,
    "status": false
}

1.3 - PUT

...

1.3.1 - Put (Atualizar um conector)

...

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 3

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

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":    {"gdrive-teste Alterado",
    "Description": "Teste Google Drive Alterado",
    "idType": 91,
        "CompanyID": 0,
    "companyIdStatus": 1,1
}

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": 3,
    "name": "Riscogdrive-teste-baixoaltered",
        "companyId": 0,
    "alertIddescription": 2
"Teste Google Drive altered",
    "type": }1,
    "status": true
}

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/filerepo/connectors

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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": 10, {
            "companyIdid": 13,
            "name": "Riscogdrive-medioteste-altoaltered",
            "alertIdcompanyId": 40,
        },
    "description": "Teste Google Drive {altered",
            "idtype": 121,
            "companyIdstatus": 1,true
        }
    "name": "Risco-baixissmo",
       ],
     "alertIdtotal": 0
        }
    ]1
}

1.1.2 - GetOne (Recuperar

...

conector 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/sodfilerepo/conflictsconnectors/{id}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 203

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

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": 20 3,
    "name": "gdrive-teste-altered",
    "companyId": 10,
    "namedescription": "Risk-TesteTeste Google Drive altered",
    "alertId"type": 1,
    "status": 0true
}

1.2 - POST

...

1.2.1 - Post (Inserir um conflito)

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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": "gdrive-teste",
    "Description": "Teste Google Drive",
    "Type": "GoogleDrive",
    "companyIdCompanyID": 1,
    "nameSystemCode": "Risk-Teste",
    "alertIdStatus": 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 3,
    "name": "gdrive-teste",
    "companyId": 1,
    "namedescription": "Risk-Teste Google Drive",
    "alertIdtype": 1,
    "status": 0false
}

1.3 - PUT

...

1.3.1 - Put (Atualizar um

...

conector)

...

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 20 3

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

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

{
    "companyIdName": "gdrive-teste Alterado",
    "Description": "Teste Google Drive Alterado",
    "Type": 1,
    "CompanyID": 0,
    "alertIdStatus": 1
}

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": 23,
    "name": "gdrive-teste-altered",
    "companyId": 0,
    "description": "Teste Google Drive altered",
    "type": 1,
 "Risco-   "status": true
}

1.4 - PATCH

...

1.4.1 - Patch (Altera algumas propriedades de um conector)

...

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/filerepo/connectors/{id}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 3

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

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

{
    "Description": "Teste Google Drive 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

3,
    "name": "gdrive-teste-altered",
    "companyId":

1

0,
    "

alertId

description":

2

 "Teste Google Drive Alterado",
    "

name

type":

"Risco-Alterado"

1,
    "status": true
}

1.

...

5 - DELETE

...

1.

...

5.1 - Delete (Deletar um

...

conector)

...

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/sodfilerepo/conflictsconnectors/{id}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 20 3

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

Informações

icon	false
title	Resultado esperado

Será retornado o respondeCode = 204 e a resposta em branco.

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

1.1.1 - Get All (Recuperar todos os

conectores)

1.1.2 - GetOne (Recuperar conector pelo Identificador)

1.2 - POST

1.2.1 - Post (Inserir um conflito)

1.3 - PUT

1.3.1 - Put (Atualizar um conector)

1.1.2 - GetOne (Recuperar

conector pelo Identificador)

1.2 - POST

1.2.1 - Post (Inserir um conflito)

1.3 - PUT

1.3.1 - Put (Atualizar um

conector)

1.4 - PATCH

1.4.1 - Patch (Altera algumas propriedades de um conector)

1.

5 - DELETE

1.

5.1 - Delete (Deletar um

conector)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

1.1.1 - Get All (Recuperar todos os

conectores)

1.1.2 - GetOne (Recuperar conector pelo Identificador)

1.2 - POST

1.2.1 - Post (Inserir um conflito)

1.3 - PUT

1.3.1 - Put (Atualizar um conector)

1.1.2 - GetOne (Recuperar

conector pelo Identificador)

1.2 - POST

1.2.1 - Post (Inserir um conflito)

1.3 - PUT

1.3.1 - Put (Atualizar um

conector)

1.4 - PATCH

1.4.1 - Patch (Altera algumas propriedades de um conector)

1.

5 - DELETE

1.

5.1 - Delete (Deletar um

conector)