Histórico da Página

...

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"
  }
}

Outros parâmetros que podem ser usados em conjunto com os queryParams de consulta dos anexos:

search: 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"	
  }
}

order: Ordenação dos campos, podendo ser ascendente ou descendente ("-" sinal negativo).
- Exemplo:
  - ordem por data ascendente: order=-createDatetime.
  - ordem por data descendente: order=-createDatetime.

pageSize: Tamanho da página (número de registros retornados). Se não informado será considerado: 10.

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\\e13190f35f57fcb02bcf91c799ed3191.txt",
            "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 no final desta documentação a descrição dos campos da temp-table: ttDocumentFile.

lHasNext

Logical

OUTPUT

Indica que existem mais registros a serem mostrados

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.

...

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão 12

Chave