PLAN

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

Inserção

POST /apigateway/se/rest/risk/plan

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
fgTypePlan	String	Não	Tipo de importação: 1 - Em branco. (Padrão) 2 - A partir de modelo
idTemplate	String	Sim¹	Identificador do modelo de plano
fgFollowTemplate	String	Não	Segue revisão modelo: 1 - Sim 2 - Não (Padrão)
idPlan	String	Não	Identificador
nmPlan	String	Sim	Nome
idType	String	Sim	Identificador do tipo
fgEscope	String	Não	Escopo: 215 – Risco (Padrão) 101 – Processo
idProcess	String	Sim²	Identificador do processo
idResp	String	Sim	Matrícula do usuário responsável
idTeam	String	Não	Identificador da equipe responsável
idBusinessUnit	String	Sim³	Identificador da unidade de negócio
idDepartment	String	Não	Identificador da área Exemplo: identificador_da_area_1;identificador_da_area_2.
dsPlan	String	Não	Descrição
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 o tipo de importação for a partir de modelo.

Sim² - Será obrigatório se o escopo for Processo.

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

{
  "fgTypePlan": 1,
  "idTemplate": "string",
  "fgFollowTemplate": 1,
  "idPlan": "string",
  "nmPlan": "string",
  "idType": "string",
  "fgEscope": 1,
  "idProcess": "string",
  "idResp": "string",
  "idTeam": "string",
  "idBusinessUnit": "string",
  "idDepartment": "string",
  "dsPlan": "string",
  "attribute": "string"
}

Exclusão

Exemplo de solicitação para exclusão:

DELETE /apigateway/se/rest/risk/plan/{idPlan}

info

É necessário trocar {idPlan} pelo identificador do plano.

atenção

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

Exemplo de resposta:

200 OK

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