CONTROL

Este método possibilita inserir, editar e excluir um controle por meio de uma API REST.

info

Só é permitido inserir ou alterar controles em planos que estão em elaboração. Para planos homologados, não é possível incluir ou modificar os dados do controle. :::

Inserção

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

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
idControlLibrary	String	Sim	Identificador da biblioteca de controle
idPlan	String	Sim	Identificador do plano
idResp	String	Sim	Identificador do responsável
idTeam	String	Não	Identificador da equipe responsável
idControl	String	Não	Identificador
idParent	String	Não	Identificador do elemento superior
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
fgImplement	String	Sim¹	Implementação: 1 – Não implementado 2 – Implementado parcialmente 3 – Implementado totalmente
dtImplement	String	Não	Data da implementação
dtNextEval	String	Não	Data da próxima avaliação
qtEvalPendency	String	Não	Prazo para a execução
idMeasunity	String	Não	Identificador da unidade de medida
vlCost	String	Não	Custo
idEval	String	Sim¹	Identificador do método de avaliação
dsControl	String	Não	Descrição
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",
  "idPlan": "string",
  "idResp": "string",
  "idTeam": "string",
  "idControl": "string",
  "idParent": "string",
  "fgAutomationType": "1",
  "fgControlCharact": "1",
  "fgControlFrequency": "1",
  "fgImplement": "1",
  "dtImplement": "string",
  "dtNextEval": "string",
  "qtEvalPendency": "1",
  "idMeasunity": "string",
  "vlCost": "1.1",
  "idEval": "string",
  "dsControl": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Edição

PUT /apigateway/se/rest/v1/risk/control/{idControl}

info

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

atenção

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

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
idResp	String	Não	Identificador do responsável
idTeam	String	Não	Identificador da equipe responsável
fgAutomationType	String	Não	Tipo de automatização: 1 – Automático 2 – Semiautomático 3 – Manual
fgControlCharact	String	Não	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	Não	Frequência: 1 – Por evento 2 – Diária 3 – Semanal 4 – Mensal 5 – Trimestral 6 – Semestral 7 – Anual
fgImplement	String	Não	Implementação: 1 – Não implementado 2 – Implementado parcialmente 3 – Implementado totalmente
dtImplement	String	Não	Data da implementação
dtNextEval	String	Não	Data da próxima avaliação
qtEvalPendency	String	Não	Prazo para a execução
idMeasunity	String	Não	Identificador da unidade de medida
vlCost	String	Não	Custo
idEval	String	Não	Identificador do método de avaliação
dsControl	String	Não	Descrição da análise de controle
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)

{
  "idResp": "string",
  "idTeam": "string",
  "fgAutomationType": "1",
  "fgControlCharact": "1",
  "fgControlFrequency": "1",
  "fgImplement": "1",
  "dtImplement": "string",
  "dtNextEval": "string",
  "qtEvalPendency": "1",
  "idMeasunity": "string",
  "vlCost": "1.1",
  "idEval": "string",
  "dsControl": "string",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Exclusão

Exemplo de solicitação para exclusão:

DELETE /apigateway/se/rest/v1/risk/control/{idControl}

info

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

atenção

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

Exemplo de resposta:

200 OK

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