API Reference

Incluir documento

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

Realiza envio de requisição para importar ou criar 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: Incluir documento

Path Params
integer
required

Deve ser informado o Código do template.

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.

boolean

Permite a duplicação de valores dos campos de metadados do documento template (Caso não seja enviado, o valor padrão é considero como ?false?).
Ao solicitar para incluir um documento, onde os valores dos campos documentData[0].field informados apresentem validação de valores duplicados e o campo ?duplicateValues? está declarado seu valor como ?false? na requisição da rota, o usuário deverá rever as informações do documento para que seja efetuada a requisição de novo com sucesso.

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