REST API for Oracle Essbase

List Locks

get

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

Returns links for locked objects and locked blocks from the specified application and database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

Locks listed successfully, including links to unlock.

Root Schema : LockObject

Type: object

Show Source

links: array links
name: string
time: integer(int64)
type: string

Allowed Values: [ "OUTLINE", "CALCSCRIPT", "REPORT", "RULES", "ALIAS", "STRUCTURE", "ASCBACKUP", "BINBACKUP", "EXCEL", "XLSX", "XLSM", "MAXL", "ZIP", "CSV", "LOTUS2", "LOTUS3", "TEXT", "LOTUS4", "WIZARD", "PARTITION", "SELECTION", "LRO", "EQD", "XML", "JAVA_CDF", "MAX", "BACKUP", "WORKSHEET", "DATA", "ERROR", "OUT", "GROOVY", "DRILLTHROUGH", "ALL", "MDX" ]
user: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "user":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "OUTLINE",
                "CALCSCRIPT",
                "REPORT",
                "RULES",
                "ALIAS",
                "STRUCTURE",
                "ASCBACKUP",
                "BINBACKUP",
                "EXCEL",
                "XLSX",
                "XLSM",
                "MAXL",
                "ZIP",
                "CSV",
                "LOTUS2",
                "LOTUS3",
                "TEXT",
                "LOTUS4",
                "WIZARD",
                "PARTITION",
                "SELECTION",
                "LRO",
                "EQD",
                "XML",
                "JAVA_CDF",
                "MAX",
                "BACKUP",
                "WORKSHEET",
                "DATA",
                "ERROR",
                "OUT",
                "GROOVY",
                "DRILLTHROUGH",
                "ALL",
                "MDX"
            ]
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    }
}

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"
        }
    }
}

500 Response

Internal Server Error.

Examples

The following example shows how to get lists of locked objects and blocks in an Essbase 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 GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks" -H  accept: application/json -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "links": [
    {
      "rel": "objects",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks/objects",
      "method": "GET"
    },
    {
      "rel": "blocks",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks/blocks",
      "method": "GET"
    }
  ]
}