Create entry lock

Creates a lock for the specified DataLens entry.

Request

POST

http://<хост_on-premises>/rpc/createEntryLock

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

Body

application/json
{
  "entryId": "example",
  "data": {
    "duration": 0.5,
    "force": true
  }
}

Name

Description

data
Type: object

duration

Type: number

Lock duration in milliseconds.

force

Type: boolean

Whether to replace an existing active lock.
Example
{
  "duration": 0.5,
  "force": true
}

entryId

Type: string

ID of the entry to lock.

Example: example

Responses

200 OK

Response

Body

application/json
{
  "lockToken": "example"
}

Name

Description

lockToken

Type: string

Token identifying the created lock.

Example: example
Previous
Overview
Next
Extend entry lock