1. Oracle EssbaseのREST API
  2. タスク
  3. アプリケーション・データソース

複数のアプリケーション・データソースの取得

get

/essbase/rest/v1/applications/{applicationName}/datasources

名前、説明、接続およびタイプなどの詳細を含め、アプリケーションレベルのデータソースのリストを返します。

リクエスト

パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

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

200 レスポンス

OK

データソースのリストが正常に返されました。

本体()
ルート・スキーマ : DatasourcesList
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : datasource
型: object
ソースの表示

  • データソースのtypeがESSBASEである場合に適用可能。Essbaseアプリケーション名。

  • ColumnsType

  • このデータソースで使用される接続。

  • データソースのtypeがESSBASEである場合に適用可能。Essbaseデータベース名。

  • delimiterに指定されている値がCustomである場合の、データ・レコードのカスタム・デリミタ。

  • データソースのtypeがDELIMITEDFILEである場合の、データ・レコードのデリミタ。デリミタは、CSVフォーマットの場合はComma、タブ区切りフォーマットの場合はTabにできます。カスタム・デリミタを使用するには、値Customを使用し、デリミタをcustomDelimiterの値として指定します。

  • このデータソースのオプションの説明。

  • データソースがExcelファイルまたはテキスト・ファイルである場合の、終了行番号。

  • データソースがExcelファイルまたはテキスト・ファイルである場合の、ヘッダー行番号。ヘッダーがない場合は0。

  • headers
  • links

  • データソース名。先頭は文字である必要があります。文字、アンダースコア文字および数字のみを含めることができます。

  • データソースに関連付けられている問合せ。たとえば、外部データベースの場合はSQL問合せ、または別のEssbaseキューブの場合はMDX問合せ。問合せによって、このデータソース内の使用可能にするデータが選択されます。

  • queryParameters

    データソース問合せがパラメータ化されている場合の、パラメータ実装詳細。たとえば、問合せselect * from profit_data where year=?のように、パラメータを渡すための?プレースホルダが問合せに含まれる場合、実装詳細を定義する必要があります。

  • データソースがExcelファイルである場合の、ワークシート名。

  • オプション(指定されていない場合、デフォルトは1です)。データソースがExcelファイルまたはテキスト・ファイルである場合の、(headerRowが存在する場合はこれを除いた)データ開始行番号。たとえば、headerRowが1として指定され、startRowが10として指定されている場合、実際のデータ開始行は11になります。

  • 指定可能な値: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]
  • widths
ネストされたスキーマ : ColumnsType
型: object
ソースの表示
ネストされたスキーマ : headers
型: array
ソースの表示
ネストされたスキーマ : queryParameters
型: array

データソース問合せがパラメータ化されている場合の、パラメータ実装詳細。たとえば、問合せselect * from profit_data where year=?のように、パラメータを渡すための?プレースホルダが問合せに含まれる場合、実装詳細を定義する必要があります。

ソースの表示
ネストされたスキーマ : widths
型: array
ソースの表示
ネストされたスキーマ : Column
型: array
ソースの表示
ネストされたスキーマ : ColumnType
型: object
ソースの表示
ネストされたスキーマ : HeaderType
型: object
ソースの表示
ネストされたスキーマ : QueryParamsInfo
型: object
ソースの表示

  • 実行時にパラメータに無効なコンテキストがある場合に、データソースがフォールバックとして使用する固定のデフォルト・パラメータ値。例: Jan。データソース問合せがパラメータ化されており(パラメータを渡すための?プレースホルダが含まれている)、かつプレースホルダが代替変数を参照することも、外部ソースで開発されたユーザー定義関数を参照することも意図されていない場合にのみ必須。

  • データソース問合せパラメータの順序インデックス。たとえば、最初のパラメータの場合は1、2番目のパラメータの場合は2、など。

  • 各自のユースケースに対して意味のある、データソース問合せパラメータのオプションの名前。たとえば、Param1のかわりにparam_G_monthを使用して、そのパラメータで現在の月のグローバル変数を使用することを示したり、名前をparam_appName_monthに変更して、そのパラメータで現在の月のアプリケーション・レベルの変数を使用することを示すことができます。

  • データソース問合せパラメータが必須の場合はtrue、それ以外の場合はfalse。

  • useSubVariableがtrueの場合、Essbase代替変数の名前。

  • 指定可能な値: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

    データソース問合せパラメータのデータ型。

  • データソース問合せパラメータでEssbase代替変数を参照する場合はtrue、それ以外の場合はfalse。

400 レスポンス

不正なリクエスト

データソースの取得に失敗しました。

先頭に戻る

例

次の例では、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/datasources?links=none" -H Accept:application/json -u %User%:%Password%

レスポンス本体の例

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

{
  "items" : [ {
    "name" : "UserDetails_DS",
    "description" : "User details CSV file",
    "connection" : "SAMPLE.UserDetails",
    "type" : "DELIMITEDFILE",
    "queryParameters" : [ ],
    "links" : [ ]
  }, {
    "name" : "Essbase2_DS",
    "description" : "Essbase instance 2",
    "connection" : "SAMPLE.Essbase2",
    "type" : "ESSBASE",
    "queryParameters" : [ ],
    "links" : [ ]
  }, {
    "name" : "OracleDB_DS",
    "description" : "Datasource for ORCL current month only",
    "connection" : "SAMPLE.OracleDB",
    "type" : "DB",
    "queryParameters" : [ ],
    "links" : [ ]
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 3,
  "totalResults" : 3,
  "hasMore" : false
}
先頭に戻る