Histórico da Página

...

Esta API tem como objetivo incluir a opção de anexar arquivos em uma ordem de compra bem como ser possível realizar ações de consulta, filtro, exclusão, download e upload.validar as regras de negócio dos arquivos de compras que serão anexados pela api de documentos hubapi/apidocuments.

Esta api recebe os parâmetros enviados pela cdp/api/v1/supplyDocuments , faz as validações necessárias nos métodos e depois envia os parâmetros necessários para a api de documentos hubapi/apidocuments. Nesta apidocuments (api do HUB), serão realizados os métodos de inclusão, exclusão, download, upload e consulta dos anexos dos documentos.

Para maiores informações sobre:

cdp/api/v1/supplyDocuments: supplyDocuments - Anexos de Suprimentos (Compras, Contratos, entre outros)
hubapi/apiDocuments: https://tdn.totvs.com/pages/viewpage.action?pageId=675561040

Funcionamento

A API fornece uma série de métodos que podem ser executados individualmente para apresentação de anexos na tela do documento.

...

pi-metadata-v1

Requisito

Nenhum.

Descrição

Repassa o parâmetro do tipo de evento recebido pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-metadata-v1.

Retorna o metadados com os campos e ações ativos referentes a tela de Listagem ou Edição, dependendo de qual tipo foi enviado pela requisição, para a montagem dinâmica da tabela tela com as informações vindas do backend.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca de metadados:

pathParams: Informar: metadata.

queryParams → type: Utilizando este atributo com uma das opções abaixo permite retornar as informações de:

list: Metadados da tela de listagem.
edit: Metadados da tela de inclusão do arquivo.

Bloco de código

title	Exemplo

{
    "queryParams": {
    "type": "list"
  },
    "pathParams": [
       "metadata"
    ],
}

cEvent

Character

INPUT

Identifica qual o tipo de evento vindo do queryParams para a busca do metadado correto.

cVersion

Character

INPUT

Identifica a versão da API.

oOutput

JsonObject

OUTPUT

Retorno contendo o metadados com campos e ações conforme parâmetros recebidos:

Metadados List:

Bloco de código

title	List

  {
    "keepfilters": false,
    "literals": {},
    "validateFields": [],
    "title": "Documentos",
    "fields": [
        {
            "visible": false,
            "property": "documentId",
            "label": "Código",
            "type": "number",
            "key": true,
            "order": 1
        },
        {
            "property": "processTypeDescription",
            "width": "15%",
            "label": "Tipo Processo",
            "type": "string",
            "order": 2
        },
        {
            "property": "processKey",
            "width": "15%",
            "label": "Chave Processo",
            "type": "string",
            "order": 3
        },
        {
            "property": "documentName",
            "width": "20%",
            "label": "Documento",
            "type": "string",
            "order": 4
        },
        {
            "property": "documentSize",
            "width": "5%",
            "label": "Tamanho",
            "type": "string",
            "order": 5
        },
        {
            "property": "documentDescription",
            "width": "25%",
            "label": "Descrição",
            "type": "string",
            "order": 6
        }
    ],
    "tableCustomActions": [],
    "actions": {
        "new": "/new",
        "removeAll": true,
        "remove": true
    },
    "pageCustomActions": []
}

Para verificar o que significa cada campo de listagem, conferir abaixo: Descrição dos campos:

keepFilters: Mantém na modal de Busca Avançada os valores preenchidos do último filtro realizado pelo usuário.
literals: Objeto com as literais usadas.
validateFields: Lista que define os campos que irão disparar o validate do form.
title: Título da página.
fields: São os campos a serem apresentados na tabela, sendo eles:
- property: Nome de referência do campo.
- label: Rótulo do campo exibido.
- type: Tipo do valor campo.
- key: Valor lógico que indica se o campo é chave.
- order: Informa a ordem de exibição do campo.
- visible: Indica se o campo será visível.
- width: Tamanho do campo.
tableCustomActions: Lista de ações customizadas da tabela que serão incorporadas às ações informadas através da propriedade actions.
actions:Ações que o usuário poderá executar na página através de botões:
- new: Rota ou função para criar um novo recurso, caso seja preenchida habilita a ação de "Novo" na tela de listagem para criação de um novo anexo.
- remove: Habilita a ação de exclusão na tabela.
- removeAll: Habilita a ação de exclusão em lote na página.
pageCustomActions: Lista de ações customizadas da página que serão incorporadas às ações informadas através da propriedade actions. Essas ações ficam localizadas na parte superior da página em botões com ações. Ex: "Novo", "Excluir".

Metadados Edit:

Bloco de código

