Data Lock API

The data lock endpoints are tightly tied to OpenSearch (responses). Please try to use the storage endpoints instead.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-core/datalock`
Description Get data lock items from the OpenSearch index `bpc-datalock`.
Query Parameter `start` first record to be read. Default is `0`. `limit` number of records to read. Default is `1000`.
Returns The requested items as JSON (1:1 OpenSearch response) HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`GET`	`/cxf/bpc-core/datalock/{itemId}`
Description Get a specific data lock item from the OpenSearch index `bpc-datalock`.
Path Parameter `itemId` the ID of the item
Returns The requested item as JSON (1:1 OpenSearch response) HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`POST`	`/cxf/bpc-core/datalock/{itemId}`
Description Sets the provided data for a specific item. The body data is written to the OpenSearch index `bpc-datalock`.
Consumes `application/json`
Path Parameter `itemId` the ID of the item to set the data for
Returns HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`PUT`	`/cxf/bpc-core/datalock/{itemId}`
Description Updates an item with the provided data in the body. The item gets updated in the OpenSearch index `bpc-datalock`.
Consumes `application/json`
Path Parameter `itemId` the ID of the item to update
Returns HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`DELETE`	`/cxf/bpc-core/datalock/{itemId}`
Description Deletes a specific item from the OpenSearch index `bpc-datalock`.
Consumes `application/json`
Path Parameter `itemId` the ID of the item to delete
Returns HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.

GET

/cxf/bpc-core/datalock

Description

Get data lock items from the OpenSearch index bpc-datalock.

Query Parameter

start: first record to be read. Default is 0.
limit: number of records to read. Default is 1000.

Returns

The requested items as JSON (1:1 OpenSearch response)

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

GET

/cxf/bpc-core/datalock/{itemId}

Description

Get a specific data lock item from the OpenSearch index bpc-datalock.

Path Parameter

itemId: the ID of the item

Returns

The requested item as JSON (1:1 OpenSearch response)

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

POST

/cxf/bpc-core/datalock/{itemId}

Description

Sets the provided data for a specific item. The body data is written to the OpenSearch index bpc-datalock.

Consumes

application/json

Path Parameter

itemId: the ID of the item to set the data for

Returns

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

PUT

/cxf/bpc-core/datalock/{itemId}

Description

Updates an item with the provided data in the body. The item gets updated in the OpenSearch index bpc-datalock.

Consumes

application/json

Path Parameter

itemId: the ID of the item to update

Returns

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

DELETE

/cxf/bpc-core/datalock/{itemId}

Description

Deletes a specific item from the OpenSearch index bpc-datalock.

Consumes

application/json

Path Parameter

itemId: the ID of the item to delete

Returns

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.