Linha RM

Atalhos

Páginas filhas
  • API de Conflitos

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
  • DELETE

1.1 - GET

1.1.1 - Get All (Recuperar todos os conflitos)

1.1.1 GetAll

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod-matrix/company/{Id da coligada}/conflicts

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Coligada: 7

Url Utilizada: http://localhost:8051/api/framework/v1/sod-matrix/company/7/conflicts

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "id": 5,
            "isGlobalCompany": false,             
            "companyId": 7,
            "name": "Conflito ADM",             
            "riskId": 1,
            "tagMenu1": 800000288,
            "permission1": 1,
            "tagMenu2": 800000288,
            "permission2": 2
		},
        {             
			"id": 6,
            "isGlobalCompany": false,             
            "companyId": 7,
            "name": "Conflito Operacional",             
            "riskId": 1,
            "tagMenu1": 800000288,
            "permission1": 3,
            "tagMenu2": 800000288,
            "permission2": 1         
		},
        {             
			"id": 7,
            "isGlobalCompany": false,             
            "companyId": 0,
            "name": "Conflito Generico",             
            "riskId": 1,
            "tagMenu1": 800000289,
            "permission1": 1,
            "tagMenu2": 800000288,
            "permission2": 1         
		}     
	]
}

1.1.2 - GetOne (Recuperar conflito pelo Identificador)


1.1.2 GetOne

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod-matrix/company/{Id da coligada}/conflicts/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Coligada: 7

Id: 20

Url Utilizada: http://localhost:8051/api/framework/v1/sod-matrix/company/7/conflicts/7

Resultado (JSON)
{             
	"id": 7,
    "isGlobalCompany": false,             
    "companyId": 7,
    "name": "Conflito Generico",             
    "riskId": 1,
    "tagMenu1": 800000289,
    "permission1": 1,
    "tagMenu2": 800000288,
    "permission2": 1         
}  


1.2 - POST

1.2.1 - Post (Inserir um conflito)

1.2.1 Post

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod-matrix/company/{Id da coligada}/conflicts

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Coligada: 7

Url Utilizada: http://localhost:8051/api/framework/v1/sod-matrix/company/7/conflicts

Exemplo de Entrada

Resultado (JSON)
{
  "isGlobalCompany": true,
  "name": "Conflito de privilégios",
  "riskId": 1,
  "tagMenu1": 123,
  "permission1": 3,
  "tagMenu2": 321,
  "permission2": 1
}

Exemplo de Resultado Positivo

Resultado (JSON)
{
    "id": 1007,
    "companyId": 0,
    "name": "Conflito de privilégios",
    "riskId": 1,
    "tagMenu1": 123,
    "permission1": 3,
    "tagMenu2": 321,
    "permission2": 1
}

1.3 - PUT

1.3.1 - Put (Atualizar um conflito)

1.3.1 Post

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod-matrix/company/{Id da coligada}/conflicts/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Coligada: 7

Id: 20

Url Utilizada: http://localhost:8051/api/framework/v1/sod-matrix/company/7/conflicts/20

Exemplo de Entrada

Resultado (JSON)
{
  "id": 20,
  "isGlobalCompany": false,
  "name": "Manutenção",
  "riskId": 1,
  "tagMenu1": 123,
  "permission1": 321,
  "tagMenu2": 1,
  "permission2": 32
}

Exemplo de Resultado Positivo

Resultado (JSON)
{
  "id": 20,
  "companyId": 7,
  "name": "Manutenção",
  "riskId": 1,
  "tagMenu1": 123,
  "permission1": 321,
  "tagMenu2": 1,
  "permission2": 32
}

1.4 - DELETE

1.4.1 - Delete (Deletar um conflito)

1.4.1 Delete

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/sod-matrix/company/{Id da coligada}/conflicts/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Coligada: 7

Id: 20

Url Utilizada: http://localhost:8051/api/framework/v1/sod-matrix/company/7/conflicts/20

Resultado esperado

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

  • Sem rótulos