CONTROL-LIBRARY

Este método possibilita inserir e excluir uma biblioteca de controle, por meio de uma API REST. A biblioteca cadastrada será disponibilizada na tela Risco -> Biblioteca -> Controle.

Inserção

POST /apigateway/se/rest/v1/risk/control-library

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
idControlLibrary	String	Não	Identificador
nmControlLibrary	String	Sim	Nome
idType	String	Sim	Identificador do tipo
idResp	String	Não	Identificador do responsável
idTeam	String	Não	Identificador da equipe responsável
fgImplement	String	Sim¹	Implementação: 1 – Não implementado 2 – Implementado parcialmente 3 – Implementado totalmente
dtImplement	String	Não	Data da implementação
fgRelevant	String	Não	Relevante: 1 – Sim 2 – Não
fgAutomationType	String	Sim¹	Tipo de automatização: 1 – Automático 2 – Semiautomático 3 – Manual
fgControlCharact	String	Sim¹	Característica: 1 – Detectivo 2 – Preventivo 3 - Detectivo + Preventivo 4 – Personalizado nos parâmetros gerais 5 – Personalizado nos parâmetros gerais 6 – Personalizado nos parâmetros gerais
fgControlFrequency	String	Sim¹	Frequência: 1 – Por evento 2 – Diária 3 – Semanal 4 – Mensal 5 – Trimestral 6 – Semestral 7 – Anual
idProcedure	String	Não	Identificador do procedimento
fgSymbol	String	Não	Identificador do ícone: Entre 0 e 99.
idEval	String	Sim¹	Identificador do método de avaliação
dsControlLibrary	String	Não	Descrição
dsDocument	String	Não	Descrição do procedimento
instance	String	Não	O valor constante: %WF_IDINSTANCE%
idact	String	Não	Identificador da atividade da instância
attribute	String	Não	Atributos Exemplo: identificador_do_atributo1=valor_do_atributo1; identificador_do_atributo2=valor_do_atributo2; identificador_do_atributo3=valor_do_atributo3 Exemplo com atributo multivalorado: identificador_do_atributo1=valor1_do_atributo1, valor2_do_atributo1, valor3_do_atributo1 Obs.: Para atributos com valor numérico, o separador de casas decimais deve ser o ’.’. Para campos data, o valor deve ter o formato "Y-M-D" (Ano-Mês-Dia)

info

Sim¹ - Será obrigatório se configurado nos parâmetros gerais.

{
  "idControlLibrary": "string",
  "nmControlLibrary": "string",
  "idType": "string",
  "idResp": "string",
  "idTeam": "string",
  "fgImplement": 1,
  "dtImplement": "string",
  "fgRelevant": 1,
  "fgAutomationType": 1,
  "fgControlCharact": 1,
  "fgControlFrequency": 1,
  "idProcedure": "string",
  "fgSymbol": 1,
  "idEval": "string",
  "dsControlLibrary": "string",
  "dsDocument": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Exclusão

Exemplo de solicitação para exclusão:

DELETE /apigateway/se/rest/v1/risk/control-library/{idControlLibrary}

info

É necessário trocar {idControlLibrary} pelo identificador do controle.

atenção

A variável idControlLibrary não aceita caracteres especiais.

Exemplo de resposta:

200 OK

{
  "success": true,
  "total": 1,
  "results": [
    {
      "Result": true,
      "Code": 1
    }
  ]
}