Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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:



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'))}"
         }
      }
   ]
}

oOutputJsonObjectOUTPUT

Informações do arquivo:

Exemplo

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

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.


RowErrorsTemp-tableOUTPUTInformaçõ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.


Exemplo

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




oOutputJsonObjectOUTPUT

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


Exemplo

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

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.  
RowErrorsTemp-tableOUTPUTInformaçõ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

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


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

Payload: Informar a relação dos documentId's a serem eliminados:


Exemplo

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

oOutputJsonObjectOUTPUT

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.

RowErrorsTemp-tableOUTPUT Relação dos erros ocorridos durante o processo de exclusão individual ou em lote. 
ListaIdsExcluidosCharacterOUTPUT Relação dos
documentId's
documentIds que foram eliminados com sucesso. 
RetornoErros 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:


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.
oOutputJsonObjectOUTPUT

Informações do anexo criado:


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 .

RowErrorsTemp-tableOUTPUTInformaçõ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

INPUTLista dos processos existentes na include.

Retorno

Listagem dos tipos de processos existentes.

Tabelas


Arquivo_docto
Informações dos Arquivos
AtributoTipoFormatoDescriçãoObrigatório
num_id_doctoINTEGER999999999

Número sequencial de identificação do documento

Sim
cdn_tipo_procesINTEGER  >>9Tipo do processo ao qual o documento está vinculadoSim
cod_chave_procesCHARACTER  X(40)Código da chave do processoSim
cod_usuar_doctoCHARACTER  X(12)Código do usuário do documento

Sim

dtm_criac_doctoDATETIME  99/99/9999 HH:MM:SS.SSSData e hora da criação do documentoSim
nom_arq_doctoCHARACTER  X(100)Nome do arquivoSim
nom_dir_doctoCHARACTER  X(250)Diretório onde está armazenado o documentoSim
ind_tam_doctoCHARACTERX(10)Tamanho do arquivoNão
des_doctoCHARACTERX(200)Descrição do DocumentoNão


Sequencia

seq_arq_doctoIncrementa 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

RowErrors
tt-anexo-ids-exclusao
ID dos anexos a serem excluídos


Atributo

Tipo

Formato

Descrição

Obrigatório

num_id_doctoINTEGER999999999

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

Erros ocorridos durante a execução do programa

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

processTypeINTEGER Número do tipo do processo

Sim


desc_tipo_procesprocessTypeDescriptionCHARACTER Descrição do tipo do processoSim
cod_chave_procesprocessKeyCHARACTER Código da chave do processoSim
cod_usuar_doctocreationUserCHARACTER Código do usuário criadorSim
nom_usuar_doctocreationUserNameCHARACTER Nome do usuário criadorSim
dtm_criac_doctocreationDatetimeDATETIMEData e hora da criação Sim
nom_arq_docto documentNameCHARACTERNome do documentoSim
nom_dir_docto documentDirCHARACTERCaminho do diretório do documentoSim
ind_tam_doctodocumentSizeCHARACTERTamanho do documentoNão
des_doctodocumentDescriptionCHARACTERDescriçã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

Sub-tipo do erro
Não