DocumentGroup

Índice

criar

Cria um novo grupo de documentos para o usuário logado.

Parâmetros ###

  • req objeto O REQobjeto uest.
  • res objeto O objeto de resposta.
  • group_name String O nome do novo grupo de documentos.

Retorna objeto O objeto de resposta que contém o grupo de documentos recém -criado e uma mensagem de sucesso, ou uma mensagem de erro se a solicitação falhar.

atualizar

Atualiza um grupo de documentos com o ID e o nome do grupo fornecido.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • group_nameString O nome do novo grupo de documentos.

*Lança Erro Se houver um erro no banco de dados ou validação.

Retorna objeto O objeto de resposta com um código de status e dados JSON.

remover

Remove um grupo de documentos do banco de dados.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • id objeto Parametro /{id}.

*Joga erro se oRE é um erro ao processar a solicitação.

Retorna objeto O objeto de resposta com um código de status e um objeto JSON contendo o resultado da operação.

getall

Recupera todos os grupos de documentos do banco de dados e os retorna como um objeto JSON.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.

*Lança Erro Se houver um erro na recuperação dos grupos de documentos do banco de dados.Retorna objeto Um objeto JSON contendo todos os grupos de documentos.

getDocumentGroup

Recupera um grupo de documentos com o ID fornecido do banco de dados e o retorna como um objeto JSON.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • id objeto Parametro /{id}.

*Lança Erro Se houver um erro na recuperação do grupo de documentos do banco de dados.

Retorna objeto A JSNo objeto que contém o grupo de documentos solicitado.

This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License, including custom images & stylesheets. Permissions beyond the scope of this license may be available at @jr0cket
Creative Commons License