Other

List currently held locks

Get table locks currently held for the specified table name and/or user login. This method requires the Locks:Get permission to be associated with your role.

GET

/gb/locks

curl --request GET \
  --url 'https://api.catch-e.com/gb/locks?table_name=%3Cstring%3E&user_login=%3Cstring%3E' \
  --header 'Authorization: <api-key>'

[
  {
    "created": "<string>",
    "duration": "<string>",
    "full_name": "<string>",
    "is_restricted": "yes",
    "lock_key": "<string>",
    "role": "<string>",
    "session_exists": "yes",
    "session_id": "<string>",
    "session_timeout": "<string>",
    "table_lock": "yes",
    "table_name": "<string>",
    "timeout": "<string>",
    "timeout_display": "<string>",
    "user_id": "<string>",
    "user_login": "<string>"
  }
]

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

Query Parameters

table_namestringquery

Table name

Maximum string length: 64

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

Maximum string length: 25

Response

Success

itemsobject[]

Show child attributes

Still need help? Ask the team