Oracle Essbase REST API

ストリームされたデータソース結果の取得

post

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

アプリケーションレベルのデータソースからストリームで結果を返します。

リクエスト

パス・パラメータ

applicationName(required): string

アプリケーション名。

問合せパラメータ

includeHeaders: boolean

問合せ結果にヘッダーを含めるかどうか。trueの場合、結果の最初のレコードは列ヘッダーで構成されます。

デフォルト値: false
metaDataOnly: boolean

ストリーム・メタデータのみかどうか。

デフォルト値: false

問合せ情報。SQL問合せ(使用する場合)、ソース・データで使用されるレコード・デリミタ、およびデータソースに関連付けられたパラメータの情報を指定するオブジェクト。

ルート・スキーマ : DatasourceQueryInfo

型: object

ソースの表示

delimiter: string
params: object params

使用可能なその他のプロパティ: additionalProperties
query: string

{
    "type":"object",
    "properties":{
        "query":{
            "type":"string"
        },
        "delimiter":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

型: object

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

ソースの表示

object additionalProperties

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

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

型: object

先頭に戻る

レスポンス

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

application/json
text/plain
text/csv

200 レスポンス

結果が正常にフェッチされました。

400 レスポンス

不正なリクエスト

結果のストリームに失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例では、アプリケーションレベルのデータソースからストリームされた結果をフェッチする方法を示します。

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

cURLコマンドを含むスクリプト - ストリーム・メタデータのみ

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/datasources/query/stream?metaDataOnly=true -H "accept: application/json" -H "Content-Type: application/json" -d '{"query":"SELECT * FROM Orcl_DS", "delimiter": ","}' -u %User%:%Password%

サンプル・レスポンス - ストリーム・メタデータのみ

データソースからの結果は、text/CSVフォーマットになります。

"DIMENSION_PRODUCT","DIMENSION_MARKET","DIMENSION_YEAR","DIMENSION_SCENARIO","SALES","COGS","MARKETING","PAYROLL","MISC","INITIAL_INVENTORY","ADDITIONS"

cURLコマンドを含むスクリプト - ストリーム・データおよびヘッダー

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/datasources/query/stream?includeHeaders=true -H "accept: application/json" -H "Content-Type: application/json" -d '{"query":"SELECT * FROM Orcl_DS", "delimiter": ","}' -u %User%:%Password%

サンプル・レスポンス - ストリーム・データおよびヘッダー

データソースからの結果は、text/CSVフォーマットになります。次のストリームされた結果は長いため、切り捨てられています。

"DIMENSION_PRODUCT","DIMENSION_MARKET","DIMENSION_YEAR","DIMENSION_SCENARIO","SALES","COGS","MARKETING","PAYROLL","MISC","INITIAL_INVENTORY","ADDITIONS"
"100-20","Washington","Aug","Actual","317.0","133.0","120.0","29.0","1.0","","304.0"
"100-20","Washington","Aug","Budget","390.0","160.0","110.0","20.0","","","350.0"
"100-20","Utah","Aug","Actual","160.0","72.0","27.0","33.0","1.0","","153.0"
"100-20","Utah","Aug","Budget","200.0","90.0","20.0","30.0","","","170.0"
"100-20","Nevada","Aug","Actual","90.0","41.0","12.0","21.0","0.0","","86.0"
"100-20","Nevada","Aug","Budget","110.0","50.0","10.0","20.0","","","100.0"
"100-20","Texas","Aug","Actual","120.0","52.0","17.0","12.0","0.0","","114.0"
"100-20","Texas","Aug","Budget","150.0","60.0","10.0","10.0","","","130.0"
"100-20","Oklahoma","Aug","Actual","55.0","22.0","6.0","11.0","0.0","","52.0"
"100-20","Oklahoma","Aug","Budget","60.0","20.0","0.0","10.0","","","60.0"
"100-20","Louisiana","Aug","Actual","154.0","63.0","17.0","11.0","0.0","","147.0"
"100-20","Louisiana","Aug","Budget","190.0","70.0","10.0","10.0","","","170.0"
"100-10","Oklahoma","Aug","Actual","155.0","68.0","22.0","12.0","0.0","","147.0"
"100-10","Oklahoma","Aug","Budget","190.0","80.0","20.0","10.0","","","170.0"
"100-10","Louisiana","Aug","Actual","118.0","48.0","13.0","11.0","0.0","","113.0"
"100-10","Louisiana","Aug","Budget","140.0","60.0","10.0","10.0","","","130.0"
...

先頭に戻る