Histórico da Página
...
pi-upload-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Faz o upload do arquivo do usuário na criação de um novo anexo, retornando as informações do arquivo que está sendo feito o upload. | |||
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:
| |
oOutput | JsonObject | OUTPUT | Informações do arquivo: Exemplo
Descrição dos campos:
| |
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 | Faz o download do arquivo, retornando as informações do nome e conteúdo do anexo. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput | JsonObject | INPUT | Parâmetros para download do anexo: pathParams: Informar: download e o documentId do documento.
| |
oOutput | JsonObject | OUTPUT | Retorno das informações do arquivo que está sendo realizado o download:
Descrição dos campos:
| |
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de download. | |
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 | Efetua a exclusão de um único anexo ou de vários anexos dependendo do tipo de requisição recebida. Neste método os arquivos de anexos são excluídos do banco de dados e também da pasta física no servidor de arquivos onde estão gravados. | ||||
Parâmetros | Tipo | Input/Output | Descrição | ||
oInput | JsonObject | INPUT | Parâmetros para eliminação de anexo individual: pathParams: Informar: o documentId do anexo. Exemplo
Parâmetros para eliminação de anexo em lote: Payload: Informar a relação dos documentId's a serem eliminados:
| ||
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. | ||
RowErrors | Temp-table | OUTPUT | Relação dos erros ocorridos durante o processo de exclusão individual ou em lote. | ||
ListaIdsExcluidos | Character | OUTPUT | Relação dos |
documentIds que foram eliminados com sucesso. | ||||
Retorno | Erros ocorridos durante a exclusão individual ou em lote e relação dos documentIds que foram excluídos com sucesso. |
Tabelas
...
Número sequencial de identificação do documento
...
Sim
...
Sequencia
...
pi-create-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Efetua a inclusão de um registro com as informações de anexo no banco de dados e também grava no servidor o arquivo físico enviado. Retorna informações sobre o anexo criado. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput | JsonObject | INPUT | Parâmetros para criação: Payload:
Descrição dos campos do payload:
| |
oOutput | JsonObject | OUTPUT | Informações do anexo criado:
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. |
pi-busca-lista-tipos-processos | ||||
Requisito | Nenhum. | |||
Descrição | Busca os tipos de processos cadastrados na include uninc/i01un403.i. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
pListaProcessos | Character | INPUT | Lista dos processos existentes na include. | |
Retorno | Listagem dos tipos de processos existentes. |
Tabelas
Arquivo_docto | ||||
Informações dos Arquivos | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id_docto | INTEGER | 999999999 | Número sequencial de identificação do documento | Sim |
cdn_tipo_proces | INTEGER | >>9 | Tipo do processo ao qual o documento está vinculado | Sim |
cod_chave_proces | CHARACTER | X(40) | Código da chave do processo | Sim |
cod_usuar_docto | CHARACTER | X(12) | Código do usuário do documento | Sim |
dtm_criac_docto | DATETIME | 99/99/9999 HH:MM:SS.SSS | Data e hora da criação do documento | Sim |
nom_arq_docto | CHARACTER | X(100) | Nome do arquivo | Sim |
nom_dir_docto | CHARACTER | X(250) | Diretório onde está armazenado o documento | Sim |
ind_tam_docto | CHARACTER | X(10) | Tamanho do arquivo | Não |
des_docto | CHARACTER | X(200) | Descrição do Documento | Não |
Sequencia
seq_arq_docto | Incrementa o ID do campo num_id_docto |
Tabelas Temporárias
RowErrors | Entrada/Saída | ||||
Erros ocorridos durante a execução do programa. | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | INTEGER | Sequência | Sim | ||
ErrorNumber | INTEGER | Número | Sim | ||
ErrorDescription | CHARACTER | Descrição | Não | ||
ErrorParameters | CHARACTER | Parãmetros | Não | ||
ErrorType | CHARACTER | Tipo de erro | Não | ||
ErrorHelp | CHARACTER | Texto de ajuda | Não | ||
ErrorSubType | CHARACTER | Sub-tipo do erro | Não |
RowErrorsAux | Entrada/Saída | ||||
Erros ocorridos durante a execução da exclusão em lote, filtra os erros ocorridos na execução da BO , retirando os do tipo INTERNAL que não devem ser passados à RowErrors. |
Tabelas Temporárias
tt-anexo-ids-exclusao | |||||
ID dos anexos a serem excluídos | |||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
num_id_docto | INTEGER | 999999999 | Número sequencial de identificação do documento | Sim | |
Evolução | |||||
ErrorSequence | INTEGER | Sequência | Sim | ||
ErrorNumber | INTEGER | Número | Sim | ||
ErrorDescription | CHARACTER | Descrição | Não | ||
ErrorParameters | CHARACTER | Parãmetros | Não | ||
ErrorType | CHARACTER | Tipo de erro | Não | ||
ErrorHelp | CHARACTER | Texto de ajuda | Não | ||
ErrorSubType | CHARACTER | Sub-tipo do erro | Não |
ttDocumentFile | Entrada/Saída |
Temp-table com os campos a serem retornados na busca dos documentos do processo. | Saída | ||||
Atributo | Nome no Objeto | Tipo |
Formato
Descrição | Obrigatório | Evolução |
ErrorSequence
INTEGER
Sequência
Sim
ErrorNumber
INTEGER
Número
Sim
ErrorDescription
CHARACTER
Descrição
Não
ErrorParameters
CHARACTER
Parãmetros
Não
ErrorType
CHARACTER
Tipo de erro
Não
ErrorHelp
CHARACTER
Texto de ajuda
Não
ErrorSubType
CHARACTER
Sub-tipo do erro
Não
RowErrorsAux
Entrada/Saída
Erros ocorridos durante a execução da exclusão em lote,
filtra os erros ocorridos na execução da BO , retirando os do tipo INTERNAL
que não devem ser passados à RowErrors.
num_id_docto | documentId | INTEGER | Número do ID do documento | Sim | |
cdn_tipo_processo | processType | INTEGER | Número do tipo do processo | Sim | |
desc_tipo_proces | processTypeDescription | CHARACTER | Descrição do tipo do processo | Sim | |
cod_chave_proces | processKey | CHARACTER | Código da chave do processo | Sim | |
cod_usuar_docto | creationUser | CHARACTER | Código do usuário criador | Sim | |
nom_usuar_docto | creationUserName | CHARACTER | Nome do usuário criador | Sim | |
dtm_criac_docto | creationDatetime | DATETIME | Data e hora da criação | Sim | |
nom_arq_docto | documentName | CHARACTER | Nome do documento | Sim | |
nom_dir_docto | documentDir | CHARACTER | Caminho do diretório do documento | Sim | |
ind_tam_docto | documentSize | CHARACTER | Tamanho do documento | Não | |
des_docto | documentDescription | CHARACTER | Descrição do documento |
Atributo
Tipo
Formato
Descrição
Obrigatório
Evolução
ErrorSequence
INTEGER
Sequência
Sim
ErrorNumber
INTEGER
Número
Sim
ErrorDescription
CHARACTER
Descrição
Não
ErrorParameters
CHARACTER
Parãmetros
Não
ErrorType
CHARACTER
Tipo de erro
Não
ErrorHelp
CHARACTER
Texto de ajuda
Não
ErrorSubType
CHARACTER
Não |