View the Lock of an Item

Use the following details to view the Lock of an Item using REST interface:

HTTP Method

GET

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/item/{id}/lock/{key}

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Mandatory
id string Yes
key string Yes

Request Model

Media Type: application/json

Response Model

{
  "data": {
    "createdBy": "string",
    "createdOn": "2016-08-01T17:33:36.406Z",
    "current": true,
    "key": "string",
    "priority": 0,
    "timeout": 0
  },
  "duration": 0,
  "result": {
    "code": "string",
    "message": "string",
    "params": [
      "string"
    ]
  },
  "startTimestampMS": 0
}

Response Codes and Descriptions

Response Code Description
401 Unauthorized
403 Forbidden
404 Not Found