REST API for Oracle Essbase

List or Download Files

get

/essbase/rest/v1/files/{path}

Returns a list of files, or downloads the specified file. To list files, use Accept='application/json' for the Accept header. To download, use Accept='application/octet-stream' for the Accept header.

Request

Path Parameters

path: string
Pattern: .+
Catalog path, starting with applications, shared, or users. If listing files, this is the folder path. If downloading files, this is the file path.
Examples:
- applications/sample
- shared
- users/ksmith

Query Parameters

action(optional): string

Validates the upload. Supported action values are validateUpload and 'Accept=application/json' or 'Accept=application/xml'.
fileSize(optional): integer(int64)

Validates whether enough free space is available. Applicable only with query parameters action='validateUpload' and Accept='application/json' or Accept='application/xml'.
filter(optional): string

Filter the list of files.
limit(optional): integer(int32)

Maximum number of files to return. Applicable only for listing files.
offset(optional): integer(int32)

Number of items to omit from the start of the result set. Default value is 0. Applicable only for listing files.
overwrite(optional): boolean

If true, overwrite files. If false, any existing file is validated but not overwritten. Applicable only with query parameters action=validateUpload and Accept='application/json' or Accept='application/xml' . Default value is false.

Default Value: false
recursive(optional): boolean

Recursive param to get search result as recursive.

Default Value: false
type(optional): string

List files by type. If type is not specified, returns all files. Applicable only for listing files.

Response

Supported Media Types

application/json
application/xml

200 Response

Response type can be either JSON/XML or stream, depending on the Accept header. If Accept=application/json or Accept=application/xml, the response lists files and current folder details. If Accept=application/octet-stream, the response is returned as a stream. If query parameters include action=validateUpload and Accept='application/json' or Accept='application/xml', the response is empty.

Root Schema : CollectionResponse

Type: object

Show Source

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

Additional Properties Allowed: additionalProperties
totalResults(optional): 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

Logged in user may not have appropriate permissions, or the file may already exist when query parameters include action=validateUpload and Accept='application/json' or Accept='application/xml'.

500 Response

Internal Server Error.

Examples

The following examples show how to list or download files.

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.

cURL Command ? User Files

The following example shows how to list or download files from a user directory.

curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/files/users/power1?overwrite=false&recursive=false" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "currentFolder": {
    "name": "power1",
    "fullPath": "/users/power1",
    "type": "folder",
    "permissions": {
      "addFolder": true,
      "addFile": true
    }
  },
  "items": [
    {
      "name": "groups.csv",
      "fullPath": "/users/power1/groups.csv",
      "type": "csv",
      "modifiedTime": 1585088753000,
      "sizeInBytes": 50,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/files/users/power1/groups.csv",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "testexamp.txt",
      "fullPath": "/users/power1/testexamp.txt",
      "type": "txt",
      "modifiedTime": 1585088753000,
      "sizeInBytes": 1074,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/files/users/power1/testexamp.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    }
  ]
}

cURL Command ? Cube Files

The following example shows how to list or download files from an Essbase cube directory.

curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/files/applications/Sample/Basic?overwrite=false&recursive=false&links=none" -H "accept: application/json" -o output_listfiles.json -u %User%:%Password%

Example of Response Body

{
  "currentFolder": {
    "name": "Basic",
    "fullPath": "/applications/Sample/Basic",
    "type": "folder",
    "permissions": {
      "addFile": true
    }
  },
  "items": [
    {
      "name": "CalcAll.csc",
      "fullPath": "/applications/Sample/Basic/CalcAll.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 64,
      "permissions": {
        "delete": true
      },
    {
      "name": "CDSSampl.xml",
      "fullPath": "/applications/Sample/Basic/CDSSampl.xml",
      "type": "xml",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 34467,
      "permissions": {
        "delete": true
      },
    {
      "name": "copy.csc",
      "fullPath": "/applications/Sample/Basic/copy.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 84,
      "permissions": {
        "delete": true
      },
    {
      "name": "Count.csc",
      "fullPath": "/applications/Sample/Basic/Count.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 355,
      "permissions": {
        "delete": true
      },
    {
      "name": "Data.rul",
      "fullPath": "/applications/Sample/Basic/Data.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1255,
      "permissions": {
        "delete": true
      },
    {
      "name": "Data_Basic.txt",
      "fullPath": "/applications/Sample/Basic/Data_Basic.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 337898,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Caffeinated.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Caffeinated.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1032,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Caffeinated.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Caffeinated.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 150,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Intro_Date.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Intro_Date.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1029,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Intro_Date.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Intro_Date.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 360,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Market.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Market.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1503,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Market.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Market.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2560,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Measures.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Measures.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1896,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Measures.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Measures.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2224,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Ounces.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Ounces.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1017,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Ounces.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Ounces.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 158,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Pkg_Type.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Pkg_Type.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1023,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Pkg_Type.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Pkg_Type.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 217,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Population.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Population.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1149,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Population.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Population.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 863,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Product.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Product.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1920,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Product.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Product.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2995,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Scenario.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Scenario.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1517,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Scenario.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Scenario.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 497,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Year.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Year.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1254,
      "permissions": {
        "delete": true
      },
    {
      "name": "Dim_Year.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Year.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1221,
      "permissions": {
        "delete": true
      },
    {
      "name": "MCDSSamp.xml",
      "fullPath": "/applications/Sample/Basic/MCDSSamp.xml",
      "type": "xml",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 4029,
      "permissions": {
        "delete": true
      },
    {
      "name": "Rank.csc",
      "fullPath": "/applications/Sample/Basic/Rank.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 188,
      "permissions": {
        "delete": true
      },
    }
  ]
}