Aller au contenu principal
Version: v20

$lock

Verrouille et déverrouille une entité en utilisant le mécanisme pessimiste.

Syntaxe

Pour verrouiller une entité pour les autres sessions et process 4D :

/?$lock=true

Pour déverrouiller l'entité pour les autres sessions et processus 4D :

/?$lock=false

The lockKindText property is "Locked by session".

Description

Les verrouillages déclenchés par l'API REST sont placés au niveau de la session.

Une entité verrouillée est considérée comme verrouillée (c'est-à-dire que les actions de verrouillage / déverrouillage / mise à jour / suppression ne sont pas possibles) par :

  • d'autres sessions REST
  • les process 4D (client/serveur, datastore distant, monoposte) exécutés sur le serveur REST.

Une entité verrouillée par l'API REST peut être déverrouillée uniquement :

  • par son cadenas, c'est-à-dire un /?$lock=false dans la session REST qui définit /?$lock=true
  • ou si le timeout d'inactivité de la session est atteint (la session est fermée).

Réponse

Une requête ?$lock retourne un objet JSON avec "result"=true si l'opération de verrouillage est réussie et "result"=false si elle échoue.

L'objet "__STATUS" retourné possède les propriétés suivantes :

PropriétéTypeDescription
Disponible uniquement en cas de succès:
successbooleanvrai si l'action de verrouillage a été réussie (ou si l'entité est déjà verrouillée dans la session courante), sinon faux (non retourné dans ce cas).
Disponible uniquement en cas d'erreur :
statusnumberCode d'erreur, voir ci-dessous
statusTexttextDescription de l'erreur, voir ci-dessous
lockKindnumberCode de verrouillage
lockKindTexttext"Locked by session" en cas de verrouillage par une session REST, "Locked by record" en cas de verrouillage par un process 4D
lockInfoobjectInformation sur l'origine du verrouillage. Les propriétés retournées dépendent de l'origine du verrouillage (process 4D ou session REST).
Disponible uniquement pour un verrouillage par process 4D:
task_idnumberID du process
user_nametextNom d'utilisateur de la session sur la machine
user4d_aliastextNom ou alias de l'utilisateur 4D
user4d_idnumberIdentifiant utilisateur dans le répertoire de la base 4D
host_nametextNom de la machine
task_nametextNom du process
client_versiontextVersion du client
Disponible uniquement pour un verrouillage par session REST :
hosttextURL d'origine du verrouillage de l'entité (ex : "127.0.0.1:8043")
IPAddrtextAdresse IP d'origine du verrouillage (ex. 127.0.0.1")
recordNumbernumberNuméro de l'enregistrement verrouillé
userAgenttextuserAgent de l'origine du verouillage (ex : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36")

Les valeurs suivantes peuvent être retournées dans les propriétés status et statusText de l'objet __STATUS en cas d'erreur :

statusstatusTextCommentaire
2"Stamp has changed"La valeur du marqueur interne (stamp) de l'entité ne correspond pas à celle de l'entité stockée dans les données (verrouillage optimiste).
3"Already locked"L'entité est verrouillée par un verrou pessimiste.
4"Other error"Une erreur critique peut être une erreur de bas niveau de la base de données (ex. clé dupliquée), une erreur matérielle, etc.
5"Entity does not exist anymore"L'entité n'existe plus dans les données.

Exemple

Nous verrouillons une entité dans un premier navigateur :

GET /rest/Customers(1)/?$lock=true

Réponse :

{
"result": true,
"__STATUS": {
"success": true
}
}

Dans un second navigateur (autre session), nous envoyons la même requête.

Réponse :

{
"result":false,
"__STATUS":{
"status":3,
"statusText":"Already Locked",
"lockKind":7,
"lockKindText":"Locked By Session",
"lockInfo":{
"host":"127.0.0.1:8043",
"IPAddr":"127.0.0.1",
"recordNumber": 7,
"userAgent": ""Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36..."
}
}
}