Histórico da Página

...

pi-query-attachments-v2

Requisito

Nenhum.

Descrição

Retorna a lista de anexos disponíveis para determinado documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para retornar a lista de anexos:

pathParams: Informar: attachments e o número da transação

Bloco de código

title	Exemplo

{
    "pathParams": [
    "attachments",
    "19308"
  ],
}

oOutput

JsonObject

OUTPUT

listagem dos anexos do documento:

Bloco de código

title	Exemplo

{
    "payload": {
        "total": 3,
        "hasNext": false,
        "items": [
            {
                "internalId": "1",
                "transactionNumber": "412297",
                "name": "arquivo1.png",
                "description": "anexo de teste",
                "creationDatetime": "2020-02-01T08:00:00.000",
                "group": ""
            },
            {
                "internalId": "2",
                "transactionNumber": "412297",
                "name": "arquivo2.pdf",
                "description": "anexo de teste 2",
                "creationDatetime": "2022-02-01T08:00:00.000",
                "group": "teste"
            },
            {
                "internalId": "3",
                "transactionNumber": "412297",
                "name": "arquivo3.doc",
                "description": "anexo de teste 3",
                "creationDatetime": "2022-05-13T08:00:00.000",
                "group": "teste3"
            }
        ]
    },
    "status": 200
}

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

tt-anexo: contém a lista de anexos com as informações de identificação do arquivo, sem o seu conteúdo.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos na busca dos anexos do documento.

Retorno

Informação de sucesso ou erros ocorridos no processo de criação da listagem dos anexos.

...

pi-get-attach-content-v2

Requisito

Nenhum.

Descrição

Retorna a lista de conteúdo dos anexos objeto com o conteúdo do anexo de um determinado documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para retornar a lista de anexoso conteúdo do anexo:

pathParams: Informar:

attachmentContent
número da transação
número do ID do anexo

Bloco de código

title	Exemplo

{
    "pathParams": [
    "attachmentContent",
    "412297",
	"2"
  ],
}

oOutput

JsonObject

OUTPUT

listagem do Objeto com o conteúdo do anexo solicitado:

Bloco de código

title	Exemplo

{    
    "internalId": 1,
    "transactionNumber": 412297,
    "name": "arquivo1.png",
    "contentType": "image/png",
    "content": "iVBORw0KGgoAAAANSUhEUgAAAMkAAADJCAYAAAH+wSaTAAAAAXNSR0IArs4c6QAAAARnQU1BAA"
}

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

tt-anexo-conteudo: contém as informações de conteúdo do anexo consultado.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos na busca do conteúdo do anexo de determinado documento.

Retorno

Informação de sucesso ou erros ocorridos no processo de consulta ao conteúdo do anexo.

...

ttTransactions					Entrada/Saída
Temp-table com números de transações de pendências					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	transactionNumber	INTEGER	Número da transação	Sim	Não se aplica

tt-anexo					Entrada/Saída
Temp-table com a lista de anexos. Possui as informações de identificação do arquivo, sem o seu conteúdo.					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	transactionNumber	INTEGER	Número da transação	Sim	Não se aplica
id	internalId	CHARACTER	Id interno do anexo	Sim	Não se aplica
nome	name	CHARACTER	Nome do anexo	Sim	Não se aplica
descricao	description	CHARACTER	Descrição do anexo	Não	Não se aplica
dt-hra-criacao	creationDatetime	DATETIME	Data e hora de criação do anexo	Não	Não se aplica
grupo	group	CHARACTER	Grupo de ordenação ao qual o anexo pertence	Não	Não se aplica

tt-anexo-conteudo					Entrada/Saída
Temp-table com as informações do conteúdo do anexo.					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	transactionNumber	INTEGER	Número da transação	Sim	Não se aplica
id	internalId	CHARACTER	Id interno do anexo	Sim	Não se aplica
nome	name	CHARACTER	Nome do anexo	Não	Não se aplica
tipo-conteudo	contentType	CHARACTER	Tipo do conteúdo usado para a abertura do arquivo	Não	Não se aplica
conteudo	content	CLOB	Conteúdo do arquivo em Base64	Sim	Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão Atual

Chave