4.1.PUT Alterar um documento de um Cliente V1

O objetivo deste método é permitir que o usuário altere os dados de um documento.

A alteração é feita apenas nos dados dos campos indexadores (campos customizados e/ou lista).

URL

Entrada

Neste serviço o usuário deve informar o id da unidade, id do cliente, id da árvore organizacional, id do documento e o JSON com os metadados que deseja alterar.

• idUnidade
• idCliente
• idArvoreOrganizacional
• idDocumento
• JSON com os dados do documento informado que serão alterados.

Request boby

[
    {
        "valor": "string",//novo valor para o campo que está sendo alterado
        "campo": "string",//nome do campo que está sendo alterado
        "nomeLista": "string"//nome da lista, se o campo pertencer a uma lista
    }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.
• Se o Id do documento existe e se pertence ao cliente informado.
• Se o Id do documento está vinculado ao id da árvore informado.
• Se os campos indexadores pertencem a árvore organizacional informada.
• Para indexadores de lista, o sistema valida se a árvore possui a configuração da lista.

1. Para Lista de Autocomplete ou Consolidação (Permitir a inclusão durante a alteração)

O sistema permite a inclusão de novos dados na lista. Os campos chaves, bem como os campos de importação obrigatória, devem ser informados.

• Ao informar um campo chave que não existe na lista, o sistema inclui um novo item e associa ao documento que está sendo alterado.
• Ao informar um campo chave que existe na lista, o sistema associa o item na lista e ao documento que está sendo alterado.

2. Para lista de Consolidação (Não Permitir a inclusão durante a alteração)

O sistema não permite a inclusão de novos dados na lista. Ou seja, deve-se realizar a importação da lista antes de iniciar o processo de cadastro de documentos.

•  Ao informar um campo chave que não existe na lista, o sistema não permite alterar o documento.
•  Ao informar um campo chave que existe na lista, o sistema associa o item na lista e ao documento que está sendo alterado.

Saída/Retorno

O sistema retorna a mensagem de registro alterado com sucesso.

Code: 200 – OK

Response

"Registro alterado com sucesso."

4.2.POST Cadastrar um documento de um Cliente V1

O objetivo deste método é permitir que o usuário cadastre documentos em determinado nível de árvore. O usuário pode incluir no documento um ou mais arquivos.

URL

Entrada

Neste serviço o usuário deve informar o id da unidade, o id do cliente, o id da árvore organizacional e o JSON com os dados do documento.

• idUnidade
• idCliente
• idArvoreOrganizacional
• JSON com os dados do documento.

• Quando documento eletrônico, informar o valor null no parâmetro codigoCaixa.
• Quando documento Guarda Interna ou Guarda Terceirizada, informar o código da caixa que o documento será armazenado no parâmetro codigoCaixa.
• O usuário deve informar os campos customizados e/ou de listas que estão configurados no idArvoreOrganizacional informado.
• O documento que será criado pode ou não ter um ou mais arquivos anexados.

Request body

{
    "codigoCaixa": null,//null ou código da caixa
    "valoresCampos": [
        {
            "nomeLista": "string",//nome da lista se for campo de lista.
            "label": "string",//nome do campo
            "valorCampo": "string",//Valor do campo        
        },
        {
            "nomeLista": "string",
            "label": " string ",
            "valorCampo": " string "
        },
        {
            "nomeLista": "string",
            "label": " string ",
            "valorCampo": " string "
        }
    ],
    "arquivos": [//Arquivos que serão anexados ao documento criado
        {
            "arquivo": "bytes",//bytes do arquivo
            "contentType": "application/extensão",[//tipo do arquivo
            "extensao": "string",[//extensão do arquivo
            "nomeAmigavel": "string"[//nome do arquivo
        },
        {
            "arquivo": "bytes",
            "contentType": "application/extensão",
            "extensao": "string",
            "nomeAmigavel": "string"
        }
    ]
}

Validações

O sistema valida:

• A permissão do usuário autenticado.
• O código da caixa informado.
• Se o Id da arvore organizacional existe e se pertence ao cliente informado.
• Os campos indexadores informados.

Saída/Retorno

O sistema retorna o id e o código do documento cadastrado.

Code: 201 – Created

Response

[
    "Registro adicionado com sucesso.",
    "IdDocumento: 4298ca74-82ac-4fc2-95b3-33c176ff4323",
    "CodigoDocumento: 106609146"
]

4.3.POST Cadastrar um documento de um Cliente: com compartilhamento V2

O objetivo deste serviço é permitir ao usuário cadastrar um documento, em determinado nível de árvore, com a possibilidade de compartilhar ou não os arquivos. Para documentos com a necessidade de compartilhamento dos arquivos, deve-se informar o parâmetro “compartilhado” igual a 1 (true) no Json, conforme o exemplo abaixo.

URL

Requisição

É obrigatório informar:

• idUnidade
• idCliente
• idArvoreOrganizacional
• JSON com os dados do documento.

Ref.: 4* – Campos indexadores

Os campos indexadores (campos customizados e/ou campos de lista) devem ser informados conforme a configuração da árvore organizacional (idArvoreOrganizacional) informada. Estes serão obrigatórios se na árvore possuir a configuração de obrigatoriedade.

Ref.: 5* – Arquivos

O arquivo não é obrigatório, mas se informado é validado.

Quando no parâmetro “compartilhado” for informado o valor “True”, o serviço retorna o link do arquivo compartilhado no parâmetro “linkCompartilhado”.

Quando no parâmetro “compartilhado” for informado o valor “False”, o sistema cadastro o documento sem compartilhar os arquivos e retorna apenas o id do arquivo, em questão.

Request Body

JSON com os dados para cadastrar o documento. Para cada arquivo do documento, o usuário pode informar se o arquivo deve ser compartilhado ou não.

Exemplo: Cadastro de documento com um arquivo compartilhado.

{
    "CodigoCaixa": null,
    "IdDocumento": "",
    "Arquivos": [
        {
            "Arquivo": "Base64 do arquivo",
            "ContentType": "application/pdf",
            "Extensao": "pdf",
            "NomeAmigavel": "POST Documento",
            "compartilhado": true
        }
    ],
    "ValoresCampos": [
        {
            "NomeLista": "",
            "Label": "Contato",
            "ValorCampo": "Digitalização de documentos"
        },
        {
            "NomeLista": "",
            "Label": "CPF/CNPJ Fornecedor",
            "ValorCampo": "07.664.483/0001-78"
        },
        {
            "NomeLista": "",
            "Label": "Data de Emissão",
            "ValorCampo": "15/08/2024"
        },
        {
            "NomeLista": "",
            "Label": "Observação",
            "ValorCampo": "Digitalizaçãoo conforme Lei geral de proteção de dados"
        }
    ]
}

Validações

O sistema valida:

• A permissão do usuário autenticado.
• Se informado, o código da caixa.
• Se o Id da arvore organizacional existe e se pertence ao cliente informado.
• Os campos indexadores informados.

Response Body

O serviço POST Cadastrar um documento de um Cliente: com compartilhamento V2 retorna o id do documento, código do documento, id’s dos arquivos juntamente com o link do arquivo compartilhado (quando for enviado no parâmetro compartilhado o valor 1 (True), conforme exemplo.

Exemplo: Retorno do cadastro de documento com um arquivo compartilhado.

{
    "IdDocumento": "5018ff7e-1e1b-4f6f-9e32-55b3f95cd3e4",
    "CodigoDocumento": 146491663,
    "Arquivos": [
        {
            "IdArquivo": "b267b001-7101-42ab-bb48-0a12ff4ec48c",
            "LinkCompartilhado": "https://arqged.arquivar.com/VisualizarDocumentos/Index?token=MWI4M2E4ZGUtN2QxNC00M2ZhLTkxNWQtMzNjYWExOWRkNjNi"
        }
    ]
}

Exemplo: Retorno do cadastro de documento com mais de um arquivo compartilhado.

{
    "IdDocumento": "e54d24a3-6380-4ea1-bf91-f65417792837",
    "CodigoDocumento": 146496045,
    "Arquivos": [
        {
            "IdArquivo": "750cdcce-b0cd-42c3-b680-bbba2ac451e7",
            "LinkCompartilhado": "https://arqged.arquivar.com/VisualizarDocumentos/Index?token=ZWY3NWRkMzUtMWNmZi00NmQ1LWIwNWUtN2VmM2I4NTM3NWY2"
        },
        {
            "IdArquivo": "898fd8ed-56c6-4d93-be7c-8648895bb077",
            "LinkCompartilhado": "https://arqged.arquivar.com/VisualizarDocumentos/Index?token=NGY2OWI3ZTktZjIyYi00N2VjLWEwNTktMGVmOTgxNWExOWY4"
        }
    ]
}

Quando não for informado o parâmetro “compartilhado” ou for informado com valor 0 (false), o sistema cadastro o documento sem compartilhar os arquivos e retorna apenas o id do arquivo, em questão.

Exemplo: Retorno do cadastro de documento sem compartilhamento de arquivos.

{
    "IdDocumento": "e54d24a3-6380-4ea1-bf91-f65417792837",
    "CodigoDocumento": 146496045,
    "Arquivos": [
        {
            "IdArquivo": "750cdcce-b0cd-42c3-b680-bbba2ac451e7"
        },
        {
            "IdArquivo": "898fd8ed-56c6-4d93-be7c-8648895bb077"
        }
    ]
}

Exemplo: Retorno de cadastro de documento com e sem compartilhamento de arquivos.

{
    "IdDocumento": "977443c8-90a5-4b22-8421-bcd5a1f958f3",
    "CodigoDocumento": 147049992,
    "Arquivos": [
        {
            "IdArquivo": "3101b3ce-9c53-4474-9631-de50bb5d0dc6"
        },
        {
            "IdArquivo": "2b9cf651-265f-4b86-ab1a-5de7bdb84ca2",
            "LinkCompartilhado": "https://arqged.arquivar.com/VisualizarDocumentos/Index?token=MmRlZTMzZDEtODg5Mi00NjNmLTg3MDctODFmMjE5NjliYmM0"
        }
    ]
}

4.4.GET Buscar documentos de um Cliente V1

O objetivo deste método é permitir que o usuário pesquise os documentos cadastrados em determinado nível de árvore. Além disso, permite filtrar as buscas informando mais parâmetros como campos indexadores, código do documento, código da caixa, e data cadastro.

URL

Entrada

Neste serviço o usuário deve informar o id do cliente e pode informar alguns parâmetros para filtrar a busca por um ou mais documentos.

O usuário pode buscar um documento informando um ou mais campos indexadores. Para buscar por campos indexadores o usuário deve informar o nome e o valor do campo do campo.

Exemplo:

ValoresCampos[0].Label=nome do campo 1

ValoresCampos[0].ValorCampo=valor do campo 1

ValoresCampos1].Label=nome do campo 2

ValoresCampos[1].ValorCampo=valor do campo 2

Validações

O sistema valida:

• A permissão do usuário autenticado.
• Se informado, o sistema valida o código da caixa pertence ao cliente informado.
• Se informado, o sistema valida o código do documento pertence ao cliente informado.
• Se o Id da árvore organizacional existe e se pertence ao cliente informado.
• Os campos indexadores informados.

Saída/Retorno

O sistema retorna os documentos conforme os filtros de busca.

Code: 200 – OK

O parâmetro MetaDados é cada documento retornado na consulta com seus respectivos dados.

Somente serão retomados valores nos campos “LabelPaginas”, “QtdDocumentos” e “TotalPaginas se o usuário informar o parâmetro “BuscarQtdPaginasDocumento”.

Response

• Caixa: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional e na caixa informada.
• Documento: Ao informar este campo, o sistema retorna o documento informado.
• DataCadastroInicial: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, a partir da Data cadastro informada.
• DataCadastroFinal: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, até a Data cadastro informada.
• DataVencimento: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, com vencimento na Data vencimento informada.
• IdUsuarioIndexador: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional pelo usuário indexador informado.
• IdDocumentoStatus: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional com status informado.
• IdCaixaTipo: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional e armazenados em caixas do tipo informado.
• ValoresCampos: Ao informar estes campos, o sistema retorna os documentos cadastrados no idArvoreOrganizacional que contém os dados dos campos indexadores (campos customizados e/ou de lista) informados.
• Pagina: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional que estão na página informada. A consulta é paginada.
• BuscarQtdPaginasDocumento (true ou false): Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional exibindo a quantidade documentos retornados.

4.5.GET Consultar Compartilhamento dos Arquivos de um Documento V2

URL

Nomenclatura

Método: GET/api/Documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos

Descrição: Consultar link de compartilhamento dos arquivos de um documento.

Para que serve: Método responsável por consultar o link de compartilhamento dos arquivos de
um documento.

Serviço:/api/Documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos

GET Consultar Compartilhamento dos Arquivos de um Documento

Somente arquivos associados a um documento cadastrado no ArqGED podem ser retornados
neste método.

Para esta consulta deve ser enviado o IdDocumento dos arquivos que deseja consultar.

Request:

2 – IdDocumento: Deve ser informado o idDocumento dos arquivos ao qual o usuário deseja consultar o link de compartilhamento. Este parâmetro é obrigatório.

3 – Guid da Imagem: Como parâmetro da requisição deverão ser informados os ids referente aos idImagem, conforme exemplo abaixo. Esta informação é opcional, não precisa ser enviada. Quando não informada significa que a consulta ocorrerá para todas as imagens do idDocumento.

Exemplo de Consulta informando apenas o IdDocumento:

Exemplo do resultado da busca:

Exemplo de busca informando as imagens:

Exemplo do retorno:

4.6.DELETAR link de copartilhamento dos arquivos de um documento V2

URL

Nomenclatura

Método: PATCH /api/documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos

Descrição: Deletar link de compartilhamento dos arquivos de um documento.

Para que serve: Método responsável por excluir o link de compartilhamento dos arquivos de um
documento.

DELETAR Compartilhamento de Arquivo de um Documento

Serviço:/api/documento/{idDocumento}/cliente/{idCliente}/removercompartilhamento-arquivos

Somente arquivos associados a um documento cadastrado no ArqGED e já compartilhados
podem ter seu compartilhamento excluído.

Para este compartilhamento deve ser enviado o IdDocumento dos arquivos que deseja excluir
o compartilhamento compartilhar.

Request:

2 – IdDocumento: Deve ser informado o idDocumento dos arquivos ao qual o usuário deseja excluir o
compartilhamento. Este parâmetro é obrigatório.

3 – IdImagem: O idImagem é opcional, não precisa ser enviado, quando ele não é informado significa que a exclusão de compartilhamento ocorrerá para todas as imagens do idDocumento.

Exemplo de exclusão do link de arquivos compartilhados:

Exemplo do resultado da exclusão:

4.7.DELETE Deletar um documento de um Cliente V1

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

URL

Entrada

Neste serviço o usuário deve informar o id da unidade, o id do cliente, id da árvore organizacional e o id do documento que será excluído.

• idUnidade
• idCliente
• idArvoreOrganizacional
• idDocumento

Validações

O sistema valida:

• O sistema valida a permissão do usuário autenticado.
• O sistema valida o id do documento pertence ao cliente informado.
• O sistema valida se o Id da arvore organizacional existe e se pertence ao cliente informado.

Saída/Retorno

O sistema retorna a mensagem de exclusão com sucesso.

Code: 200 – OK

Response

"Documento excluído com sucesso!"

4.8.POST Compartilhar Arquivos de um Documento V2

URL

Nomenclatura

Método: POST /api/documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos

Descrição: Gerar link de compartilhamento dos arquivos de um documento.

Para que serve: Método responsável por gerar link de compartilhamento dos arquivos de um
documento.

POST Compartilhar Arquivos de um Documento

Serviço: /api/documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos

Somente arquivos associados a um documento cadastrado no ArqGED podem ser
compartilhados.

Para este compartilhamento deve ser enviado o IdDocumento dos arquivos que deseja
compartilhar.

Request:

2 – IdDocumento: Deve ser informado o idDocumento dos arquivos ao qual o usuário deseja
compartilhar. Este parâmetro é obrigatório.

3 – IdImagem: O idImagem é opcional, não precisa ser enviado, quando ele não é informado significa que
o compartilhamento ocorrerá para todas as imagens do idDocumento.

5 – PrazoCompartilhamento: O prazo do compartilhamento não é obrigatório, mas quando informado
irá definir que o compartilhamento é com prazo determinado, ou seja, o link deixa de funcionar após a
data em questão. Este parâmetro é de envio obrigatório.

Exemplo de Compartilhamento de arquivos de um documento:

Exemplo do resultado:

4.9 POST Cadastro de Documento: com link de arquivo V3

URL

Nomenclatura

Método: POST /api/v3/Documento

Parâmetros de consulta: idUnidade, idCliente, idArvoreOrganizacional

Descrição: Cadastrar documentos em nível específico da árvore organizacional.

Para que serve: Permite o cadastro de documentos em um nível específico da árvore organizacional, possibilitando a associação de campos indexadores, anexar arquivos e, opcionalmente, gerar links para compartilhamento destes arquivos.

POST – Cadastro de Documento: com link de arquivo (API v3)

Objetivo

Permitir a integração com sistemas externos para cadastro de documentos no ArqGED, incluindo:

• Definição de campos indexadores: possibilita a inclusão de campos do tipo lista ou de campos customizados previamente configurados na árvore organizacional, utilizados na criação do documento.
• Inclusão de arquivos anexos: ampliação do serviço para permitir a utilização de links para download dos arquivos que serão anexados ao documento (devendo ser informado o link do arquivo ou Base64).
• Compartilhamento opcional dos arquivos anexados: disponibiliza, de forma opcional, a geração de um link de compartilhamento para visualização dos arquivos anexados, independentemente de terem sido enviados por Base64 ou por link.

Acesso ao Serviço

O consumo do serviço é realizado por meio de uma requisição HTTP do tipo POST para o endpoint api/v3/Documento.

As informações necessárias devem ser enviadas através de:

• Headers;
• Query Parameters;
• Body da requisição.

Header

Query Parameters

Body da Requisição

É obrigatório informar pelo menos um dos seguintes grupos:

• valoresCampos
• arquivos

Campos Principais

Exemplo

Estrutura do parâmetro valoresCampos

Os campos indexadores devem seguir a configuração definida na árvore organizacional informada.

Caso existam campos obrigatórios configurados para a árvore, eles deverão ser enviados na requisição.

Estrutura do parâmetro arquivos

Regras para Envio de Arquivos

• Ao informar qualquer atributo do objeto arquivos, torna-se obrigatório enviar linkArquivo ou arquivo (Base64).
• O campo extensão deve corresponder ao tipo do arquivo enviado.
• Quando compartilhado = True, o serviço retorna o link do compartilhamento em linkCompartilhado para visualização do arquivo.
• Quando compartilhado = False ou não informado, o campo linkCompartilhado não será retornado.

Saída/Retorno

HTTP Status: 201 Created

Exemplo do resultado: