移動先

• リクエスト
• レスポンス
• 例

オブジェクトのロック解除

post

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

指定されたアプリケーションおよびデータベース内のオブジェクトのロックを解除します。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

本体()

ロック解除するオブジェクトの詳細。

ルート・スキーマ : LockObject

型: object

ソースの表示

• links: array links
• name: string
• time: integer(int64)
• type: string
  指定可能な値: [ "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"
        }
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

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

ネストされたスキーマ : Link

型: object

ソースの表示

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

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

先頭に戻る

レスポンス

204 レスポンス

OK

オブジェクトが正常にロック解除されました。

400 レスポンス

不正なリクエスト

オブジェクトのロック解除に失敗しました。アプリケーション名、データベース名またはオブジェクト名が正しくないか、オブジェクト・タイプが正しくない可能性があります。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbaseキューブ内のオブジェクトのロックを解除する方法を示します。データベース・マネージャ以上の権限が必要です。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

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%

ロック解除可能なオブジェクトのタイプ

キューブ・オブジェクトの次のタイプは、ロックおよびロック解除できます。

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

先頭に戻る