REST API for Oracle Essbase

List Root Folders

get

/essbase/rest/v1/files

List catalog root folders.

Request

Query Parameters

filter: string

Filter the list of files.
recursive: boolean

Return search results recursively.

Default Value: false

Response

Supported Media Types

application/json
application/xml

200 Response

Folder list.

Root Schema : CollectionResponse

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: 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"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : items

Type: object

400 Response

Bad Request

Invalid path.

500 Response

Internal Server Error.

Examples

The following example shows how to use the REST API to list the root folders of the Essbase file catalog.

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/files?links=none" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "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" : { }
  } ]
}