title	Edit

  {
    "defaultFields": [
        {
            "gridColumns": 4,
            "divider": "Processo",
            "label": "Tipo Processo",
            "property": "processType",
            "disabled": true,
            "options": [
                {
                    "value": 1,
                    "label": "Ordem de Compra"
                }
            ]
        },
        {
            "gridColumns": 4,
            "label": "Chave",
            "property": "processKey",
            "disabled": true
        },
        {
            "autoUpload": true,
            "gridColumns": 4,
            "divider": "Anexar Documento",
            "label": "Selecione o documento",
            "property": "documentUpload",
            "required": true,
            "type": "upload"
        },
        {
            "maxLength": 200,
            "gridColumns": 4,
            "label": "Descrição",
            "property": "documentDescription",
            "rows": 4
        }
    ],
    "title": "Novo Documento",
    "breadcrumb": {
        "items": [
            {
                "link": "/",
                "label": "Documentos"
            },
            {
                "link": "/new",
                "label": "Novo Documento"
            }
        ]
    }
}

Para verificar o que significa cada campo de edição, conferir abaixo:

Descrição dos campos:

defaultFields: Armazena as informações dos campos padrões do formulários:
- gridColumns: Tamanho de exibição do campo em telas.
- divider: Exibirá um divisor acima, utilizando o seu conteúdo como título.
- label: Rótulo do campo exibido.
- property: Nome de referência do campo.
- disabled: Função que deve retornar um booleano para habilitar ou desabilitar a ação para o registro selecionado.
- options: Lista de opções que serão exibidas em um componente, podendo selecionar uma opção.
  - value: Valor que será usado como referência para exibição do conteúdo na coluna, representa o tipo de processo.
  - label: Rótulo do campo exibido, referenciando o nome do tipo de processo.
autoUpload: Define se o envio do arquivo será automático ao selecionar o mesmo.
required: Indica que o campo será obrigatório.
type: Tipo do valor do campo.
maxLength: Tamanho máximo de caracteres.
rows: Quantidade de linhas exibidas no campo "Descrição".
title: Título da página.
breadcrumb: Objeto com propriedades do breadcrumb, componente que gera uma estrutura de navegação que apresenta ao usuário a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação:
- items: Lista de itens do breadcrumb:
  - link: Url do item.
  - label: Rótulo do item.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos dados.

Retorno

Retorna informações do metadados ou erros ocorridos durante a busca

...

pi-query-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) após a execução das validações de restrição, chamando o método pi-query-v1.

Retorna a lista de anexos relacionados a um documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca de anexos:

queryParams:

→ processType=: Tipo do processo vinculado ao documento, sendo "1" a Ordem de Compra, com base na include uninc/i01un403.i.

→ processKey=: Código da chave do processo, identifica o processo ao qual o anexo pertence. A chave pode ou não ser composta. Caso seja, será separada por pipe "|" e deve ser enviada no formato encode. No exemplo abaixo, a chave "1234%7CABC" está no formato encode e corresponde a chave composta: "1234|ABC".

Bloco de código

title	Exemplo

{
    "queryParams": {
       "processType": "1",
       "processKey": "1234%7CABC"
  }
}

A consulta também permite a pesquisa por campos. Os parâmetros são os mesmos utilizados na queryParams de busca, sendo apenas adicionando o "search" na requisição juntamente com o critério de filtro que pode ser: nome do anexo, descrição do anexo ou usuário criador. No exemplo abaixo está sendo solicitada uma consulta utilizando um filtro para mostrar apenas os documentos anexados pelo usuário "super".

Bloco de código

title	Exemplo

{
    "queryParams": {
       "processType": "1",
       "processKey": "1234%7CABC",
	   "search":"super"	
  }
}

aResult

JsonArray

OUTPUT

Retorno do processo, contendo os itens da listagem de anexos conforme parâmetros enviados.

Bloco de código

title	Exemplo

{
    "total": 3,
    "totalHits": 3,
    "hasNext": false,
    "items": [
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\123\\5\\c3e349d230b2d176eefb7d58f2eb35e1.txt",
            "creationUser": "super",
            "documentDescription": "arquivo 123",
            "processKey": "123|5",
            "documentId": 392,
            "processType": 1,
            "documentName": "arquivo123.txt",
            "documentSize": "74 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T09:12:43.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\123\\5\\",
            "creationUser": "SUPER",
            "documentDescription": "teste download",
            "processKey": "123|5",
            "documentId": 393,
            "processType": 1,
            "documentName": "testando.txt",
            "documentSize": "1GB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T18:01:17.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\2\\1234\\5\\2ca28ec306fb5e55c24448f2bdb1baa3",
            "creationUser": "SUPER",
            "documentDescription": "teste download",
            "processKey": "123|5",
            "documentId": 396,
            "processType": 1,
            "documentName": "testando.txt",
            "documentSize": "1GB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T18:08:29.000"
        }
    ]
}

