BPM

Adicionando anexos na solicitação

104 views 14/08/2020 14/09/2020 adriner-andrade 0

Pré-requisitos:
  • Estar autenticado com a API da plataforma (detalhes).
Utilização:

Em determinados cenários, podem existir a necessidade de adicionar anexos via integração a uma solicitação. Para isso, é possível utilizar a API do BPM  (acesse para verificar detalhes sobre a chamada), realizando os seguintes passos:

1 – Requisitando uma url de upload

Chame o endpoint newAttachment. Ele será responsável por criar um registro de anexo do BPM e retornar o identificador do anexo e a url para onde o arquivo deverá ser enviado.

"Cria uma nova representação de um anexo do BPM";
public action newAttachment {
    in {
        "Nome do arquivo a ser anexado"
        name : string
        "Tamanho do arquivo a ser anexado"
        size : integer?
    }
    out {
        "Anexo"
        attachment : serviceAttachment
        "URL para o anexo"
        uploadUrl : string
    }
}
"Representação de um anexo no BlobService"
record serviceAttachment {
    "Identificador do anexo"
    id : string
    "Nome do arquivo anexado"
    name : string
    "Tamanho do arquivo anexado"
    size : integer
    "Data do envio"
    uploadDate : dateTime
    "Responsável pelo anexo"
    addedBy : string
}
2 – Efetivando um arquivo atualizado

Após o término do upload, o BPM necessita ser informado que o anexo foi enviado com sucesso. Para essa ação, chame o endpoint commitAttachment.

"Faz commit de um anexo movendo ele da área temporária para permanente"
public action commitAttachment {
    in {
        "Identificador do anexo"
        id : string
    }
    out {
    }
}
3 – Relacionando a uma instância de processo

Após as etapas anteriores terem concluído com sucesso tendo os anexos sido enviados com sucesso, é possível associar os anexos enviados à solicitação através do endpoint linkAttachments.

"Faz commit de um anexo movendo ele da área temporária para permanente"
public action linkAttachments {
    in {
        "Identificadores de anexo"
        ids : string*
        "Identificador da instância de processo a qual o arquivo pertence."
        processInstance : integer
    }
    out {
    }
}

Após essas três etapas o anexo estará disponível na solicitação.

Este artigo foi útil para você?