Histórico da Página

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

Descrição

oInput

JsonObject

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

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

Payload: Informar os IDs a serem eliminados:

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

• 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:

{
  "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:

{
    "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/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:

{
    "_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.
• 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.

Requisito

Nenhum.

Descrição

Realiza a verificação dos parâmetros passados na queryParams da no queryParams e pathParams dos métodos: pi-query-v1, para restrição de consulta, permitindo buscar apenas todos os documentos do tipo e chave de processo informadospi-create-v1, pi-delete-v1 e pi-download-v1, validando se o tipo de processo é um processo válido e existente, caso contrário, a execução do método será interrompida já no começo.

Parâmetros

Tipo

Descrição

Identificação do endpoint:

• create : inclusão de anexo.
• query: consulta dos anexos.
• download: download do anexo.
• delete: exclução dos anexos.

iProcessType

Integer

Retorno

Informações sobre os erros ocorridos durante o processo.

Requisito

Nenhum.

Descrição

Realiza a verificação das permissões do usuário logado em relação ao programa de ordens de compra.

Parâmetros

Tipo

Descrição

iProcessType

Integer

Retorno

Informações sobre os erros ocorridos durante o processo.