Para verificar o que significa cada campo, conferir na descrição das temp-tables , conferir no final desta documentação :

ttDocumentFile: Contém os campos a serem retornados na busca dos documentos do processo

a descrição dos campos da temp-table : ttDocumentFile.

lHasNext

Logical

OUTPUT

Indica se existem mais registros a serem mostrados na página.

iTotalHits

Integer

OUTPUT

Contagem do total de registros encontrados.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo.

Retorno

Retorna a lista de arquivos relacionados a um documento ou erros ocorridos durante a busca.

...

pi-upload-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-upload-v1.

Retorna informações do arquivo em que o upload está sendo efetuado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para o upload:

pathParams: Informar: upload.

queryParams → files=: Arquivo a ser efetuado o upload, sendo enviado também como parâmetro.

Exemplo abaixo do formato de requisição com arquivo enviado como parâmetro:

Bloco de código

title	Exemplo

{
  "content-type": "multipart/form-data",
   "multipart": [
    	{
         "headers": {
                     "Content-Disposition": "form-data; name=\"file\"; filename=\"Adobe Sign Form Field.pdf\""
         },
         "body": {
                   "content-type": "application/pdf",
                   "content": "@{base64(body('Get_file_content_Signed_PDF'))}"
         }
      }
   ]
}

oOutput

JsonObject

OUTPUT

Informações do arquivo:

Bloco de código

title	Exemplo

{
  "fileName": "Evidencia_DMANSUPIMPA2-419.docx",
  "content": "UEsDBBQABgAIAAAAIQCJi8MJ4gEAAF4KAAATAAgCW0NvbnRlbnRfVHlwZXN..."
}

Para verificar o que significa cada campo, conferir abaixo: Descrição dos campos:

fileName: Nome do arquivo que está sendo efetuado upload, seguido pela extensão.
content: Conteúdo presente no arquivo, convertido para base64.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de upload.

Retorno

Retorna informações do nome do arquivo e seu conteúdo em base64 ou erros ocorridos durante o processo.

...

pi-download-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-download-v1. Também realiza validações de restrição dos usuários em relação a menu e processos.

Retorna informações do arquivo em que o download está sendo efetuado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para download do anexo:

pathParams: Informar: download e ID do documento.

Bloco de código

title	Exemplo

{
    "pathParams": [
    "download",
    "402"
  ],
}

oOutput

JsonObject

OUTPUT

Retorno das informações do arquivo que está sendo realizado o download:

Bloco de código

title	Exemplo

{
    "headers": {
        "Content-Type": "application/octet-stream"
    },
    "payload": {
        "file": {
            "FN_File": "Evidencia_COD_DMANSUPIMPA2-605.docx",
            "DN_File": "UEsDBBQABgAIAAAAIQBkdsOlw57DhwEAAMOKCQAAEwAIAltD..."
        }
    }
}

Para verificar o que significa cada campo, conferir abaixo: Descrição dos campos:

File : contém as informações do anexo
- FN_File: Nome do arquivo com extensão, vindo da tabela arquivo_docto.
- DN_File: Conteúdo do arquivo em base64.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a busca dos códigos dos anexos.

Retorno

Retorna informações de nome e conteúdo do anexo que está sendo feito download ou erros ocorridos durante o processo.

...

pi-delete-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-delete-v1. Também realiza validações de restrição dos usuários em relação a menu e processos.

Retorna informações relacionadas a exclusão dos anexos.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para eliminação de anexo individual:

pathParams: Informar: ID do anexo.

Bloco de código

title	Exemplo

{
    "pathParams": [
       "1234"
    ],
}

Parâmetros para eliminação de anexo em lote:

Payload: Informar os IDs a serem eliminados:

Bloco de código

title	Exemplo

[
   {"documentId": 552, 
   {"documentId": 553},
   {"documentId": 554}
]

oOutput

JsonObject

OUTPUT

Informações da exclusão:

Não há retorno direto via Output nesse método. Em caso de sucesso na exclusão individual ou lote, será retornado vazio.

A montagem do JsonObject e seu retorno ocorrerá na API de comunicações, cdp/api/v1/supplyDocuments com base no conteúdo vindo da temp-table RowErrors. Para mais informações vide documentação : supplyDocuments - Anexos de Suprimentos (Compras, Contratos, entre outros).

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo:

A temp-table vem populada com registros criados na API de documentos (hubapi/apiDocuments), devido a erros ocorridos durante o processo de exclusão de anexos.

Esses registros serão usados para a montagem da mensagem de erro que será retornada via OUTPUT de um JsonObject, na API de comunicação (cdp/api/v1/supplyDocuments), conforme cada caso específico.

Caso haja erro na tentativa de excluir um único registro inexistente, serão repassados para a API de comunicação (cdp/api/v1/supplyDocuments) valores na temp-table RowErrors para montagem e retorno do objeto Json. Exemplo do modelo da mensagem utilizando o registro 553:

Bloco de código

title	Exemplo

{
  "detailedMessage": "Registro não encontrado na tabela anexo_docto - Id: 553.\n",
  "code": "57401",
  "message": "Registro não encontrado.",
  "type": "error"
}

Caso haja erro na tentativa de excluir registros em lote, serão repassados para a API de comunicação (cdp/api/v1/supplyDocuments) valores na temp-table RowErrors para montagem e retorno do objeto Json. Exemplo do modelo da mensagem utilizando os registros 552, 553 e 554:

Bloco de código

title	Exemplo

{
    "detailedMessage": "Registro não encontrado na tabela anexo_docto - Id: 552.\n",
    "code": "57401",
    "details": [
        {
            "detailedMessage": "Registro não encontrado na tabela anexo_docto - Id: 553.\n",
            "code": "57401",
            "message": "Registro não encontrado.",
            "type": "error"
        },
        {
            "detailedMessage": "Registro não encontrado na tabela anexo_docto - Id: 554.\n",
            "code": "57401",
            "message": "Registro não encontrado.",
            "type": "error"
        }
    ],
    "message": "Registro não encontrado.",
    "type": "error"
}

Caso haja erro na eliminação de registros juntamente com sucesso na exclusão registros em lote, serão repassados para a API de comunicação (cdp/api/v1/supplyDocuments) valores na temp-table RowErrors para montagem e retorno do objeto Json. Exemplo do modelo da mensagem utilizando os registros 637, 404 e 554:

Bloco de código

title	Exemplo

{
    "_messages": [
        {
            "detailedMessage": "Registro não encontrado na tabela anexo_docto - Id: 554.\n",
            "code": 57401,
            "type": "error",
            "message": "Registro não encontrado."
        }
    ],
    "idList": "404,637"
}

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

RowErrors: Contém os erros e informações sobre os erros ocorridos durante o processo.
Outros campos retornado no Json:
- detailedMessage: Mensagem detalhada do erro ocorrido.
- code: Número do código do erro ocorrido.
- message: Mensagem simplificada do erro.
- type: Tipo da mensagem.
- idList: Lista de IDs eliminados com sucesso em uma exclusão em lote com erros.

ListaIdsExcluidos

Character

OUTPUT

IDs que foram eliminados com sucesso. Serão apresentados na mensagem de retorno caso aconteça de ter erros e sucessos em uma mesma eliminação em lote.

Retorno

Erros ocorridos durante a exclusão individual ou em lote identificando qual o id com erro e id's dos documentos excluídos com sucesso.

...

pi-create-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-create-v1. Também realiza validações de restrição dos usuários em relação a menu e processos.

Retorna informações sobre o anexo criado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para criação:

Payload:

Bloco de código

title	Exemplo

{
         "processType":1,
         "processKey":"12345|10",
         "documentName":"testeArquivo.txt",
         "documentDescription":"teste de arquivo",
         "documentFile": "JC9CVVNJTkVTU0hVQi9Gb250ZXNfRG9jL1N1c3RlbnRhY2FvL1YxMS9WMTEv..."
 }

Descrição dos campos do payload:

processType: Tipo do processo ao qual o documento está vinculado.
processKey: Código da chave do processo podendo ser composta (separado por pipes).
documentName : Nome do arquivo.
documentDescription: Descrição do Documento.
documentFile: Conteúdo do arquivo, convertido para base64.

oOutput

JsonObject

OUTPUT

Informações do anexo criado:

Bloco de código

title	Exemplo

{
    "items": [
        {
            "creationUserName": "Super",
            "documentDir": "\\\\moitas\\tmp\\ERP\\1\\12345\\10\\3c3bbcd88a4f01fb34fb63ae7f845f6c.txt",
            "creationUser": "super",
            "documentDescription": "teste de arquivo",
            "processKey": "12345|10",
            "documentId": 725,
            "processType": 1,
            "documentName": "testeArquivo.txt",
            "documentSize": "74 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-29T10:59:46.376"
        }
    ]
}

Para verificar o que significa cada campo conferir no final desta documentação o detalhamento dos campos da temp-table : ttDocumentFile .

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a criação de arquivo.

Retorno

Informações do anexo criado ou erros ocorridos durante o processo.

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave