GenericKey

Índice

criar

Cria uma nova chave genérica e registra a criação.

parameters

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • field_value string O valor do campo a ser adicionado.
  • field_name string O nome do campo a ser adicionado.

*Lança Erro Se houver um erro criando a chave genérica ou registrando a criação.

Retorna qualquer nenhum

atualizar

Atualiza uma chave genérica com o ID fornecido com o valor fornecido e o nome do campo fornecido.

parâmetros

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • field_value string O valor do campo a ser adicionado.
  • field_name string O nome do campo a ser adicionado.

*Lança Erro Se houver um erro ao atualizar a chave genérica.

Retorna objeto O objeto de resposta com um código de status e um objeto JSON contendo uma mensagem de erro ou uma mensagem de sucesso.

remover

Removes uma chave genérica do banco de dados.

Parâmetros ###

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

*Lança Erro lança um erro se houver um problema na conexão do banco de dados ou se o usuário não estiver conectado.

Retorna objeto O objeto de resposta com um código de status e um objeto JSON contendo uma mensagem de erro ou uma mensagem de sucesso.

getall

RetRieve todos os objetos genéricos do banco de dados, ou apenas aqueles com uma referência específica
Se uma referência for fornecida na consulta de solicitação.

Parâmetros ###

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

*Lança Erro Se houver um erro recuperando os dados, um erro do servidor será retornado.

Retorna objeto O objeto de resposta com um objeto JSON contendo os dados recuperados.

getGenericbyfieldName

RetRieves todos os registros da tabela GenericKey que correspondem ao nome do campo fornecido.

Parâmetros ###

  • req objeto O objeto de solicitação que contém o parâmetro do nome do campo.
  • res objeto O objeto de resposta para enviar os resultados de volta ao cliente.
  • field_name Object Parametro Field_Name.

*Lança Erro lança um erro se houver um problema recuperando os registros.

Retorna Objeto Retorna um objeto JSON contendo o MATCHing Records.

getGK

Recupera um objeto GenericKey do banco de dados com o ID fornecido e o retorna como uma resposta JSON.

Parâmetros ###

  • req Object O objeto de solicitação que contém o ID do GenericKey para recuperar.
  • res Object O objeto de resposta para enviar o GenericKey recuperado como uma resposta JSON.
  • id objeto Parametro /{id}.

*Joga Erro Se houver um erro recuperando o GenericKey do banco de dados.Retorna qualquer nenhum


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