Oracle Essbase REST API

監査データの取得

get

/essbase/rest/v1/applications/{application}/databases/{database}/audittrail/data

Accept='text/csv'またはAccept='text/plain'である場合は、CSV文字列フォーマットで監査証跡データが返されます。Accept='application/octet-stream'である場合は、ダウンロードするCSVストリームとして監査データが返されます。Accept='application/json'である場合は、JSONフォーマットで監査データ・リストが返されます。

監査証跡レコードは、Essbaseリポジトリ・データベース・スキーマのESSBASE_DATA_AUDIT_TRAIL表に格納されます。

リクエスト

パス・パラメータ

application(required): string

アプリケーション名。
database(required): string

データベース名。

問合せパラメータ

fetchCount: integer(int64)

フェッチするレコードの数。

先頭に戻る

レスポンス

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

text/plain
text/csv

200 レスポンス

監査証跡データが正常に返されました。

ルート・スキーマ : schema

型: string

400 レスポンス

不正なリクエスト

監査データの返戻に失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例では、以前に収集されたEssbaseデータベースのデータ監査証跡情報を取得する方法を示します。

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

cURLコマンドを含むスクリプト - 監査証跡の有効化

データ監査証跡情報を確認する前に、アプリケーション構成プロパティAUDITTRAILを使用して監査証跡を有効にする必要があります。次の例では、これを有効にする方法を示します。

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/configurations?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -d '{"key": "AUDITTRAIL", "value": "DATA", "configured": false}' -u %User%:%Password%

サンプル・レスポンス

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

{
  "key" : "AUDITTRAIL",
  "value" : "DATA",
  "configured" : false
}

cURLコマンドを含むスクリプト - 監査証跡詳細の取得

少なくとも1人のユーザーがSmart Viewで更新を送信することによってキューブ内のデータが更新された後、次の例を使用してデータ監査結果を表示できます。

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/audittrail/data -H "Accept:application/json" -H "Content-Type:application/json" -o audit_data.json -u %User%:%Password%

サンプル・レスポンス

次の例は、audit_data.jsonに含まれるレスポンス本体の内容を示しています。

{
  "items" : [ {
    "seqNo" : 1,
    "noOfDimensions" : "5",
    "operationType" : "INPUT",
    "user" : "power1",
    "time" : "1662754461",
    "members" : "Jan,Sales,100-10,New York,Actual",
    "oldValue" : "678.0",
    "newValue" : "701.0",
    "displayText" : "(Jan,Sales,100-10,New York,Actual) Value changed from 678.0 to 701.0",
    "cellNote" : ""
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 1,
  "totalResults" : 1,
  "hasMore" : false
}

cURLコマンドを含むスクリプト - フェッチ数の例

fetchCountパラメータを使用して、特定の数の監査レコードを返します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/audittrail/data?fetchCount=50" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

警告:

fetchCount=-1を使用してすべてのレコードを返すことができますが、お薦めしません。データベース・リポジトリ・スキーマに格納された監査レコードの数が非常に多い場合、REST呼出しはメモリーを過剰に消費する可能性があります。

先頭に戻る