Other

List currently held record locks

Get record locks currently held for the specified table name and unique id.

GET

/gb/locks/{table_name}/{unique_id}

curl --request GET \
  --url https://api.catch-e.com/gb/locks/{table_name}/{unique_id} \
  --header 'Authorization: <api-key>'

[
  {
    "created": "<string>",
    "is_restricted": "yes",
    "lock_key": "<string>",
    "session_id": "<string>",
    "table_lock": "yes",
    "table_name": "<string>",
    "timeout": "<string>",
    "user_id": "<string>"
  }
]

This method requires the Locks:Get permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

table_namestringrequired

Table name

Maximum string length: 64

Pattern: ^[a-z0-9\_]+$

unique_idstringrequired

Unique Id to check for locks on

Maximum string length: 20

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

itemsobject[]

Maximum array length: 100

Show child attributes

Still need help? Ask the team