OPPORTUNITY

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

info

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

Inserção

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

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
idOpportunityLibrary	String	Sim	Identificador da biblioteca de oportunidade
idPlan	String	Sim	Identificador do plano
idResp	String	Sim	Identificador do responsável
idTeam	String	Não	Identificador da equipe responsável
idOpportunity	String	Não	Identificador
idParent	String	Não	Identificador do elemento superior
dtNextEval	String	Não	Data para a próxima avaliação
qtPendecy	String	Não	Prazo para a execução
idTreatment	String	Não	Identificador do tratamento
idMeasunity	String	Não	Identificador da unidade de medida
vlTotal	String	Não	Valor das outras perdas
vlApetite	String	Não	Valor do apetite
vlTolerance	String	Não	Valor da tolerância
dsOpportunity	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)
instance	String	Não	O valor constante: %WF_IDINSTANCE%
idact	String	Não	Identificador da atividade da instância

{
  "idOpportunityLibrary": "string",
  "idPlan": "string",
  "idResp": "string",
  "idTeam": "string",
  "idOpportunity": "string",
  "idParent": "string",
  "dtNextEval": "string",
  "qtPendecy": "1",
  "idTreatment": "string",
  "idMeasunity": "string",
  "vlTotal": "1.1",
  "vlApetite": "1.1",
  "vlTolerance": "1.1",
  "dsOpportunity": "string",
  "attribute": "string",
  "instance": "string",
  "idact": "string"
}

Edição

POST /apigateway/se/rest/v1/risk/opportunity/{idOpportunity}

info

É necessário trocar {idOpportunity} pelo identificador da oportunidade.

atenção

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

Exemplo de solicitação:

Request Body Parameter	Tipo	Requerido	Descrição
idResp	String	Sim	Identificador do responsável
idTeam	String	Não	Identificador da equipe responsável
idOpportunity	String	Não	Identificador
dtNextEval	String	Não	Data para a próxima avaliação
qtPendecy	String	Não	Prazo para a execução
idTreatment	String	Não	Identificador do tratamento
idMeasunity	String	Não	Identificador da unidade de medida
vlTotal	String	Não	Valor das outras perdas
vlApetite	String	Não	Valor do apetite
vlTolerance	String	Não	Valor da tolerância
dsOpportunity	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)
instance	String	Não	O valor constante: %WF_IDINSTANCE%
idact	String	Não	Identificador da atividade da instância

{
  "idResp": "string",
  "idTeam": "string",
  "idOpportunity": "string",
  "idParent": "string",
  "dtNextEval": "string",
  "qtPendecy": "1",
  "idTreatment": "string",
  "idMeasunity": "string",
  "vlTotal": "1.1",
  "vlApetite": "1.1",
  "vlTolerance": "1.1",
  "dsOpportunity": "string",
  "attribute": "string",
  "instance": "string",
  "idact": "string"
}

Exclusão

DELETE /apigateway/se/rest/v1/risk/opportunity/{idOpportunity}

info

É necessário trocar {idOpportunity} pelo identificador da oportunidade.

atenção

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

Exemplo de resposta:

200 OK

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