Integração

Este serviço permite que uma ação de aprovação, reprovação ou inutilização seja executada no BPM, por um agente externo, baseado no ID Transaction fornecido pelo serviço de WEBHOOK.

Metadado

ocorrência

#

schema

Nome

Ele

key

Tipo

Tam.

Dec.

regex

Ocor.

min

max

Descrição / schema

Observação / Regras

1

bpm

G

true

1

1

bpm

bpm

1

bpm

idBPM

E

X

string

256

true

1

1

Id do BPM

ID Identificador do BPM origem do dados 

2

bpm

idTransasaction

E

X

string

256

-

true

1

1

Id da transação

Identifica a transação da que está sendo notificada.

3

bpm

eventoNotificacao

E

X

string

256

-

true

1

1

Código do evento de notificação

Identifica o evento que está sendo notificado.

OPORTUNIDADE.APROVACAO

CONTRATO.APROVACAO

CONTRATO.FORMALIZACAO

4

bpm

acao

E

string

1

-

^((A|I|R))$

true

1

1

Código da ação

Ações disponíveis:

A - Aprovar

I - Inutilizar

R - Reprovar

5

bpm

sequenciaReprovar

E

number

5

-

false

0

1

Código da ação

Indicar a sequência de reprovação, conforme as sequências apresentadas pela mensagem do webhook

Metadado

ocorrência

#

schema

Nome

Ele

key

Tipo

Tam.

Dec.

regex

Ocor.

min

max

Descrição / schema

Observação / Regras

1

bpm

G

true

1

1

res_bpm

res_bpm

1

res_bpm

idBPM

E

X

string

256

true

1

1

Id do BPM

ID Identificador do BPM origem do dados 

2

res_bpm

idTransasaction

E

X

string

256

-

true

1

1

Id da transação

Identifica a transação da que está sendo notificada.

3

res_bpm

eventoNotificacao

E

X

string

256

-

true

1

1

Código do evento de notificação

Identifica o evento que está sendo notificado.

OPORTUNIDADE.APROVACAO

CONTRATO.APROVACAO

CONTRATO.FORMALIZACAO

4

res_bpm

retornoSituacao

G

schema

true

1

1

res_t_retornoSituacao

res_t_retornoSituacao

1

res_t_retornoSituacao

dados

G

schema

true

1

1

res_t_retornoSituacao_dado

2

res_t_retornoSituacao

aviso

G

schema

false

0

1

res_t_retornoSituacao_aviso

3

res_t_retornoSituacao

erro

G

schema

RC

0

1

res_t_retornoSituacao_erro

RC- Se a situação = "1" ocur = "1-N" senão ocur = "0-0"

res_t_retornoSituacao_dado

1

res_t_retornoSituacao_dado

ID

E

number

9

true

1

1

Identificador Serviço

Identificador interno do serviço

2

res_t_retornoSituacao_dado

situacao

E

integer

3

-

^((0|1))$

true

1

1

Código

Status da execução do registro

0: ERRO

1: OK

res_t_retornoSituacao_aviso

1

res_t_retornoSituacao_aviso

dados

G

schema

true

1

N

res_t_retornoSituacao_aviso_dado

res_t_retornoSituacao_aviso_dado

1

res_t_retornoSituacao_aviso_dado

codigo

E

string

3

-

true

1

1

Código

Código da advertência

2

res_t_retornoSituacao_aviso_dado

motivo

E

string

300

true

1

1

Motivo 

Motivo pelo qual a advertência é apresentada.

res_t_retornoSituacao_erro

1

res_t_retornoSituacao_erro

dados

G

schema

true

1

N

res_t_retornoSituacao_erro_dado

res_t_retornoSituacao_erro_dado

1

res_t_retornoSituacao_erro_dado

codigo

E

string

3

-

true

1

1

Código

Código do erro

2

res_t_retornoSituacao_erro_dado

motivo

E

string

300

true

1

1

Motivo 

Motivo pelo qual o erro é apresentado.