Jump to

• Request
• Response
• Examples

Unlock Object

post

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

Unlocks the object in the specified application and database.

Request

Supported Media Types

• application/json

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Body ()

Details about object to be unlocked.

Root Schema : LockObject

Type: object

Show Source

• links(optional): array links
• name(optional): string
• time(optional): integer(int64)
• type(optional): 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(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

Back to Top

Response

204 Response

OK

Object unlocked successfully.

400 Response

Bad Request

Failed to unlock the object. The application, database, or object name may be incorrect, or the object type may be incorrect.

415 Response

Not Acceptable

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

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to unlock objects in an Essbase cube. Requires Database Manager permission or higher.

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/objects/unlock" -H  "accept: application/json" -H  "Content-Type: application/json" -d '{"type": "OUTLINE", "name": "Basic"},{"type": "CALCSCRIPT", "name": "CalcAll"}' -u %User%:%Password%

Type of Objects You Can Unlock

The following types of cube objects can be locked and unlocked.

• OUTLINE
• CALCSCRIPT
• REPORT
• RULES
• ALIAS
• STRUCTURE
• EXCEL
• TEXT
• PARTITION
• SELECTION
• LRO
• XML
• JAVA_CDF
• BACKUP
• MAXL
• WORKSHEET
• DATA
• ALL
• XLSX
• XLSM

Back to Top