GET /api/dlmlocks
List all DLM locks

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les résultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entrées par requête

Validations:

  • Must be a String


GET /api/dlmlocks/:id
Show a DLM lock

GET /api/dlmlocks/:id/lock
Show a DLM lock

Erreurs

Code Description
404 Lock could not be found.

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Id or name of the DLM lock

Validations:

  • Must be a String


POST /api/dlmlocks
Create a DLM lock

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

dlmlock
requis

Validations:

  • Must be a Hash

dlmlock[name]
requis

Nom

Validations:

  • Must be a String

dlmlock[type]
requis

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.

dlmlock[enabled]
optionel , nil autorisé

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0


PUT /api/dlmlocks/:id
Update a DLM lock

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Id or name of the DLM lock

Validations:

  • Must be a String

dlmlock
requis

Validations:

  • Must be a Hash

dlmlock[name]
optionel

Nom

Validations:

  • Must be a String

dlmlock[type]
optionel

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.

dlmlock[enabled]
optionel , nil autorisé

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0


DELETE /api/dlmlocks/:id
Delete a DLM lock

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Id or name of the DLM lock

Validations:

  • Must be a String


PUT /api/dlmlocks/:id/lock
Acquire a DLM lock

Acquire a lock

This action acquires a lock. It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

Erreurs

Code Description
200 Lock acquired successfully.
412 Lock could not be acquired.

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Id or name of the DLM lock

Validations:

  • Must be a String


DELETE /api/dlmlocks/:id/lock
Release a DLM lock

Release a lock

This action releases a lock.
It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

Erreurs

Code Description
200 Lock released successfully.
412 Lock could not be released.

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Id or name of the DLM lock

Validations:

  • Must be a String