Add a Lock to a Item

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

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/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 No
priority No
timeout No

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

{
  "data": {
    "createdBy": "string",
    "createdOn": "2016-07-31T05:17:58.984Z",
    "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
201 Created
401 Unauthorized
403 Forbidden
404 Not Found