API Reference

Substituir documento

patch
{protocol}://{host}/service/bpm/api/v1/process-instances//activity-instances//cycles//fields//documents/

Realiza envio de requisição para atualizar o documento para campo template de uma atividade do processo instanciado em um documento já existente

Após a execução da rota de importação, será preciso salvar os dados do processo seguindo os padrões da rota https://lecomsa.readme.io/reference/postbusinessdata-v2

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

O que precisa saber antes de usar este serviço?

Se você ainda não viu, acesse a documentação de negócios: Substituir documento

Path Params
integer
required

Deve ser informado o número do processo instanciado onde criará ou importará o documento para campo template.

integer
required

Deve ser informado o número da atividade do processo instanciado onde criará ou importará documento para campo template.

integer
required

Deve ser informado o número do ciclo da atividade do processo instanciado onde criará ou importará documento para campo template.

string
required

Deve ser informado o nome do campo template onde criará ou importará documento na atividade do processo instanciado.

integer
required

Código do documento para criação ou importação em um documento já existente para campo template da atividade do processo instanciado. Este código pode ser obtido através da rota "Informações do documento", os valores para preencher os campos "fieldName" e "fileUniqueId" podem ser obtidos através da rota "Consulta dos dados da atividade".

Body Params

Caso seja necessário a alteração de mais de um campo metadata do template, será preciso indicar novos campos de metadata.id e metadata.value, para tanto utilizar aplicativo específico de consumo de rotas para o OpenAPI

string
enum

Ação a ser tomada na rota.

Allowed:
string
enum

Declara o tipo de documento criado para o campo templates da atividade do processo. Para o uso desse campo é necessário usar a action=CREATE. Caso a action não for CREATE ou não for enviada, o campo será ignorado.

variáveis defaultType:
EXCEL = documento com extensão do tipo xlxs
WORD = documento com extensão do tipo docx
POWER_POINT = documento com extensão do tipo pptx
PROJECT = documento com extensão do tipo mpp
VISIO = documento com extensão do tipo vsd

Allowed:
string
enum
required
Defaults to REVISION

REVISION - Gera um número de revisão do documento existente.
Gera uma revisão na versão do documento (ex. de “1.0” para “1.1”)
VERSION - Gera um número de versão do documento existente.
Gera uma versão nova do documento(ex. de “1.0” para “2.0”)

Allowed:
string

Informação referente ao identificador do campo do documento template onde haverá alteração do valor no módulo Documentos. Para colocar mais de um campo, basta adicionar outro campo incrementando o valor que está entre couchetes. Exemplo
documentData[0].field=CAMPO1
documentData[0].value=valorcampo1
documentData[1].field=CAMPO2
documentData[1].value=valorcampo2

string

Informação referente ao valor a ser alterado ao campo metadado existente do módulo Documentos.
Atenção, para adicionar valores nos campos devemos seguir o exemplo indicado no campo anterior.

integer
required

Deve ser informado o código do template existente do documento vinculado ao campo template da atividade do processo instanciado.

file

Local onde será informado o arquivo que será inserido no documento e vinculado com o campo templates da atividade do processo instanciado. Para o uso desse campo é necessário usar a action=IMPORT. Caso a action não for IMPORT ou não for enviada, o campo será ignorado.

Headers
string
required

Deve ser informado o domínio do ambiente onde será realizada a requisição onde criará ou importará documento para campo template de uma atividade de processo instanciado.

boolean

Header para indicar o uso do Modo Teste. Por padrão a plataforma não trabalha no modo teste.

integer

Header para indicar qual o id do usuário está sendo simulado qual o header test-mode for igual a true. Caso esse header não seja informado, o próprio usuário autenticado será considerado no modo teste.

Response

Updated over 2 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago