Add a Lock to an Item

Use the following details to add a lock to an Item using the REST interface:

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/restapi/v1/item/{id}/lock

Request Parameters

Provide values for the following parameters

Parameter Name Data Type Mandatory
id string Yes
createdBy string No
createdOn dateTime No
current boolean No
key string Yes
priority   Yes
timeout   Yes

Request Model

Media Type: application/json

{
  "createdBy": "string",
  "createdOn": "2016-07-31T05:17:58.844Z",
  "current": true,
  "key": "string",
  "priority": 0,
  "timeout": 0
}

Response Model

{
  "result": {
    "code": {
      "severity": "Success",
      "message": "Success.",
      "code": "0000"
    },
    "params": [],
    "message": "Success."
  },
  "data": {
    "current": true,
    "timeout": 0,
    "key": "string",
    "createdBy": "admin",
    "createdOn": "2022-08-05T13:32:34.896+0000",
    "priority": 0
  },
  "startTimestampMS": 1659706457249,
  "duration": 137
}