Inclusão de Arquivo

End-points responsáveis por inserir arquivos no sistema McFile, assim como os metadados relacionados. 

É necessário o envio de uma chave de integração de usuário, que autentica o procedimento. A mesma pode ser obtida no menu  "minha conta -> segurança" do sistema.

Detalhes da função

URL para POSThttps://[dominio].mcfile.com/mcfile/CtrlAPI?cmd=INSEREARQUIVOAPI

Content-Type: multipart/form-data             

Paramêtros:

Nome do parâmetro           Descrição
arquivoUpload Arquivo para fazer o upload. Obrigatório.
chave                                    Chave de integração de usuário. Campo obrigatório.
naoCriarEstrutura Deve ser enviado como 'true' para que não seja criados clientes ou assuntos. Campo opcional.
removerVersoesAntigas Se enviado como 'true', remove versões anteriores do arquivo sendo inserido.
criarShareLink Se enviado como 'true', retorna um link de share para o documento criado com validade de um dia

Campos de Documento

tipoDocumento     Tipo de documento. Campo obrigatório.
descDocumento Descrição do documento. Campo obrigatório.
codigoDocumento
Código do formulário de documento. Campo opcional. Se informado o upload irá para um destino especifico.
areaID Código da área de sigilo desejada. Campo opcional. Caso não seja informado e um novo formulário for criado, este será associado à área default do usuário. O mesmo ocorre caso o usuário não tenha acesso de edição à área informada.
dataDocumento

Data do arquivo sendo inserido. Formato: dd/MM/yyyy. Campo opcional.

Campos de Cliente

clienteID  Identificador do cliente ao qual o documento pertence. Campo opcional.
razaoSocial Razão social do cliente. Campo opcional.

Campos de Assunto

assuntoID Identificador do assunto ao qual o documento pertence. Campo opcional.
tipoAssunto Tipo de assunto. Campo opcional.
tituloAssunto Título do assunto. Campo opcional

Campos de Processo

numProcesso  Número do processo, utilizado caso o assunto seja do tipo "Processo". Campo opcional.
parte Nome da parte, utilizado caso o assunto seja do tipo "Processo". Campo opcional.

Observações:

-> Apesar dos campos de cliente e assunto não serem obrigatórios, é necessário que pelo menos um dos dois seja identificado.

-> Caso os metadados informados já existam no sistema, o arquivo irá para este formulário pré-existente. Note que, para isso acontecer, é necessário que o formulário esteja em uma área que o usuário tenha permissão de cadastro ou na área informada como parâmetro.

     

Respostas da função

200 - OK Tudo funcionou corretamente. É retornado o código de formulário do documento no qual o arquivo foi inserido.
400 - Bad Request Request não aceito. Geralmente pela falta de algum parâmetro.
401 - Unauthorized Chave incorreta, expirada ou inválida.
403 - Forbidden Falta de permissão para inclusão de arquivo.
406 - Not Acceptable Os parâmetros estavam sintáticamente corretos mas o comando falhou. Verificar na mensagem.
500 - Server Error Algum erro interno no McFile.


Exemplos de uso

Em Java:

Utilizando seguinte classe:  https://svn.apache.org/repos/asf/wicket/sandbox/wicket-sandbox/src/jonathan/java/wicket/util/upload/MultiPartFormOutputStream.java

Implementação de exemplo: ChamadaMcFile.java

Em .NET:

Utilizando implementação descrita nesse post:  http://www.briangrinstead.com/blog/multipart-form-post-in-c

Em HTML:

Utilizando form no seguinte padrão:  form.html