移動先

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

ルート・フォルダのリスト

get

/essbase/rest/v1/files

カタログのルート・フォルダをリストします。

リクエスト

問合せパラメータ

• filter: string

  ファイルのリストをフィルタします。

• recursive: boolean

  再帰的に検索結果を返します。

  デフォルト値: false

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

フォルダ・リスト。

本体()

ルート・スキーマ : CollectionResponse

型: 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":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

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

型: object

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

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

型: object

400 レスポンス

不正なリクエスト

パスが無効です。

500 レスポンス

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

先頭に戻る

例

次の例では、REST APIを使用してEssbaseファイル・カタログのルート・フォルダをリストする方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/files?links=none" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "currentFolder" : {
    "name" : "/",
    "fullPath" : "/",
    "type" : "folder",
    "permissions" : { }
  },
  "items" : [ {
    "name" : "applications",
    "fullPath" : "/applications",
    "type" : "folder",
    "permissions" : { }
  }, {
    "name" : "gallery",
    "fullPath" : "/gallery",
    "type" : "folder",
    "permissions" : { }
  }, {
    "name" : "shared",
    "fullPath" : "/shared",
    "type" : "folder",
    "permissions" : {
      "addFolder" : true,
      "addFile" : true
    }
  }, {
    "name" : "users",
    "fullPath" : "/users",
    "type" : "folder",
    "permissions" : { }
  } ]
}

先頭に戻る