Histórico da Página

...

pi-delete-v1

Requisito

Nenhum.

Descrição

Repassa os parâmetros recebidos pela API de comunicação (cdp/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 do anexo.

Bloco de código

title	Exemplo

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

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

Payload: Informar os IDs 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/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 (cdphubapi/apiDocuments), devido a erros ocorridos durante o processo de eliminaçãoexclusã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/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/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 inexistentes em lote, serão repassados para a API de comunicação (cdp/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 em lote, serão repassados para a API de comunicação (cdp/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"
}

No caso de nenhum registro ter sido excluído com sucesso, é retornado o parâmetro ListaIdsExcluidos vazio, assim como um Output e o código do retorno da requisição é 404.

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.
- 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 que foram eliminados com sucesso. Serão apresentado na mensagem de retorno caso aconteça de ter erros e sucessos em uma mesma eliminação em lote

Retorno

Erros ocorridos durante a eliminação via temp-table RowErrors.

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave