◼️2. Arquivo

2.1.GET/api/Arquivo/Get

O objetivo deste método é permitir que o usuário consulte os arquivos do documento.

Entrada

Neste serviço o usuário deve informar o ID do Documento que deseja consultar o(s) arquivo(s).

• idDocumento

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se o Id do documento existe e se pertence ao cliente do usuário logado.

Saída/Retorno

O sistema retorna um JSON completo com os dados do(s) arquivo(s) do documento informado.

Code: 200 - OK

Response

{
    "qtdArquivos": 1,//Quantidade de arquivos do documento informado.
    "arquivos": [
        {
            "idImagem": "guid",//id do arquivo
            "nomeDoArquivo": "string",//nome do arquivo
            "versao": "string",//versão do arquivo/imagem
            "binario": "string",//bytes do arquivo/imagem
            "extensao": "string", //extensão/formato do arquivo/imagem
        },
        {
            "idImagem": "guid",//id do arquivo
            "nomeDoArquivo": "string",//nome do arquivo
            "versao": "string",//versão do arquivo/imagem
            "binario": "string",//bytes do arquivo/imagem
            "extensao": "string", //extensão/formato do arquivo/imagem
        }
    ]
}

---

2.2.POST/api/Arquivo/Post

O objetivo deste método é permitir que o usuário cadastre arquivos no documento. O usuário pode incluir no registro um ou mais arquivos.

Entrada

Neste serviço o usuário deve informar o ID do Documento e o(s) arquivo(s) que serão inseridos ao documento.

• idDocumento

• JSON com os dados dos arquivos que serão anexados ao documento informado.

Request body

[
  {
    "arquivo": "string ",//bytes do arquivo
    "nomeImagem": "string",//nome do arquivo
    "versao": "string",//versão do arquivo
    "extensao": "string"//extensão do arquivo  
},
  {
    "arquivo": "string ",//bytes do arquivo
    "nomeImagem": "string",//nome do arquivo
    "versao": "string",//versão do arquivo
    "extensao": "string"//extensão do arquivo  
  }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se o Id do documento existe e se pertence ao cliente do usuário logado.

• É obrigatório informar ao menos um arquivo para cadastrar no documento.

• O sistema não permite upload do mesmo arquivo para o id documento informado.

Saída/Retorno

O sistema retorna o Code 200 OK

Response

"Ok!"

---

2.3.POST/api/Arquivo/Upload

O objetivo deste método é permitir que o usuário cadastre arquivos no documento. O usuário pode incluir no registro um ou mais arquivos.

Entrada

Neste serviço o usuário deve informar o ID do Documento e o(s) arquivo(s) que serão inseridos ao documento.

• idDocumento

• JSON com os dados dos arquivos que serão anexados ao documento informado.

Request boby

[
  {
    "arquivo": "string ",//bytes do arquivo
    "nomeImagem": "string",//nome do arquivo
    "versao": "string",//versão do arquivo
    "extensao": "string"//extensão do arquivo  
},
  {
    "arquivo": "string ",//bytes do arquivo
    "nomeImagem": "string",//nome do arquivo
    "versao": "string",//versão do arquivo
    "extensao": "string"//extensão do arquivo  
  }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se o Id do documento existe e se pertence ao cliente do usuário logado.

• É obrigatório informar ao menos um arquivo para upload no documento.

• O sistema deve permitir upload do mesmo arquivo para o id documento informado.

Saída/Retorno

O sistema retorna o(s) id(s) do(s) arquivo(s) anexados ao documento informado.

Code: 200 - OK

Response

[
    {
        "idImagem": "guid",//id do arquivo
        "nomeImagem": "string"//nome do arquivo
    },
    {
        "idImagem": "guid",//id do arquivo
        "nomeImagem": "string"//nome do arquivo
    }
]

---

2.4.DELETE/api/Arquivo/Delete

O objetivo deste método é permitir que o usuário exclua um arquivo no documento.

Entrada

Neste serviço o usuário deve informar o ID do Documento e o id do arquivo que deseja excluir no documento informado.

• idDocumento

• idArquivo

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se o Id do documento existe e se pertence ao cliente do usuário logado.

• Se o Id do arquivo existe e se está vinculado ao id do documento informado.

Saída/Retorno

O sistema retorna o Code 200 OK

Response

"Ok!"

---

2.5.GET/api/Arquivo/{idImagem}/Cliente/{idCliente}

O objetivo deste método é permitir que o usuário busque um arquivo que pode estar vinculado a um fluxo e/ou documento.

Entrada

Neste serviço o usuário deve informar o id do arquivo e o id do cliente dono do arquivo.

• idImagem

• idCliente

Validações

O sistema valida:

• A permissão do usuário autenticado

• Se o Id da Imagem existe e se pertence ao cliente informado.

Saída/Retorno

O sistema retorna os dados do arquivo informado. O Arquivo pode estar relacionado a um documento ou a um workflow.

Code 200 OK

Response

{
    "idWorkflow": null, //*
    "idDocumento": "guid",//**
    "nomeImagem": "string",//nome do arquivo
    "extensao": "string",//extensão do arquivo
    "arquivo": "byte"//bytes do arquivo
}

Um arquivo estará vinculado somente a um documento ou um workflow. Jamais aos dois ao mesmo tempo.

*"idWorkflow": null ou id do workflow quando o arquivo estiver vinculado a workflow.

**"idDocumento": null ou id do documento quando o arquivo estiver vinculado a um documento.