REST API for Oracle Essbase

Unlock Block

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/locks/blocks/unlock

Unlocks the locked block in the specified application and database.

Request

Supported Media Types

application/json

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Block details to be unlocked.

Root Schema : LockBlock

Type: object

Show Source

count: integer(int32)
duration: integer(int32)
links: array links
user: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "user":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "duration":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Response

204 Response

Block unlocked successfully.

400 Response

Bad Request

Failed to get the settings. The application or database name may be incorrect, or the JSON for the username in the block details may be incorrect.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Examples

The following example shows how to unlock locked data blocks in an Essbase block storage cube.

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/Sample/databases/Basic/locks/blocks/unlock" -H  "accept: application/json" -H  "Content-Type: application/json" -d '{"user": "power1", "count": 1}' -u %User%:%Password%