Histórico da Página

...

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 o documentId 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..."
        }
    }
}

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 o documentId do anexo.

Bloco de código

title	Exemplo

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

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

Payload: Informar os IDs a relação dos documentId's 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 relação dos documentId's 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 documentId com erro e idna mensagem e a lista dos documentId's dos documentos excluídos com sucesso.

...

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	Descrição	Obrigatório	Evolução
num_id_docto	documentId	INTEGER	Número do ID do documento	Sim	Não se aplica
cdn_tipo_processo	processType	INTEGER	Número do tipo do processo	Sim	Não se aplica
desc_tipo_proces	processTypeDescription	CHARACTER	Descrição do tipo do processo	Sim	Não se aplica
cod_chave_proces	processKey	CHARACTER	Código da chave do processo	Sim	Não se aplica
cod_usuar_docto	creationUser	CHARACTER	Código do usuário criador	Sim	Não se aplica
nom_usuar_docto	creationUserName	CHARACTER	Nome do usuário criador	Sim	Não se aplica
dtm_criac_docto	creationDatetime	DATETIME	Data e hora da criação	Sim	Não se aplica
nom_arq_docto	documentName	CHARACTER	Nome do documento	Sim	Não se aplica
nom_dir_docto	documentDir	CHARACTER	Caminho do diretório do documento	Sim	Não se aplica
ind_tam_docto	documentSize	CHARACTER	Tamanho do documento	SimNão	Não se aplica
des_docto	documentDescription	CHARACTER	Descrição do documento	SimNão	Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 8

Nova versão 9

Chave