移動先

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

ロック済オブジェクトのリスト

get

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

指定されたアプリケーションおよびデータベースからすべてのロック済オブジェクトを返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• limit: integer(int32)

  返される最大オブジェクト数。デフォルトは50です。

  デフォルト値: 50
• offset: integer(int32)

  結果セットの先頭から省略するアイテムの数。デフォルト値は0です。

  デフォルト値: 0

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ロック済オブジェクトを正常に取得しました。ロック済オブジェクトの詳細、およびそのオブジェクトをロックまたはロック解除するためのリンクを提供します。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object LockObjectList

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

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LockObject"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object LockObject

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"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"
        }
    }
}

400 レスポンス

不正なリクエスト

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

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseキューブ内のロック済オブジェクトをリストする方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks/objects?offset=0&limit=25" -H  accept: application/json -u %User%:%Password%

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items": [
    {
      "name": "Basic",
      "type": "OUTLINE",
      "user": "power1",
      "time": 1625702089000,
      "links": [
        {
          "rel": "lock",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks/objects/lock",
          "method": "POST"
        },
        {
          "rel": "unlock",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locks/objects/unlock",
          "method": "POST"
        }
      ]
    }
  ],
  "totalResults": 1,
  "limit": 25,
  "count": 1,
  "offset": 0,
  "hasMore": false
}

先頭に戻る