Oracle EssbaseのREST API

ファイルのリストまたはダウンロード

get

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

ファイルのリストを返すか、指定されたファイルをダウンロードします。ファイルをリストするには、AcceptヘッダーにAccept='application/json'を使用します。ダウンロードするには、AcceptヘッダーにAccept='application/octet-stream'を使用します。

要求

パス・パラメータ

path: string
Pattern: .+
applications、sharedまたはusersで始まるカタログ・パス。ファイルをリストする場合、これはフォルダ・パスです。ファイルをダウンロードする場合、これはファイル・パスです。
例:
- applications/sample
- shared
- users/ksmith

問合せパラメータ

action(optional): string

アップロードを検証します。サポートされているアクション値は、validateUploadおよび'Accept=application/json'または'Accept=application/xml'です。
fileSize(optional): integer(int64)

十分な空き領域があるかどうかを検証します。問合せパラメータaction='validateUpload'およびAccept='application/json'またはAccept='application/xml'でのみ適用可能です。
filter(optional): string

ファイルのリストをフィルタします。
limit(optional): integer(int32)

返されるファイルの最大数。リスト・ファイルにのみ適用されます。
offset(optional): integer(int32)

結果セットの先頭から除外するアイテムの数。デフォルト値は0です。リスト・ファイルにのみ適用されます。
overwrite(optional): boolean

trueの場合、ファイルを上書きします。 falseの場合、既存のファイルは検証されますが、上書きされません。問合せパラメータaction=validateUploadおよびAccept='application/json'またはAccept='application/xml'でのみ適用可能です。デフォルト値はFALSEです。

デフォルト値: false
recursive(optional): boolean

検索結果を再帰的として取得する再帰的パラメータ。

デフォルト値: false
type(optional): string

ファイルをタイプ別にリストします。 typeが指定されていない場合は、すべてのファイルを返します。リスト・ファイルにのみ適用されます。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

レスポンス・タイプは、Acceptヘッダーに応じてJSON/XMLまたはストリームのいずれかになります。 Accept=application/jsonまたはAccept=application/xmlの場合、レスポンスにはファイルおよび現在のフォルダの詳細がリストされます。 Accept=application/octet-streamの場合、レスポンスはストリームとして返されます。問合せパラメータにaction=validateUploadおよびAccept='application/json'またはAccept='application/xml'が含まれている場合、レスポンスは空です。

ルート・スキーマ : CollectionResponse

タイプ: 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

許可される追加プロパティ: additionalProperties
totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

タイプ: array

Show Source

Array of: object items

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

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

タイプ: object

許可される追加プロパティ

Show Source

string

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

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

タイプ: object

400 レスポンス

不正なリクエスト

ログイン・ユーザーに適切な権限がないか、問合せパラメータにaction=validateUploadおよびAccept='application/json'またはAccept='application/xml'が含まれている場合はファイルがすでに存在している可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る

例

次の例は、ファイルをリストまたはダウンロードする方法を示しています。

cURLコマンド

次の例は、ユーザー・ディレクトリからファイルを一覧表示またはダウンロードする方法を示しています。

curl -X GET "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic?overwrite=false&recursive=false" 
     -H "accept: application/json"

レスポンス本体の例

{
  "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://192.0.2.1:443/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://192.0.2.1:443/essbase/rest/v1/files/users/power1/testexamp.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    }
  ]
}

cURLコマンド

次の例は、Essbaseキューブ・ディレクトリからファイルをリストまたはダウンロードする方法を示しています。

curl -X GET "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic?overwrite=false&recursive=false" 
     -H "accept: application/json"
     -o output_listfiles.json

レスポンス本体の例

{
  "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
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/CalcAll.csc",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "CDSSampl.xml",
      "fullPath": "/applications/Sample/Basic/CDSSampl.xml",
      "type": "xml",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 34467,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/CDSSampl.xml",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "copy.csc",
      "fullPath": "/applications/Sample/Basic/copy.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 84,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/copy.csc",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Count.csc",
      "fullPath": "/applications/Sample/Basic/Count.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 355,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Count.csc",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Data.rul",
      "fullPath": "/applications/Sample/Basic/Data.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1255,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Data.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Data_Basic.txt",
      "fullPath": "/applications/Sample/Basic/Data_Basic.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 337898,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Data_Basic.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Caffeinated.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Caffeinated.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1032,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Caffeinated.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Caffeinated.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Caffeinated.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 150,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Caffeinated.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Intro_Date.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Intro_Date.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1029,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Intro_Date.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Intro_Date.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Intro_Date.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 360,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Intro_Date.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Market.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Market.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1503,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Market.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Market.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Market.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2560,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Market.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Measures.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Measures.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1896,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Measures.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Measures.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Measures.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2224,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Measures.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Ounces.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Ounces.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1017,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Ounces.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Ounces.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Ounces.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 158,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Ounces.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Pkg_Type.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Pkg_Type.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1023,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Pkg_Type.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Pkg_Type.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Pkg_Type.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 217,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Pkg_Type.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Population.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Population.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1149,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Population.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Population.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Population.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 863,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Population.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Product.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Product.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1920,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Product.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Product.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Product.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 2995,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Product.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Scenario.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Scenario.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1517,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Scenario.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Scenario.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Scenario.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 497,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Scenario.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Year.rul",
      "fullPath": "/applications/Sample/Basic/Dim_Year.rul",
      "type": "rul",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1254,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Year.rul",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Dim_Year.txt",
      "fullPath": "/applications/Sample/Basic/Dim_Year.txt",
      "type": "txt",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 1221,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Dim_Year.txt",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "MCDSSamp.xml",
      "fullPath": "/applications/Sample/Basic/MCDSSamp.xml",
      "type": "xml",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 4029,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/MCDSSamp.xml",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    },
    {
      "name": "Rank.csc",
      "fullPath": "/applications/Sample/Basic/Rank.csc",
      "type": "csc",
      "modifiedTime": 1574369590371,
      "sizeInBytes": 188,
      "permissions": {
        "delete": true
      },
      "links": [
        {
          "rel": "download",
          "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Rank.csc",
          "method": "GET",
          "type": "application/octet-stream"
        }
      ]
    }
  ]
}

先頭に戻る