Substituir documento em grid

patch

{protocol}://{host}/service/bpm/api/v1/process-instances/{processInstanceId}/activity-instances/{activityInstanceId}/cycles/{cycle}/grids/{gridIdentifier}/fields/{fieldName}/documents/{documentId}

Realiza envio de requisição para atualizar o documento para campo template da GRID de uma atividade do processo instanciado

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 em grid

Path Params

processInstanceId

integer

required

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

activityInstanceId

integer

required

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

cycle

integer

required

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

gridIdentifier

string

required

Deve ser informado o nome da GRID da atividade do processo instanciado onde realizará a importação do documento vinculado com o campo template da GRID.

fieldName

string

required

Nome do campoDeve ser informado o nome do campo template da GRID onde importará documento na atividade do processo instanciado.

documentId

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.

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

action

string

enum

Ação a ser tomada na rota.

Allowed:

defaultType

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:

documentUpdateType

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:

documentData[0].field

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

documentData[0].value

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.

templateId

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

X-Server

string

required

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

test-mode

boolean

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

test-user

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

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json;charset=UTF-8

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

200OK