Pular para o conteúdo principal
Versão: 2.2.3

RISK

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

info

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

Inserção

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

Exemplo de solicitação:

Atributos suportados:

Request Body ParameterTipoRequeridoDescrição
idRiskLibraryStringSimIdentificador da biblioteca de risco
idPlanStringSimIdentificador do plano
idRespStringSimIdentificador do responsável
idTeamStringNãoIdentificador da equipe responsável
idRiskStringNãoIdentificador
idParentStringNãoIdentificado do elemento superior
dtNextEvalStringNãoData para a próxima avaliação
qtPendecyStringNãoPrazo para a execução
idTreatmentStringNãoIdentificador do tratamento
idMeasunityStringNãoIdentificador da unidade de medida
vlTotalStringNãoValor das outras perdas
vlAppetiteStringNãoValor do apetite
vlToleranceStringNãoValor da tolerância
dsRiskStringNãoDescrição
attributeStringNãoAtributos
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)
instanceStringNãoO valor constante: %WF_IDINSTANCE%
idactStringNãoIdentificador da atividade da instância
{
"idRiskLibrary": "string",
"idPlan": "string",
"idResp": "string",
"idTeam": "string",
"idRisk": "string",
"idParent": "string",
"dtNextEval": "string",
"qtPendecy": "1",
"idTreatment": "string",
"idMeasunity": "string",
"vlTotal": "1.1",
"vlApetite": "1.1",
"vlTolerance": "1.1",
"dsRisk": "string",
"attribute": "string",
"instance": "string",
"idact": "string"
}

Edição

PUT /apigateway/se/rest/v1/risk/risk/{idRisk}
info

É necessário trocar {idRisk} pelo identificador do risco.

atenção

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

Exemplo de solicitação:

Atributos suportados:

Request Body ParameterTipoRequeridoDescrição
idRespStringSimIdentificador do responsável
idTeamStringNãoIdentificador da equipe responsável
idRiskStringNãoIdentificador
dtNextEvalStringNãoData para a próxima avaliação
qtPendecyStringNãoPrazo para a execução
idTreatmentStringNãoIdentificador do tratamento
idMeasunityStringNãoIdentificador da unidade de medida
vlTotalStringNãoValor das outras perdas
vlApetiteStringNãoValor do apetite
vlToleranceStringNãoValor da tolerância
dsRiskStringNãoDescrição
attributeStringNãoAtributos
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)
instanceStringNãoO valor constante: %WF_IDINSTANCE%
idactStringNãoIdentificador da atividade da instância
{
"idResp": "string",
"idTeam": "string",
"idRisk": "string",
"idParent": "string",
"dtNextEval": "string",
"qtPendecy": "1",
"idTreatment": "string",
"idMeasunity": "string",
"vlTotal": "1.1",
"vlApetite": "1.1",
"vlTolerance": "1.1",
"dsRisk": "string",
"attribute": "string",
"instance": "string",
"idact": "string"
}

Exclusão

DELETE /apigateway/se/rest/v1/risk/risk/{idRisk}
info

É necessário trocar {idRisk} pelo identificador do risco.

atenção

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

Exemplo de resposta:

200 OK

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