Add a Lock to a Party

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

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/restapi/v1/party/{id}/lock

Request Parameters

Provide values for the following parameters:

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

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-05T10:33:11.447+0000",
    "priority": 0
  },
  "startTimestampMS": 1659695597012,
  "duration": 160
}