Frameworksp

Páginas filhas
  • VirtualLockService

Descrição:

API para inserção, atualização e deleção de bloqueio de registros para transações.

Disponível a partir da lib 20220905.


post

Descrição:
Efetua a inserção do bloqueio de um registro.


Exemplos de uso

/api/framework/v1/virtualLockService/


Body

Exemplo de body para efetuar o bloqueio por RECNO
{
	"table": "SA1",
	"recno": 1,
	"lockTime": "00:02:00"
}
Exemplo de body para efetuar o bloqueio por índice e chave de pesquisa
{
	"table": "SA1",
	"index": "A1_FILIAL+A1_COD+A1_LOJA",
	"key": "D MG 01 00000101",
	"lockTime": "00:02:00"
}


Importante: A propriedade lockTime indica quanto tempo o registro deve ficar bloqueado para transações, no formato hh:mm:ss. Caso não seja informado, será atribuído um valor de 03 minutos (00:03:00).

Bloqueio por índice e chave de pesquisa

Caso o bloqueio seja realizado por índice e chave de pesquisa, é obrigatório informar as propriedades index e key.

put

Descrição:
Efetua a alteração do bloqueio de um registro.

Importante: Só é possível atualizar o lockTime do registro bloqueado. Caso o registro não esteja mais bloqueado, será retornado que o mesmo não foi encontrado.


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
searchTypeNumericIndica qual tipo de pesquisa será realizada para localizar o registro: por recno (1) ou por índice + chave de pesquisa (2)X
Exemplos de uso

/api/framework/v1/virtualLockService/1


Body

Exemplo de body para searchType 1
{
	"table": "SA1",
	"recno": 1,
	"lockTime": "00:02:00"
}
Exemplo de body para searchType 2
{
	"table": "SA1",
	"index": "A1_FILIAL+A1_COD+A1_LOJA",
	"key": "D MG 01 00000101",
	"lockTime": "00:02:00"
}

delete

Descrição:
Efetua a deleção do bloqueio de um registro (libera o registro para uso).

Importante: A deleção só será realizada pelo mesmo usuário que incluiu o registro. Caso sejam usuários diferentes, será retornada a mensagem "Não é possível prosseguir com a operação".


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
tableCharacterIndica qual a tabela do registroX
searchTypeNumericIndica qual tipo de pesquisa será realizada para localizar o registro: por recno (1) ou por índice + chave de pesquisa (2)X
keyCharacterIndica o recno (1) ou a chave de pesquisa (D MG 01 00000101) do registroX
Exemplos de uso

/api/framework/v1/virtualLockService/SA1/2/D MG 01 00000101