Lock Partition
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/partitions/lock
Locks partition object. For non-federated partitions, both the source and target partition objects are locked.
For federated partitions, the partition type, Datasource name, measures dimension name, and optional application level Datasource are required.
For transparent or replicated partitions, the source server, source application, and source database are required.
Request
-
applicationName(required): string
Application name.
-
databaseName(required): string
Database name.
-
applicationLevelDatasource: boolean
Specify whether the Datasource is defined at the application level.
-
applicationName: string
Partition source application name.
-
databaseName: string
Partition source database name.
-
datasourceName: string
Datasource name.
-
measuresDimensionName: string
Pivot dimension name. Can be Measures dimension, but does not have to be.
-
serverName: string
Partition source server name.
-
type(required): string
Partition type.
Allowed Values:[ "TRANSPARENT", "REPLICATED", "FEDERATED", "LAZY_TRANSPARENT" ]
Response
- application/json
- application/xml
204 Response
OK
Partition locked successfully.
400 Response
Bad Request
Failed to lock partition.
500 Response
Internal Server Error.
Examples
The following example shows how to lock a partition object.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.
Script with cURL Command
call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/SampTgt/databases/Basic/partitions/lock?type=TRANSPARENT&serverName=https%3A%2F%2Fmyserver.example.com%2Fessbase%2Fagent&applicationName=SampSrc&databaseName=Basic"
-H "accept: application/json"
-u %User%:%Password%