API Reference

Substituir documento

put
{protocol}://{host}/service/ecmcore/api/v1/templates//documents/

Realiza envio de requisição para substituir um documento para um template que o usuário logado tem acesso.

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 Código do template.

integer
required

Deve ser informado o Código do documento.

Body Params

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

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.

file

Local onde será informado o arquivo que será inserido no documento.

string
enum
Defaults to OVERWRITE

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?)
OVERWRITE - Mantém o Número de versão do documento existente.

Allowed:
Headers
string
required

Deve ser informado o domínio do ambiente onde será enviada a requisição para listagem de documentos por template.

Response

Updated over 1 year 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 1 year ago