SAP Web Intelligence RESTful Web サービス SDK

SAP BusinessObjects Business Intelligence プラットフォーム
Document Version: 4.0 Support Package 9 - 2014-02-18
SAP Web Intelligence RESTful Web サ
ービス SDK 開発者ガイド
目次
1
Web Intelligence RESTful Web サービス SDK の概要. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1
ドキュメント履歴. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2
SAP Web Intelligence RESTful Web サービス SDK の使用. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1
始める前に. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
2.2
HTTP ステータスエラー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3
トレースログを有効化するには. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4
Web Intelligence RESTful Web サービスの要求の URL を取得する. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3
API リファレンス. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1
BI プラットフォームへのログオンとログオフ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2
3.3
3.4
2
3.1.1
BI プラットフォームにログオンする. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1.2
BI プラットフォームからログオフする. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ドキュメントの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.1
BI プラットフォームでのローカライズされたドキュメントのサポート. . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.2.2
ドキュメント: 取得、コピー、または作成. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2.3
ドキュメント: 詳細の取得、更新、または削除. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.2.4
ドキュメントのプロパティ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.2.5
ドキュメントのエクスポート. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.2.6
スタイル、形式、フォント、スキン、および文字セットの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.2.7
関数、演算子、および変数の管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.2.8
アラータおよび変更の追跡の管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
3.2.9
添付ファイルとリンクの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.2.10
ドキュメントへのキャッシュエントリの追加. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ドキュメントライフサイクルの管理 (LCM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
3.3.1
ドキュメントの状態: ドキュメントの状態の管理 (ライフサイクルマネジメント). . . . . . . . . . . . . . . . . . .131
3.3.2
スナップショット: スナップショットの一覧の取得またはドキュメントのスナップショットの作成 . . . . . . . . 135
3.3.3
スナップショット: 特定のスナップショットへのドキュメントの復元. . . . . . . . . . . . . . . . . . . . . . . . . . 139
レポートの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
3.4.1
レポートの取得、移動、または作成. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
3.4.2
レポートの詳細の取得およびレポートの削除. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.4.3
レポートのマップの取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.4.4
レポートのエクスポート. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.4.5
レポートで使用されている要素の一覧の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
3.4.6
レポート要素の詳細の取得、レポート要素のエクスポート. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.4.7
レポート構造: レポートの構造の取得と更新. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.4.8
レポートデータのドリル操作. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
目次
3.5
3.6
3.7
3.8
3.9
データプロバイダの管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
3.5.1
データプロバイダの一覧の取得またはデータプロバイダの追加 . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.5.2
ドキュメント内のデータプロバイダの移動. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.5.3
データプロバイダの詳細の取得、データプロバイダの更新または削除. . . . . . . . . . . . . . . . . . . . . 230
3.5.4
データプロバイダの変更. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.5.5
フロー: データプロバイダのフロー件数の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.5.6
フロー: CSV または XML 形式でのフロー詳細の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.5.7
クエリ仕様: クエリ仕様の取得および更新. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
BW 接続および BEx クエリの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
3.6.1
BW 接続のリストの取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.6.2
ID による BW 接続の詳細の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
3.6.3
BW 接続の詳細の参照. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
3.6.4
BEx クエリのアウトラインの取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
3.6.5
BEx クエリの機能の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269
ドキュメントのスケジュール. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272
3.7.1
日時形式について. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.7.2
ドキュメントのスケジュール一覧の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
3.7.3
ドキュメントへのスケジュールの追加. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.7.4
スケジュールの詳細の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
3.7.5
ドキュメントスケジュールの削除またはキャンセル. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295
ドキュメントの最新表示. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.8.1
ドキュメントの最新表示前におけるドキュメント最新表示パラメータの取得. . . . . . . . . . . . . . . . . . . 298
3.8.2
ドキュメントの最新表示. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
3.8.3
ドキュメントの最新表示のキャンセル. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
ユニバースの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
3.9.1
使用可能なユニバースの一覧の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
3.9.2
ユニバースの詳細の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
3.9.3
ユニバースのクエリ機能の取得. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
4
ワークフローの例: ドキュメントを開き、最新表示、保存し、レポートをエクスポートする. . . . . . . . . . . . . . . . . . 348
5
RESTful サービスのクイックリファレンスセクション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.1
ドキュメントの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.2
ドキュメントライフサイクルの管理 (LCM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
5.3
レポートの管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.4
データプロバイダの管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
5.5
BW 接続および BEx クエリの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.6
ドキュメントのスケジュールと最新表示. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.7
ユニバースの管理. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
目次
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
3
1
Web Intelligence RESTful Web サービス
SDK の概要
Web Intelligence RESTful Web サービス SDK は、以下の操作に使用する API です。
●
Web Intelligence ドキュメントおよびレポートの操作
●
データプロバイダからのデータの取得
●
使用可能なユニバースのリストとユニバースの詳細の取得
●
ドキュメントのスケジュール
空のドキュメントを作成し、レポート仕様を使用してドキュメントの内容を設定することもできます。ドキュメントを編集するに
は、レポート仕様を更新することでこれを行う必要があります。
Web Intelligence RESTful Web サービス SDK は、セッション管理とリポジトリへのアクセスに、BI プラットフォーム RESTful
Web サービス API を使用します。 Web Intelligence RESTful Web サービス SDK を起動する前に、以下のリンクの
Business Intelligence プラットフォーム RESTful Web サービス開発者ガイドを参照することを強くお勧めします。
関連リンク
http://help.sap.com/bobip#section6
1.1
ドキュメント履歴
以下の表は、最も重要なドキュメント変更の概要です。
表 1: ドキュメント履歴
バージョン
日付
説明
SAP Web Intelligence RESTful Web
2012 年 9 月
このドキュメントの初版です。
2013 年 4 月
以下の側面が拡張されました。
サービス SDK 4.0 サポートパッケージ
5
SAP Web Intelligence RESTful Web
サービス SDK 4.0 サポートパッケージ
6
●
ドキュメント管理 (プロパティ、スタイル、関
数、演算子、変数、アラータ、変更の追跡、
添付、およびリンク)。 3.2 節を参照してくだ
さい。
●
ドキュメントライフサイクル管理 (ドキュメン
トの状態、スナップショット)。 3.3 節を参照
してください。
●
レポート管理 (エクスポート、リスト、ドリル、
構造)。 3.4 節を参照してください。
4
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
Web Intelligence RESTful Web サービス SDK の概要
バージョン
日付
説明
●
データプロバイダの管理 (データプロバイダ
の詳細、マッピング、データプロバイダの移
動、フロー情報の取得、クエリ仕様の取
得)。 3.5 節を参照してください。
●
ドキュメントのスケジュール (追加、削除、
スケジュールのキャンセル、スケジュール
の一覧の取得、スケジュールの詳細の取
得)。 3.6 節を参照してください。
●
ドキュメントの最新表示 (最新表示パラメー
タの取得、最新表示、および最新表示のキ
ャンセル)。 3.7 節を参照してください。
●
ユニバースの管理 (クエリ機能の取得)。
3.8 節を参照してください。
SAP Web Intelligence RESTful Web
2013 年 7 月
●
レポートセクションの管理: 一覧モード時
に、zip 圧縮した HTML 形式としてレポート
サービス SDK 4.0 サポートパッケージ
7
をエクスポートできるようになりました。
●
レポートセクションの管理: レポートのペー
ジも、zip 圧縮した HTML 形式としてエクス
ポートできます。
SAP Web Intelligence RESTful Web
2014 年 2 月
サービス SDK 4.0 サポートパッケージ
9
●
例の修正と改善
●
ドキュメントの管理の節: 一覧モードのドキ
ュメントを、zip 圧縮した HTML 形式として
エクスポートし、HTTP 呼び出しでその ZIP
ファイル名を指定できるようになりました。
ドキュメント全体のエクスポート [ページ
33]を参照してください。
●
データプロバイダの管理の節: .unv ユニ
バースの場合、データプロバイダの詳細
に、データソースオブジェクト識別子のデー
タソースプレフィックスが含まれます。デー
タプロバイダの詳細の取得、データプロバ
イダの更新または削除 [ページ 230]を参
照してください。
●
レポートの管理の節: 一覧モードのレポート
を、zip 圧縮した HTML 形式としてエクス
ポートするときに、HTTP 呼び出しでその
ZIP ファイル名を指定できるようになりまし
た。一覧モード (ページ区切りなし) でのレ
ポートのエクスポート [ページ 157]を参照
してください。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
Web Intelligence RESTful Web サービス SDK の概要
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
5
2
SAP Web Intelligence RESTful Web サービス
SDK の使用
SAP Web Intelligence RESTful Web サービス SDK は、RESTful 方法論に準拠します。Web Intelligence RESTful Web
サービス SDK には、HTTP 要求の作成をサポートする任意のプログラミング言語を使用してアクセスできます。
cURL ツールは HTTP 要求を完全にサポートしているので、このガイドのサンプル（Windows 用と UNIX 用）は、このツール
を使用して提供します。cURL の詳細については、下のリンクを参照してください。
関連リンク
http://curl.haxx.se/
2.1
始める前に
最初に、WebApplicationContainerServer（WACS）サーバが起動しており、有効になっていることを確認します。
サーバを起動するには、セントラル管理コンソールを起動します。
1.
［整理］で、［サーバ］を選択します。
2.
［サーバカテゴリ］フォルダを展開し、［コアサービス］を選択します。
3.
MySIA.WebApplicationContainerServer->［サーバの起動］を右クリックします。
4.
MySIA.WebApplicationContainerServer->［サーバの有効化］を右クリックします。
2.2
HTTP ステータスエラー
次の表に、HTTP 要求のステータスを提供する一連のステータスコードを示します。
表 2: HTTP 標準エラーコード
Status code
エラー
説明
200
Success
要求が成功しました。
400
不正な要求
要求されたリソースは存在しますが、要
求にエラーがあります。
401
ログオンの失敗または無効なセッション
ログオンに失敗しました。ユーザ名、パ
スワード、およびサーバ名が正しいこと
を確認してください。
6
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
SAP Web Intelligence RESTful Web サービス SDK の使用
Status code
エラー
説明
403
アクセス拒否
要求されたリソースを操作する権限が
ありません。現在のセッションが期限切
れになっている可能性があります。ログ
オンして新しいセッションを取得してくだ
さい。
404
サービスがない
要求されたサービスは、RESTful Web
サービス SDK から提供されていませ
ん。
405
要求メソッドが無効
リソースがサポートしていないメソッドを
使用して要求が行われました。たとえ
ば、読み取り専用リソースに対して PUT
要求を行いました。
406
受容不可
要求されたリソースは、要求ヘッダの
Accept 属性で指定されているコンテ
ンツタイプを生成できません。
408
BI プラットフォームサーバタイムアウト
要求の待機中にサーバがタイムアウト
になりました。
415
サポートされていないメディアタイプ
サーバまたはリソースがサポートしてい
ないメディアタイプが要求に含まれてい
ます。
500
RESTful Web サービス内部エラー
未分類のエラーが発生しました。詳細
については、応答本文を参照してくださ
い。
503
RESTful Web サービスプラグインが見つから
RESTful Web サービスを利用できませ
ない
ん。RESTful Web サービスが正しく構
成されていることを確認してください。
2.3
トレースログを有効化するには
返されたエラーの詳細を取得するには：
1.
［セントラル管理コンソール］を起動します。
2.
［サーバ］を選択します。
3.
［サービスカテゴリ］を展開し、［コアサービス］フォルダを選択します。
4.
WACS（MySIA.WebApplicationContainerServer）サーバを右クリックして、プロパティを取得します。
5.
［RESTful Web サービス情報］の［エラースタックの表示］をオンにします。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
SAP Web Intelligence RESTful Web サービス SDK の使用
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
7
2.4
する
Web Intelligence RESTful Web サービスの要求の URL を取得
Web Intelligence RESTful Web サービス SDK を使用するには、RESTful Web サービス要求をリスニングするサービスの
プロトコル、サーバ名、ポート番号、およびパスの情報が必要です。
デフォルトでは、この URL は次のとおりです。
http://<serverName>:6405/biprws/raylight/vx
注記
vx は、バージョンに対応します。このリリースでは v1 です。
8
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
SAP Web Intelligence RESTful Web サービス SDK の使用
3
API リファレンス
この章では、Web Intelligence RESTful Web サービスの一連の URL および BI プラットフォームにログオンするために使用
する URL を示します。
URL はカテゴリごとに編成されています。
●
BI プラットフォームへのログオンとログオフ
●
ドキュメント管理
●
ドキュメントのライフサイクル管理
●
レポート管理
●
DataProvider へのアクセス
●
スケジュール
●
ドキュメントの最新表示
●
ユニバース管理
注記
プラットフォームサービスの詳細については、下のリンクにある BI プラットフォーム RESTful Web サービス開発者ガイドを
参照してください。
関連リンク
http://help.sap.com/bobip#section6
BI プラットフォームへのログオンとログオフ [ページ 9]
ドキュメントの管理 [ページ 14]
ドキュメントライフサイクルの管理 (LCM) [ページ 131]
レポートの管理 [ページ 141]
データプロバイダの管理 [ページ 224]
ドキュメントのスケジュール [ページ 272]
ドキュメントの最新表示 [ページ 297]
ユニバースの管理 [ページ 336]
3.1
BI プラットフォームへのログオンとログオフ
GET メソッドを使用して XML テンプレートを取得し、ユーザ名、パスワード、および認証モードを使用して BI プラットフォーム
にログオンします。次に、POST メソッドを使用してログオンし、ログオントークンを取得します。
ログオントークンを無効にしてログオフします。
これらの機能は BI プラットフォームによって開発されたもので、詳細な説明は、以下のリンクから参照できる Business
Intelligence プラットフォーム RESTFful Web サービス開発者ガイドにあります。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
9
BI プラットフォーム Web サービスを要求するためのデフォルト URL は、次のとおりです。
http://<serverName>:6405/biprws/
関連リンク
http://help.sap.com/bobip#section6
BI プラットフォームにログオンする [ページ 10]
BI プラットフォームからログオフする [ページ 13]
3.1.1
BI プラットフォームにログオンする
このセクションでは、BI プラットフォームに接続する方法について説明します。
詳細な説明については、このセクションの末尾にあるリンクにある Business Intelligence Platform RESTful Web サービス
開発者ガイドを参照してください。
XML テンプレートをを取得するには
取得する XML テンプレートは、後述の POST 要求本文のために使用されます。
要求:
GET http://<serverName>:6405>/biprws/logon/long
ヘッダ
値
Accept
application/xml または application/json
応答:
ヘッダ
値
Status Code
HTTP 応答コード
サーバ
サーバのタイプ
Date
応答の日付と時刻
Content-Type
応答本文のコンテンツの種類
Content-Length
応答本文のコンテンツの長さ
10
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ボディ
POST 要求を作成するためのテンプレート
例
Windows
curl -G http://<serverName>:6405/biprws/logon/long -H accept="application/xml"
UNIX
curl -G http://<serverName>:6405/biprws/logon/long -H "accept=application/xml"
応答
<attrs xmlns="http://www.sap.com/rws/bip">
<attr name="userName" type="string">
</attr>
<attr name="password" type="string">
</attr>
<attr name="auth" type="string"
possibilities="secEnterprise,secLDAP,secWinAD,secSAPR3">secEnterprise
</attr>
</attrs>
ユーザ名とパスワードを指定してログオントークンを受信する
上記の GET 要求によって取得した XML テンプレートを使用します。
要求:
POST http://<serverName>:6405/biprws/logon/long
ヘッダ
Content-Type
Accept
値
application/xml または application/json
application/xml または application/json
ボディ
説明
XML
ユーザ名、パスワード、および認証の種類を定義します。
<attrs>
<attr name="userName" type="string"/></
attr>
<attr name="pass"
type="string"></attr>
<attr name="auth" type="string"></
attr>
</attrs>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
次の認証を指定できます。 secEnterprise、secLDAP、
secWinAD、または secSAPR3
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
11
ボディ
説明
Json
{"userName":username,"password":passwor
d,"auth":secEnterprise}
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Server
サーバのタイプ
X-SAP-LogonToken
ログオントークン。 SAP ログオンは引用符で囲みます。
X-SAP-LogonToken:"tokenValue"
Date
応答日時
Content-Type
応答本文のコンテンツの種類
ボディ
説明
<attr name="logonToken" type="string">
ログオントークンのコピーが含まれます。 XML エンコード形
式のログオントークンを使用するには、元の形式に変換する
必要があります
例
ログイン
注記
認証情報は cURL コマンドの "@login.xml" で呼び出された login.xml ファイルに指定されます。
login.xml の詳細。
<attrs>
<attr name="userName" type="string">Administrator</attr>
<attr name="password" type="string">Password</attr>
<attr name="auth" type="string">secEnterprise</attr>
</attrs>
Windows
curl -i -X "POST" -H "content-type: application/xml" -H "accept: application/xml"
-d "@login.xml" http://<serverName>:6405/biprws/logon/long
12
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
X-SAP-LogonToken を取得した後は、変数によりこれを使用できるようになります。トークン値をコピーし、次のように
コマンドラインに入力します。 Set tokenValue=<pasted_value>。また、cURL 要求の変数は %tokenValue%
をそのまま使用します。
次の要求により、X-SAP-LogonToken は xsaplogontoken.txt ファイルにエクスポートされます。
curl -i -X "POST" -H "content-type: application/xml" -H "accept: application/xml"
-d "@login.xml" http://<serverName>:6405/biprws/logon/long | find "X-SAPLogonToken: " > xsaplogontoken.txt
for /f "tokens=1,2 delims= " %a in (xsaplogontoken.txt) do @echo %b >
xsaplogontoken.txt
UNIX
注記
X-SAP-LogonToken は logtok 変数でエクスポートされます。この変数は、ほかのすべての URL によって使用さ
れます。
export logtok=`curl -i -X "POST" -H "content-type: application/xml" -H "accept:
application/xml" -d "@login.xml" http://<serverName>:6405/biprws/logon/long |
grep "X-SAP-LogonToken: " | awk '{print $2;}'`
関連リンク
http://help.sap.com/bobip#section6
3.1.2
BI プラットフォームからログオフする
ログオントークンを無効化し、BI プラットフォームからログオフします。
要求:
POST http://<serverName>:6405/biprws/logoff
ヘッダ
値
Accept
application/xml
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
13
ヘッダ
値
ステータスコード
HTTP 応答コード
Server
サーバのタイプ
Date
応答の日付と時刻
Content-Type
応答本文のコンテンツの種類
Content-Length
応答本文のコンテンツの長さ
ボディ
なし
例
Windows
curl -i -X "POST" -H "accept: application/xml" -H 'X-saplogontoken:"<TokenValue>"' http://<serverName>:6405/biprws/logoff
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept: application/xml" -H "X-sap-logontoken:$logtok"
http://<serverName>:6405/biprws/logoff
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 24 May 2012 14:41:20 GMT
Content-Type: text/xml
Content-Length: 0
関連リンク
BI プラットフォームにログオンする [ページ 10]
3.2
ドキュメントの管理
以下は Web Intelligence ドキュメントを管理するために使用できる主な操作です。
14
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
以下に関する情報を取得できます。
●
設定書式
●
カスタム書式
●
ドキュメント
●
フォントマッピング
●
関数
●
演算子
●
レポートスキン
以下を管理できます。
●
アラータ
●
添付ファイル
●
変更の追跡
●
ドキュメント (ドキュメントのエクスポートなど)
●
リンク
●
スタイル
●
スタイルシート (CSS)
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
ドキュメント: 詳細の取得、更新、または削除 [ページ 22]
ページ区切りモードでのドキュメントのエクスポート [ページ 36]
3.2.1
BI プラットフォームでのローカライズされたドキュメントのサポート
RESTful Web サービス SDK は、BI プラットフォームのローカライズされたドキュメントをサポートします。ローカライズされた
ドキュメントを使用するには、ヘッダ内の以下の宣言を含めます。
追加のオプションのヘッダ宣言
値
Accept-Language
このヘッダ宣言では、製品ロケール (UI ロケール) を定義し
ます。ドキュメントのローカライズされた表示ロケール、また
は優先表示ロケールに宣言された言語です。たとえば、
en_US、fr_FR です。
X-SAP-PVL
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
このヘッダ宣言は、コンテンツのロケールとも呼ばれる優先
表示ロケールを定義します。
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
15
Raylight サービスは、クライアントが要求する優先表示ロケールごとにメモリ内で Web Intelligence ドキュメントの 1 つのイ
ンスタンスを開きます。
例
特定のロケールのドキュメントのコンテンツを取得する: fr-FR
Windows
curl -G -i -H "accept:application/xml" "X-SAP-PVL:fr-FR" -H X-SAPLogonToken:"""%tokenValue%""" "http://<serverName>:6405/biprws/raylight/v1/
documents/12345"
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i "accept:application/xml" "X-SAP-PVL:fr-FR" -H 'X-SAPLogonToken:"$logtok"' "http://<serverName>:6405/biprws/raylight/v1/documents/
12345"
3.2.2
ドキュメント: 取得、コピー、または作成
この URL を使用して、以下の操作を行います。
●
CMS からのドキュメント一覧の取得 (GET <url>/documents)
●
ドキュメントのコピー (POST <url>/documents)
●
空のドキュメントの作成 (POST <url>/documents)
CMS からの Web Intelligence ドキュメント一覧の取得
これは、CMS に格納されているドキュメントの一覧を取得します。ドキュメントは名前で並べ替えられます。一覧はユーザア
クセス権に依存します。一覧に返すドキュメントの数、および取得するドキュメント一覧内で開始ドキュメントとして使用する最
初のドキュメントを指定することもできます。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
16
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
limit
オプション。返すドキュメントの数
デフォルトは 10 です。
最小値は 0 です。
最大値は 50 です。
offset
オプション。一覧の先頭の指標
デフォルトは 0 です。
最小値は 0 です。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
名前で並べ替えた Web Intelligence ドキュメントの一覧。一覧はユーザアクセス権に依存します。ドキュメントごとに、以
下が示されます。
<id>: ドキュメント ID
<cuid>: 一意のドキュメント ID
<name>: ドキュメント名
<folderId>: フォルダ ID
<state>: Raylight によって使用されるドキュメントの状態。次の値を指定できます。
●
Unused ドキュメントは Raylight によってロードされていません。
●
Original ドキュメントは Raylight によってロードされましたが、変更されていません。
●
Modified ユーザは Raylight にドキュメントの状態を変更する要求を送信しました。
例
CMS から 6 つのドキュメントを取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents?limit=6
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
17
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents?limit=1
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<documents>
<document>
<id>6804</id>
<cuid>AbrVz6E95lNMtjZk4KLzPuM</cuid>
<name>BOF-ROLE_AA_ActiveHierOnCtry - Levels 02 and 03</name>
<folderId>7611</folderId>
<state>Original</state>
</document>
<document>
<id>6861</id>
<cuid>AUwfvPdEG3xOoLNoNEzDquQ</cuid>
<name>This is a sample for BOF-QRY_SIMPLE - Filter not in Result</name>
<folderId>7611</folderId>
<state>Unused</state>
</document>
<document>
<id>6869</id>
<cuid>Ac1wDFEOuvNHtovI4H.anSM</cuid>
<name>BOF-QRY_SIMPLE - Filter on Country</name>
<folderId>48162</folderId>
<state>Original</state>
</document>
<document>
<id>7048</id>
<cuid>AUiVpegCKnFBh4AX8YxMT5A</cuid>
<name>BOF-QRY_SIMPLE - Filter on Prompt not in Result</name>
<folderId>7611</folderId>
<state>Modified</state>
</document>
<document>
<id>7125</id>
<cuid>AWa48YHHT6FFiUMP.T5wtBs</cuid>
<name>BOF-QRY_SIMPLE - Query Prompt not in Result</name>
<folderId>7611</folderId>
<state>Unused</state>
</document>
<document>
<id>5121</id>
<cuid>ARnGKBoLv7lDuK_UWMUli5Q</cuid>
<name>Chart demo</name>
<description>Shows how data can be visualized on different kinds of charts. And
the features supported on the charts. </description>
<folderId>5127</folderId>
<state>Unused</state>
</document>
18
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</documents>
Web Intelligence ドキュメントのコピー
sourceId パラメータ sourceId=<Web_Intelligence_document_id> を使用して、コピーするドキュメントの ID を指
定する必要があります。現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本
文のドキュメントとフォルダの名前を定義します。たとえば、copy.xml です。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents?
sourceId=<Web_Intelligence_document_id>
ヘッダ
Accept
Content-type
値
application/xml または application/json
application/xml または application/json
パラメータ
説明
sourceId
必須。整数。コピーする Web Intelligence ドキュメントの識
別子。
最小値は 1 です。
最大値は、既存のドキュメントの最大ドキュメント番号です。
本文 (XML)
<document>
<name> </name>
<folderId> </folderId>
</document>
説明
<name>: BI 起動パッドフォルダにあるコピーされたドキュメ
ントの名前
<folderId>: ドキュメントが作成される BI 起動パッドフォ
ルダ。デフォルトでは、元のドキュメントのフォルダです。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
サーバ
サーバのタイプ
Date
応答日時
コンテンツタイプ
application/xml または application/json
Content Length
応答本文のコンテンツの長さ
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
19
ボディ
成功の場合:
<success>
<message>Document has been created successfully.</message>
<id>5678</id>
<success>
それ以外の場合: <error> ... </error>
例
ドキュメント ID 4990 をコピーする
注記
コピーされたドキュメントの名前は、cURL コマンドの -d "@copy.xml" によって呼び出される copy.xml ファイルに
指定されています。コピーされたドキュメントには、ID 5875 が割り当てられ、BI 起動パッドフォルダに次のように表示さ
れます: Copy of 4990。
copy.xml の詳細
<document>
<name>
Copy of 4990
</name>
</document>
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H X-SAP-LogonToken:"""%tokenValue%""" -d "@copy.xml" http://<serverName>:6405/
biprws/raylight/v1/documents?sourceId=4990
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' -d "@copy.xml" http://<serverName>:6405/biprws/
raylight/v1/documents?sourceId=4990
応答
HTTP/1.1 200 OK
Server:Apache-Coyote/1.1
Date: Mon, 04 Jun 2012 11:59:02 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type 'document' with identifier '5875' has been
20
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
successfully created.</message>
<id>5875</id>
</success>
空の Web Intelligence ドキュメントの作成
このコマンドを使用して、空のドキュメントを作成します。要求の本文は、 newdocument.xml などの .xml ファイルに記述
され、-d "@copy.xml". を使用して指定します。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
Accept
Content-type
本文 (XML)
<document>
<name>Name_of_new_document </name>
<folderId>Id_of_folder</folderId>
</document>
値
application/xml または application/json
application/xml または application/json
説明
<name>: 作成する空のドキュメントの名前。名前を割り当
てない場合は、自動的に ID が割り当てられます。
<folderId>: ドキュメントが作成される BI 起動パッドフォ
ルダ。フォルダを宣言しない場合は、デフォルトの BI 起動パ
ッドフォルダが使用されます。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
サーバ
サーバのタイプ
日付
応答日時
Content Type
application/xml または application/json
ボディ
成功の場合:
<success>
<message>The resource of type 'Document' with identifier '{documentId} ' has been
successfully created.</message>
<id>{documentId}</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
21
ボディ
</success>
それ以外の場合: <error> ... </error>
例
新しい Web Intelligence ドキュメントを作成する
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H X-SAP-LogonToken:"""%tokenValue%""" -d "@newdocument.xml" http://<serverName>:
6405/biprws/raylight/v1/documents
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' -d "@newdocument.xml" http://<serverName>:6405/
biprws/raylight/v1/documents
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Document' with identifier '5022' has been
successfully created.</message>
<id=“5022“></id>
</success>
関連リンク
BI プラットフォームにログオンする [ページ 10]
ドキュメント: 詳細の取得、更新、または削除 [ページ 22]
3.2.3
ドキュメント: 詳細の取得、更新、または削除
この URL を使用して以下の操作を実行します。
22
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
ドキュメントの詳細の取得 (GET <url>/documents/{documentId})
●
ドキュメントの更新 (閉じる/保存) (PUT <url>/documents/{documentId} )
●
ドキュメントの削除 (DELETE <URL>/documents/{documentId})
Web Intelligence ドキュメントはその ID で参照されます。
また、ドキュメントをさまざまな形式でエクスポートします。
次の形式を指定できます。
●
XML
●
PDF
●
Excel 2003
●
Excel 2007
また、PUT メソッドを使用して、ドキュメントライフサイクルの管理 (状態を変更する、Web Intelligence ドキュメントの変更を
閉じる、保存する、破棄する) にも使用できます。この機能は、ライフサイクルマネジメントの節で説明されています。このセク
ションの最後にあるリンクを参照してください。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
指定した Web Intelligence ドキュメントの詳細の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
trackerDocumentId
オプションのクエリパラメータ。追跡データ機能用の参照ドキュメントの ID を指定しま
す。ドキュメントが 'Unused' の状態のときにのみ、指定する必要があります。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
23
ヘッダ
値
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別されるドキュメントの詳細:
<id>, <cuid>, <name>, <folderId>, <path>, 最終更新日時、および <scheduled> (false または true) で
ドキュメントがスケジュールされているかどうか。
およびドキュメントプロパティ
<updated>: 最終更新の日付と時刻
<createdBy>: ドキュメント作成者の名前
<lastAuthor>: ドキュメントを最後に変更した人の名前
<size>: ドキュメントのサイズ
<refreshOnOpen>: "true" ドキュメントを開くときに更新するよう設定する場合。それ以外の場合は、"false" です。
<state>: Raylight によって使用されるドキュメントの状態。
次の値を指定できます。 Unused、Original、および Modified。 Unused とは、ドキュメントは Raylight によってロード
されていないという意味です。 Original とは、ドキュメントは Web サービスによってロードされましたが、変更されていな
いという意味です。 Modified とは、ユーザはドキュメントの状態を変更する要求を送信したという意味です。
例
ドキュメント ID 8022 の詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/1458
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/1458
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
24
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<document>
<id>4958</id>
<cuid>AQtkbbSqN4NOj3ydf.Sw1lY</cuid>
<name>Formatting Sample</name>
<description>This is a sample document showing formatting capabilities.</
description>
<folderId>8246</folderId>
<path>My Favorites/web Intelligence</path>
<updated>2012-09-05T14:25:05.277+02:00</updated>
<scheduled>true</scheduled>
<state>Unused</state>
<createdBy>Administrator</createdBy>
<lastAuthor>User1</lastAuthor>
<size>29410</size>
<refreshOnOpen>false</refreshOnOpen>
</document>
ドキュメントの削除
ドキュメントをその ID で参照して、削除できます。
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}
注記
{documentId}: 削除する Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得できます:
GET http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
削除するドキュメントの ID。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
25
ボディ
成功の場合、"The resource of type 'Document' with identifier {documentId} has been succesfully removed" が返
されます。それ以外の場合、<error> ... </error> が返されます。
例
ドキュメント ID 8022 を削除する
Windows
curl -X "DELETE" -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8022
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "DELETE" -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Document' with identifier '8022' has been
successfully removed.</message>
<id=“5022“></id>
</success>
関連リンク
BI プラットフォームにログオンする [ページ 10]
ドキュメント: 取得、コピー、または作成 [ページ 16]
ページ区切りモードでのドキュメントのエクスポート [ページ 36]
ドキュメントの状態: ドキュメントの状態の管理 (ライフサイクルマネジメント) [ページ 131]
26
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.2.4
ドキュメントのプロパティ
これらの機能を使用して、[ドキュメントの要約] に表示されるドキュメントのプロパティの一覧の表示や編集を行います。前回
の最新表示時刻など、一部の設定は自動的に属性が設定され、手動では設定できません。
関連リンク
ドキュメントのプロパティの取得 [ページ 27]
ドキュメントのプロパティの更新 [ページ 30]
3.2.4.1
ドキュメントのプロパティの取得
documentId パラメータで参照されるドキュメントプロパティを取得します。( GET <url>documents/{documentId}/
properties
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
ドキュメントのプロパティの取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/properties
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
応答
ヘッダ
値
ステータスコード
HTTP 応答コード
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
27
ヘッダ
値
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
ドキュメントのプロパティ
<property key="SI_CUID">ATuas0Mb.mxHpfioi7Xrwfo</property>
<property key="lastrefreshtime">1352999520</property>
<property key="lastrefreshduration">1</property>
<property key="lastsavedby">管理者</property>
<property key="enablealternateusertoeditdoc">true</property>
<property key="creatorversion">14.0.6.894</property>
<property key="disablequerypanel">false</property>
<property key="lastrefreshdate">15 novembre 2012 18:12:00 GMT+01:00</property>
<property key="enhancedViewing">false</property>
<property key="current_doc_id">9939</property>
<property key="osversion">?</property>
<property key="modificationtime">1352999598</property>
<property key="stripquery">true</property>
<property key="modificationdate">15 novembre 2012 18:13:18 GMT+01:00</property>
<property key="name">doc_unv_drill_enable</property>
<property key="createdby">Administrator</property>
<property key="tdcactivated">false</property>
<property key="reportselected">1</property>
<property key="nameinrepo">doc_unv_drill_enable</property>
<property key="permanentregionalformatting">false</property>
<property key="reporterversion">14.0.6.894</property>
<property key="repositorytype">C</property>
<property key="locale">en_US</property>
<property key="refreshonopen">false</property>
<property key="docrepoid">9939</property>
<property key="documenttype">WID</property>
<property key="autosynchro">false</property>
28
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<property key="hassamplingresults">false</property>
<property key="tdcmodeauto">true</property>
<property key="effectiverefreshonopen">false</property>
<property key="contentlocale">fr_FR</property>
<property key="mergeprompts">true</property>
<property key="documentsize">31070</property>
<property key="extendmergedimension">false</property>
<property key="autorefresh">false</property>
<property key="creationtime">1352999595</property>
<property key="creationdate">15 novembre 2012 18:13:15 GMT+01:00</property>
<property key="ispartiallyrefreshed">false</property>
<property key="nbqaawsconnection">0</property>
<property key="documentversion">14.0.6.894</property>
例
ドキュメントのプロパティを取得する
注記
ドキュメント (ID 7858) からレポート (ID 3) の詳細を取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/properties
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/properties
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 14:24:12 GMT
Content-Type: application/xml
Content-Length: 167
<properties>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
29
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
property>
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
<property
</properties>
key="SI_CUID">ATuas0Mb.mxHpfioi7Xrwfo</property>
key="lastrefreshtime">1352999520</property>
key="lastrefreshduration">1</property>
key="lastsavedby">Administrator</property>
key="enablealternateusertoeditdoc">true</property>
key="creatorversion">14.0.6.894</property>
key="disablequerypanel">false</property>
key="lastrefreshdate">15 novembre 2012 18:12:00 GMT+01:00</property>
key="enhancedViewing">false</property>
key="current_doc_id">9939</property>
key="osversion">?</property>
key="modificationtime">1352999598</property>
key="stripquery">true</property>
key="modificationdate">15 novembre 2012 18:13:18 GMT+01:00</
key="name">doc_unv_drill_enable</property>
key="createdby">Administrator</property>
key="tdcactivated">false</property>
key="reportselected">1</property>
key="nameinrepo">doc_unv_drill_enable</property>
key="permanentregionalformatting">false</property>
key="reporterversion">14.0.6.894</property>
key="repositorytype">C</property>
key="locale">en_US</property>
key="refreshonopen">false</property>
key="docrepoid">9939</property>
key="documenttype">WID</property>
key="autosynchro">false</property>
key="hassamplingresults">false</property>
key="tdcmodeauto">true</property>
key="effectiverefreshonopen">false</property>
key="contentlocale">fr_FR</property>
key="mergeprompts">true</property>
key="documentsize">31070</property>
key="extendmergedimension">false</property>
key="autorefresh">false</property>
key="creationtime">1352999595</property>
key="creationdate">15 novembre 2012 18:13:15 GMT+01:00</property>
key="ispartiallyrefreshed">false</property>
key="nbqaawsconnection">0</property>
key="documentversion">14.0.6.894</property>
関連リンク
ドキュメントのプロパティの更新 [ページ 30]
3.2.4.2
ドキュメントのプロパティの更新
documentId パラメータで参照されるドキュメントプロパティを更新します。( PUT <url>documents/{documentId}/
properties
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
30
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/properties
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
ボディ
XML ファイル内の更新するドキュメントプロパティ。たとえば、docprop.xml というファイルを定義します。
<properties>
<property key="refreshonopen">true</property>
</properties>
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'properties' has been successfully updated.</message>
<id>{documentId}</id>
</success>
例
ドキュメント ID 9939 のドキュメントプロパティを更新する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポートプロパティ
を定義します。たとえば、properties.xml です。
要求:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
31
Windows
curl -i -X "PUT" -H "accept:application/xml" X-SAP-LogonToken:"""%tokenValue%"""
-d "@properties.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9939/
properties
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" 'X-SAP-LogonToken:"$logtok"' -d
"@properties.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9939/
properties
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success>The resource of type 'properties' has been successfully updated.
<id>9939</id>
</success>
関連リンク
ドキュメントのプロパティの取得 [ページ 27]
3.2.5
ドキュメントのエクスポート
ドキュメントは、ドキュメント全体またはページ区切りモードの 2 種類の方法でエクスポートできます。以下の 2 つの URL を
使用します。
●
ドキュメントのエクスポート (GET -s <url>/documents/{documentId}[?parameters] >
<outputfilename>)
●
ページ区切りモードでのドキュメントのエクスポート (GET -s <url>/documents/{documentId}/pages)
次の出力形式を指定できます。
●
XML
●
PDF
32
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
zip 形式で圧縮された HTML
●
Excel 2003
●
Excel 2007
関連リンク
ドキュメント全体のエクスポート [ページ 33]
ページ区切りモードでのドキュメントのエクスポート [ページ 36]
3.2.5.1
ドキュメント全体のエクスポート
ドキュメントは以下の形式でエクスポートできます。
●
XML
●
PDF
●
zip 形式で圧縮された HTML
●
Excel 2003
●
Excel 2007
ドキュメントのエクスポート
注記
HTML 出力が選択されている場合、Raylight によって画像のリンクが生成されます。そのため、HTML 出力を表示してい
る間は (生成されたリンクから画像を取得できるように)、ログオントークンを引き続き有効にしておく必要があります。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}[?parameters]
ヘッダ
Accept
値
text/xml または
application/pdf または
application/zip または
application/vnd.ms-excel (Excel 2003 の場合) また
は
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
33
ヘッダ
値
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007
の場合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
表 3: ドキュメントのエクスポート: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャート (存在する場合) の解像度 (DPI: ドット数/インチ)。
最大: 9600
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)。
表 4: ドキュメントのエクスポート: zip 形式で圧縮された HTML 向けのオプションパラメータ
パラメータ
説明
fileName
文字列。 zip ファイルの名前です。
最大長: 96
表 5: ドキュメントのエクスポート: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
optimized
説明
論理値。デフォルト: false。生成される出力は、Excel 内の計算向けに最適化され
ません。そうしない場合は、true。
応答:
ボディ
エクスポートされるファイルの形式は、accept:[text/xml]|[application/pdf]|[application/zip]|
[application/vnd.ms-excel ]|[application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet] によって定義されます。ドキュメントは、出力拡張子タイプが付いた
documentId として保存されます。
34
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
ドキュメントを XML 形式でエクスポートする
注記
XML の結果を xmlfile.xml にエクスポートします。生成されるすべてのチャートの解像度は 150 DPI です。
Windows
curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" "http://
<serverName>:6405/biprws/raylight/v1/documents/8022?dpi=150" > xmlfile.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022?dpi=150" > xmlfile.xml
例
ドキュメントを PDF 形式でエクスポートする
結果を exportpdf.pdf というファイルにエクスポートします。生成されるすべてのチャートには、デフォルトの解像度
300 DPI が使用されます。
Windows
curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/8022" > exportpdf.pdf
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/pdf" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022" > exportpdf.pdf
例
ドキュメントを Excel 2003 形式でエクスポートする
結果を excel2003.xls というファイルにエクスポートします。出力は Excel 内の計算用に最適化され、生成されるすべ
てのチャートの解像度は 150 DPI になります。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
35
Windows
curl -G -s -H "accept:application/vnd.ms-excel" -H X-SAP-LogonToken:"""%tokenValue
%""" "http://<serverName>:6405/biprws/raylight/v1/documents/8022?
optimized=true&dpi=150" > excel2003.xls
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.ms-excel" -H 'X-SAP-LogonToken:"$logtok"'
"http://<serverName>:6405/biprws/raylight/v1/documents/8022?
optimized=true&dpi=150" > excel2003.xls
例
ドキュメントを Excel 2007 形式でエクスポートする
結果を excel2007.xlsx ファイルにエクスポートします。出力は Excel 内の計算用に最適化されます。
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/8022?optimized=true" >
excel2007.xlsx
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022?optimized=true" >
excel2007.xlsx
3.2.5.2
ページ区切りモードでのドキュメントのエクスポート
ID で参照される Web Intelligence ドキュメントをページ区切りモードでさまざまな形式にエクスポートします。
次の出力形式を指定できます。
●
XML
●
PDF
●
Excel 2003
●
Excel 2007
36
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
要求:
GET -s http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/pages
ヘッダ
値
Accept
●
text/xml
●
application/pdf
●
application/vnd.ms-excel (Excel 2003 の場合)
●
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場
合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値
表 6: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャートの解像度 (DPI: ドット数/インチ)(存在する場合)。
最大: 9600。
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)
mode
normal または quickDisplay
表 7: オプションパラメータ mode=normal
パラメータ
説明
orientation
ページの方向。特定のページの向きを指定するために使用します。
値: portrait、landscape
widthScaling
レポート表示 1 回あたりのページ数 (幅)。
デフォルト: 0 は、幅に制約がないことを意味します。
heightScaling
レポート表示 1 回あたりのページ数 (高さ)。
デフォルト: 0 は、高さに制約がないことを意味します。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
37
表 8: ドキュメントのエクスポート: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
optimized
説明
論理値。デフォルト: false。それ以外の場合は true。生成される出力は、Excel 内
の計算向けに最適化されます。
応答:
ボディ
エクスポートされるファイルの形式は、accept:[text/xml]|[application/pdf]|[application/vnd.msexcel ]|[application/vnd.openxmlformats-officedocument.spreadsheetml.sheet] によって定義
されます。ドキュメントは、出力拡張子タイプが付いた documentId として保存されます。
例
XML (ページ区切りモード) でのドキュメントのエクスポート
注記
XML の結果を xmlfile.xml にエクスポートします。
Windows
curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" "http://
<serverName>:6405/biprws/raylight/v1/documents/8022/pages" > xmlfile.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022/pages" > xmlfile.xml
例
PDF (ページ区切りモード) でのドキュメントのエクスポート
注記
PDF の結果を exportpdffile.pdf にエクスポートします。
Windows
curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/8022/pages?
mode=quickDisplay" > exportpdffile.pdf
UNIX
38
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/pdf" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022/pages?mode=quickDisplay" >
exportpdffile.pdf
例
Excel 2003 (ページ区切りモード) でのドキュメントのエクスポート
結果を excel2003.xls ファイルにエクスポートします。
Windows
curl -G -s -H "accept:application/vnd.ms-excel" -H X-SAP-LogonToken:"""%tokenValue
%""" "http://<serverName>:6405/biprws/raylight/v1/documents/8022/pages?
mode=normal" > excel2003.xls
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.ms-excel" -H 'X-SAP-LogonToken:"$logtok"'
"http://<serverName>:6405/biprws/raylight/v1/documents/8022/pages?
mode=normal&orientation=landscape" excel2003.xls
例
Excel 2007 (ページ区切りモード) でのドキュメントのエクスポート
結果を excel2007.xlsx ファイルにエクスポートします。
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -s -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/8022/pages?optimized=true"
> excel2007.xlsx
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -s -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022/pages?optimized=true" >
excel2007.xlsx
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
39
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
BI プラットフォームにログオンする [ページ 10]
3.2.6
スタイル、形式、フォント、スキン、および文字セットの管理
ドキュメントとレポートに関する以下の視覚的な性質を管理できます。
●
設定書式
●
カスタム書式
●
フォントマッピング
●
レポートスキン
●
スタイル
●
CSS スタイルシート
●
文字セット
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.1
宣言済み書式設定の一覧の取得
デフォルトのロケール用に、Web Intelligence サーバで宣言したすべての書式の一覧を取得します。デフォルトの書式と使
用可能な書式を返します。
結果は優先表示ロケール (PVL) に応じて異なります。特定のロケール設定が必要な場合は、HTTP 要求のヘッダでロケー
ルを渡す必要があります。
要求
40
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
GET http://<serverName>:6405/biprws/raylight/vx/configuration/formats
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって指定される使用可能な書式の詳細:
<format default="true" type="Number" sample="1 234,57"> 数値のデフォルトの書式。同様に指定され
る、"通貨"、"日時"、"論理値"、"日付"、および "時刻" のデフォルトの書式。
同様に、その他の使用可能な書式はすべて以下の方法で表現されます。 <format type="DateTime" sample="tuesday
21 september 2004"> <template positive="dddd d mmmm yyyy"/> </format>。
"数値"、"通貨"、"日時"、"論理値"、"日付"、および "時刻" それぞれで使用できる書式には、複数の種類があります。
<formats>
<format default="true" type="Number" sample="1 234,57">
<template positive=""/>
</format>
<format default="true" type="Currency" sample="1 234,57 €; -1 234,57 €">
<template positive="#,##0.00' €'"/>
</format>
<format default="true" type="DateTime" sample="21/09/2004 20:45:30">
<template positive="dd'/'MM'/'yyyy HH':'mm':'ss"/>
</format>
<format default="true" type="Boolean" sample="vrai; faux">
<template positive="BOOLEAN"/>
</format>
<format default="true" type="Date" sample="21/09/2004">
<template positive="dd'/'MM'/'yyyy"/>
</format>
<format default="true" type="Time" sample="20:45:30">
<template positive="HH':'mm':'ss"/>
</format>
<format type="Number" sample="1 234,57">
<template positive="STANDARD"/>
</format>
<format type="Number" sample="1,234567E3">
<template positive="SCIENTIFIC"/>
</format>
<format type="Number" sample="1235; (1235)">
<template positive="0" negative="(0)"/>
</format>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
41
本文 (XML)
<format type="Number" sample="1234,57">
<template positive="0.00"/>
</format>
<format type="Number" sample="1 235">
<template positive="#,##0"/>
</format>
<format type="Currency" sample="1 234,57 €; -1 234,57 €">
<template positive="#,##0.00' €'"/>
</format>
<format type="Currency" sample="1 234,57 €; 1 234,57 €">
<template positive="#,##0.00' €'" negative="[Rouge]#,##0.00' €'"/>
</format>
<format type="DateTime" sample="mardi 21 septembre 2004">
<template positive="dddd d mmmm yyyy"/>
</format>
<format type="DateTime" sample="21 septembre 2004">
<template positive="d mmmm yyyy"/>
</format>
<format type="DateTime" sample="21/09/04">
<template positive="dd'/'MM'/'yy"/>
</format>
<format type="DateTime" sample="20:45:30">
<template positive="HH':'mm':'ss"/>
</format>
<format type="Boolean" sample="vrai; faux">
<template positive="BOOLEAN"/>
</format>
<format type="Percent" sample="123 456,70%">
<template positive="#,##0.00[%]'%'"/>
</format>
</formats>
例
Web Intelligence サーバから各種の書式とそれらのデフォルトの設定を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/formats
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/formats
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 3055
<formats>
<format default="true" type="Number" sample="1 234,57">
42
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<template positive=""/>
</format>
<format default="true" type="Currency" sample="1 234,57 €; -1 234,57 €">
<template positive="#,##0.00' €'"/>
</format>
<format default="true" type="DateTime" sample="21/09/2004 20:45:30">
<template positive="dd'/'MM'/'yyyy HH':'mm':'ss"/>
</format>
<format default="true" type="Boolean" sample="vrai; faux">
<template positive="BOOLEAN"/>
</format>
<format default="true" type="Date" sample="21/09/2004">
<template positive="dd'/'MM'/'yyyy"/>
</format>
<format default="true" type="Time" sample="20:45:30">
<template positive="HH':'mm':'ss"/>
</format>
<format type="Number" sample="1 234,57">
<template positive="STANDARD"/>
</format>
<format type="Number" sample="1,234567E3">
<template positive="SCIENTIFIC"/>
</format>
<format type="Number" sample="1235; (1235)">
<template positive="0" negative="(0)"/>
</format>
<format type="Number" sample="1234,57">
<template positive="0.00"/>
</format>
<format type="Number" sample="1 235">
<template positive="#,##0"/>
</format>
<format type="Currency" sample="1 234,57 €; -1 234,57 €">
<template positive="#,##0.00' €'"/>
</format>
<format type="Currency" sample="1 234,57 €; 1 234,57 €">
<template positive="#,##0.00' €'" negative="[Rouge]#,##0.00' €'"/>
</format>
<format type="DateTime" sample="mardi 21 septembre 2004">
<template positive="dddd d mmmm yyyy"/>
</format>
<format type="DateTime" sample="21 septembre 2004">
<template positive="d mmmm yyyy"/>
</format>
<format type="DateTime" sample="21/09/04">
<template positive="dd'/'MM'/'yy"/>
</format>
<format type="DateTime" sample="20:45:30">
<template positive="HH':'mm':'ss"/>
</format>
<format type="Boolean" sample="vrai; faux">
<template positive="BOOLEAN"/>
</format>
<format type="Percent" sample="123 456,70%">
<template positive="#,##0.00[%]'%'"/>
</format>
</formats>
関連リンク
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
43
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.2
取得
ドキュメント内の数値で使用されているカスタム書式の一覧の
この URL を使用して、ドキュメント内で定義されたカスタム書式の数値のリストを取得します。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
書式の一覧の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/formats
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
44
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
application/xml または application/json
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
Web Intelligence ドキュメントで使用されているカスタム書式の説明。
: ドキュメント ID
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formats>
<format type="Custom" sample="1,235"> 書式の名前、数値サンプル
<template positive="#,##0" negative="[red]#,##0" zero="No value" undefined="NaN" > 数値書式と定義されて
いる色。この例では、負の数値は赤色になります。
</template>
</format>
</formats>
例
ドキュメント ID 4326 の数値書式を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/4326/formats
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/
raylight/v1/documents/4326/formats
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formats>
<format type="Custom" sample="1,235">
<template positive="#,##0" negative="[red]#,##0"
zero="No value" undefined="NaN">
</template>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
45
</format>
</formats>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.3
サーバのすべての宣言済みフォントマッピングの取得
Web Intelligence サーバのすべての宣言済みフォントマッピングのリストを取得します。 HTML、Java、および Windows の
3 つの使用可能なプラットフォームがあり、これらのフォントマッピングは異なります。この呼び出しにより、すべてのプラットフ
ォームのすべてのマッピングが返されます。
要求
GET http://<serverName>:6405/biprws/raylight/vx/configuration/fontmappings
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
Web Intelligence サーバのすべての宣言済みフォントマッピングのリストを示します。
46
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<fontmappings>: フォントマッピング情報を囲むタグ
<mapping platform="HTML"> ...</mapping>: "HTML"、"JAVA"、または "WINDOWS" のマッピングプラットフォ
ームのフォントを含みます。
<font> ... </font>: 返されたプラットフォームのフォント定義を囲みます。
<serverName>Arial</serverName>: フォントサーバの名前。
<platformName>Arial, Helvetica... : 使用可能なフォント。名前が 2 語以上のフォントはかっこで囲まれます。
例
Web Intelligence サーバのフォントマッピングの取得
次の例では、3 つのサーバすべてのフォントマッピングが返され、さらに、HTML プラットフォーム用日本語サーバのフォン
トマッピングが返されます。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/fontmappings
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/fontmappings
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<fontmappings>
<mapping platform="HTML">
<font>
<serverName>Arial</serverName>
<platformName>Arial, Helvetica, 'Courier New', 'Times New Roman'</
platformName>
</font>
<font>
<serverName>BOJapan</serverName>
<platformName>'MS Gothic', 'Arial Unicode MS'</platformName>
</font>
</mapping>
<mapping platform="Java">
<font>
<serverName>Arial</serverName>
<platformName>Arial, Helvetica, 'Courier New', 'Times New Roman'</
platformName>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
47
</font>
</mapping>
<mapping platform="Windows">
<font>
<serverName>Arial</serverName>
<platformName>Arial</platformName>
</font>
<font>
<serverName>default</serverName>
<platformName>Arial</platformName>
</font>
</mapping>
</fontmappings>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.4
すべての宣言済みレポートスキンの一覧の取得
Web Intelligence サーバにあるすべての宣言されたスキンの一覧を取得します。使用可能なスキンのタイプは 4 つありま
す。
●
セル
●
ブロック
●
セクション
●
レポート
この呼び出しにより、すべてのタイプのすべてのスキンが返されます。
使用可能なスキンの詳細の取得
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/configuration/skins
48
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別される使用可能なスキンの詳細:
<skins> 定義済みスキンの一覧が含まれます。
<skin type="Cell"> 一意の名前 <name>Skin_name</name> によって識別されるスキンのタイプ。 4 つのタイプ
があり、各タイプに多数のスキンが存在します。 4 つのタイプは以下のとおりです。
●
"セル"
●
"ブロック"
●
"セクション"
●
"レポート"
スキンの背景の塗りつぶしの色、パターン、または gif URL は、以下のように定義されます。
<background>
<color rgb="#ffffff>
image src="boimg://skin_marble.gif" display="Tile"/>
</background>
例
使用可能なスキンの詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/skins
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
49
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/skins
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<skins>
<skin type="Cell">
<name>Curve</name>
<background> <color rgb="#ffffff"/> <image src="boimg://skin_marble.gif"
display="Tile"/>
</background>
</skin>
<skin type="Cell">
<name>Business Objects</name>
<background> <color rgb="#ffffff"/>
display="Stretch"/>
</background>
</skin>
<skin type="Block">
<name>Business Objects</name>
<background> <color rgb="#ffffff"/>
display="Stretch"/>
</background>
</skin>
<image src="boimg://skin_bo.gif"
<image src="boimg://skin_bo.gif"
<skin type="Section">
<name>Business Objects</name>
<background> <color rgb="#ffffff"/> <image src="boimg://skin_bo.gif"
display="Stretch"/>
</background>
</skin>
<skin type="Section">
<name>Dots</name>
<background> <color rgb="#ffffff"/> <image src="boimg://skin_listing.gif"
display="Tile"/>
</background>
</skin>
<skin type="Report">
<name>Dots</name>
<background> <color rgb="#ffffff"/> <image src="boimg://skin_listing.gif"
display="Tile"/>
</background>
</skin>
</skins>
50
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.5
ドキュメント内のスタイルの一覧の取得
この URL を使用して、以下の操作を行います。
●
指定したドキュメント内のすべての定義されたスタイルの一覧の取得 (GET <url>/documents/{documentId}/
styles)
●
ドキュメントへの新しいスタイルの追加 (POST <url>/documents/{documentId}/styles)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
Web Intelligence ドキュメントの定義されたスタイルの取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
応答:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
51
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<styles>
<style>
<id>1</id> <background> <color rgb="#ffffff"/> </background>
<alignment horizontal="left" vertical="bottom"/>
</style>
<style>
<id>2</id> <parentId>1</parentId> <border> <top thickness="none" rgb="#000000"
style="none"/> <bottom thickness="thin" rgb="#000000" style="plain"/> <left
thickness="none" rgb="#000000" style="none"/> <right thickness="none" rgb="#000000"
style="none"/> </border> <font size="12" face="Arial" italic="false" bold="true"
strikethrough="false" underline="false" rgb="#000000"/> <alignment horizontal="left"
vertical="bottom"/>
</style>
<style>
<id>3</id> <parentId>1</parentId> <border> <top thickness="thin" rgb="#cacad9"
style="plain"/> <bottom thickness="thin" rgb="#cacad9" style="plain"/> <left
thickness="thin" rgb="#cacad9" style="plain"/> <right thickness="thin" rgb="#cacad9"
style="plain"/> </border> <background> <color rgb="#5175b9"/> </background> <font
size="9" face="Arial" italic="false" bold="true" strikethrough="false"
underline="false" rgb="#ffffff"/> <alignment horizontal="left" vertical="bottom"/>
</style>
</styles>
例
ドキュメント ID 3422 の定義されたスタイルを取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/3422/styles
UNIX
52
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
3422/styles
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<styles>
<style>
<id>1</id>
<background>
<color rgb="#ffffff"/>
</background>
<alignment horizontal="Left" vertical="Bottom"/>
</style>
<style>
<id>2</id>
<parentId>1</parentId>
<border>
<top thickness="None" rgb="#000000" style="None"/>
<bottom thickness="Thin" rgb="#000000" style="Plain"/>
<left thickness="None" rgb="#000000" style="None"/>
<right thickness="None" rgb="#000000" style="None"/>
</border>
<font size="12" face="Arial" italic="false" bold="true"
strikethrough="false" underline="false" rgb="#000000"/>
<alignment horizontal="Left" vertical="Bottom"/>
</style>
<style>
<id>3</id>
<parentId>1</parentId>
<border>
<top thickness="Thin" rgb="#cacad9" style="Plain"/>
<bottom thickness="Thin" rgb="#cacad9" style="Plain"/>
<left thickness="Thin" rgb="#cacad9" style="Plain"/>
<right thickness="Thin" rgb="#cacad9" style="Plain"/>
</border>
<background>
<color rgb="#5175b9"/>
</background>
<font size="9" face="Arial" italic="false" bold="true"
strikethrough="false" underline="false" rgb="#ffffff"/>
<alignment horizontal="Left" vertical="Bottom"/>
<style>
</styles>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
53
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.6
ドキュメントへの新しいスタイルの追加
Web Intelligence ドキュメントへの新しいスタイルの追加
backgroundstyle.xml など、スタイル定義を含む XML ファイルで、新しいスタイルを定義します。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
本文 (XML)
スタイル定義を含む XML ファイル。backgroundstyle.xml など。
<style> <background width="100" height="50"/> </style>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
54
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Style' with identifier 'StyleId} ' has been
successfully created.</message>
<id>{StyleId}</id>
</success>
例
ドキュメント ID 3422 にスタイルを追加する
ファイル backgroundstyle.xml を呼び出し、背景スタイルを追加します。
Windows
curl -i X "POST" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@backgroundstyle.xml" http://<serverName>:
6405/biprws/raylight/v1/documents/3422/styles
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' -d "@backgroundstyle.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/3422/styles
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Style' with identifier '64' has been
successfully created.</message>
<id>64</id>
</success>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
55
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.7
スタイル定義の取得
この URL を使用して、以下の操作を行います。
●
スタイルの詳細な説明の取得 (GET <url>/documents/{documentId}/styles/{styleId})
注記
{styleId}: Web Intelligence ドキュメントのスタイルの識別子は、次によってドキュメントのスタイル一覧から取得され
ます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
指定した Web Intelligence ドキュメントの詳細の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles/
{styleId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
56
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
styleId
ドキュメントスタイルの有効な ID
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別されるドキュメントスタイルの詳細:
<style>
<id>3</id>
<parentId>58</parentId>
<border>
<top thickness="thin" rgb="#cacad9" style="plain"/>
<bottom thickness="thin" rgb="#cacad9" style="plain"/>
<left thickness="thin" rgb="#cacad9" style="plain"/>
<right thickness="thin" rgb="#cacad9" style="plain"/>
</border>
<background>
<color rgb="#5175b9"/> </background>
<font size="9" face="Arial" italic="false" bold="true" strikethrough="false"
underline="false" rgb="#ffffff"/>
<alignment horizontal="left" vertical="bottom"/>
</style>
例
ドキュメント 5022 のドキュメントスタイルを取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/5022/styles/?styleId=cccTODO
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
57
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
5022/styles/?styleId=cccTODO
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<style>
<id>3</id>
<parentId>58</parentId>
<border>
<top thickness="thin" rgb="#cacad9" style="plain"/>
<bottom thickness="thin" rgb="#cacad9" style="plain"/>
<left thickness="thin" rgb="#cacad9" style="plain"/>
<right thickness="thin" rgb="#cacad9" style="plain"/>
</border>
<background>
<color rgb="#5175b9"/>
</background>
<font size="9" face="Arial" italic="false" bold="true" strikethrough="false"
underline="false" rgb="#ffffff"/>
<alignment horizontal="left" vertical="bottom"/>
</style>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.8
ドキュメントスタイルの削除
この URL を使用して、以下の操作を行います。
58
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
スタイル定義の削除 (DELETE <url>/documents/{documentId}/styles/{styleId})
ドキュメントスタイルの削除
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles/
{styleId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
styleId
ドキュメントスタイルの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Style' with identifier '{StyleId} ' has been
successfully deleted.</message>
<id>{StyleId}</id>
</success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
59
例
ドキュメント 5022 のスタイル L4 を削除する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/styles/?L4
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/5022/styles/?L4
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Style' with identifier 'L4' has been
successfully removed.</message>
<id>L4</id>
</success>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの更新 [ページ 61]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
60
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.2.6.9
ドキュメントスタイルの更新
この URL を使用して、以下の操作を行います。
●
スタイル定義の更新 (PUT <url>/documents/{documentId}/styles/{styleId})
ドキュメントスタイルの更新
ドキュメントで使用する styleId を宣言します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/styles/
{styleId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
styleId
ドキュメントスタイルの有効な ID
本文 (XML)
以下によって、ドキュメントスタイルの定義を含む xml ファイルを識別します。
<style>
<id>3</id>
<parentId>58</parentId>
<border>
<top thickness="thin" rgb="#cacad9" style="plain"/>
<bottom thickness="thin" rgb="#cacad9" style="plain"/>
<left thickness="thin" rgb="#cacad9" style="plain"/>
<right thickness="thin" rgb="#cacad9" style="plain"/>
</border>
<background>
<color rgb="#5175b9"/> </background>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
61
本文 (XML)
<font size="9" face="Arial" italic="false" bold="true" strikethrough="false"
underline="false" rgb="#ffffff"/>
<alignment horizontal="left" vertical="bottom"/>
</style>
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Style' with identifier '{StyleId} ' has been
successfully updated.</message>
<id>{StyleId}</id>
</success>
例
ドキュメント 5022 のスタイル (スタイル ID 24) を更新する
この例では、スタイル定義を含む xml ファイル (style3.xml) を記述します。
<style>
<id>3</id>
<parentId>58</parentId>
<border>
<top thickness="thin" rgb="#cacad9" style="plain"/>
<bottom thickness="thin" rgb="#cacad9" style="plain"/>
<left thickness="thin" rgb="#cacad9" style="plain"/>
<right thickness="thin" rgb="#cacad9" style="plain"/>
</border>
<background>
<color rgb="#5175b9"/>
</background>
<font size="9" face="Arial" italic="false" bold="true" strikethrough="false"
underline="false" rgb="#ffffff"/>
<alignment horizontal="left" vertical="bottom"/>
</style>
62
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@style.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/5022/styles/?24
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' -d "@style.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/styles/?24
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Style' with identifier '24' has been
successfully updated.</message>
<id>24</id>
</success>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
CSS: ドキュメントの CSS の取得または更新 [ページ 63]
3.2.6.10 CSS: ドキュメントの CSS の取得または更新
この URL を使用して、以下の操作を行います。
●
ドキュメントの CSS の取得 (GET <url>/documents/{documentId}/css)
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
63
●
ドキュメントの CSS の更新 (PUT <url>/documents/{documentId}/css)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
指定したドキュメントの CSS の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/css
ヘッダ
値
Accept
text/css
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須。ドキュメントの ID。
応答:
ドキュメント CSS を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/css
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
ドキュメントの CSS の詳細
例
ドキュメント ID 451 の CSS を取得する
Windows
curl -G -i -H "accept:text/css" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/451/css
UNIX
64
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/css" 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/documents/451/css
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
FORM CELL.ia-form-header {
/*
background-fill:color;
font-size:9pt;
color:#1D7DB3;
background-color:#f8fbfc;
font-weight-bold:yes;
never-alternate:yes;
}
Settings for header cells in a form
*/
CELL.ia-form-separator {
/* Settings for cells separating two form
instances */
background-fill:none;
/* Invisible cell making the separation */
border-top-style:none;
border-right-style:none;
border-bottom-style:none;
border-left-style:none;
border-top-width:0;
border-right-width:0;
border-bottom-width:0;
border-left-width:0;
}
指定したドキュメントの CSS の更新
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/css
ヘッダ
値
Accept
application/xml
X-SAP-LogonToken
必須。引用符で囲まれた SAP ログオントークン
パラメータ
説明
documentId
必須。ドキュメントの ID。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
65
本文 (XML)
CSS ファイル
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/css
Content-Length
応答本文のコンテンツの長さ
ボディ
成功の場合:
<success>
<message>The resource of type 'CSS' has been successfully updated.</message>
<id>11416</id>
<success>
それ以外の場合: <error> ... </error>
例
ドキュメント 5022 の CSS を更新する
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/css" -H X-SAPLogonToken:"""%tokenValue%""" -d "@css2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/css
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/css" -H 'X-SAPLogonToken:"$logtok"' -d "@css2.xml" http://<serverName>:6405/biprws/raylight/v1/
documents/5022/css
ファイル css2.xml に記述された要求本文
66
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
FORM CELL.ia-form-header {
/*
background-fill:color;
font-size:9pt;
color:#1D7DB3;
background-color:#f8fbfc;
font-weight-bold:yes;
never-alternate:yes;
}
Settings for header cells in a form
*/
CELL.ia-form-separator {
/* Settings for cells separating two form
instances */
background-fill:none;
/* Invisible cell making the separation */
border-top-style:none;
border-right-style:none;
border-bottom-style:none;
border-left-style:none;
border-top-width:0;
border-right-width:0;
border-bottom-width:0;
border-left-width:0;
}
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Document' with identifier '5022' has been
successfully updated.</message>
<id=“5022“></id>
</success>
関連リンク
宣言済み書式設定の一覧の取得 [ページ 40]
ドキュメント内の数値で使用されているカスタム書式の一覧の取得 [ページ 44]
サーバのすべての宣言済みフォントマッピングの取得 [ページ 46]
すべての宣言済みレポートスキンの一覧の取得 [ページ 48]
ドキュメント内のスタイルの一覧の取得 [ページ 51]
ドキュメントへの新しいスタイルの追加 [ページ 54]
スタイル定義の取得 [ページ 56]
ドキュメントスタイルの削除 [ページ 58]
ドキュメントスタイルの更新 [ページ 61]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
67
3.2.6.11
サポートされる文字セットのリストの取得
Web Intelligence サーバで、すべてのサポートされる文字セットのリストを取得します。文字セットは、CSV 形式でドキュメン
トをエクスポートするときに、パラメータとして使用されます。
この呼び出しにより、サポートされる文字セットのリストが返されます。
サポートされる文字セットの取得
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/configuration/charsets
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
応答本文 (XML)
サポートされる文字セットの詳細。以下により、各文字セットが識別される。
<charset> サポートされる文字セットの説明を記載。
<name>EUC-KR</name> 文字セット名。
<description>Korean (EUC-KR)</description> 文字セットの説明
例
サポートされる文字セットの詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/charsets
UNIX
68
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/charsets
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<charsets>
<charset>
<name>EUC-KR</name>
<description>Korean (EUC-KR)</description>
</charset>
<charset>
<name>ISO-8859-8</name>
<description>Hebrew (ISO-8859-8)</description>
</charset>
<charset>
<name>ISO-8859-5</name>
<description>Cyrillic (ISO-8859-5)</description>
</charset>
. . .
<charset>
<name>UTF-8</name>
<description>UTF-8</description>
</charset>
<charset>
<name>HZ-GB-2312</name>
<description>Chinese Simplified (HZ-GB2312)</description>
</charset>
<charset>
<name>CNS-11643</name>
<description>Chinese Traditional (EUC-TW)</description>
</charset>
<charset>
<name>CP437</name>
<description>IBM Latin US (CP437)</description>
</charset>
</charsets>
3.2.7
関数、演算子、および変数の管理
この節では、式エンジン関数と演算子の管理、および変数の管理に使用できるさまざまな方法について説明します。
●
使用可能な式エンジン関数の一覧の取得 (GET <url>/configuration/functions)
●
使用可能な式エンジン演算子の一覧の取得 (GET <url>/configuration/operators)
●
ドキュメントの変数辞書のコンテンツの取得 (GET <url>/documents/{documentId}/variables)
●
ドキュメントの変数辞書に対する新しい式の追加 (POST <url>/documents/{documentId}/variables )
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
69
●
ドキュメントの変数辞書からの変数の定義の取得 (GET <url>/documents/{documentId}/variables/
{variableId})
●
ドキュメントの変数辞書からの変数の定義の変更 (PUT <url>/documents/{documentId}/variables/
{variableId})
●
ドキュメントの変数辞書からの変数の削除 (DELETE <url>/documents/{documentId}/variables/
{variableId})
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.1
使用可能な式エンジン関数の一覧の取得
使用可能な式エンジンの関数をすべて取得します。これは、レポート仕様に式を作成する、またはドキュメント辞書に変数を
定義するために使用できます。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/configuration/functions
注
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
70
application/xml または
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
以下に説明する、指定したデータプロバイダに添付されたクエリ仕様の詳細
<functions> 関数の一覧とその説明を含みます。
<function category="Logical" returnType="Boolean"> 関数のタイプ
<id>EVEN</id> 関数の ID
<name>Even</name>
<description></description> 関数の説明
<syntax>bool Even(number)</syntax>
例
関数の説明をすべて取得する
以下の例では、関数の説明をすべて取得する方法を示しています。返された本文の例には 2 つの例のみ示しています。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/functions
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/functions
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<functions>
<function category="Logical" returnType="Boolean">
<id>EVEN</id>
<name>Even</name>
<description>Determines whether a number is even</description>
<syntax>bool Even(number)</syntax>
</function>
<function category="Document" returnType="String">
<id>DOCUMENTAUTHOR</id>
<name>DocumentAuthor</name>
<description>Returns the InfoView logon of the document creator</description>
<syntax>string DocumentAuthor()</syntax>
</function>
</functions>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
71
関連リンク
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.2
使用可能な式エンジン演算子の一覧の取得
式エンジンの演算子をすべて取得します。これは、レポート仕様に式を作成する、またはドキュメント辞書に変数を定義する
ために使用できます。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/configuration/operators
注
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
式エンジンから使用できるドキュメント演算子の詳細。各演算子は、次のとおりです。
<operators> 演算子の説明の一覧を含みます。
<operator> 演算子の説明の先頭。
<id>LINEAR</id> 演算子の ID。
<name> Linear</name> 演算子の名前。
72
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<description>...</description> 演算子の説明。
<syntax>Linear</syntax> 演算子の構文。
</operator>
...
...
</operators>
例
すべての演算子の説明を取得する
以下の例では、すべての演算子の説明を取得する方法を示しています。返された本文の例には 2 つの例のみ示していま
す。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/configuration/operators
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/configuration/operators
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<operators>
<operator>
<id>LINEAR</id>
<name>Linear</name>
<description>Tells the Interpolation function to use linear regression to
supply missing measure values</description>
<syntax>Linear</syntax>
</operator>
<operator>
<id>INLIST</id>
<name>InList</name>
<description>Determines if a value is in a list</description>
<syntax>bool test_value Inlist(value_list)</syntax>
</operator>
</operators>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
73
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.3
変数の一覧の取得
このレポートを使用して、以下の操作を行います。
●
ドキュメントの変数辞書のコンテンツの取得 (GET <url>/documents/{documentId}/variables)
ドキュメントの変数辞書のコンテンツの取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/variables
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
応答:
ドキュメント一覧を含む XML または Json フロー。
74
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
ドキュメントで使用される変数の説明。各変数は、次のように記述されます。
<variable dataType="Numeric" qualification="Measure">データの型 (数値、文字列、xxx,、および資格 (メジャー、デ
ィメンション、ss)
<id>L6</id> 変数の識別子
<name>Min Revenue</name> ドキュメントで使用されている変数の名前
例
ドキュメント ID 4326 で使用される変数の定義の取得
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/4326/formats
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/
raylight/v1/documents/4326/formats
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<variables>
<variable dataType="Numeric" qualification="Measure">
<id>L6</id>
<name>Min Revenue</name>
</variable>
<variable dataType="Numeric" qualification="Measure">
<id>L7</id>
<name>RevenueThreshold</name>
</variable>
<variable dataType="Numeric" qualification="Measure">
<id>L8</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
75
<name>Threshold factor</name>
</variable>
<variable dataType="Numeric" qualification="Measure">
<id>L9</id>
<name>Threshold Max</name>
</variable>
<variable dataType="Numeric" qualification="Measure">
<id>LA</id>
<name>Threshold Min</name>
</variable>
</variables>
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.4
変数定義の追加
ドキュメントの変数辞書に対する新しい式の追加
現在のパス (通常は cURL ツールと同じパス) に保存されている XML ファイルに定義されている本文の式を定義します。た
とえば、variable2.xml です。
注記
式が有効である必要があります。
注記
メジャー、属性、またはディメンションのみを作成できます。
注記
属性を作成する場合、関連付けられたディメンションが必須です。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/variables
76
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
本文 (XML)
ドキュメントで使用される変数の定義を含む XML ファイル。各変数は、次のように記述されます。
<variable qualification= "Measure" >
<name>New variable</name>
<definition>=[RevenueThreshold]*[Threshold factor]</definition> ドキュメントで使用される式の定義。 </
definition>
</variable>
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Variable' with identifier '{LB} ' has been
successfully created.</message>
<id>{LB}</id>
</success>
それ以外の場合: <error> ... </error>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
77
例
ドキュメント ID 4326 への新しい変数定義の追加
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@variable2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
4326/variables
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H 'X-SAP-LogonToken:"$logtok"' -d "@variable2.xml" http://
<serverName>:6405/biprws/raylight/v1/documents/4326/variables
応答
HTTP/1.1 200 OK
Server:Apache-Coyote/1.1
Date: Mon, 04 Jun 2012 11:59:02 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type 'Variable' with identifier 'LB' has been
successfully created.</message>
<id>LB</id>
</success>
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数の一覧の取得 [ページ 74]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.5
変数の定義の取得
これを使用して、以下の操作を行います。
●
78
ドキュメントの変数辞書からの変数の定義の取得 (GET <url>/documents/{documentId}/variables/
{variableId})
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{variableId}: Web Intelligence 変数の識別子は、以下によってドキュメントの変数一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents/documentId/variables
ドキュメントで使用されている変数の定義の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/variables/
{variableId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須。ドキュメントの ID。
variableId
必須。宣言されたドキュメントによって使用される変数の
ID。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下のように記述された、変数の定義:
<variable dataType="Numeric" qualification="Measure"> 変数の型と資格
<id>L9</id> 変数の識別子
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
79
本文 (XML)
<name>Threshold Max</name> ドキュメントで使用されるとおりの変数の名前
<description></description> 変数の説明 (オプション)。変数の使用方法の説明に使用できます。
<formulaLanguageId>[Threshold Max]</formulaLanguageId>
<definition>=[RevenueThreshold]*(1+[Threshold factor])</definition> 変数で使用する式
</variable>
例
変数 'L9' の定義を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/variables/?
variableId=L9
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/variables/?variableId=L9
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<variable dataType="Numeric" qualification="Measure">
<id>L9</id>
<name>Threshold Max</name>
<description></description>
<formulaLanguageId>[Threshold Max]</formulaLanguageId>
<definition>=[RevenueThreshold]*(1+[Threshold factor])</definition>
</variable>
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
80
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数定義の変更 [ページ 81]
変数定義の削除 [ページ 83]
3.2.7.6
変数定義の変更
ドキュメントで使用されている変数の定義の変更
これを使用して、以下の操作を行います。
●
ドキュメントの変数辞書からの変数の定義の変更 (PUT <url>/documents/{documentId}/variables/
{variableId})
変更できる変数の性質は、変数の資格、名前、式です。
注記
変更された式が有効である必要があります。
注記
変数の定義を変更した場合、変更をレポートに反映するため、ドキュメントを最新表示する必要があります。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/variables/
{variableId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン。
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
variableId
必須入力項目です。宣言されたドキュメントによって使用さ
れる変数の ID。
本文 (XML)
以下のように記述された、XML ファイル内の変数の新しい定義。
<variable qualification="Measure">
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
81
本文 (XML)
<name>Updated variable</name>
<definition>=[RevenueThreshold]*[Threshold factor]/10</definition>
</variable>
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Variable' with identifier '{variableId} ' has been
successfully updated.</message>
<id>{VariableId}</id>
</success>
例
変数を変更する
現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本文の変更される変数
を定義します。たとえば、variable3.xml です。
本文 (XML) "variable3.xml"
以下のように記述された、XML ファイル内の変数の新しい定義。
<variable qualification="Measure">
<name>Updated variable</name>
<definition>=[RevenueThreshold]*[Threshold factor]/10</definition>
</variable>
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@variable3.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8022/variables/?variableId=L9
82
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' -d "@variable3.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/8022/variables/?variableId=L9
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Variable' with identifier 'L9' has been
successfully updated.</message>
<id>L9</id>
</success>
注記
変更をレポートに反映するため、忘れずにドキュメントを最新表示します。
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の削除 [ページ 83]
3.2.7.7
変数定義の削除
ドキュメントの変数辞書からの変数の削除
以下を使用して、以下の操作を行います。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
83
●
ドキュメントの変数辞書からの変数の削除 (DELETE <url>/documents/{documentId}/variables/
{variableId})
ドキュメントの変数辞書から、変数を削除できます。変数がドキュメントのクエリによって使用されていないことを確認してくだ
さい。
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/variables/
{variableId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
variableId
必須入力項目です。削除するする変数の ID です。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Variable' with identifier '{variableId} ' has been
successfully deleted.</message>
<id>{variableId}</id>
</success>
84
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
変数辞書から変数 (L9) を削除する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/
raylight/v1/documents/8022/variables/?variableId=L9
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/8022/variables/?variableId=L9
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Variable' with identifier 'L9' has been
successfully deleted.</message>
<id>L9</id>
</success>
関連リンク
使用可能な式エンジン関数の一覧の取得 [ページ 70]
使用可能な式エンジン演算子の一覧の取得 [ページ 72]
変数の一覧の取得 [ページ 74]
変数定義の追加 [ページ 76]
変数の定義の取得 [ページ 78]
変数定義の変更 [ページ 81]
3.2.8
アラータおよび変更の追跡の管理
この節では、アラータおよびデータ変更の追跡機能の管理管理に使用できるさまざまな方法について説明します。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
85
アラータ
アラータは選択されたデータ内変更を追跡したり、変更されたデータの表示を設定するのに使用します。データの変更をフォ
ーマットするためのカスタムアラータを作成するには、式言語を使用してください。データの変更に基づいた特別な計算を含
めることができます。たとえば、メジャーの前の値と現在の値の差を表示する計算を含めることができます。
この URL を使用して、以下の操作を行います。
●
ドキュメント内のすべての定義されたアラータの一覧の取得 (GET <url>/documents/{documentId}/
alerters)
●
ドキュメントへの新しいアラータの追加 (POST <url>/documents/{documentId}/alerters)
●
指定したアラータの完全な説明の取得 (GET <url>/documents/{documentId}/alerters/{alerterId})。
●
指定したアラータの説明の更新 (PUT <url>/documents/{documentId}/alerters/{alerterId})。
●
指定したアラータの削除 (DELETE <url>/documents/{documentId}/alerters/{alerterId})。
注記
{alerterId}: 次によってドキュメントのアラータ一覧から取得される Web Intelligence ドキュメントのアラータの識別
子。 GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
追跡データ
データの変化を追跡するときは、基準点として特定のデータの最新表示を選択します。このデータは参照データと呼ばれま
す。データ追跡を有効にすると、参照データに関するデータを見ることができます。
自動またはマニュアルで変更を追跡するための書式設定。次のデータ変更の種類を追跡できます。
●
挿入されたデータ
●
削除されたデータ
●
変更されたデータ
●
増加した値
●
減少した値
自動データ追跡モードでは、現在のデータを最終の最新表示前のデータと常に比較します。これは、各最新表示の前に現在
のデータを参照データとして設定し、自動的に実行されます。参照データは常に現在のデータの 1 つ前の最新表示です。自
動データ追跡は、現在のデータを最終の最新表示前のデータと比較したい場合の定期配信ドキュメントに適しています。
手動データ追跡モードでは、参照データを手動で選択します。参照点が更新されるまで、このデータを参照点として使用し続
けます。
これを使用して、以下の操作を行います。
86
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
トラッカ情報の取得 (GET <url>/documents/{documentId}/tracker)
●
トラッカリソースの登録 (POST <url>/documents/{documentId}/tracker)
●
追跡データ情報の更新 (PUT <url>/documents/{documentId}/tracker)
●
トラッカリソースの削除 (DELETE <url>/documents/{documentId}/tracker)
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.1
アラータの一覧の取得
この URL を使用して、以下の操作を行います。
●
ドキュメント内のすべての定義されたアラータの一覧の取得 (GET <url>/documents/{documentId}/
alerters)
●
ドキュメントへの新しいアラータの追加 (POST <url>/documents/{documentId}/alerters)
注記
{alerterId}: 次によってドキュメントのアラータ一覧から取得される Web Intelligence ドキュメントのアラータの識別
子。GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
指定されたドキュメントに定義されているすべてのアラータの一覧の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
87
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
ドキュメントアラータの一覧。各アラータは以下により識別されます。
<id>{alerterId}</id>: アラータの ID。
<name>{alerterName}</name>: アラータの名前。
<description>...</description>: アラータの説明 (存在する場合)。
例
ドキュメント ID 1223 のアラータの一覧を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/1223/alerters"
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/1223/alerters"
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
88
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Content-Type: application/xml
Content-Length: 355
<alerter>
<id>1</id>
<name>Sales Revenue</name>
<description>Test Raylight</description>
<rule>
<conditions>
<condition expressionId="DP0.DO93" operator="Greater">
<operand>2000000</operand>
</condition>
</conditions>
<action>
<data>
<formula type="HyperLink">test</formula>
<format type="Custom">
<template positive="STANDARD"/>
</format>
</data>
<style>
<background>
<color rgb="#ffff00"/>
</background>
<font rgb="#ff0000"/>
</style>
</action>
</rule>
</alerter>
関連リンク
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.2
アラータの説明の取得
この URL を使用して、以下の操作を行います。
●
指定したアラータの完全な説明の取得 (GET <url>/document/{documentId}/alerters/{alerterId})。
●
指定したアラータの説明の更新 (PUT <url>/document/{documentId}/alerters/{alerterId})。
●
指定したアラータの削除 (DELETE <url>/document/{documentId}/alerters/{alerterId})。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
89
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{alerterId}: Web Intelligence ドキュメントアラータの識別子は、以下によってドキュメントのアラータ一覧から取得さ
れます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/
alerters
アラータの説明の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters/
{alerterId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
alerterId
ドキュメントのアラータの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別されるドキュメントアラータの詳細:
<id>{alerterId}</id>: アラータの ID。
<name>{alerterName}</name>: アラータの名前。
90
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<description>...</description>: アラータの説明 (存在する場合)。
<rule>...</rule>: ルールの定義。
<action>...</action>: ドキュメントの書式に影響を与える定義。
例
ドキュメント 8022 のアラータ 3 の説明を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/alerters/?alerterId=3
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/alerters/?alerterId=3
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 720
<alerter>
<id>1</id>
<name>Sales Revenue</name>
<description>Test Raylight</description>
<rule>
<conditions>
<condition expressionId="DP0.DO93" operator="Greater">
<operand>2000000</operand>
</condition>
</conditions>
<action>
<data>
<formula type="HyperLink">test</formula>
<format type="Custom" sample="1á234,57">
<template positive="STANDARD"/>
</format>
</data>
<style>
<background>
<color rgb="#ffff00"/>
</background>
<font rgb="#ff0000"/>
</style>
</action>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
91
</rule>
</alerter>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.3
アラータの説明の更新
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters/
{aleterId}
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents/
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
alerterId
ドキュメントのアラータの有効な ID
92
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ボディ
XML ファイル内のアラータの説明。たとえば、alerter4.xml というファイルを定義します。
<alerter>
<id>1</id>
<name>Sales Revenue</name>
<description>Test Raylight</description>
<rule>
<conditions>
<condition expressionId="DP0.DO93" operator="Greater">
<operand>2000000</operand>
</condition>
</conditions>
<action>
<data>
<formula type="HyperLink">test</formula>
<format type="Custom" sample="1á234,57">
<template positive="STANDARD"/>
</format>
</data>
<style>
<background>
<color rgb="#ffff00"/>
</background>
<font rgb="#ff0000"/>
</style>
</action>
</rule>
</alerter>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Alerter' with identifier '{alerterId} ' has been
successfully updated.</message>
<id>{alerterId}</id>
</success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
93
例
ドキュメントアラータの説明を更新する (ドキュメント ID=5022、アラータ ID= 2)
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@alerter4.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/5022/alerters/?alerterId=2
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' -d "@alerter4.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/alerters/?alerterId=2
本文:
PUT メソッドで呼び出される、XML ファイル 'alerter4.xml'。
<alerter>
<name>My alerter updated</name>
<description>This is my new alerter updated</description>
<rule>
<expression>="goodbye"</expression>
</rule>
</alerter>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Alerter' with identifier '2' has been
successfully updated.</message>
<id=“2“></id>
</success>
例
2: XML 本文ファイルでの複雑なアラータの更新
以下の本文 XML ファイルは複雑なアラータを定義します。
本文:
94
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
PUT メソッドで呼び出される、XML ファイル 'complexalerter.xml'。 "PUT" 呼び出しでこの XML ファイルを参照しま
す。
<alerter>
<name>Sample 2</name>
<description>Add a complexe alerter using Raylight</description>
<rule>
<conditions>
<condition expressionId="DP0.DO93" operator="Greater">
<operand>10</operand>
<operand>20</operand>
</condition>
<condition expressionId="DP0.DO93" operator="Greater">
<target expressionId="DP0.DO93" />
</condition>
</conditions>
<action>
<data>
<formula type="HyperLink">my hyperlink</formula>
<format type="Custom" sample="1 234,57">
<template positive="STANDARD"/>
</format>
</data>
<style>
<border>
<top thickness="Medium" rgb="#800000" style="Plain"/>
<bottom thickness="Medium" rgb="#800000" style="Plain"/>
<left thickness="Medium" rgb="#800000" style="Plain"/>
<right thickness="Medium" rgb="#800000" style="Plain"/>
</border>
<background width="0" height="0">
<color rgb="#00ff00"/>
<image src="bores://00002">
<alignment horizontal="Left" vertical="Top"/>
</image>
</background>
<font size="12" face="Arial" italic="false" bold="false"
strikethrough="true" underline="true" rgb="#ff6600"/>
<alignment horizontal="Center" vertical="Center"/>
</style>
</action>
</rule>
<rule>
<expression>="hello"</expression>
</rule>
</alerter>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
95
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.4
ドキュメントへのアラータの追加
要求：
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
本文 (XML)
説明
本文は XML ファイルに定義され、要求で呼び出されます。本文には、ア
<alerter>
ラータの名前、説明 (オプション)、および SQL 式を記述します。
<name>My alerter</name>
<description>This is my new
alerter</description>
<rule>
<expression>={the expression for
the alerter}</expression>
</rule>
空の本文
注記
Modified のドキュメントは、要求の本文を使用しません。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
96
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Alerter' with identifier '{alerterId} ' has been
successfully created.</message>
<id>{alerterId}</id>
</success>
例
ドキュメント ID 1223 に新しいアラータを追加する
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@newalerter.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
1223/alerters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@newalerter.xml"
http://<serverName>:6405/biprws/raylight/v1/documents/1223/alerters
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Alerter' with identifier '2' has been successfully
created.</message>
<id>2</id>
</success>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
97
アラータの説明の更新 [ページ 92]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.5
アラータの削除
アラータの削除
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/alerters/
{aleterId}
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents/
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
alerterId
ドキュメントのアラータの有効な ID
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
98
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Alerter' with identifier '{alerterId} ' has been
successfully deleted.</message>
<id>{alerterId}</id>
</success>
例
ドキュメント 5022 のアラータ ID=3 を削除する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/alerters/3
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/5022/alerters/3
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Alerter' with identifier '3' has been
successfully removed.</message>
<id>3</id>
</success>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
99
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.6
ドキュメントのトラッカ設定の取得
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
ドキュメントで使用される追跡データ設定の定義の取得
ドキュメントの現在の追跡データ定義を取得します。このドキュメントで追跡データ機能が有効になっていない場合は、エラー
を返します。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/tracker
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
100
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
application/xml または application/json
応答本文のコンテンツの長さ
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
以下のように記述された、追跡データ情報の定義:
<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
<added active="true"> <background/> <style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000aa"/>
</added>
<changed active="true"> <background rgb="#aabbcc"/> <style italic="false" bold="true" strikethrough="false"
underline="false" rgb="#0000bb"/> </changed>
<removed active="true"> <background/> <style italic="false" bold="true" strikethrough="false"
underline="false" rgb="#0000cc"/> </removed>
<increasing threshold="5.0" applyThreshold="false" active="true"> <background rgb="#33cc33"/> <style
italic="false" bold="true" strikethrough="false" underline="false"/> </increasing>
<decreasing threshold="8.0" applyThreshold="true" active="false"> <background rgb="#33cc33"/> <style
italic="true" bold="false" strikethrough="true" underline="true"/></decreasing></tracker>
場所:
mode: (タイプ = 列挙、("Auto"、"Manual")) 追跡データのモードの変更を指定します。
Auto: 前回のデータの最新表示との比較に基づいて、変更を表示します。
Manual: ユーザ参照からのデータの最新表示との比較に基づいて、変更を表示します。
Threshold: (タイプ = ダブル) 数値データに対して表示変更のしきい値をパーセントで指定します。
エラーの場合に返されるメッセージ: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Tracker' does not exist.</message>
</error>
例
ドキュメント ID 8022 の追跡データ定義を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/tracker
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
101
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/tracker
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
<added active="true">
<background/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000aa"/>
</added>
<changed active="true">
<background rgb="#aabbcc"/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000bb"/>
</changed>
<removed active="true">
<background/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000cc"/>
</removed>
<increasing threshold="5.0" applyThreshold="false" active="true">
<background rgb="#33cc33"/>
<style italic="false" bold="true" strikethrough="false" underline="false"/>
</increasing>
<decreasing threshold="8.0" applyThreshold="true" active="false">
<background rgb="#33cc33"/>
<style italic="true" bold="false" strikethrough="true" underline="true"/>
</decreasing>
</tracker>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
102
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.2.8.7
追跡データ設定の更新
ドキュメントの追跡データ設定の定義の更新
ドキュメントの追跡データ機能を更新します。アラータに適用されるスタイルを更新します。また、変更タイプのビジュアライゼ
ーションを有効/無効にできます。追跡データ定義が指定されていない場合、モードは "手動" に設定され、ドキュメントは参照
用に設定されます。
要求はオプションです。指定されていない場合、デフォルト設定により有効化されるか、または追跡データが以前に有効化さ
れたことがあれば以前の設定により有効化されます。
リソースが作成されていない場合はエラーを返します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/tracker
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
本文 (XML)
以下の使用可能なプロパティから更新する追跡データ設定を定義します。
<tracker mode="Manual">
<added active="true">
<style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000aa"/>
</added>
<changed active="true">
<background rgb="#aabbcc"/>
<style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000bb"/>
</changed>
<removed active="true">
<style italic="false" bold="true" strikethrough="false" underline="false" rgb="#0000cc"/>
</removed>
<increasing threshold="5.0" applyThreshold="false" active="true">
<background rgb="#33cc33"/>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
103
本文 (XML)
<style italic="false" bold="true" strikethrough="false" underline="false"/>
</increasing>
<decreasing threshold="8.0" applyThreshold="true" active="false">
<background rgb="#33cc33"/>
<style italic="true" bold="false" strikethrough="true" underline="true"/>
</decreasing>
</tracker>
応答:
成功メッセージまたはエラーメッセージを含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Tracker' has been successfully updated for document.</
message>
<id>{documentId}</id>
</success>
例
ドキュメントの追跡データ設定を更新する
要求の本文の xml ファイルを記述します。この例では、ファイルは tracker2.xml という名前で、要求内の -d
"@tracker2.xml" により呼び出されています。
本文ファイル (XML) "tracker2.xml"
<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
<added active="true">
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000aa"/>
</added>
<changed active="true">
<background rgb="#aabbcc"/>
104
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文ファイル (XML) "tracker2.xml"
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000bb"/>
</changed>
<removed active="true">
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000cc"/>
</removed>
<increasing threshold="5.0" applyThreshold="false" active="true">
<background rgb="#33cc33"/>
<style italic="false" bold="true" strikethrough="false" underline="false"/>
</increasing>
<decreasing threshold="8.0" applyThreshold="true" active="false">
<background rgb="#33cc33"/>
<style italic="true" bold="false" strikethrough="true" underline="true"/>
</decreasing>
</tracker>
Windows
curl "PUT" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@tracker2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/8022/
tracker
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@tracker2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/8022/tracker
応答:
本文 (XML)
<success>
<message> The resource of type 'Tracker' has been
successfully updated for the document.</message>
<id>{documentId}</id>
</success>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
105
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の作成または有効化 [ページ 106]
追跡データ設定の無効化 [ページ 109]
3.2.8.8
追跡データ設定の作成または有効化
ドキュメントの追跡データ設定の定義の作成
ドキュメントの追跡データ機能を有効化します。
要求はオプションです。指定されていない場合、デフォルト設定により有効化されるか、または TDC が以前に有効化されたこ
とがあれば以前の設定により有効化されます。
リソースが作成されていない場合はエラーを返します。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/tracker
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須。ドキュメントの ID。
本文 (XML)
追跡データ設定の定義。デフォルト設定は、以下のとおりです。
<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
<added active="true"> <background/> <style italic="false" bold="true"
strikethrough="false" underline="false" rgb="#0000aa"/>
</added>
<changed active="true"> <background rgb="#aabbcc"/> <style italic="false" bold="true"
strikethrough="false" underline="false" rgb="#0000bb"/> </changed>
<removed active="true"> <background/> <style italic="false" bold="true"
strikethrough="false" underline="false" rgb="#0000cc"/> </removed>
<increasing threshold="5.0" applyThreshold="false" active="true"> <background
rgb="#33cc33"/> <style italic="false" bold="true" strikethrough="false"
underline="false"/> </increasing>
106
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<decreasing threshold="8.0" applyThreshold="true" active="false"> <background
rgb="#33cc33"/> <style italic="true" bold="false" strikethrough="true"
underline="true"/></decreasing></tracker>
場所:
mode: (タイプ = 列挙、("Auto"、"Manual")) 追跡データのモードの変更を指定します。
Auto: 前回のデータの最新表示との比較に基づいて、変更を表示します。
Manual: ユーザ参照からのデータの最新表示との比較に基づいて、変更を表示します。
Threshold: (type=double) 数値データに対して表示変更のしきい値をパーセントで指定します。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Tracker' has been successfully created for document.</
message>
<id>{TrackerId}</id>
</success>
エラーの場合に返されるメッセージ: HTTP 応答コード: 404
<error>
<error_code>401</error_code>
<message>The resource of type 'Tracker' is already created.</message>
</error>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
107
例
ドキュメントの追跡データ設定を作成する
追跡データの定義は、cURL コマンドの -d "@{filename}.xml" によって呼び出される xml ファイルに指定されています。
このファイルは要求の本文です。この例では、ファイルは tracker1.xml という名前で、要求内の -d "@tracker1.xml" によ
り呼び出されています。
本文ファイル (XML) "tracker1.xml"
<tracker mode="Manual" referenceDate="2012-11-16T10:56:21.951+01:00">
<added active="true">
<background/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000aa"/>
</added>
<changed active="true">
<background rgb="#aabbcc"/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000bb"/>
</changed>
<removed active="true">
<background/>
<style italic="false" bold="true" strikethrough="false" underline="false"
rgb="#0000cc"/>
</removed>
<increasing threshold="5.0" applyThreshold="false" active="true">
<background rgb="#33cc33"/>
<style italic="false" bold="true" strikethrough="false" underline="false"/>
</increasing>
<decreasing threshold="8.0" applyThreshold="true" active="false">
<background rgb="#33cc33"/>
<style italic="true" bold="false" strikethrough="true" underline="true"/>
</decreasing>
</tracker>
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@tracker1.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
8022/tracker
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@tracker1.xml" http://<serverName>:6405/biprws/raylight/v1/documents/8022/tracker
応答:
本文 (XML)
<success>
108
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<message> The resource of type 'Tracker' has been
successfully created for the document.</message>
<id>{TrackerId}</id>
</success>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の無効化 [ページ 109]
3.2.8.9
追跡データ設定の無効化
ドキュメントの追跡データ設定の無効化
追跡データ設定を無効化するには、ドキュメントで追跡データ機能を削除します。
リソースが削除されていない場合はエラーを返します。
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/tracker
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
応答:
要求の結果を含む XML または Json フロー。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
109
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Tracker' has been successfully removed.</message>
<id>{variableId}</id>
</success>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Tracker' does not exist.</message>
</error>
例
ドキュメントの追跡データ設定を無効化する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/tracker
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/5022/tracker
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
110
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<success>
<message>The resource of type 'Tracker' with identifier '5022' has been
successfully removed.</message>
<id=“5022“></id>
</success>
関連リンク
アラータの一覧の取得 [ページ 87]
アラータの説明の取得 [ページ 89]
アラータの説明の更新 [ページ 92]
ドキュメントへのアラータの追加 [ページ 96]
アラータの削除 [ページ 98]
ドキュメントのトラッカ設定の取得 [ページ 100]
追跡データ設定の更新 [ページ 103]
追跡データ設定の作成または有効化 [ページ 106]
3.2.9
添付ファイルとリンクの管理
この節では、ドキュメントの添付ファイルとリンクの管理に使用できるさまざま方法について説明します。
●
ドキュメントの添付ファイルの一覧の取得 (GET <url>/documents/{documentId}/attachments/)
●
ドキュメントへの添付ファイルの追加 (POST <url>/documents/{documentId}/attachments/)
●
ドキュメントリンクの辞書のコンテンツの取得 (GET <url>/documents/{documentId}/links)
●
ドキュメントの式の辞書に対するリンクの追加 (POST <url>/documents/{documentId}/links )
●
ドキュメントのリンクの説明の取得 (GET <url>/documents/{documentId}/links/{linkId})
●
ドキュメントのリンクの変更 (PUT <url>/documents/{documentId}/links/{linkId})
●
ドキュメントからのリンクの削除 (DELETE <url>/documents/{documentId}/links/{linkId})
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
111
3.2.9.1
ドキュメントの添付ファイル一覧の取得
この URL を使用して、以下の操作を行います。
●
ドキュメントの添付ファイルの一覧の取得 (GET <url>/documents/{documentId}/attachments/)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
リクエスト URL
指定された Web Intelligence ドキュメントの添付ファイル一覧の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/attachments
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
ドキュメントの添付ファイルの詳細。以下により、各添付ファイルが識別される。
添付ファイルの MIME タイプ <mimeType>
ドキュメント名 <name>
ドキュメントの説明 (存在する場合。存在しない場合、このタグは空白です) <description>
112
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
ドキュメント ID 8022 の添付ファイル一覧を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/attachments
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/attachments
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<attachments>
<attachment>
<name>barometer.png</name>
<size>13229</size>
<releasemode>auto</releasemode>
<md5hashcode>97B3E3B2745595A2CBA42CA825CCD656</md5hashcode>
<mimeType>image/png</mime>
</attachment>
<attachment>
<name>statistics.jpg</name>
<size>18239</size>
<releasemode>auto</releasemode>
<md5hashcode>97B3E3B2745595A2CBA42CA825CCD656</md5hashcode>
<mimeType>image/jpeg</mimeType>
</attachment>
</attachments>
関連リンク
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
113
3.2.9.2
ドキュメントへの添付ファイルの追加
この URL を使用して、以下の操作を行います。
●
ドキュメントへの添付ファイルの追加 (POST <url>/documents/{documentId}/attachments/)
Web Intelligence ドキュメントへの添付ファイルの追加
現在のパス (通常は cURL ツールと同じパス) に保存されている attachment.xml などの .XML ファイルに定義されている
本文の添付ファイルを定義します。マルチパートの本文要求では、添付ファイル (attachmentInfos) および添付ファイル
の内容 (attachmentContent) に関する情報の 2 つ以上のパートを使用できます。
画像アップロードの場合、使用できる MIME タイプは image/png、image/jpeg、および image/gif です。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/attachments
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Request type
multipart/form-data
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
本文 (XML)
<attachment>
<name>sales_report</name>
<mimeType>image/png</mimeType>
<size>123</size>
</attachment>
--------------------####boundary123456798
Content-Disposition: form-data; name=""attachmentInfos""
114
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
Content-Type: application/xml
<attachment>
<name>logo_picture</name>
<mimeType>image/png</mimeType> 
<size>123</size>
</attachment>
--------------------####boundary123456798
Content-Disposition: form-data; name=""attachmentContent"";
filename=""logo_picture.png""
Content-Type: image/png
(Content of file)
--------------------####boundary123456798
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The attachment resource has been successfully created.</message>
例
ドキュメント ID 3422 に添付ファイルを追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本文の添付ファイルの
名前を定義します。たとえば、attachment.xml です。
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:multipart/formdata" -H X-SAP-LogonToken:"""%tokenValue%""" -d "@attachment.xml" http://
<serverName>:6405/biprws/raylight/v1/documents/3422/attachments
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
115
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:multipart/formdata" -H 'X-SAP-LogonToken:"$logtok"' -d "@attachment.xml" http://<serverName>:
6405/biprws/raylight/v1/documents/3422/attachments
要求本文
<attachment>
<mimeType>image/png</mimeType>
<name> myResourceName </name>
<description> myResourceDescription </description>
</attachment>
応答
HTTP/1.1 200 OK
Server:Apache-Coyote/1.1
Date: Mon, 04 Jun 2012 11:59:02 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type "Attachment" has been successfully created.</
message>
</success>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
3.2.9.3
ドキュメントのリンクの取得
この URL を使用して、以下の操作を行います。
●
ドキュメントリンクの辞書のコンテンツの取得 (GET <url>/documents/{documentId}/links)
●
ドキュメントの式の辞書に対するリンクの追加 (POST <url>/documents/{documentId}/links )
116
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
ドキュメントリンクの辞書のコンテンツの取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/links
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別されるドキュメントリンクの詳細:
<links>
<link dataType="String" qualification="Dimension">
<id>LB</id>
<name>Category</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L8</id>
<name>City</name>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
117
本文 (XML)
</link>
<link dataType="String" qualification="Dimension">
<id>LA</id>
<name>Lines</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L7</id>
<name>State</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L9</id>
<name>Store name</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L6</id>
<name>Year</name>
</link>
</links>
例
ドキュメント ID 8022 のリンクの詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/links
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/links
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
118
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Content-Type: application/xml
Content-Length: 355
<links>
<link dataType="String" qualification="Dimension">
<id>LB</id>
<name>Category</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L8</id>
<name>City</name>
</link>
<link dataType="String" qualification="Dimension">
<id>LA</id>
<name>Lines</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L7</id>
<name>State</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L9</id>
<name>Store name</name>
</link>
<link dataType="String" qualification="Dimension">
<id>L6</id>
<name>Year</name>
</link>
</links>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
3.2.9.4
ドキュメントへのリンクの追加
この URL を使用して、以下の操作を行います。
●
ドキュメントの式の辞書に対するリンクの追加 (POST <url>/documents/{documentId}/links )
Web Intelligence ドキュメントへのリンクの追加
現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本文のリンクを定義しま
す。たとえば、link1.xml です。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
119
リンクを作成/更新するには、以下の条件を考慮する必要があります。
●
ディメンション、属性、および階層のみをリンクできます。
●
リンク先の式には、同じデータタイプが含まれている必要があります。
●
リンク先の式は、異なるデータプロバイダからのものである必要があります。
●
リンク先の式は、別のリンクですでに使用されていてはなりません。
●
分割された式にはリンクできません (クエリストリッピングは許可されていません)。
●
式には互換性がある必要があります。
互換性について
●
すべてのカスタム式と変数は、他のすべての式と互換性があるとみなされてから、無視されます。
●
メジャーは、常にすべての項目と互換性があります。
●
ディメンション A がリンクされている場合は、リンクを含むフロー一覧のすべての式と互換性があります。
●
異なるフロー一覧からの 2 つのディメンションまたは属性には互換性がありません。ただし、上で説明したようにディメン
ションがリンクされている場合は除きます。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/links
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
本文 (XML)
...リンクの説明
<link>
<name>新しいリンク</name>
<linkedExpressions>
<linkedExpression id="DP0.DObc"/>
<linkedExpression id="DP1.DObc"/>
</linkedExpressions>
</link>
120
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>タイプ 'Link' のリソースが作成されました。</message>
例
ドキュメント ID 3422 に新しいリンクを追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている XML ファイルに定義されている本文のリンクを定義しま
す。たとえば、link1.xml です。
Windows
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@link1.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/attachments
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' -d "@link1.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/attachments
要求本文
<link>
<name>new link</name>
<linkedExpressions>
<linkedExpression id="DP0.DObc"/>
<linkedExpression id="DP1.DObc"/>
</linkedExpressions>
</link>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
121
応答
HTTP/1.1 200 OK
Server:Apache-Coyote/1.1
Date: Mon, 04 Jun 2012 11:59:02 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type 'Link' with identifier 'L6' has been successfully
created.</message>
</success>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
3.2.9.5
ドキュメントリンクの定義の取得
次の操作を実行できます。
●
ドキュメントのリンクの説明の取得 (GET <url>/documents/{documentId}/links/{linkId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{linkId}: Web Intelligence リンクの識別子は、以下によってドキュメントのリンク一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents/links
リンクの説明の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/links/{linkId}
122
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
linkId
Web Intelligence ドキュメントリンクの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<link dataType="文字列" qualification="ディメンション">
<id>L6</id>
<name>年</name>
<description>2003 年～ 2006 年</description>
<dataSourceObjectId>DS0.DObc</dataSourceObjectId>
<formulaLanguageId>[Year]</formulaLanguageId>
<linkedExpressions>
<linkedExpression id="DP0.DObc"/>
<linkedExpression id="DP1.DObc"/>
</linkedExpressions>
</link>
例
リンクの説明を取得する
注記
ドキュメント ID は 7738 です。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
123
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/7738/links/linkIdxxxx
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7738/links/linkIdxxxx
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 07 Jun 2012 08:23:37 GMT
Content-Type: application/xml
Content-Length: 217
<link dataType="String" qualification="Dimension">
<id>L6</id>
<name>Year</name>
<description>Year 2003 - 2006.</description>
<dataSourceObjectId>DS0.DObc</dataSourceObjectId>
<formulaLanguageId>[Year]</formulaLanguageId>
<linkedExpressions>
<linkedExpression id="DP0.DObc"/>
<linkedExpression id="DP1.DObc"/>
</linkedExpressions>
</link>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメント内のリンクの変更 [ページ 124]
ドキュメントリンクの削除 [ページ 127]
3.2.9.6
ドキュメント内のリンクの変更
次の操作が可能です。
●
124
ドキュメントのリンクの変更 (PUT <url>/documents/{documentId}/links/{linkId})
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
リンクを変更するには、以下の条件を考慮する必要があります。
●
ディメンション、属性、および階層のみをリンクできます。
●
リンク先の式には、同じデータタイプが含まれている必要があります。
●
リンク先の式は、異なるデータプロバイダからのものである必要があります。
●
リンク先の式は、別のリンクですでに使用されていてはなりません。
●
分割された式にはリンクできません (クエリストリッピングは許可されていません)。
●
式には互換性がある必要があります。
互換性について
●
すべてのカスタム式と変数は、他のすべての式と互換性があるとみなされてから、無視されます。
●
メジャーは、常にすべての項目と互換性があります。
●
ディメンション A がリンクされている場合は、リンクを含むフロー一覧のすべての式と互換性があります。
●
異なるフロー一覧からの 2 つのディメンションまたは属性には互換性がありません。ただし、上で説明したようにディメン
ションがリンクされている場合は除きます。
リンクの定義の変更
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/links/{linkId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
linkId
Web Intelligence ドキュメントリンクの有効な ID
本文 (XML)
説明
<link> <name>
必須入力項目です。
new
link</name> <description>A
new
link</description> <linkedExpressions>
<linkedExpression id=
"DP0.DObc"
/> <linkedExpression id=
"DP1.DObc"
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
125
本文 (XML)
説明
/> </linkedExpressions> </link
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success> <message> Success. the resource of type 'Link' with identifier 'L9' has been successfully updated. </
message> </success>
例
リンクを変更する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文のリンクを定義しま
す。たとえば、link2.xml です。
要求:
Windows
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@link2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/links/L2
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' -d "@link2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/links/L2
要求本文
<link dataType="String" qualification="Dimension">
<id>L6</id>
<name>Year</name>
<description>Year 2003 - 2006.</description>
126
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<dataSourceObjectId>DS0.DObc</dataSourceObjectId>
<formulaLanguageId>[Year]</formulaLanguageId>
<linkedExpressions>
<linkedExpression id="DP0.DObc"/>
<linkedExpression id="DP1.DObc"/>
</linkedExpressions>
</link>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Link' with identifier 'L2' has been successfully
updated.</message>
<id=“67“></id>
</success>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメントリンクの削除 [ページ 127]
3.2.9.7
ドキュメントリンクの削除
次の操作を実行できます。
●
ドキュメントからのリンクの削除 (DELETE <url>/documents/{documentId}/links/{linkId})
リンクの削除
ドキュメントをその ID で参照して、削除できます。
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/links/
{linkId}
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
127
注記
{documentId}: 削除する Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得できま
す:GET http://<serverName>:6405/biprws/raylight/vx/documents
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
linkId
Web Intelligence ドキュメントリンクの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
成功の場合、"タイプ 'リンク' および ID '{linktId}' のリソースが削除されました"。
linkId
それ以外の場合、<error> ... </error>
例
ドキュメント ID 8022 のリンク L4 を削除する
Windows
curl -X "DELETE" -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8022/links/L4
UNIX
128
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "DELETE" -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022/links/L4
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Link' with identifier 'L4' has been successfully
removed.</message>
<id=“L4“></id>
</success>
関連リンク
ドキュメントの添付ファイル一覧の取得 [ページ 112]
ドキュメントへの添付ファイルの追加 [ページ 114]
ドキュメントのリンクの取得 [ページ 116]
ドキュメントへのリンクの追加 [ページ 119]
ドキュメントリンクの定義の取得 [ページ 122]
ドキュメント内のリンクの変更 [ページ 124]
3.2.10 ドキュメントへのキャッシュエントリの追加
これを使用して、キャッシュエントリをドキュメントへ追加します。
ドキュメントへの新しいスケジュールの追加 (POST <url>/documents/{documentId}/cache)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。 GET
http://<serverName>:6405/biprws/raylight/vx/documents。
backgroundstyle.xml など、スタイル定義を含む XML ファイルで、新しいスタイルを定義します。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/cache
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
129
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
Web Intelligence ドキュメントの有効な ID
本文 (XML)
キャッシュエントリ定義を含む XML ファイル。cache1.xml など。
<cache>
<output mimeType="application/pdf">
<locale value="fr_FR" />
<locale value="de_DE" />
</output>
<output mimeType="application/pdf">
<locale value="en" />
</output>
</cache>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Cache' with identifier '{documentId} ' has been
successfully updated.</message>
<id>{documentId}</id>
</success>
例
ドキュメント ID 3422 にキャッシュエントリを追加する
ファイル cache1.xml を呼び出し、背景スタイルを追加します。
130
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H X-SAP-LogonToken:"""%tokenValue%""" -d "@cache1.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/3422/cache
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' -d "@cache1.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/cache
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Cache' has been successfully updated.</message>
<id>3422</id>
</success>
3.3
ドキュメントライフサイクルの管理 (LCM)
Web Intelligence ライフサイクルドキュメントを管理するために使用できる主な操作は、次のとおりです。この機能は、次のリ
ソースによって取得されるドキュメントの状態に関係します。
GET http://<serverName>:6405/biprws/raylight/vx/documents
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
3.3.1
ドキュメントの状態: ドキュメントの状態の管理 (ライフサイクルマ
ネジメント)
この URL は、Web Intelligence ドキュメントのライフサイクルを管理するために使用します。ドキュメントの状態を変更した
り、Web Intelligence RESTful Web サービスのコンテナのメモリを管理するために使用します。 ID によって参照されているド
キュメントを閉じる、保存する、それまでに行ったすべての変更を破棄することができます。ドキュメントに行ったすべての変更
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
131
を破棄するためにドキュメントの状態を Modified または Original から Unused に移行してから、ドキュメントを閉じることが
できます。
ドキュメントの状態は、GET メソッドを使用して取得します。次の状態があります。 Unused、Original、または
Modified。この状態は、Raylight コンテナのドキュメントの状態に対応します。
●
Unused ドキュメントは、Raylight コンテナにロードされていないドキュメントです。
●
Original ドキュメントは、Raylight コンテナにロードされており、変更はされていないドキュメントです。状態を Unused
に変更すると、ドキュメントを閉じて Raylight のメモリを解放できます。
●
状態が Modified のドキュメントは、Raylight を介してロードされ、変更されているドキュメントです。状態を Unused に
変更すると、ドキュメントを閉じて Raylight のメモリを解放できます。
注記
ドキュメントを開くと、ステータスは Original になります。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
要求
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
本文 (XML)
説明
<document>
<state>Unused</state>
<document>
オプション。
状態が Original または Modified のドキュメントの状態を変更する
ために使用します。
Original から Unused に変更されたドキュメントが閉じます。
Modified から Unused に変更されたドキュメントが閉じます。
注記
Modified のドキュメントは、要求の本文を使用しません。
ドキュメントの
元の状態
現在の状態 =
Unused
現在の状態 =
Original
現在の状態 =
Modified
Unused
なにもしない/リ
ドキュメントが閉
じる/リソースは
ドキュメントが閉
じる/リソースは
変更されない
更新される
該当なし
該当なし
ソースは変更さ
れない
元の順序
132
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
該当なし
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
説明
空の本文
ドキュメントの
元の状態
現在の状態 =
Unused
現在の状態 =
Original
現在の状態 =
Modified
更新
該当なし
該当なし
該当なし
空 (新しいドキュ
なにもしない/リ
メント)
ソースは変更さ
れない
ドキュメントが閉
じる/リソースは
ドキュメントを保
存/リソースは更
変更されない
新される
重要: Modified のドキュメントを保存できるのは、本文がない要求本文
または空の本文の要求のみです。
Original のドキュメントに対して本文がない要求または空の本文の要
求を行うと、Original ドキュメントが閉じます。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
Message:
<success>
<message>The resource of type 'document' with identifier '9326' has been
successfully updated.<
/message>
<id>9326</id></success>
例
変更されていないドキュメントを閉じる
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/8009
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
133
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<servername>:6405/biprws/raylight/v1/
documents/8009
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 21 Aug 2012 08:35:08 GMT
Content-Type: application/xml
Content-Length: 196
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success>
<message>The resource of type 'document' with identifier '8008' has not been
modified.</message>
<id>8008</id>
</success>
例
Original または Modified のドキュメントを閉じる
Web サービスのコンテナを閉じてメモリを解放します。
警告: Modified ドキュメントへの変更は失われます。
注記
Unused 状態は、cURL コマンドの -d "@UnusedState.xml" によって呼び出される UnusedState.xml ファイ
ルを使用して提供します。
UnusedState.xml の詳細
<document>
<state>Unused</state>
</document>
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -d
"@UnusedState.xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:
6405/biprws/raylight/v1/documents/12192
UNIX
134
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -d
"@UnusedState.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/12192
例
Modified ドキュメントを保存する
.
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/12192
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/12192
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
ドキュメントの最新表示前におけるドキュメント最新表示パラメータの取得 [ページ 298]
ドキュメント: 詳細の取得、更新、または削除 [ページ 22]
3.3.2 スナップショット: スナップショットの一覧の取得またはドキュメント
のスナップショットの作成
これを使用して、以下の操作を行います。
●
ドキュメントのスナップショットの一覧の取得 (GET <url>/documents/{documentId}/snapshots/)
●
ドキュメントのスナップショットの作成 (POST <url>/documents/{documentId}/snapshots/)
スナップショットは、スナップショット ID トークンで識別されます。ドキュメントのステータス管理は、ストレージトークンによって
REBean で管理されます。ドキュメントには以下のステータスがあります。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
135
●
開く -> (ステータス 1)
●
プロンプトの設定 -> (ステータス 2)
●
最新表示 -> (ステータス 3)
●
出力 -> (ステータス 4)
これらのステータスは、ドキュメントの各変更の影響を受けます (前述のようなプロンプトワークフローの場合だけではありま
せん)。たとえば、以下のような変更があります。
●
ドリルワークフロー
●
変換
●
レポートフィルタの操作
●
折りたたみ/展開 ?
ストレージトークンは、スケジュールワークフローで使用できます。
手順はカスタマイズでき、初期ステータスから結果ステータスの間で順序を入れ替えることができます。この操作は、元に戻
す、やり直す、またはカスタムプロンプトダイアログボックスの実装として使用できます。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
ドキュメントの作成者は、スナップショット (wid に対応、ストレージトークンを使用) を作成でき、以下の操作を実行できます。
既存のスナップショット ID トークンの取得
以下の呼び出しを適用してください。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/snapshots
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須入力項目です。 Web Intelligence ドキュメントの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
136
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Server
サーバのタイプ
Date
応答日時
Content Type
application/xml または application/json
ボディ
成功した場合は、ドキュメントのスナップショット ID の一覧:
<snapshots maxStackSize=“10“><snapshot id=“token1“ /><snapshot id=“token2“ /> <snapshot
id=“token3“ /></snapshots>
<snapshots maxStackSize=“10“>
<snapshot id=“token1“/>
<snapshot id=“token2“/>
<snapshot id=“token3“/>
</snapshots>
それ以外の場合: <error> ... </error>
例
ドキュメント ID 8022 の ID トークンを取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
./curl.exe -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<snapshots maxStackSize=“10“>
<snapshot id=“we00000000d447acb133a0“ />
<snapshot id=“we00000000e5df6062ca2a“ />
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
137
<snapshot id=“we00010000dc73921d7b5d“ />
</snapshots>
新しいストレージトークンを作成する
この呼び出しにより、新しく作成されたストレージトークンが返されます。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/snapshots
ヘッダ
値
Accept
ドキュメントの詳細を取得する: application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須入力項目です。 Web Intelligence ドキュメントの有効な ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Server
サーバのタイプ
Date
応答日時
Content Type
application/xml または application/json
ボディ
成功した場合は、ドキュメントの新しいスナップショット ID:
<snapshot id=“tokenID“/>
それ以外の場合: <error> ... </error>
例
ドキュメント ID 8022 のスナップショット (それによる ID トークン) を作成する
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
UNIX
138
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<snapshots>
<snapshot id=“we00000000d447acb133a0“ />
</snapshots>
3.3.3
スナップショット: 特定のスナップショットへのドキュメントの復元
ドキュメントを、指定のスナップショットに対応する状態に復元します。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{snapshotId}: Web Intelligence ドキュメントスナップショットの識別子は、以下によってドキュメントのスナップショット
一覧から取得されます: GET http://<serverName>:6405/biprws/raylight/vx/documents/
{documentId}/snapshots
要求
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}?
snapshotId={token}
ヘッダ
Accept
X-SAP-LogonToken
値
ドキュメントの詳細を取得する。application/xml または
application/json
引用符で囲んだログオントークンの値
本文 (XML)
以下によって識別されるドキュメントの詳細:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
139
本文 (XML)
<documentId> ドキュメントの ID。
<token> スナップショットの ID。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Document' with identifier '{documentId} ' has been
successfully updated.</message>
<id>{documentId}</id>
</success>
例
ドキュメント 5022 をスナップショット ID we00000000e5df6062ca2a に復元する
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/5022?snapshotId=we00000000e5df6062ca2a
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/5022?snapshotId=we00000000e5df6062ca2a
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
140
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<success>
<message>The resource of type 'Document' with identifier '5022' has been
successfully updated.</message>
<id=“5022“></id>
</success>
3.4
レポートの管理
この節では、レポートで使用できる主な操作について説明します。
●
レポートのエクスポート
●
レポートの管理
●
レポートドリラの管理
●
レポート要素の管理
●
レポート構造の管理
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
関連リンク
ドキュメントの管理 [ページ 14]
レポートの取得、移動、または作成 [ページ 141]
レポートの詳細の取得およびレポートの削除 [ページ 149]
3.4.1
レポートの取得、移動、または作成
これを使用して、以下の操作を行います。
●
documentId URL パラメータで指定されたドキュメントのすべてのレポートの取得 (GET <url>/documents/
{documentId}/reports)
●
ドキュメント内のレポートの移動 (PUT <url>/documents/{documentId}/reports)
●
URL パラメータで指定された特定のドキュメントでの Web Intelligence レポートの作成 (POST <url>/documents/
{documentId}/reports)
注記
{documentId}: 次によってドキュメント一覧から取得される Web Intelligence ドキュメントの識別子。 GET http://
<serverName>:6405/biprws/raylight/vx/documents。下記リンクを参照してください。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
141
Web Intelligence レポートの取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識
別子。 documentId: (型は整数で、最小値は 1、最大値は
既存ドキュメントの最大ドキュメント番号です)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
レポートごとに id、name、reference、および showDataChanges 設定を示します。
例
ドキュメント 12782 のレポートを取得する
注記
ドキュメント ID が 12782 のレポートを取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/12782/reports
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/12782/reports
142
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<reports>
<report>
<id>1</id>
<name>Cross Tab View</name>
<reference>1.RS</reference>
<element>
<name>2004</name>
<reference>1.K.0</reference>
</element>
<element>
<name>2005</name>
<reference>1.K.1</reference>
</element>
<element>
<name>2006</name>
<reference>1.K.2</reference>
</element>
</report>
<report>
<id>2</id>
<name>Simple charting view</name>
<reference>2.RS</reference>
<element>
<name>2004</name>
<reference>2.K.0</reference>
</element>
<element>
<name>2005</name>
<reference>2.K.1</reference>
</element>
<element>
<name>2006</name>
<reference>2.K.2</reference>
</element>
</report>
</reports>
ドキュメント内のレポートの移動
レポートをドキュメント内の別の位置に移動します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports?
fromId=<fromId>&toId=<toId>
ヘッダ
Accept
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
値
application/xml または application/json
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
143
ヘッダ
値
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。ドキュメントの ID。
fromId
必須。整数。移動するレポートの有効な識別子。
toId
必須。整数。レポートの有効な識別子 (移動後のレポートの
位置)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
成功の場合:
<success>
<message>The reource of type 'Report' with identifier '1' has been successfully
moved.</message>
<id>2</id>
<success>
それ以外の場合: <error> ... </error>
例
ドキュメント 12782 内の位置 1 から位置 3 へレポートを移動する
注記
ドキュメント ID が 12782 のレポートを取得します。
Windows
curl -PUT -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/12782/reports?
fromId=1&toId=3
UNIX
144
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -PUT -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/12782/reports?fromId=1&toId=3
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Report' with identifier '1' has been
successfully moved.</message>
<id>1</id>
</success>
Web Intelligence レポートの作成
URL パラメータで指定された特定のドキュメント内のレポートを作成します。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須: Web Intelligence ドキュメントの有効な ID
本文 (XML)
オプション
<report>
<name>New report</name> レポートの名前
<report>
応答:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
145
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
成功の場合:
<success>
<message>The resource of type 'Report' with identifier '2' has been created
successfully.</message>
<id>2</id>
<success>
それ以外の場合: <error> ... </error>
例
ドキュメント 12782 のレポートを作成する
report2.xml など、レポートについて説明する XML ファイルを記述します。
<report>
<name>New report</name>
</report>
注記
ドキュメント ID 12782 内の新しいレポートを作成します。
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@report2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
12782/reports
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@report2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/12782/reports
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
146
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Report' with identifier '2' has been
successfully created.</message>
<id=“2“></id>
</success>
Web Intelligence レポートのコピー
URL パラメータで指定された特定のドキュメント内のレポートをコピーします。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須: Web Intelligence ドキュメントの有効な ID
fromId
必須: コピーするレポートの有効な識別子。
keepDriller
コピーされたレポートでドリラーモードを保持します。コピー元のレポートがドリラーモー
ドの場合のみ適用されます。値: true/false、デフォルトは true
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
成功の場合:
<success>
<message>The resource of type 'Report' with identifier '2' has been successfully
created.</message>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
147
ボディ
<id>2</id>
<success>
それ以外の場合: <error> ... </error>
例
ドキュメント 12782 のレポートをコピーする
report2.xml など、レポートについて説明する XML ファイルを記述します。
注記
ドキュメント ID 12782 内の新しいレポートを作成します。
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/14308/reports?
fromId=1&keepDriller=false
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/14308/reports?
fromId=1&keepDriller=false
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Report' with identifier '2' has been
successfully created.</message>
<id=“2“></id>
</success>
関連リンク
ドキュメント: 詳細の取得、更新、または削除 [ページ 22]
148
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.4.2
レポートの詳細の取得およびレポートの削除
これを使用して、以下の操作を行います。
●
reportId パラメータによって指定されたレポートの詳細の取得 (GET <url>documents/{documentId}/
reports/{reportId})
●
reportId パラメータによって指定されたレポートの削除 (DELETE <url>documents/{documentId}/
reports/{reportId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: レポートの識別子は、以下によって取得されます。GET http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/reports
レポートの詳細の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}
ヘッダ
Accept
X-SAP-LogonToken
値
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識
別子。 documentId: (type=integer, minimum=1,
maximum=既存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。レポートの識別子。
応答
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
application/xml または application/json
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
149
ヘッダ
値
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
reportId URL パラメータによって指定されたレポートの詳細。id、name、reference、および showDataChanges。
例
レポートの詳細を取得する
注記
ドキュメント (ID 7858) からレポート (ID 3) の詳細を取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/7858/reports/3
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7858/reports/3
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 14:24:12 GMT
Content-Type: application/xml
Content-Length: 167
<report>
<id>1</id>
<name>Cross Tab View</name>
<reference>1.RS</reference>
<showDataChanges>false</showDataChanges>
<element>
<name>2004</name>
<reference>1.K.0</reference>
</element>
<element>
<name>2005</name>
<reference>1.K.1</reference>
</element>
<element>
<name>2006</name>
<reference>1.K.2</reference>
</element>
</report>
150
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
指定されたレポートの削除
これを使用して、ドキュメント内の指定されたレポートを削除します。この操作は元に戻すことができません。
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}
ヘッダ
Accept
X-SAP-LogonToken
値
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識
別子。 documentId: (type=integer, minimum=1,
maximum=既存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。レポートの識別子。
応答
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success>The resource of type 'report' with identifier '9372' has been successfully
removed. <id>9372</id></success>
例
ドキュメント ID 9512 のレポート 67 を削除する
Windows
curl -X "DELETE" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
151
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "DELETE" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67
応答
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Report' with identifier '67' has been
successfully deleted.</message>
<id=“67“></id>
</success>
指定されたレポートのプロパティの更新
これを使用して、ドキュメント内の指定されたレポートを削除します。この操作は元に戻すことができません。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須: Web Intelligence ドキュメントの有効な ID
ReportId
必須: Web Intelligence レポートの有効な ID
要求本文 (XML)
<report>
<showDataChanges>true</showDataChanges> showDataChanges: レポート (トラッカ) で追跡データを表示しま
す ("true"、"false")。
<report>
152
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
応答
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success>The resource of type 'report' with identifier '9372' has been successfully
removed. <id>9372</id></success>
例
ドキュメント ID 9512 のレポート 67 を更新する
Windows
curl -PUT -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" -d
@"update.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9512/
reports/67
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -PUT -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
@"update.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9512/
reports/67
要求本文:
<report>
<showDataChanges>true</showDataChanges>
</report>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Report' with identifier '67' has been
successfully deleted.</message>
<id=“67“></id>
</success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
153
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
ドキュメント: 詳細の取得、更新、または削除 [ページ 22]
レポートの取得、移動、または作成 [ページ 141]
BI プラットフォームにログオンする [ページ 10]
3.4.3
レポートのマップの取得
Web Intelligence ドキュメントのレポートのマップを取得します。
要求
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/map
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
reference
オプション。マップノードの有効な参照。例:
reference=1.G.1
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード。
Content-Type
Content-Length
154
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<map>
<node reference="1.G.0" name="2004"/>
<node reference="1.G.1" name="2005"/>
<node reference="1.G.2" name="2006"/>
</map>
例
ドキュメント 18809 のレポート 1 のマップを取得する
この例では、レポートの完全なマップ参照を取得する方法を示します。応答の本文内に 8 つのマップノードがあります。
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/18809/reports/1/map
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
18809/reports/1/map
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 175
<map>
<node reference="1.G.0" name="2004"/>
<node reference="1.G.1" name="2005"/>
<node reference="1.G.2" name="2006"/>
</map>
例
レポートのノードのマップを取得する
以下の例では、レポートの特定のノードのマップ参照を取得する方法を示します。前の例を使用してノード参照を取得した
後、?reference=<node reference> パラメータを含めます。ここでも、ドキュメントは ID 18809、取得するレポートは ID 1
です。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
155
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/18809/reports/1/map?reference=1.G.1
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
18809/reports/1/map?reference=1.G.1
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 175
<map>
<node
<node
<node
<node
<node
<node
<node
<node
</map>
3.4.4
reference="1.5.1.0"
reference="1.5.1.1"
reference="1.5.1.2"
reference="1.5.1.3"
reference="1.5.1.4"
reference="1.5.1.5"
reference="1.5.1.6"
reference="1.5.1.7"
name="California"/>
name="Colorado"/>
name="DC"/>
name="Florida"/>
name="Illinois"/>
name="Massachusetts"/>
name="New York"/>
name="Texas"/>
レポートのエクスポート
次のエクスポートができます。
●
1 つのドキュメントとして、レポート全体
●
ページ区切りモードのレポート (1 レポートページあたり 1 ファイル)
●
レポートの 1 ページ
レポートは以下の形式でエクスポートできます。
●
HTML
●
zip 形式で圧縮された HTML
●
MHTML (マルチパート HTML)
●
XML
●
PDF
●
Excel 2003
156
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
Excel 2007
●
CSV
レポートのエクスポートの詳細については、以下の関連するリンクを参照してください。
関連リンク
一覧モード (ページ区切りなし) でのレポートのエクスポート [ページ 157]
ページ区切りモードでのレポートのエクスポート [ページ 160]
レポートページのエクスポート [ページ 163]
3.4.4.1
一覧モード (ページ区切りなし) でのレポートのエクスポート
レポートのエクスポート
レポートを定められた形式でエクスポートします。ドキュメント名および形式は <documentname>.xxx によって識別されま
す。ここで、xxx は以下の形式です。
●
<documentname>.htm は、HTML 形式でエクスポートされたレポートです。
●
<documentname>.htm は、MHTML 形式でエクスポートされたレポートです。
●
<documentname>.zip は、HTML 形式で zip ファイルにエクスポートされたレポートです。
●
<documentname>.xml は、XML 形式でエクスポートされたレポートです。
●
<documentname>.pdf は、PDF 形式でエクスポートされたレポートです。
●
<documentname>.xls は、Excel 2003 形式でエクスポートされたレポートです。
●
<documentname>.xlsx は、Excel 2007 形式でエクスポートされたレポートです。
●
<documentname>.csv は、CSV 形式でエクスポートされたレポートです。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントのレポート一覧から取得され
ます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId} > <reportName.htm>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
157
ヘッダ
値
Accept
text/xml (オブジェクトを表す中立的な XML 形式) または
text/html (HTML の場合)
application/zip (zip 形式で圧縮された HTML の場合) または
multi-part/related (MHTML の場合) または
application/pdf または
application/vnd.ms-excel (Excel 2003 の場合) または
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場合)
text/csv (CSV 形式の場合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値
表 10: レポートのエクスポート: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャートの解像度 (DPI: ドット数/インチ)(存在する場合)
最大: 9600
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)
表 11: レポートのエクスポート: HTML/MHTMP/ZIP 出力のためのオプションパラメータ
パラメータ
説明
dpi
生成されたチャートの解像度 (DPI: ドット数/インチ)(存在する場合)
最大: 9600
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)
chartOutputFormat
生成されるチャートの出力形式。
値: jpeg、bmp、gif、png
デフォルト = png
注記
HTML 形式では、Web サービスによって画像のリンクが生成されるので、生成さ
れるリンクから画像を取得するために X-SAP-LogonToken を有効にしておく必
要があります。
158
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
fileName
文字列。 zip ファイルの名前です。
最大長: 96
表 12: レポートのエクスポート: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
説明
dpi
生成されたチャートの解像度 (DPI: ドット数/インチ)(存在する場合)
最大: 9600
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)
optimized
論理値。デフォルト: false。それ以外の場合は true。生成される出力は、Excel 内
の計算向けに最適化されます。
表 13: レポートのエクスポート: CSV 向けのオプションパラメータ
パラメータ
説明
textQualifier
(型 = 文字、値 = ' または ") 各列の値を囲むために使用される文字。
columnDelimiter
(型 = 文字列、値 = , または ; または特殊文字列 Tab) 列の間に追加される文字。
charset
(型 = 文字列) 有効なサーバ文字セット。使用可能な文字セットのリストを取得するに
は、コマンド GET http://<serverName>:6405/biprws/raylight/vx/
configuration/charsets を使用します。
結果:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/xml (オブジェクトを表す中立的な XML 形式) または
text/html または
application/zip または
application/pdf または
application/vnd.ms-excel (Excel 2003 の場合) または
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場合)
text/csv (CSV 出力の場合)
Content-Length
応答本文のコンテンツの長さ
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
159
ボディ
指定された形式でエクスポートされたレポートの結果。
例
レポートを HTML 形式でエクスポートする
注記
レポートを exportedreport.htm ファイルにエクスポートします。
Windows
curl -G -s -H "accept:text/html" -H X-SAP-LogonToken:"""%tokenValue%""" "http://
<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67?
chartOutputFormat=jpeg" > exportedreport.htm
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/html" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67?
chartOutputFormat=jpeg" > exportedreport.htm
3.4.4.2
ページ区切りモードでのレポートのエクスポート
Web Intelligence ドキュメントのレポートをさまざまな形式にページ区切りモードでエクスポートします。 Web Intelligence ド
キュメントの最初のページは 0 です。最後のレポートページを取得した後は、「見つかりません」という 404 エラーメッセージ
が返されます。
次の形式を指定できます。
●
XML
●
PDF
●
Excel 2003
●
Excel 2007
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/pages
注記
●
160
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
{reportId}: レポートの識別子は、以下によって取得されます: GET http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/reports
ヘッダ
値
Accept
text/xml (オブジェクトを表す中立的な XML 形式) または
application/pdf または
application/vnd.ms-excel (Excel 2003 の場合) または
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値。
表 14: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャートの解像度 (DPI: ドット数/インチ)(存在する場合)。
最大: 9600。
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)
mode
normal または quickDisplay
表 15: オプションパラメータ mode=normal
パラメータ
説明
orientation
ページの方向。特定のページの向きを指定するために使用します。
値: portrait、landscape
widthScaling
レポート表示 1 回あたりのページ数 (幅)。
デフォルト: 0 は、幅に制約がないことを意味します。
heightScaling
レポート表示 1 回あたりのページ数 (高さ)。
デフォルト: 0 は、高さに制約がないことを意味します。
表 16: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
optimized
説明
論理値。デフォルト: false。それ以外の場合は true。生成される出力は、Excel 内
の計算向けに最適化されます。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
161
例
レポートを XML (ページ区切りモード) でエクスポートする
Windows
curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""<tokenValue>""" "http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages" > xmlfile.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/xml" -H "X-SAP-LogonToken:$logtok" "http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages" > xmlfile.xml
例
レポートを PDF (ページ区切りモード) でエクスポートする
Windows
curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""<tokenValue>"""
"http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages?
mode=normal&widthScaling=1" > exportedreport.pdf
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/pdf" -H "X-SAP-LogonToken:$logtok" "http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages?
mode=normal&widthScaling=1" > exportedreport.pdf
例
レポートを Excel 2003 (ページ区切りモード) でエクスポートする
Windows
curl -G -s -H "accept:application/vnd.ms-excel" -H "X-SAPLogonToken:""<tokenValue>""" "http://<serverName>:6405/biprws/raylight/v1/
documents/9227/reports/1/pages" > exportedexcel2003.xls
UNIX
162
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.ms-excel" -H "X-SAP-LogonToken:$logtok"
"http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages" >
exportedexcel2003.xls
例
レポートを Excel 2007 (ページ区切りモード) でエクスポートする
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""<tokenValue>"""
"http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/pages" >
exportedexcel2007.xlsx
UNIX
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H "X-SAP-LogonToken:$logtok" "http://
$serverName:6405/biprws/raylight/v1/documents/9227/reports/1/pages" >
exportedexcel2007.xlsx
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
レポートの取得、移動、または作成 [ページ 141]
BI プラットフォームにログオンする [ページ 10]
レポートページのエクスポート [ページ 163]
3.4.4.3
レポートページのエクスポート
レポートページを、さまざまな形式にエクスポートします。次の形式を指定できます。
●
HTML
●
ZIP (圧縮 HTML ファイル)
●
MHTML (マルチパート HTML)
●
XML
●
PDF
●
Excel 2003
●
Excel 2007
要求:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
163
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/pages/{pageIndex}
注記
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
●
{reportId}: レポートの識別子は、以下によって取得されます: GET http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/reports
●
{pageIndex}: ページ番号。この値は 0 から始まります。レポートのページ数は事前にわからないので、この URL
をループで使用して、最後のページの後に「見つかりません」という 404 エラーメッセージが返されるまで実行する必
要があります。
ヘッダ
値
Accept
text/html または
application/zip (zip 形式で圧縮された HTML の場合) または
multi-part/related (MHTML の場合) または
text/xml または
application/pdf または
application/vnd.ms-excel (Excel 2003 の場合) または
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum=既
存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。エクスポートする Web Intelligence レポートの
レポートの識別子。reportId: (type=integer, minimum=1,
maximum=ドキュメントの最大レポート番号)。
pageIndex
必須。整数。エクスポートするレポートのページの識別子。
pageIndex: (type=integer, minimum=1, maximum=レポ
ートの最大ページ番号)。
表 17: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャート (存在する場合) の解像度 (DPI: ドット数/インチ)。
最大: 9600。
164
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)。
mode
normal または quickDisplay
表 18: オプションパラメータ mode=normal
パラメータ
説明
orientation
ページの方向。特定のページの向きを指定するために使用します。
値: portrait、landscape
widthScaling
レポート表示 1 回あたりのページ数 (幅)。
デフォルト: 0 は、幅に制約がないことを意味します。
heightScaling
レポート表示 1 回あたりのページ数 (高さ)。
デフォルト: 0 は、高さに制約がないことを意味します。
表 19: HTML/MHTML/ZIP 出力のためのオプションパラメータ
パラメータ
説明
chartOutputFormat
生成されたチャート (存在する場合) の出力形式。
値: jpeg、bmp、gif、png
デフォルト = png
注記
HTML 形式では、Web サービスによって画像のリンクが生成されるので、生成さ
れるリンクから画像を取得するために X-SAP-LogonToken を有効にしておく必要
があります。
表 20: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
optimized
説明
論理値。デフォルト: false。それ以外の場合は true。生成される出力は、Excel 内
の計算向けに最適化されます。
例
レポートページ 1 を XML 形式でエクスポートする
注記
page1.xml ファイルとして最初のレポートページをエクスポートします。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
165
Windows
curl -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" "http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/0" >
page1.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' "http://<serverName>:
6405/biprws/raylight/v1/documents/9646/reports/479/pages/0" > page1.xml
例
レポートページ 2 を PDF 形式でエクスポートする
注記
page2.pdf ファイルとしてレポートページ 2 をエクスポートします。
Windows
curl -H "accept:application/pdf" -H X-SAP-LogonToken:"""<tokenValue>""" "http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/1" >
page2.pdf
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -H "accept:application/pdf" -H "X-SAP-LogonToken:$logtok" "http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/1" >
page2.pdf
例
レポートページ 3 を Excel 2003 形式でエクスポートする
注記
page3.xls ファイルとしてレポートページ 3 をエクスポートします。
Windows
curl -H "accept:application/vnd.ms-excel" -H X-SAP-LogonToken:"""<tokenValue>"""
"http://<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/2"
> page3.xls
UNIX
166
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -H "accept:application/vnd.ms-excel" -H "X-SAP-LogonToken:$logtok" "http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/2" >
page3.xls
例
レポートページ 1 を Excel 2007 形式でエクスポートする
注記
page1.xlsx ファイルとして最初のレポートページをエクスポートします。
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""<tokenValue>"""
"http://<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/0"
> page1.xlsx
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H "X-SAP-LogonToken:$logtok" "http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/0" >
page1.xlsx
関連リンク
ページ区切りモードでのレポートのエクスポート [ページ 160]
ドキュメント: 取得、コピー、または作成 [ページ 16]
レポートの取得、移動、または作成 [ページ 141]
BI プラットフォームにログオンする [ページ 10]
3.4.5
レポートで使用されている要素の一覧の取得
この URL は、特定のレポートを ID で参照してその要素を取得します。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
167
注記
{documentId}: 次によってドキュメント一覧から取得される Web Intelligence ドキュメントの識別子。 GET http://
<serverName>:6405/biprws/raylight/vx/documents。
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得され
ます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
下記リンクを参照してください。
Web Intelligence レポートの要素の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/elements
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
レポートの要素ごとに、各要素の id、name、reference を指定します。
168
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<elements> ... </element> レポート内の各要素の説明の一覧を含みます。
<element type="cell"> レポートの要素を識別します。要素は以下のとおりです。
<id>4</id> 要素の識別子 (内部)。各識別子は一意です。
<name></name> 要素の名前 (存在する場合)。
<reference>UIREF:RID=1:BID=4</reference>
例
ドキュメント ID 1224 のレポート 2 の要素を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/1224/reports/2
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/1224/reports/2
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<elements>
<element type="cell">
<id>4</id>
<name></name>
<reference>UIREF:RID=1:BID=4</reference>
</element>
<element type="vtable">
<id>15</id>
<name>Block 1</name>
<reference>UIREF:RID=1:BID=15</reference>
</element>
</elements>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
169
3.4.6
レポート要素の詳細の取得、レポート要素のエクスポート
この URL を使用して、以下の操作を行います。
●
ID で参照される特定のレポート要素の詳細の取得 (GET <url>/documents/{documentId}/reports/
{reportId}/elements/{elementId})
●
レポートの要素のエクスポート (GET -s <url>/documents/{documentId}/reports/{reportId}/
elements/{elementId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントのレポート一覧から取得され
ます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
注記
{elementId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントのレポート一覧から取得さ
れます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/
reports/{reportId}/elements
レポートの要素の詳細の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/elements/{elementId}
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
170
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
reportId
説明
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = 既存ドキュメント
の最大レポート番号)。
elementId
必須。整数。Web Intelligence レポートの要素の識別子。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下のように記述された、レポート要素の定義
<element type="PageZone">
<element type="Cell">
<element type="VTable">
<id>4</id>
<name></name>
<reference>UIREF:RID=1:BID=4</reference>
</element>
例
ドキュメント ID 8022 のレポート 2 の要素 4 の詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
"http://<serverName>:6405/biprws/raylight/v1/documents/8022/reports/2/elements/4"
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/8022/reports/2/elements/4"
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
171
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<elements>
<element type="PageZone">
<id>1</id>
<name>Header</name>
<size minimalHeight="1984"/>
</element>
<element type="Cell">
<id>12</id>
<reference>UIREF:V=1:RID=1:BID=12</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="300" bottom="350"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=NameOf([Lines])</formula>
</expression>
</content>
</element>
<element type="Cell">
<id>8</id>
<reference>UIREF:V=1:RID=1:BID=8</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="220" bottom="230"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="Numeric">=[Sales revenue]</
formula>
</expression>
</content>
</element>
<element type="Cell">
<id>13</id>
<reference>UIREF:V=1:RID=1:BID=13</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="300" bottom="350"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=NameOf([Sales revenue])</
formula>
</expression>
</content>
</element>
<element type="Cell">
<id>6</id>
<reference>UIREF:V=1:RID=1:BID=6</reference>
<parentId>15</parentId>
172
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="220" bottom="230"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=[State]</formula>
</expression>
</content>
</element>
<element type="Cell">
<id>10</id>
<reference>UIREF:V=1:RID=1:BID=10</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="300" bottom="350"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=NameOf([Year])</formula>
</expression>
</content>
</element>
<element type="Cell">
<id>4</id>
<reference>UIREF:V=1:RID=1:BID=4</reference>
<parentId>2</parentId>
<size minimalWidth="15048" minimalHeight="1548" autofitWidth="false"
autofitHeight="true"/>
<position x="7416" y="432" horizontalAnchorType="None"
verticalAnchorType="None"/>
<padding left="213" right="213" top="156" bottom="156"/>
<style>
<border>
<bottom thickness="None" style="None"/>
</border>
<font size="16" bold="false" underline="true"/>
<alignment horizontal="Auto" vertical="Center" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=ReportName()</formula>
</expression>
</content>
</element>
<element type="Cell">
<id>5</id>
<reference>UIREF:V=1:RID=1:BID=5</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="220" bottom="230"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=[Year]</formula>
</expression>
</content>
</element>
<element type="Cell">
<id>7</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
173
<reference>UIREF:V=1:RID=1:BID=7</reference>
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="220" bottom="230"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=[Lines]</formula>
</expression>
</content>
</element>
<element type="PageZone">
<id>2</id>
<name>Body</name>
</element>
<element type="VTable">
<id>15</id>
<reference>UIREF:V=1:RID=1:BID=15</reference>
<name>Block 1</name>
<parentId>2</parentId>
<position x="450" y="900" horizontalAnchorType="None"
verticalAnchorType="End" verticalAnchorId="4"/>
<content>
<axes duplicateRowAggregation="true">
<axis role="Row" folded="false">
<expressions>
<formula dataType="String">=[Year]</formula>
<formula dataType="String">=[State]</formula>
<formula dataType="String">=[Lines]</formula>
</expressions>
<alternateStyles>
<style>
<alignment horizontal="Left" vertical="Bottom"
wrapText="false"/>
<frequency>2</frequency>
</style>
</alternateStyles>
</axis>
</axes>
<layout>
<zone horizontalType="Body" verticalType="Body">
<child row="0" rowSpan="1" column="0" columnSpan="1" id="5"/
>
<child row="0" rowSpan="1" column="1" columnSpan="1" id="6"/
>
<child row="0" rowSpan="1" column="2" columnSpan="1" id="7"/
>
<child row="0" rowSpan="1" column="3" columnSpan="1" id="8"/>
</zone>
<zone horizontalType="Body" verticalType="Header">
<child row="0" rowSpan="1" column="0" columnSpan="1" id="10"/
>
<child row="0" rowSpan="1" column="1" columnSpan="1" id="11"/
>
<child row="0" rowSpan="1" column="2" columnSpan="1" id="12"/
>
<child row="0" rowSpan="1" column="3" columnSpan="1"
id="13"/>
</zone>
</layout>
</content>
</element>
<element type="Cell">
<id>11</id>
<reference>UIREF:V=1:RID=1:BID=11</reference>
174
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<parentId>15</parentId>
<size minimalWidth="3005" minimalHeight="567" autofitWidth="false"
autofitHeight="true"/>
<padding left="250" right="250" top="300" bottom="350"/>
<style>
<alignment horizontal="Auto" vertical="Auto" wrapText="false"/>
</style>
<content>
<expression>
<formula type="Text" dataType="String">=NameOf([State])</formula>
</expression>
</content>
</element>
<element type="PageZone">
<id>3</id>
<name>Footer</name>
<size minimalHeight="1701"/>
</element>
</elements>
レポートの要素のエクスポート
レポート要素をさまざまな形式にエクスポートします。次の形式を指定できます。
●
HTML
●
XML
●
PDF
●
Excel 2003
●
Excel 2007
注記
ヘッダ、ボディ、フッタなどのページゾーン全体をエクスポートすることはできません。
注記
HTML 出力が選択されている場合、RESTful サービスによって画像のリンクが生成されます。そのため、HTML 出力を表
示している間は (生成されたリンクから画像を取得できるように)、ログオントークンを引き続き有効にしておく必要がありま
す。
注記
ページゾーン (ヘッダ、ボディ、フッタ) をエクスポートすることはできません。これを行うと空のドキュメントが生成されます。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/elements/{elementId}
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
175
注記
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
●
{reportId}: レポートの識別子は、以下によって取得されます: GET http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/reports
ヘッダ
値
Accept
text/html または
text/xml または
application/pdf または
application/vnd.ms-excel (Excel 2003 の場合) または
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet (Excel 2007 の場合)
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。エクスポートする Web Intelligence レポートの
レポートの識別子。reportId: (型 = 整数、最小 = 1、最大 =
既存ドキュメントの最大レポート番号)。
elementId
必須。整数。エクスポートするレポート要素の識別子。
reportId: ((型 = 整数、最小 = 1、最大 = レポートの最大要
素番号)。
表 21: サポートされているすべての形式のオプションパラメータ
パラメータ
説明
dpi
生成されたチャート (存在する場合) の解像度 (DPI: ドット数/インチ)。
最大: 9600。
最小: 75
デフォルト: 300 (PDF 形式)、96 (他のすべての形式)。
mode
normal または quickDisplay
表 22: オプションパラメータ mode=normal
パラメータ
説明
orientation
ページの方向。特定のページの向きを指定するために使用します。
176
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
値: portrait、landscape
widthScaling
レポート表示 1 回あたりのページ数 (幅)。
デフォルト: 0 は、幅に制約がないことを意味します。
heightScaling
レポート表示 1 回あたりのページ数 (高さ)。
デフォルト: 0 は、高さに制約がないことを意味します。
表 23: HTML 出力のためのオプションパラメータ
パラメータ
説明
chartOutputFormat
生成されたチャート (存在する場合) の出力形式。
値: jpeg、bmp、gif、png
デフォルト = png
注記
HTML 形式では、Web サービスによって画像のリンクが生成されるので、生成さ
れるリンクから画像を取得するために X-SAP-LogonToken を有効にしておく必要
があります。
表 24: Excel 2003 および Excel 2007 向けのオプションパラメータ
パラメータ
optimized
説明
論理値。デフォルト: false。それ以外の場合は true。生成される出力は、Excel 内
の計算向けに最適化されます。
例
レポート要素を HTML でエクスポートする
Windows
curl -G -s -H "accept:text/html" -H X-SAP-LogonToken:"""%tokenValue%""" "http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4" >
reportelement4.htm
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/html" -H 'X-SAP-LogonToken:"$logtok"' "http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4"
> reportelement4.htm
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
177
例
レポート要素を XML でエクスポートする
Windows
curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.xml
例
レポート要素を PDF でエクスポートする
Windows
curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.pdf
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/pdf" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.pdf
例
レポート要素を Excel 2003 でエクスポートする
Windows
curl -G -s -H "accept:application/vnd.ms-excel" -H "X-SAP-LogonToken:""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/
elements/4
> reportelement4.xls
UNIX
178
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.ms-excel" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.xls
例
レポート要素を Excel 2007 でエクスポートする
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.xlsx
UNIX
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' http://
$serverName:6405/biprws/raylight/v1/documents/9227/reports/1/elements/4
> reportelement4.xlsx
3.4.7
レポート構造: レポートの構造の取得と更新
この URL を使用して、以下の操作を行います。
●
指定したレポートのレポート構造の取得 (GET <url>/documents/{documentId}/reports/{reportId}/
specification )。
●
指定したレポートのレポート構造の更新 (PUT <url>/documents/{documentId}/reports/{reportId}/
specification )。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得さ
れます: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/
reports
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
179
Web Intelligence レポートの構造の取得
ドキュメントは名前で並べ替えられます。一覧はユーザアクセス権に依存します。返すドキュメントの数、およびドキュメント一
覧内で開始ドキュメントとして使用する最初のドキュメントを指定することができます。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/specification
ヘッダ
値
Accept
text/xml
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
reportId
必須入力項目です。レポートの ID。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/xml
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
レポート構造の説明:
<REPORT rId="12" name="Report1">
<PAGE_HEADER bId="1" />
<PAGE_BODY bId="2">
<VTABLE y="100" x="100" bId="21" name="Table 1" >
<ROWGROUP type="header" >
<TR>
<TDCELL bId="211" ><CONTENT>=nameof([YEAR])</CONTENT></TDCELL>
<TDCELL bId="212" ><CONTENT>=nameof([INCOME])</CONTENT></TDCELL>
</TR>
180
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
</ROWGROUP>
<ROWGROUP type="body" >
<TR> <TDCELL bId="213" ><CONTENT>=[YEAR]</CONTENT></TDCELL>
<TDCELL bId="214" ><CONTENT>=[INCOME]</CONTENT></TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
<PAGE_FOOTER bId="3" />
</REPORT>
例
レポートの構造を取得する
要求:
Windows
curl -G -i -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/xml" 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<REPORT rId="12" name="Report1">
<PAGE_HEADER bId="1" />
<PAGE_BODY bId="2">
<VTABLE y="100" x="100" bId="21" name="Table 1" >
<ROWGROUP type="header" >
<TR>
<TDCELL bId="211" ><CONTENT>=nameof([YEAR])</CONTENT></TDCELL>
<TDCELL bId="212" ><CONTENT>=nameof([INCOME])</CONTENT></
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
181
TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="body" >
<TR>
<TDCELL bId="213" ><CONTENT>=[YEAR]</CONTENT></TDCELL>
<TDCELL bId="214" ><CONTENT>=[INCOME]</CONTENT></TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
<PAGE_FOOTER bId="3" />
</REPORT>
指定したレポートのレポート構造の更新
要求
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/specification
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
説明
documentId
必須入力項目です。ドキュメントの ID。
reportId
必須入力項目です。レポートの ID。
本文 (XML)
<REPORT rId="12" name="Report1">
<PAGE_HEADER bId="1" />
<PAGE_BODY bId="2">
<VTABLE y="100" x="100" bId="21" name="Table 1" >
<ROWGROUP type="header" >
<TR>
<TDCELL bId="211" ><CONTENT>=nameof([YEAR])</CONTENT></TDCELL>
<TDCELL bId="212" ><CONTENT>=nameof([INCOME])</CONTENT></TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="body" >
<TR>
<TDCELL bId="213" ><CONTENT>=[YEAR]</CONTENT></TDCELL>
<TDCELL bId="214" ><CONTENT>=[INCOME]</CONTENT></TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
182
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<PAGE_FOOTER bId="3" />
</REPORT>
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/xml
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
<success><message>The resource of type 'report' with identifier '12' has been
successfully updated.</message> <id>12</id></success>
例
1: レポート ID 23 のレポート仕様にシンプルなセルを追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポート仕様を定
義します。たとえば、cell.xml です。
本文 (XML)
<REPORT rId="12" name="My First Cell">
<PAGE_BODY>
<CELL x="1000" y="1500">
<CONTENT>="My First CELL"</CONTENT>
</CELL>
</PAGE_BODY>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@cell.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@cell.xml" http://<serverName>:6405/biprws/raylight/v1/
documents/2334/reports/23/specification
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
183
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>23</id>
</success>
identifier '23' has been
例
2: シンプルな垂直テーブルをレポート ID 23 に追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポート仕様を定
義します。たとえば、table.xml です。
本文 (XML)
<REPORT name="Vertical Table">
<PAGE_HEADER/>
<PAGE_BODY>
<VTABLE name="My Vertical Table" x="3037" y="4455">
<ROWGROUP type="HEADER">
<TR>
<TDCELL>
<CONTENT>=NameOf([Country])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Revenue])</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="BODY">
<TR>
<TDCELL>
<CONTENT>=[Country]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=[Revenue]</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="FOOTER">
<TR>
<TDCELL>
<CONTENT/>
</TDCELL>
<TDCELL>
<CONTENT>=[Revenue]</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
184
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<PAGE_FOOTER/>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@table.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@table.xml" http://<serverName>:6405/biprws/raylight/v1/
documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>23</id>
</success>
identifier '23' has been
例
3: ブレークのあるシンプルな垂直テーブルをレポート ID 23 に追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポート仕様を定
義します。たとえば、tablebreak.xml です。
本文 (XML)
<REPORT name="Vertical Table And Break">
<PAGE_HEADER/>
<PAGE_BODY>
<VTABLE name="Table And Break " x="3037" y="4455">
<AXIS>
<EXPRS>
<AXIS_EXPR>=[Country]</AXIS_EXPR>
<AXIS_EXPR>=[Resort]</AXIS_EXPR>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
185
本文 (XML)
</EXPRS>
<BREAK bId="1" expr="=[Country]" addSort="yes" onePage="yes"
newPage="yes" duplicate="center"/>
</AXIS>
<ROWGROUP breakId="1" type="HEADER">
<TR>
<TDCELL>
<CONTENT>=NameOf([Country])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Resort])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Revenue])</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="BODY">
<TR>
<TDCELL>
<STYLE>
<TEXTVALIGN value="center"/>
</STYLE>
<CONTENT>=[Country]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=[Resort]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=[Revenue]</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP breakId="1" type="FOOTER">
<TR>
<TDCELL>
<CONTENT>=[Country]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT/>
</TDCELL>
<TDCELL>
<CONTENT/>
</TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
<PAGE_FOOTER/>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@tablebreak.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/2334/reports/23/specification
UNIX
186
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@tablebreak.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>23</id>
</success>
identifier '23' has been
例
4: レポートに対するフィルタとテーブルに対するフィルタを持つシンプルな垂直テーブルをレポート ID 23 に追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポート仕様を定
義します。たとえば、tablefilter.xml です。
本文 (XML)
<REPORT name="Filter">
<DATA>
<DATA_FILTER>
<WHERE>
<FILTER key="[Country]">
<CONDITION operatorCondition="InList">
<MEMBER>France</MEMBER>
</CONDITION>
</FILTER>
</WHERE>
</DATA_FILTER>
</DATA>
<PAGE_BODY>
<VTABLE bId="17" name="Block 1" x="3749" y="3443" >
<AXIS>
<EXPRS>
<AXIS_EXPR>=[Country]</AXIS_EXPR>
<AXIS_EXPR>=[Resort]</AXIS_EXPR>
</EXPRS>
</AXIS>
<DATA>
<DATA_FILTER>
<WHERE>
<FILTER key="[Resort]">
<CONDITION operatorCondition="InList">
<MEMBER>French Riviera</MEMBER>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
187
本文 (XML)
</CONDITION>
</FILTER>
</WHERE>
</DATA_FILTER>
</DATA>
<ROWGROUP type="HEADER">
<TR height="567">
<TDCELL>
<CONTENT>=NameOf([Country])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Resort])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Revenue])</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="BODY">
<TR height="567">
<TDCELL>
<CONTENT>=[Country]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=[Resort]</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=[Revenue]</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</PAGE_BODY>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@tablefilter.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@tablefilter.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
188
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>9372</id>
</success>
identifier '23' has been
例
5: テーブルとフリーセルを持つセクション (並べ替えおよびフィルタ) をレポート ID 23 に追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .xml ファイルに定義されている本文でレポート仕様を定
義します。たとえば、section.xml です。
本文 (XML)
<REPORT name="Section & Filter">
<DATA/>
<PAGE_BODY>
<ROW height="6255"/>
<SECTION>
<DATA>
<DATA_FILTER>
<WHERE>
<FILTER key="[Country]">
<CONDITION operatorCondition="InList">
<MEMBER>France</MEMBER>
</CONDITION>
</FILTER>
</WHERE>
</DATA_FILTER>
</DATA>
<AXIS>
<SORTS>
<SORT sign="desc" expr="=[Country]"/>
</SORTS>
<AXIS_EXPR>=[Country]</AXIS_EXPR>
</AXIS>
<SBODY bottomPadding="3638" bookmark="yes">
<CELL class="ia-section-cell" x="600" y="500">
<CONTENT>=[Country]</CONTENT>
</CELL>
<VTABLE name="Block 1" x="3749" y="500">
<DATA/>
<ROWGROUP type="HEADER">
<TR>
<TDCELL>
<CONTENT>=NameOf([Resort])</CONTENT>
</TDCELL>
<TDCELL>
<CONTENT>=NameOf([Revenue])</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
<ROWGROUP type="BODY">
<TR>
<TDCELL>
<CONTENT>=[Resort]</CONTENT>
</TDCELL>
<TDCELL>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
189
本文 (XML)
<CONTENT>=[Revenue]</CONTENT>
</TDCELL>
</TR>
</ROWGROUP>
</VTABLE>
</SBODY>
</SECTION>
<ROW height="1500"/>
</PAGE_BODY>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@section.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@section.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>23</id>
</success>
identifier '23' has been
例
非表示条件付きのフリーセルの追加
本文 ( freecell.xml file)
<REPORT name="Cell with hide always and Cell with hide conditional">
<DATA/>
<PAGE_BODY>
190
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 ( freecell.xml file)
<ROW height="2992" bottomPadding="0">
<CELL x="7416" y="432" hideAlways="yes" width="15048" height="1547">
<CONTENT>ALWAYS HIDE</CONTENT>
</CELL>
<CELL x="7416" y="2000" hideAlways="no"
hideExpr="=Count([Country]) > 3" width="15048" height="1547">
<CONTENT>=Count([Country])> 3</CONTENT>
</CELL>
</ROW>
</PAGE_BODY>
</REPORT>
要求:
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" X-SAPLogonToken:"""%tokenValue%""" -d "@freecell.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:text/xml" 'X-SAPLogonToken:"$logtok"' -d "@freecell.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/2334/reports/23/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<success><message>The resource of type 'Report' with
successfully updated.</message>
<id>23</id>
</success>
3.4.8
identifier '23' has been
レポートデータのドリル操作
レポートに表示されている結果を分析するには、ドリル機能を使用します。レポートをドリルすることでテーブル、チャートまた
はセクションに表示されているデータを掘り下げ、要約された結果に隠れている詳細な内容を発見できます。
●
レポートの現在のドリル情報の取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller)
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
191
●
クエリドリルの有効化 (POST <url>/documents/{documentId}/reports/{reportId}/driller)
●
ドリル出力モードの更新 (PUT <url>/documents/{documentId}/reports/{reportId}/driller)
●
ドリルの無効化 (DELETE <url>/documents/{documentId}/reports/{reportId}/driller)
●
ドリル階層の取得 (GET <url>/documents/{documentId}/reports/{reportId}/driller/
hierarchies).
●
レポートのドリルフィルタのリストの取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller/filters)
●
ドリルフィルタの詳細の取得 (GET <url>/documents/{documentId}/reports/{reportId}/driller/
filters/{filterId})
●
ドリルフィルタの作成 (POST <url>/documents/{documentId}/reports/{reportId}/driller/
filters)
●
ドリルフィルタの更新 (PUT <url>/documents/{documentId}/reports/{reportId}/driller/
filters/{filterId})
●
ドリルフィルタの削除 (DELETE <url>/documents/{documentId}/reports/{reportId}/driller/
filters/{filterId})
●
空きドリル要素の一覧の取得 (GET <url>/documents/{documentId}/reports/{reportId}/driller/
drillelements)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
関連リンク
クエリドリル設定に関する情報の取得 [ページ 201]
クエリドリルの有効化 [ページ 206]
ドリル設定の変更 [ページ 203]
クエリドリルの無効化 [ページ 208]
ドリル階層に関する情報の取得 [ページ 193]
レポートのドリルフィルタのリストの取得 [ページ 196]
ドリルフィルタの詳細の取得 [ページ 210]
レポートのドリルフィルタの作成 [ページ 212]
ドリルフィルタの更新 [ページ 215]
ドリルフィルタの削除 [ページ 217]
空きドリル要素の一覧の取得 [ページ 198]
192
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.4.8.1
ドリル階層に関する情報の取得
ドリル階層を取得します。このレポートでドリルが有効になっていない場合は、エラーを返します。
GET <url>/documents/{documentId}/reports/{reportId}/driller/hierarchies
現在のドリル情報を取得します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/hierarchies
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。 Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum=既
存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。 Web Intelligence レポートのレポートの識別
子。 reportId: (type=integer, minimum=1, maximum=ド
キュメントの最大レポート番号)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<hierarchies>
<hierarchy>
<id>DP0.DH1</id>
<name>Resort Hierarchy</name>
<dataProviderId>DP0</dataProviderId>
<elements>
<element qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO39</id>
<name>Country</name>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
193
本文 (XML)
</element>
<element qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO2</id>
<name>Resort</name>
</element>
<element qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO4</id>
<name>Service Line</name>
</element>
<element qualification="Dimension" inQuery="false"
ambiguous="false"inScope="true">
<id>DP0.DO5</id>
<name>Service</name>
</element>
</elements>
</hierarchy>
</hierarchies>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
例
ドキュメント ID 4567 のレポート 1 に対するドリル階層情報を取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller/hierarchies
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
4567/reports/1/driller/hierarchies
194
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 775
<hierarchies>
<hierarchy>
<id>DP0.DH1</id>
<name>Resort Hierarchy</name>
<dataProviderId>DP0</dataProviderId>
<elements>
<element>
<id>DP0.DO39</id>
<name>Country</name>
<description></description>
<filterValue></filterValue>
<qualification>dimension</qualification>
<inQuery>false</inQuery>
<ambiguous>false</ambiguous>
<inScope>true</inScope>
</element>
<element>
<id>DP0.DO2</id>
<name>Resort</name>
<description></description>
<filterValue></filterValue>
<qualification>dimension</qualification>
<inQuery>false</inQuery>
<ambiguous>false</ambiguous>
<inScope>true</inScope>
</element>
<element>
<id>DP0.DO4</id>
<name>Service Line</name>
<description></description>
<filterValue></filterValue>
<qualification>dimension</qualification>
<inQuery>false</inQuery>
<ambiguous>false</ambiguous>
<inScope>true</inScope>
</element>
<element>
<id>DP0.DO5</id>
<name>Service</name>
<description></description>
<filterValue></filterValue>
<qualification>dimension</qualification>
<inQuery>false</inQuery>
<ambiguous>false</ambiguous>
<inScope>true</inScope>
</element>
</elements>
</hierarchy>
</hierarchies>
関連リンク
クエリドリル設定に関する情報の取得 [ページ 201]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
195
クエリドリルの有効化 [ページ 206]
ドリル設定の変更 [ページ 203]
クエリドリルの無効化 [ページ 208]
3.4.8.2
レポートのドリルフィルタのリストの取得
この構文を使用して、以下の操作を行います。
●
レポートのドリルフィルタのリストの取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller/filters)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
レポートドリルフィルタのリストの取得
レポートのドリルフィルタのリストを取得します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/filters
ヘッダ
値
Accept
X-SAP-LogonToken
ドキュメントの詳細を取得する。application/xml または
application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
196
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
レポートに対して使用可能なフィルタの説明
<filters>
<filter qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO39</id>
<value>France</value>
</filter>
</filters>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>タイプ 'Driller'のリソースは存在しません。</message>
</error>
例
ドキュメント ID 4567 のレポート 1 に対するドリルフィルタのリストを取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller/filters
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
197
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
4567/reports/1/driller/filters
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 375
<filters>
<filter qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO39</id>
<value>France</value>
</filter>
</filters>
3.4.8.3
空きドリル要素の一覧の取得
空きドリル要素を取得します。このレポートでドリルが有効になっていない場合は、エラーを返します。
これを使用して、以下の操作を行います。
●
レポートの空きドリル要素の一覧の取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller/drillelements)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
空きドリル要素の一覧の取得
レポートの空きドリル要素の一覧を取得します。
レポートでドリルが有効になっていない場合は、エラーを返します。
198
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/drillelements
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
レポートに対して使用可能なドリル要素の説明。
drillelements: 使用可能なドリル要素の一覧を含みます。
drillelement qualification=: ドリル要素を説明します。
id: ドリル要素の一意の識別子
name: ドリル要素の名前
<drillelements>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO39</id>
<name>Country</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO2</id>
<name>Resort</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
199
本文 (XML)
inScope="true">
<id>DP0.DO4</id>
<name>Service Line</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO5</id>
<name>Service</name>
</drillelement>
</drillelements>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
例
ドキュメント ID 4567 のレポート 1 に対する使用可能なドリル要素の一覧を取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller/drillelements
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
4567/reports/1/driller/drillelements
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 375
<drillelements>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO39</id>
<name>Country</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO2</id>
200
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<name>Resort</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO4</id>
<name>Service Line</name>
</drillelement>
<drillelement qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO5</id>
<name>Service</name>
</drillelement>
</drillelements>
3.4.8.4
クエリドリル設定に関する情報の取得
これを使用して、以下の操作を行います。
●
レポートの現在のドリル情報の取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller)
●
クエリドリルの有効化 (POST <url>/documents/{documentId}/reports/{reportId}/driller)
●
ドリル出力モードの更新 (PUT <url>/documents/{documentId}/reports/{reportId}/driller)
●
ドリラリソースの削除 (これにより、ドリルは無効化されます) (DELETE <url>/documents/{documentId}/
reports/{reportId}/driller)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます:GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
レポートドリラ設定に関する情報の取得
現在のドリル情報を取得します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
201
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum =
既存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (type=integer, minimum=1, maximum = ド
キュメントの最大レポート番号)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<driller>
<output>true</output>
</driller>
ここで、<output> は論理値で、ドリルのモードを指定します (true = ドリルまたは false = ドリルライト)
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
202
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
ドキュメント ID 4567 のレポート 1 に対するドリル設定を取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
4567/reports/1/driller
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 175
<driller>
<output>true</output>
</driller>
関連リンク
クエリドリルの有効化 [ページ 206]
ドリル設定の変更 [ページ 203]
クエリドリルの無効化 [ページ 208]
ドリル階層に関する情報の取得 [ページ 193]
3.4.8.5
ドリル設定の変更
リクエスト URL
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
203
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。 Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum=既
存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。 Web Intelligence レポートのレポートの識別
子。 reportId: (type=integer, minimum=1, maximum=ド
キュメントの最大レポート番号)。
本文 XML
<driller>
<output>false</output>
</driller>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success><message>The resource of type 'Driller' has been successfully updated. </
message>
<id>1</id>
</success>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
<id>1</id>
/error>
204
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
ドリル設定を変更する
現在のパス (通常は cURL ツールと同じパス) に保存されている XML ファイルに定義されている本文のドリラの状態を定
義します。たとえば、drilelr.xml です。
Windows
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@driller.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/3422/reports/2/driller
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' -d "@driller.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/reports/2/driller
要求本文
<driller>
<output>false</output>
</driller>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Driller' has been successfully updated.</message>
<id>1</id>
</success>
関連リンク
クエリドリル設定に関する情報の取得 [ページ 201]
クエリドリルの有効化 [ページ 206]
クエリドリルの無効化 [ページ 208]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
205
ドリル階層に関する情報の取得 [ページ 193]
3.4.8.6
クエリドリルの有効化
レポートでのドリルを有効にします。要求本文はオプションです。指定されていない場合、デフォルトの設定 (出力の設定が
true) でドリルが有効化されます。リソースが作成されていない場合はエラーを返します。
リクエスト URL
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = 既存ドキュメント
の最大レポート番号)。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success>
<message>The resource of type 'Driller' has been successfully created. </message>
<id>2</id>
</success>
206
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
エラーの場合: HTTP 応答コード: 400
<error>
<error_code>401</error_code>
<message>The resource of type 'Driller' is already created.</message>
</error>
例
ドキュメント ID 4567 のドリルを有効化する
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/4567/reports/1/driller
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Driller' has been successfully created.</message>
<id>2</id>
</success>
関連リンク
クエリドリル設定に関する情報の取得 [ページ 201]
ドリル設定の変更 [ページ 203]
クエリドリルの無効化 [ページ 208]
ドリル階層に関する情報の取得 [ページ 193]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
207
3.4.8.7
クエリドリルの無効化
指定されたレポートでのドリルを無効にします。リソースが作成されていない場合はエラーを返します。
リクエスト URL
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller
注
ヘッダ (通常、ただし必ずではない)
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = 既存ドキュメント
の最大レポート番号)。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success>
<message>The resource of type 'Driller' has been successfully removed. </message>
<id>2</id>
</success>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
208
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
エラーの場合: HTTP 応答コード: 404
</error>
例
レポートでのドリルを無効にする
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/
raylight/v1/documents/8022/reports/1/driller
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/8022/reports/1/driller
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Driller' has been successfully removed.</message>
<id>2</id>
</success>
関連リンク
クエリドリル設定に関する情報の取得 [ページ 201]
クエリドリルの有効化 [ページ 206]
ドリル設定の変更 [ページ 203]
ドリル階層に関する情報の取得 [ページ 193]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
209
3.4.8.8
ドリルフィルタの詳細の取得
これを使用して、以下の操作を行います。
●
レポートのドリルフィルタの詳細の取得 (GET <url>/documents/{documentId}/reports/{reportId}/
driller/filters/{filterId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
レポートドリルフィルタの詳細の取得
レポートのドリルフィルタの詳細を取得します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/filters/{filterId}
ヘッダ
値
Accept
X-SAP-LogonToken
ドキュメントの詳細を取得する。application/xml または
application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
filterId
必須。整数。レポートのドリルフィルタの識別子。filtertId:
(型 = 整数、最小 = 1、最大 = レポートの最大フィルタ番
号)。
応答:
210
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
ドリルフィルタの説明。
<filter qualification="Dimension" inQuery="false" ambiguous="false" inScope="true">
<id>DP0.DO13</id>
<lov hierarchical="false" partial="false" refreshable="false">
<values>
<value>Albertville</value>
<value>Augsburg</value>
<value>Belfast</value>
. . .
<value>Washington D.C.</value>
<value>Yokohama</value>
</values>
<columns mappingId="0">
<column id="0" type="String">
</column>
</columns>
</lov>
</filter>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
例
ドキュメント ID 13343 のレポート 1 に対するドリルフィルタ DP0.DO13 の詳細を取得する
Windows
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/13343/reports/1/driller/filters/DP0.DO13
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
211
13343/reports/1/driller/filters/DP0.DO13
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 375
<filter qualification="Dimension" inQuery="false" ambiguous="false"
inScope="true">
<id>DP0.DO13</id>
<lov hierarchical="false" partial="false" refreshable="false">
<values>
<value>Albertville</value>
<value>Augsburg</value>
<value>Belfast</value>
. . .
<value>Washington D.C.</value>
<value>Yokohama</value>
</values>
<columns mappingId="0">
<column id="0" type="String">
</column>
</columns>
</lov>
</filter>
3.4.8.9
レポートのドリルフィルタの作成
これを使用して、以下の操作を行います。
●
レポートのドリルフィルタの作成 (POST <url>/documents/{documentId}/reports/{reportId}/
driller/filters)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
212
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
レポートドリルフィルタの作成
レポートのドリルフィルタを作成します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/filters
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
本文 (XML)
レポートのドリルフィルタの説明を書いた XML ファイルを記述し、その XML ファイルを要求の本文として含めます。たとえ
ば、drillfilter1.xml です。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<filter>
<id>DP0.DO39</id>
<value>France</value>
</filter>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
213
本文 (XML)
要求の結果を示すメッセージ。
<success>
<message>The resource of type 'DrillFilter' with identifier 'DP0.O39' has been
successfully created.</message>
<id>DP0.O39</id>
</success>
例
ドキュメント 127 のレポート 1 のドリルフィルタを作成する
注記
要求の本文の xml ファイル drillfilter2.xml を使用します。
drillfilter2.xml の詳細は以下のとおりです。
<filter>
<id>DP1.DO22</id>
<value>France</value>
</filter>
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@drillfilter2.xml" http://<serverName>:6405/biprws/raylight/v1/
documents/127/reports/1/driller/filters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@drillfilter2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/127/
reports/1/driller/filters
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'DrillFilter' with identifier 'DP1.DO22' has been
successfully created.</message>
<id>DP1.DO22</id>
</success>
214
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.4.8.10 ドリルフィルタの更新
これを使用して、以下の操作を行います。
●
レポートのドリルフィルタの定義の更新 (PUT <url>/documents/{documentId}/reports/{reportId}/
driller/filters/{filterId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
レポートドリルフィルタの更新
レポートのドリルフィルタの説明を更新します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/filters/{filterId}
ヘッダ
Accept
X-SAP-LogonToken
値
ドキュメントの詳細を取得する。application/xml または
application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
filterId
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
必須入力項目です。レポートのドリルフィルタの識別子。
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
215
本文 (XML)
更新されたドリルフィルタの説明。
<filter>
<value>Germany</value>
</filter>
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
成功の場合:
<success>
<message>The resource of type 'DrillFilter' with identifier 'DP2.O11' has been
successfully updated. </message>
<id>DP2.O11</id>
</success>
エラーの場合: HTTP 応答コード: 404
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
例
ドキュメント 223 のレポート 2 のドリルフィルタ DP2.O11 を更新する
注記
新しいドリルフィルタの説明を cURL コマンドの -d "@updatedrillfilter.xml" によって呼び出される
updatedrillfilter.xml ファイルに記述します。
updatedrillfiter.xml の詳細は以下のとおりです。
<filter>
<value>Germany</value>
</filter>
216
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -d
"@updatedrillfilter.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/223/reports/2/driller/filters/
DP2.O11
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -d
"@updatedrillfilter.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/223/reports/2/driller/filters/DP2.O11
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Mon, 11 Jun 2012 08:38:03 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type 'DrillFilter' with identifier 'DP2.O11' has been
successfully updated.</message>
<id>DP2.O11</id>
</success>
3.4.8.11
ドリルフィルタの削除
以下を使用して、以下の操作を行います。
●
レポートのドリルフィルタの削除 (DELETE <url>/documents/{documentId}/reports/{reportId}/
driller/filters/{filterId})
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: Web Intelligence ドキュメントレポートの識別子は、以下によってドキュメントレポート一覧から取得されま
す: GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
217
レポートドリルフィルタの削除
レポートのドリルフィルタを削除します。
レポートでドリルが有効になっていない場合は、エラーを返します。
リクエスト URL
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/filters/{filterId}
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュメン
トの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
filterId
必須入力項目です。レポートのドリルフィルタの識別子。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'DrillFilter' with identifier 'DP1.O34' has been
deleted successfully.</message>
<id>DP1.O34</id>
<success>
それ以外の場合: <error> ... </error>
218
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
ドリルフィルタ DP5.O12 をドキュメント ID 9512 のレポート 67 から削除する
Windows
curl -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/9512/reports/67/driller/filters/DP5.O12
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/9512/reports/67/driller/filters/DP5.O12
応答
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'DrillFiltert' with identifier 'DP5.O12' has been
successfully deleted.</message>
<id>DP5.012</id>
</success>
3.4.8.12 ドリルアクションの実行
このメソッドは、レポートでドリルアクションを実行します。これは、リソースが作成されていない場合、またはパラメータが無効
な場合にエラーを返します。
●
レポートに対するドリルアクションの実行 (POST <url>/documents/{documentId}/reports/{reportId}/
driller/instructions)
注記
{documentId}: 次によってドキュメント一覧から取得される Web Intelligence ドキュメントの識別子。 GET http://
<serverName>:6405/biprws/raylight/vx/documents
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
219
注記
{reportId}: 次によってドキュメントレポート一覧から取得される Web Intelligence ドキュメントレポートの識別子。 GET
http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
リクエスト URL
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/instructions
ヘッダ
値
Accept
X-SAP-LogonToken
ドキュメントの詳細を取得する。application/xml または
application/json
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum =
既存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
本文 (XML)
XML ファイル内のドリル手順:
<instruction type="Down"> ここで、type は "Down"、 "Up"、または "By" です。
<elementId>11</elementId> ここで elementId の値は、ドリルアクションを実行する要素の ID (例: 垂直テーブル
の ID) と等しい値です。
<from>
<drillElement>
<id>DP0.DO2</id>
<filterValue>French Riviera</filterValue>
</drillElement>
</from>
<to>
<drillElement>
<id>DP0.DO4</id>
<hierarchyId>DP0.DH1</hierarchyId>
</drillElement>
220
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
</to>
</instruction>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>タイプ 'DrillerInstruction' のリソースが作成されました。</message>
<id>1</id>
</success>
それ以外の場合: <error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
例
ドリルダウンする
Windows
curl -POST -H "accept:application/xml" -H "content-type:application/xml" -H X-SAPLogonToken:"""%tokenValue%""" -d "@drilldown.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9512/reports/67/driller/instructions
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl POST -H "accept:application/xml" -H "content-type:application/xml" -H 'X-SAPLogonToken:"$logtok"' -d "@drilldown.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9512/reports/67/driller/instructions
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
221
XML 本文ファイルのコンテンツ (drilldown.xml):
<instruction type="Down">
<elementId>11</elementId>
<from>
<drillElement>
<id>DP0.DO2</id>
<filterValue>French Riviera</filterValue>
</drillElement>
</from>
<to>
<drillElement>
<id>DP0.DO4</id>
<hierarchyId>DP0.DH1</hierarchyId>
</drillElement>
</to>
</instruction>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'DrillerInstruction' has been successfully
created.</message>
<id>1</id>
</success>
3.4.8.13 ドリルモードでのスナップショットの作成
このメソッドは、モードでレポートのスナップショットを作成します。これは、リソースが作成されていない場合、またはパラメー
タが無効な場合にエラーを返します。
●
レポートに対するドリルアクションの実行 (POST <url>/documents/{documentId}/reports/{reportId}/
driller/snapshot)
注記
{documentId}: 次によってドキュメント一覧から取得される Web Intelligence ドキュメントの識別子。 GET http://
<serverName>:6405/biprws/raylight/vx/documents
注記
{reportId}: 次によってドキュメントレポート一覧から取得される Web Intelligence ドキュメントレポートの識別子。 GET
http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports
リクエスト URL
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/reports/
{reportId}/driller/snapshot
222
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Accept
ドキュメントの詳細を取得する。application/xml または
application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
documentId: (type=integer, minimum=1, maximum =
既存ドキュメントの最大ドキュメント番号)。
reportId
必須。整数。Web Intelligence レポートのレポートの識別
子。reportId: (型 = 整数、最小 = 1、最大 = ドキュメントの最
大レポート番号)。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>タイプ '{Report}' および ID '{reportId}' のリソースが作成されました。</message>
<id>{reportId}</id>
</success>
それ以外の場合:
<error>
<error_code>400</error_code>
<message>The resource of type 'Driller' does not exist.</message>
</error>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
223
例
ドリルモードでスナップショットを作成する
注記
ドキュメント 7738 のレポート 12 のスナップショットを作成します。
Windows
curl "POST" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/7738/reports/12/
driller/snapshot
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "POST" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/7738/reports/12/driller/
snapshot
応答
<success>
<message>Resource of type 'Report' with identifier '12' has been successfully
created.</message>
<id>12</id>
</success>
3.5
データプロバイダの管理
データプロバイダはクエリです。この節では、データプロバイダで使用できる主な操作について説明します。
●
データプロバイダの管理
●
フローの管理
●
クエリ仕様の管理
●
クエリマッピングの詳細の取得
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
224
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
関連リンク
データプロバイダの一覧の取得またはデータプロバイダの追加 [ページ 225]
データプロバイダの詳細の取得、データプロバイダの更新または削除 [ページ 230]
フロー: データプロバイダのフロー件数の取得 [ページ 246]
フロー: CSV または XML 形式でのフロー詳細の取得 [ページ 247]
3.5.1
データプロバイダの一覧の取得またはデータプロバイダの追加
次の操作を実行できます。
●
ドキュメントのデータプロバイダの一覧の取得 (GET <url>/documents/{documentId}/dataproviders)
●
ドキュメントへのデータプロバイダの追加 (POST <url>/documents/{documentId}/dataproviders)
●
ドキュメントからのデータプロバイダの移動 (PUT <url>/documents/{documentId}/dataproviders)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents
ドキュメントのデータプロバイダの一覧の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders
ヘッダ
Accept
X-SAP-LogonToken
値
application/xml または application/json
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
225
本文 (XML)
各データプロバイダの id、name および最終更新日
<dataproviders>
<dataprovider>
<id>DP1</id>
<name>Query 1</name>
</dataprovider>
</dataproviders>
例
ドキュメントのデータプロバイダの一覧を取得する
注記
ドキュメント ID は 7738 です。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 07 Jun 2012 08:23:37 GMT
Content-Type: application/xml
Content-Length: 217
<dataproviders>
<dataprovider>
<id>DP0</id>
<name>Query 1</name>
<updated>2006-09-20Z</updated>
</dataprovider>
<dataprovider>
...
</dataprovider>
</dataproviders>
226
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ドキュメントへのデータプロバイダの追加
この URL を使用すると、Web Intelligence ドキュメントに新しいデータプロバイダを追加できます。
データプロバイダは、WebI ドキュメント内の一意の名前と、ユニバース (UNV または UNX) またはデータソースへの直接ア
クセスに使用する接続仕様のいずれかの CUID により定義されます。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
本文 (XML)
引用符で囲んだログオントークンの値
説明
<dataprovider>
<name>Query1</name>
<datasourceId>1234ABCD</
datasourceId>
必須入力項目です。
<dataprovider>
datasourceId は、データソースの参照 ID です。
BEx クエリを参照する場合の本文 (XML)
データソースの名前と ID を指定するために使用します。name はデータ
ソースの名前です。
説明
<dataprovider>
<name>Query1</name>
必須。
<datasourceId>11990;Z_BOBJ;AAQU
ERY_SAMPLE</datasourceId>
ソースの名前です。
<dataprovider>
データソースの名前と ID を指定するために使用します。name はデータ
datasourceId は、BEx データソースの参照 ID です。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
<success> <message> Success. the resource of type 'Data Provider' with identifier 1234ABCD has been
successfully updated. </message> </success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
227
例
ドキュメントにデータプロバイダを追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本文に追加するデータ
プロバイダを定義します。たとえば、dp3.xml です。
要求:
Windows
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H X-SAP-LogonToken:"""%tokenValue%""" -d "@dp3.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/3422/dataproviders
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H "content-type:application/xml" H 'X-SAP-LogonToken:"$logtok"' -d "@dp3.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/dataproviders
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Data provider' with identifier 'DP3' has been
successfully created.</message>
<id=“67“></id>
</success>
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
BI プラットフォームにログオンする [ページ 10]
3.5.2
ドキュメント内のデータプロバイダの移動
Web Intelligence ドキュメント内の既存のデータプロバイダを移動します。
228
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ documentId によって指定した Web Intelligence ドキュメント内で、パラメータ dataproviderId を使用してデ
ータプロバイダの参照を移動します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders?
fromId=<DP_to_move>&toID=<pos_of_DP_aftermove>
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須: Web Intelligence ドキュメントの有効な ID
fromId
必須: 移動するデータプロバイダの ID。
toId
必須: データプロバイダの ID (移動後のデータプロバイダの位置)。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Document' with identifier 'DP0' has been
successfully updated.</message>
<id>DP2</id>
</success>
例
ドキュメント ID 8022 の DP0 を位置 DP2 に移動する
Windows
curl - i -X "PUT" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/8022/dataproviders?
fromId=DP0&toId=DP2
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
229
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/8022/dataproviders?
fromId=DP0&toId=DP2
応答
本文 (XML)
<success>
<message>Resources of type 'Data provider' with identifier 'DP0' has been
successfully moved.</message>
<id>DP2</id>
</success>
3.5.3
削除
データプロバイダの詳細の取得、データプロバイダの更新または
データプロバイダの詳細の取得
URL パラメータ documentId を指定して、Web Intelligence ドキュメントのデータプロバイダの詳細を取得します。
要求:
GET http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/dataproviders/
{dataproviderId}
この場合、
●
documentId は、Web Intelligence ドキュメントの有効な ID です。
●
dataproviderId は、Web Intelligence ドキュメントで使用されるデータプロバイダの有効な ID です。
応答タイプ: application/xml または application/json
応答本文: 以下の情報を含む、データプロバイダの詳細:
●
id
●
name
●
データソースオブジェクトの ID
230
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
.unv ユニバースの場合に、データソースオブジェクトの識別子に使用されるデータソースのプレフィックス
●
最終更新の日付と時刻
●
ispartial
●
dictionary における、それぞれの式に対するオブジェクト id、type、name、description、およびデータソースオ
ブジェクトの ID
例
ドキュメント ID 7738 で使用できるデータプロバイダ ID DP0 の詳細を取得します。
応答
<?xml version="1.0" encoding="UTF-8"?>
<dataprovider>
<id>DP1</id>
<name>Query 2</name>
<dataSourceId>7599</dataSourceId>
<dataSourcePrefix>DS0</dataSourcePrefix>
<updated>2012-12-13T12:40:54.000+01:00</updated>
<duration>1</duration>
<isPartial>false</isPartial>
<rowCount>66</rowCount>
<flowCount>1</flowCount>
<dictionary>
<expression dataType="String" qualification="Dimension">
<id>DP1.DO1</id>
<name>City</name>
<description>City</description>
<dataSourceObjectId>AZ_CITY</dataSourceObjectId>
</expression>
<expression dataType="String" qualification="Dimension">
<id>DP1.DO1d</id>
<name>Customer</name>
<description>Customer</description>
<dataSourceObjectId>AZ_CUSTOM</dataSourceObjectId>
</expression>
...
</dictionary>
</dataprovider>
データプロバイダの更新
このメソッドを使用して、データプロバイダを消去します。
要求:
PUT http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/dataproviders/
{dataproviderId}?purge={purge}&purgeOptions={purgeOptions}
この場合、
●
documentId は、Web Intelligence ドキュメントの有効な ID です。
●
dataproviderId は、Web Intelligence ドキュメントで使用されるデータプロバイダの有効な ID です。
●
{purge} (オプション) は、データプロバイダを消去するかどうかを示します。デフォルト値は false です。
●
{purgeOptions} (オプション) は、消去操作を制御する prompts です。設定されていない場合、または空の場合
は、データプロバイダのみ消去されます。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
231
要求本文 (オプション):
<dataprovider>
<name>...</name>
</dataprovider>
応答タイプ: application/xml または application/json
応答は、要求の成功または失敗を示すメッセージです。
例
プロンプトを除くデータプロバイダを消去する
PUT <url>/documents/7738/dataproviders/DP0?purge=true
<success>
<message>The resource of type 'Data provider' with identifier 'DP0' has been
successfully updated.</message>
<id>DP0</id>
</success>
例
データプロバイダとプロンプトを消去する
PUT <url>/documents/7738/dataproviders/DP0?purge=true&purgeOptions=prompts
<success>
<message>The resource of type 'Data provider' with identifier 'DP0' has been
successfully updated.</message>
<id>DP0</id>
</success>
例
データプロバイダの名前を変更する
PUT <URL>/documents/7738/dataproviders/DP0
XML ファイルの要求本文:
<dataprovider>
<name>My Renamed Data Provider</name>
</dataprovider>
応答:
<success>
<message>The resource of type 'Data provider' with identifier 'DP0' has been
successfully updated.</message>
<id>DP0</id>
</success>
232
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
データプロバイダの削除
Web Intelligence ドキュメントのデータプロバイダの一覧からデータプロバイダを削除します。
DELETE http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/
dataproviders/{dataproviderId}
この場合、
●
documentId は、Web Intelligence ドキュメントの有効な ID です。
●
dataproviderId は、Web Intelligence ドキュメントで使用されるデータプロバイダの有効な ID です。
応答タイプ: application/xml または application/json
応答は、要求の成功または失敗を示すメッセージです。
例
DELETE <url>/documents/7738/dataproviders/DP1
<success>
<message>The resource of type 'Data provider' with identifier 'DP1' has been
successfully removed.</message>
<id>DP1</id>
<success>
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
クエリ仕様: クエリ仕様の取得および更新 [ページ 251]
3.5.4
データプロバイダの変更
マッピング URL を使用して、以下を行います。
マッピング情報の取得: GET <URL>/documents/{documentId}/dataproviders/mappings
データソースの変更: POST <URL>/documents/{documentId}/dataproviders/mappings
3.5.4.1
ドキュメントのデータプロバイダと指定したターゲットデータソー
スの間の提案マッピングを取得する
この URL を使用して、使用可能なマッピングの一覧を取得します。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
233
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{originDataproviderIds}: Web Intelligence ドキュメントのデータプロバイダの識別子は、以下によってドキュメン
トのデータプロバイダ一覧から取得されます: GET http://<serverName>:6405/biprws/raylight/vx/
documents/{documentId}/dataproviders
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders/
mappings?originDataproviderIds={DP1Id},{DP2Id}&targetDatasourceId={DatasourceId}
注記
originDataproviderIds は、カンマで区切られたデータプロバイダの一覧です。 originDataproviderIds が指
定されていない場合、この要求はドキュメントに含まれるすべての既存データプロバイダで実行されます。
ヘッダ
値
Accept
ドキュメントの詳細を取得する: text/xml
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
ドキュメントの有効な ID。
originDataproviderIds
マッピングを考慮するための、カンマで区切られたデータプロバイダの ID。
targetDatasourceId
提案のマッピングに使用されるデータソースの有効な ID。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または
応答本文のコンテンツの長さ
本文 (XML)
以下に説明する、データプロバイダマッピングの詳細
<mappings>
234
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<content>
<mapping status="Ok"/"Ambiguous"/"Not found">. ステータスは、マッピングが完全に一致した場合は
"OK"、不確実なマッピングがある場合は "Ambiguous"、可能な一致がない場合は "NotFound" になります。 'NotFound'
ステータスの場合、ソース変更の実行時に該当する ID がドキュメントから削除されます。各マッピングのソースと対応する
(互換性のある) ターゲット:
<source>
<id>{sourceId}</id>データソース ID
</source>
<target>
<id>{targetId}</id>ターゲット ID
</mapping>
...その他マッピング
...
</mappings>
例
データプロバイダ DP0 およびデータソース ID 9455 のマッピングを取得する
以下の例では、すべての関数の説明を取得する方法を示しています。返された本文の例には 2 つの例のみ示していま
す。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/9460/dataproviders/mappings?
originDataproviderIds=DP0,DP1&targetDatasourceId=11414
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/9460/dataproviders/mappings?
originDataproviderIds=DP0,DP1&targetDatasourceId=11414
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 1800
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
235
<mappings>
<content>
<mapping status="Ok">
<source>
<id>DS0.DO12</id>
</source>
<target>
<id>DS1.DO12</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO13</id>
</source>
<target>
<id>DS1.DO13</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO17</id>
</source>
<target>
<id>DS1.DO17</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO18</id>
</source>
<target>
<id>DS1.DO31</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO2</id>
</source>
<target>
<id>DS1.DO2</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO25</id>
</source>
<target>
<id>DS1.DO25</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO4</id>
</source>
<target>
<id>DS1.DO4</id>
</target>
</mapping>
<mapping status="Ok">
<source>
<id>DS0.DO6</id>
</source>
<target>
<id>DS1.DO6</id>
</target>
</mapping>
236
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<mapping status="Ok">
<source>
<id>DS0.DO7</id>
</source>
<target>
<id>DS1.DO7</id>
</target>
</mapping>
<mapping status="Ambiguous">
<source>
<id>DS0.DO84</id>
</source>
<target>
<id>DS1.DO6</id>
</target>
</mapping>
</content>
</mappings>
マッピングステータスは、マッピングが完全に一致した場合は "OK"、不確実なマッピングがある場合は "Ambiguous"、可
能な一致がない場合は "NotFound" になります。 "NotFound" ステータスの場合、ソース変更の実行時に該当する ID が
ドキュメントから削除されます。
例
2: ターゲットソースが BEx クエリである場合にデータプロバイダ DP0 のマッピングを取得する
下の例は、ターゲットソースが BEx クエリ ID= 10326;Z_BOBJ;AAQUERY_RESTRICT_KF である場合に、すべての関数
説明を取得する方法を示しています。
要求:
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/10554/dataproviders/
mappings?
originDataproviderIds=DP0,DP1&targetDatasourceId=10326;Z_BOBJ;AAQUERY_RESTRICT_KF
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/10554/dataproviders/mappings?
originDataproviderIds=DP0,DP1&targetDatasourceId=10326;Z_BOBJ;AAAQUERY_RESTRICT_KF
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 1800
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
237
<mappings>
<content>
<mapping status="Ok">
<source>
<id>AZ_CITY</id>
</source>
<target>
<id>AZ_CITY</id>
</target>
</mapping>
<mapping status="Ambiguous">
<source>
<id>MA55OT46EO4K803Z77TO03LNMU</id>
</source>
<target>
<id>MD4NTN2159JU9ONUUHTLMNBW3U</id>
</target>
</mapping>
</content>
</mappings>
3.5.4.2 ドキュメントのデータプロバイダと指定したターゲットデータソー
スの間の提案マッピングを更新する
特定のマッピングを使用したデータソースを変更します。提案のマッピングを使用またはカスタムマッピングを宣言できます。
カスタムマッピングでは、特定のマッピングのターゲット ID のみ変更できますが、すべてのソース ID を維持する必要がありま
す。ターゲット ID が null の場合、データソースオブジェクトは削除されます。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{originDataproviderIds}: Web Intelligence ドキュメントのデータプロバイダの識別子は、以下によってドキュメン
トのデータプロバイダ一覧から取得されます: GET http://<serverName>:6405/biprws/raylight/vx/
documents/{documentId}/dataproviders
リクエスト URL
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders/
mappings?originDataproviderIds={DP1Id},{DP2Id}&targetDatasourceId={DatasourceId}
ヘッダ
値
Accept
X-SAP-LogonToken
238
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
ドキュメントの詳細を取得する: text/xml
引用符で囲んだログオントークンの値
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
documentId
ドキュメントの有効な ID。
originDataproviderIds
マッピングを考慮するための、カンマで区切られたデータプロバイダの ID。
targetDatasourceId
提案のマッピングに使用されるデータソースの有効な ID。
本文 (XML)
changesource マッピング、必要時にパラメータを含む (要求に応じる):
<mappings>
<content>
. . . [mappings]
</content>
<parameters>
. . . [parameters]
</parameters>
</mappings>
マッピングの例:
<mappings>
<content>
<mapping>
<source>
<id>DS0.DO84</id>
</source>
<target>
<id>DS1.DO6</id>
</target>
</mapping>
</content>
マッピング情報の後に続くパラメータ例:
<parameters>
<parameter optional="false" type="context">
<id>0</id>
<name>Select a context</name>
<answer constrained="true" type="Text">
<values>
<value id="2">Reservations</value>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
239
本文 (XML)
<values/>
</answer>
</parameter>
</parameters>
</mappings>
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success>
<message>The resource of type 'Document' with identifier 'documentId' has been
successfully updated.</message>
<id>{documentId}</id>
</success>
例
データプロバイダ DP0 およびデータソース ID 9455 のマッピングを更新する
以下の例は、ドキュメント ID 9455 のマッピングを更新する方法です。
本文 (XML) "mappings1.xml"
changesource マッピング、パラメータなし、すべてのソースがターゲットにマップ済み:
<mappings>
<content>
<mapping>
<source>
<id>DS0.DO12</id>
</source>
<target>
<id>DS1.DO12</id>
</target>
</mapping>
<mapping>
<source>
<id>DS0.DO2</id>
240
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML) "mappings1.xml"
</source>
<target>
<id>DS1.DO2</id>
</target>
</mapping>
<mapping>
<source>
<id>DS0.DO6</id>
</source>
<target>
<id>DS1.DO39</id>
</target>
</mapping>
</content>
</mappings>
要求:
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@mappings1.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@mappings1.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
応答:
<success>
<message>The resource of type 'Document' with identifier '9455' has been
successfully updated.</message>
<id>9455</id>
</success>
例
ターゲットに 1 つのソースがマップされていないマッピングファイル
本文 (XML) "mappings2.xml"
changesource マッピング、パラメータなし、最後のソース (DS0.DO6) がターゲットにマップされていない、マッピングか
ら削除予定:
<mappings>
<content>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
241
本文 (XML) "mappings2.xml"
<mapping>
<source>
<id>DS0.DO12</id>
</source>
<target>
<id>DS1.DO12</id>
</target>
</mapping>
<mapping>
<source>
<id>DS0.DO2</id>
</source>
<target>
<id>DS1.DO2</id>
</target>
</mapping>
<mapping>
<source>
<id>DS0.DO6</id>
</source>
<target/>
</mapping>
</content>
</mappings>
要求:
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@mappings2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@mappings2.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
例
パラメータを含むマッピングを宣言する
ドキュメントがパラメータを含む場合、パラメータが要求本文に入力されている必要がある限り応答に表示されます。すべ
てのパラメータが値を持つ場合、応答は成功します。
242
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
要求本文 (XML) "mappings3.xml"
changesource マッピング:
<mappings>
<content>
<mapping>
<source>
<id>_Vy_yePzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Product].[Size]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_ye_zREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Employee].[Birth Date]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_yfPzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Reseller].[Bank Name]</id>
</target>
</mapping>
</content>
</mappings>
要求:
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@mappings3.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@mappings3.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
応答
パラメータ (プロンプトへの応答が必要)、その為、この要求への応答はマッピング情報およびパラメータ要求を返します:
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
243
応答本文 (XML)
changesource マッピング:
<mappings>
<content>
<mapping>
<source>
<id>_Vy_yePzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Product].[Size]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_ye_zREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Employee].[Birth Date]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_yfPzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Reseller].[Bank Name]</id>
</target>
</mapping>
</content>
<parameters>
<parameter optional="false" type="prompt" dpId="DP1">
<id>0</id>
<technicalName>psEnter Age:</technicalName>
<name>Enter Age:</name>
<answer constrained="false" type="Text">
<info cardinality="Single"/>
</answer>
</parameter>
</parameters>
</mappings>
正式に提供されたパラメータと組み合わせた要求を再送します:
パラメータが追加された要求本文 (XML) "mappings3.xml"
changesource マッピングおよびパラメータ:
<mappings>
<content>
<mapping>
<source>
<id>_Vy_yePzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Product].[Size]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_ye_zREeG4Q-3y4CsnNg</id>
</source>
244
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータが追加された要求本文 (XML) "mappings3.xml"
<target>
<id>A[Employee].[Birth Date]</id>
</target>
</mapping>
<mapping>
<source>
<id>_Vy_yfPzREeG4Q-3y4CsnNg</id>
</source>
<target>
<id>A[Reseller].[Bank Name]</id>
</target>
</mapping>
</content>
<parameters>
<parameter>
<id>0</id>
<answer>
<values>
<value id="1">25</value>
</values>
</answer>
</parameter>
</parameters
</mappings>
要求:
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@mappings3.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@mappings3.xml" http://<serverName>:6405/biprws/raylight/v1/documents/9460/
dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414
応答:
<success>
<message>The resource of type 'Document' with identifier '9460' has been
successfully updated.</message>
<id>9460</id>
</success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
245
3.5.5
フロー: データプロバイダのフロー件数の取得
データプロバイダのフロー件数を取得します。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders/
{dataproviderId}/flows/count
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
●
{dataproviderId}: ドキュメントで使用できる dataprovider の識別子は、以下によって取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders
ヘッダ
値
Accept
text/plain
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
dataproviderId
必須。整数。データプロバイダの識別子。
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
text/plain
Content-Length
応答本文のコンテンツの長さ
ボディ
1 ～ n の整数で示されたフローの数。
例
データプロバイダのフロー件数を取得する
注記
ドキュメント ID 7738 で使用できるデータプロバイダ ID DP0 のフローの数を取得します。 1 を返します。
Windows
curl -G -i -H "accept:text/plain" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0/flows/count
246
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/plain" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0/flows/count
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 07 Jun 2012 08:25:56 GMT
Content-Type: text/plain
Content-Length: 1
1
関連リンク
BI プラットフォームにログオンする [ページ 10]
データプロバイダの一覧の取得またはデータプロバイダの追加 [ページ 225]
ドキュメント: 取得、コピー、または作成 [ページ 16]
3.5.6
フロー: CSV または XML 形式でのフロー詳細の取得
XML 形式または CSV 形式で、URL パラメータ flowIndex によって指定されるデータプロバイダフローの詳細を取得しま
す。
注記
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。 GET
http://<serverName>:6405/biprws/raylight/vx/documents。
●
{dataproviderId}: ドキュメントで使用できる dataprovider の識別子は、以下によって取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders
●
{flowIndex}: 1 つのドキュメントで使用できるデータプロバイダフローの数は、以下によって取得されます。GET
http://<serverName>:6405/biprws/raylight/vx/documents/documentId/dataproviders/
dataproviderId/flow/count。最初のインデックス位置は 0 です。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders/
{dataproviderId}/flows/{flowIndex}
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
247
ヘッダ
値
Accept
text/xml または text/plain
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
dataproviderId
必須。整数。データプロバイダの識別子。
flowId
必須。整数。フローの識別子。
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
text/xml または text/plain
応答本文のコンテンツの長さ
ボディ
単一のデータプロバイダに対して、フローおよび詳細タローを取得します。
XML 形式では、行ごとのインデックスセルおよび値です。
CSV 形式では、値のみです。
例
データプロバイダフローの値をテキスト形式で取得する
注記
ドキュメント ID 7744 で使用できるデータプロバイダ DP0 の最初のフロー (flowIndex 0) を取得します。
Windows
curl -G -i -H "accept:text/plain" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/7744/dataproviders/DP0/flows/0
UNIX
248
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/plain" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7744/dataproviders/DP0/flows/0
応答 (CSV 形式)
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 07 Jun 2012 12:10:05 GMT
Content-Type: text/plain
Content-Length: 1026
"Year";"State";"Sales revenue";"Margin"
"2001";"California";"1704210.8";"774893.4"
"2001";"Colorado";"448301.5";"203700.6"
"2001";"DC";"693210.5";"310356.2"
"2001";"Florida";"405985.1";"192479.3"
"2001";"Illinois";"737914.2";"348749.8"
"2002";"California";"2782679.5";"1076528"
"2002";"Colorado";"768389.5";"294482.6"
"2002";"DC";"1215158";"457230.6"
"2003";"California";"2992679";"1121488.5"
...
応答 (XML 形式)
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Thu, 07 Jun 2012 12:10:05 GMT
Content-Type: text/plain
Content-Length: 1026
<DATA_PROVIDERS>
<DATA_PROVIDER>
<ROW>
<CELL INDEX="0">2006</CELL>
<CELL INDEX="1">12</CELL>
<CELL INDEX="2">Texas </CELL>
<CELL INDEX="3">Dallas</CELL>
<CELL INDEX="4">e-Fashion Dallas</CELL>
<CELL INDEX="5">43302.1</CELL>
<CELL INDEX="6">222</CELL>
<CELL INDEX="7">17829.4</CELL>
</ROW>
<ROW>
<CELL INDEX="0">2006</CELL>
<CELL INDEX="1">12</CELL>
<CELL INDEX="2">Texas </CELL>
<CELL INDEX="3">Houston</CELL>
<CELL INDEX="4">e-Fashion Houston</CELL>
<CELL INDEX="5">55454.6</CELL>
<CELL INDEX="6">258</CELL>
<CELL INDEX="7">24614.6</CELL>
</ROW>
<ROW>
<CELL INDEX="0">2006</CELL>
<CELL INDEX="1">12</CELL>
<CELL INDEX="2">Texas </CELL>
<CELL INDEX="3">Houston</CELL>
<CELL INDEX="4">e-Fashion Houston Leighton</CELL>
<CELL INDEX="5">77237.7</CELL>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
249
<CELL INDEX="6">366</CELL>
<CELL INDEX="7">34926.7</CELL>
</ROW>
</DATA_PROVIDER>
</DATA_PROVIDERS>
"Year";"State";"Sales revenue";"Margin"
"2001";"California";"1704210.8";"774893.4"
"2001";"Colorado";"448301.5";"203700.6"
"2001";"DC";"693210.5";"310356.2"
"2001";"Florida";"405985.1";"192479.3"
"2001";"Illinois";"737914.2";"348749.8"
"2002";"California";"2782679.5";"1076528"
"2002";"Colorado";"768389.5";"294482.6"
"2002";"DC";"1215158";"457230.6"
"2003";"California";"2992679";"1121488.5"
...
例
データプロバイダフローの値を XML 形式で取得する
注記
ドキュメント ID 12575 で使用できるデータプロバイダ DP0 の最初のフロー (flowIndex 0) を取得します。
Windows
curl -G -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/12575/dataproviders/DP0/flows/0
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/documents/12575/dataproviders/DP0/flows/0
応答
<DATA_PROVIDERS UID="20916|0|doc_basic|wid" FORCE_REFRESH="FALSE"
DATA_PROVIDER="" FORMATTED="FALSE" REFRESH="FALSE" >
<DATA_PROVIDER NAME="Query 1" SOURCE="eFashion-raylight" DATE="2012/07/31
13:44:25" DURATION="1" CUBE="0">
<COLUMN DSID="DS0.DObc" DPID="DP0.DObc" INDEX="0" TYPE="string">Year</COLUMN>
<COLUMN DSID="DS0.DOda" DPID="DP0.DOda" INDEX="1" TYPE="string">State</COLUMN>
<COLUMN DSID="DS0.DOa5"DPID="DP0.DOa5" INDEX="2" TYPE="string">Lines</COLUMN>
<COLUMN DSID="DS0.DO93" DPID="DP0.DO93" INDEX="3" TYPE="double">Sales revenue</
COLUMN>
<ROW>
<CELL INDEX="0">2004</CELL>
<CELL INDEX="1">California</CELL>
<CELL INDEX="2">Accessories</CELL>
<CELL INDEX="3">489665.9</CELL>
</ROW>
<ROW>
<CELL INDEX="0">2004</CELL>
<CELL INDEX="1">California</CELL>
250
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<CELL INDEX="2">City Skirts</CELL>
<CELL INDEX="3">11072.2</CELL>
</ROW>
<ROW>
<CELL INDEX="0">2004</CELL>
<CELL INDEX="1">California</CELL>
<CELL INDEX="2">City Trousers</CELL>
<CELLINDEX="3">10935.1</CELL>
</ROW>
<ROW>
...
</ROW>
<ROW>
...
</ROW>
<DATA_PROVIDER/>
<DATA_PROVIDERS/>
関連リンク
ドキュメント: 取得、コピー、または作成 [ページ 16]
データプロバイダの一覧の取得またはデータプロバイダの追加 [ページ 225]
フロー: データプロバイダのフロー件数の取得 [ページ 246]
BI プラットフォームにログオンする [ページ 10]
3.5.7
クエリ仕様: クエリ仕様の取得および更新
この URL を使用して、以下の操作を行います。
●
指定したデータプロバイダに添付されているクエリ仕様を返す (GET <url>/documents/{documentId}/
dataproviders/{dataproviderId}/specification)
●
指定したデータプロバイダに添付されているクエリ仕様の更新 (PUT <url>/documents/{documentId}/
dataproviders/{dataproviderId}/specification)
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
注記
{dataproviderId}: Web Intelligence ドキュメントのデータプロバイダの識別子は、以下によってドキュメントのデータ
プロバイダ一覧から取得されます: GET http://<serverName>:6405/biprws/raylight/vx/documents/
{documentId}/dataproviders
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
251
データプロバイダのクエリ仕様の取得
データプロバイダに添付されているクエリ仕様を返します。
リクエスト URL
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/dataproviders/
{dataproviderId}/specification
ヘッダ
値
Accept
text/xml
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
dataproviderId
必須。整数。データプロバイダの識別子。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
text/xml
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
式エンジンから使用できるドキュメント関数の詳細。各関数は、次のとおりです。
<queryspec:QuerySpec xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:queryspec="http://com.sap.sl.queryspec" dataProviderId="DP0">
<queryParameters>
<duplicatedRowsProperty activated="true" value="true"/>
<maxRetrievalTimeInSecondsProperty value="300"/>
<maxRowsRetrievedProperty value="90000"/>
<removeEmptyRowsProperty activated="true" value="true"/>
<allowOtherUserToEditQueryProperty activated="true" value="true"/>
<resetContextOnRefreshProperty activated="true" value="true"/>
<stripQueryProperty/>
</queryParameters>
252
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<queriesTree xsi:type="queryspec:QueryOperatorNode" queryOperator="Union">
<children xsi:type="queryspec:QueryDataNode">
<bOQuery name="Query" identifier="_1y8aENsVEeGswMB7H6m1Qw">
<resultObjects identifier="DS0.DObc" name="Year"/>
<resultObjects identifier="DS0.DOda" name="State"/>
<resultObjects identifier="DS0.DOa5" name="Lines"/>
<resultObjects identifier="DS0.DO93" name="Sales revenue"/>
<conditionPart/>
</bOQuery>
</children>
</queriesTree>
<propertyBag key="DUPLICATED_ROWS_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="RESET_CONTEXT_ON_REFRESH_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="ALLOW_THE_USER_TO_EDIT_QUERY_UNDEFINED_VALUE" value="-1"/>
</queryspec:QuerySpec>
例
ドキュメント ID 7738 のデータプロバイダ ID DP0 のクエリ仕様を取得する
注記
データプロバイダ ID は DP0、ドキュメント ID は 7738 です。
Windows
curl -G -i -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0/
specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0/
specification
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
253
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<queryspec:QuerySpec xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:queryspec="http://com.sap.sl.queryspec" dataProviderId="DP0">
<queryParameters>
<duplicatedRowsProperty activated="true" value="true"/>
<maxRetrievalTimeInSecondsProperty value="300"/>
<maxRowsRetrievedProperty value="90000"/>
<removeEmptyRowsProperty activated="true" value="true"/>
<allowOtherUserToEditQueryProperty activated="true" value="true"/>
<resetContextOnRefreshProperty activated="true" value="true"/>
<stripQueryProperty/>
</queryParameters>
<queriesTree xsi:type="queryspec:QueryOperatorNode"
queryOperator="Union">
<children xsi:type="queryspec:QueryDataNode">
<bOQuery name="Query"
identifier="_1y8aENsVEeGswMB7H6m1Qw">
<resultObjects identifier="DS0.DObc" name="Year"/>
<resultObjects identifier="DS0.DOda" name="State"/>
<resultObjects identifier="DS0.DOa5" name="Lines"/>
<resultObjects identifier="DS0.DO93" name="Sales revenue"/
>
<conditionPart/>
</bOQuery>
</children>
</queriesTree>
<propertyBag key="DUPLICATED_ROWS_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="RESET_CONTEXT_ON_REFRESH_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="ALLOW_THE_USER_TO_EDIT_QUERY_UNDEFINED_VALUE" value="-1"/>
</queryspec:QuerySpec>
データプロバイダのクエリ仕様の更新
データプロバイダに添付されているクエリ仕様を更新します。
要求: PUT http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/
dataproviders/{dataproviderId}/specification
ヘッダ
値
Accept
X-SAP-LogonToken
パラメータ
documentId
ドキュメントの詳細を取得する: text/xml
引用符で囲んだログオントークンの値
説明
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (type=integer, minimum=1,
maximum=既存ドキュメントの最大ドキュメント番号)。
254
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
dataproviderId
必須。整数。データプロバイダの識別子。
本文 (XML)
データプロバイダの更新されたプロパティの詳細:
<queryParameters>
<duplicatedRowsProperty activated="true" value="true"/>
<maxRetrievalTimeInSecondsProperty value="300"/>
<maxRowsRetrievedProperty value="90000"/>
<removeEmptyRowsProperty activated="true" value="true"/>
<allowOtherUserToEditQueryProperty activated="true" value="true"/>
<resetContextOnRefreshProperty activated="true" value="true"/>
<stripQueryProperty/>
</queryParameters>
<queriesTree xsi:type="queryspec:QueryOperatorNode" queryOperator="Union">
<children xsi:type="queryspec:QueryDataNode">
<bOQuery name="Query" identifier="_1y8aENsVEeGswMB7H6m1Qw">
<resultObjects identifier="DS0.DObc" name="Year"/>
<resultObjects identifier="DS0.DOda" name="State"/>
<resultObjects identifier="DS0.DOa5" name="Lines"/>
<resultObjects identifier="DS0.DO93" name="Sales revenue"/>
<conditionPart/>
</bOQuery>
</children>
</queriesTree>
<propertyBag key="DUPLICATED_ROWS_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="RESET_CONTEXT_ON_REFRESH_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="ALLOW_THE_USER_TO_EDIT_QUERY_UNDEFINED_VALUE" value="-1"/></
queryspec:QuerySpec>
注記
<resultObjects> の識別子は、以下の情報で構成される書式 "data_source_prefix.data_source_object_id" の文
字列です。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
255
●
[GET] <url>/documents/{documentId}/dataproviders/{dataproviderId} から取得されるデータ
ソースのプレフィックス
●
[GET] <url>/universes/{universeId} から取得されるデータソースのオブジェクト ID
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
text/xml
Content-Length
応答本文のコンテンツの長さ
本文 (XML)
成功の場合:
<success> <message>The resource of type 'Data provider' with identifier 'DP0' has
been successfully updated.</message> <id>DP0</id></success>
それ以外の場合: <error> ... </error>
例
ドキュメント ID 7738 のデータプロバイダ ID DP0 のクエリ仕様を更新する
更新するクエリ仕様を、specifications.xml などの xml ファイルに記述します。
本文 (XML) "specifications.xml"
<queryspec:QuerySpec xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:queryspec="http://com.sap.sl.queryspec" dataProviderId="DP0">
<queryParameters>
<duplicatedRowsProperty activated="true" value="true"/>
<maxRetrievalTimeInSecondsProperty value="300"/>
<maxRowsRetrievedProperty value="90000"/>
<removeEmptyRowsProperty activated="true" value="true"/>
<allowOtherUserToEditQueryProperty activated="true" value="true"/>
<resetContextOnRefreshProperty activated="true" value="true"/>
<stripQueryProperty/>
</queryParameters>
<queriesTree xsi:type="queryspec:QueryOperatorNode" queryOperator="Union">
<children xsi:type="queryspec:QueryDataNode">
<bOQuery name="Query" identifier="_1y8aENsVEeGswMB7H6m1Qw">
<resultObjects identifier="DS0.DObc" name="Year"/>
<resultObjects identifier="DS0.DOda" name="State"/>
<resultObjects identifier="DS0.DOa5" name="Lines"/>
<resultObjects identifier="DS0.DO93" name="Sales revenue"/>
<conditionPart/>
</bOQuery>
</children>
</queriesTree>
<propertyBag key="DUPLICATED_ROWS_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="RESET_CONTEXT_ON_REFRESH_UNDEFINED_VALUE" value="-1"/>
<propertyBag key="ALLOW_THE_USER_TO_EDIT_QUERY_UNDEFINED_VALUE" value="-1"/>
256
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML) "specifications.xml"
</queryspec:QuerySpec>
Windows
curl -PUT -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@specifications.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
7738/dataproviders/DP0/specification
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -PUT -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@specifications.xml" http://<serverName>:6405/biprws/raylight/v1/documents/7738/
dataproviders/DP0/specification
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'Data provider' with identifier 'DP0' has been
successfully updated.</message>
<id=“DP0“></id>
</success>
3.6
BW 接続および BEx クエリの管理
この節では、BW 接続および BEx クエリの管理に使用できる、以下の主要な操作について説明します。
●
BW 接続のリストの取得 GET <URL>/bwconnections
●
BW 接続の詳細の取得 GET <URL>/bwconnections/{BwConnectionId}
●
BW 接続の詳細の閲覧 PUT <URL>/bwconnections/{BwConnectionId}
●
BEx クエリのアウトラインの取得 PUT <URL>/bwconnections/{BwConnectionId}/outline
●
BEx クエリの機能の取得 PUT <URL>/bwconnections/{BwConnectionId}/capabilities
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
257
3.6.1
BW 接続のリストの取得
BW 接続のリストの取得
この要求は、使用可能な Business Warehouse 接続のリストを返します。表示する権限がある接続のみ、表示できます。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/bwconnections
ヘッダ
値
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
limit
整数。返される接続の最大数。デフォルトは 10 です。
offset
リストの先頭からのオフセット。デフォルト値は 0 です。
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
表示/アクセスする権限がある BW 接続のリストを提供します。
例
BW 接続のリストを取得する
注記
使用可能な BW 接続のリストを取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/bwconnections
258
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/bwconnections
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<bwconnections>
<bwconnection type="Cube">
<id>7052</id>
<cuid>AdDDU67.DyxBkOgpzjDJn30</cuid>
<name>Adventure Works MSAS2005</name>
<folderId>7131</folderId>
</bwconnection>
<bwconnection type="Cube">
<id>11540</id>
<cuid>AbUAJD7zVpZFgy2jQQNMyI8</cuid>
<name>AdventureWorks</name>
<folderId>11484</folderId>
</bwconnection>
<bwconnection type="Cube">
<id>11537</id>
<cuid>AROnvrBXn1tOpsXj_jPPtYo</cuid>
<name>ADW</name>
<folderId>11484</folderId>
</bwconnection>
<bwconnection type="Query">
<id>11487</id>
<cuid>AZSaRdG.bLFAhGKZrHR_Evc</cuid>
<name>bex_all_dim</name>
<folderId>11484</folderId>
</bwconnection>
<bwconnection type="Query">
<id>11489</id>
<cuid>AXRu2fNiQphAtF4O4lJ4OKg</cuid>
<name>bex_simple</name>
<folderId>11484</folderId>
</bwconnection>
<bwconnection type="Cube">
<id>7249</id>
<cuid>Adi_9N.gvR5MjotdV5akMkQ</cuid>
<name>BICS_Cube</name>
<folderId>4066</folderId>
</bwconnection>
<bwconnection type="Query">
<id>7268</id>
<cuid>AUeWmURZfzVKjnpwfTWVxvM</cuid>
<name>BICS_Query</name>
<folderId>4066</folderId>
</bwconnection>
<bwconnection type="System">
<id>7039</id>
<cuid>AY2UQVyb3WRLioC8GBg5Vi0</cuid>
<name>BICS_Server</name>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
259
<folderId>4066</folderId>
</bwconnection>
</bwconnections>
3.6.2
ID による BW 接続の詳細の取得
BW 接続の詳細の取得
この要求は、Business Warehouse 接続の詳細を返します。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/bwconnections/{bwConnectionId}
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
bwConnectionId
必須入力項目です。 BW 接続の ID。
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
表示/アクセスする権限がある BW 接続の詳細を提供します。
<bwconnection type="Query">
<id>11489</id>
<cuid>AXRu2fNiQphAtF4O4lJ4OKg</cuid>
<name>bex_simple</name>
<folderId>11484</folderId>
<bwnodes>
<bwnode type="Query">
260
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<id>11489</id>
<name>A simple Bex Query</name>
<technicalName>QRY_SIMPLE</technicalName>
<path>/QRY_SIMPLE</path>
</bwnode>
</bwnodes>
</bwconnection>
例
BW 接続の詳細を参照する (タイプがクエリ)
注記
使用可能な BW 接続のリストを取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/bwconnections/{bwConnectionId}
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/bwconnections/{bwConnectionId}
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<bwconnection type="Query">
<id>11489</id>
<cuid>AXRu2fNiQphAtF4O4lJ4OKg</cuid>
<name>bex_simple</name>
<folderId>11484</folderId>
<bwnodes>
<bwnode type="Query">
<id>11489</id>
<name>A simple Bex Query</name>
<technicalName>QRY_SIMPLE</technicalName>
<path>/QRY_SIMPLE</path>
</bwnode>
</bwnodes>
</bwconnection>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
261
例
不完全な BW 接続の詳細を参照する (タイプがシステムまたはキューブ)
注記
使用可能な BW 接続のリストを取得します。不完全な BW 接続の場合、システム/キューブを参照し、接続を完全にす
る、タイプがクエリ (BEx クエリ) の BW ノードを探す必要があります。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/bwconnections/{bwConnectionId}
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/bwconnections/{bwConnectionId}
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<bwconnection type="System">
<id>11990</id>
<cuid>Aaj0N_I.bSJElyDKk08sxTU</cuid>
<name>raylight_BOF</name>
<folderId>11484</folderId>
<bwnodes>
<bwnode type="Favorites">
<name>Favorites</name>
<technicalName>SystemFavoritesTopLevel</technicalName>
<path>/SystemFavoritesTopLevel</path>
</bwnode>
<bwnode type="InfoArea">
<name>InfoArea</name>
<technicalName>SystemInfoareaTopLevel</technicalName>
<path>/SystemInfoareaTopLevel</path>
</bwnode>
</bwnodes>
</bwconnection>
262
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.6.3
BW 接続の詳細の参照
BW 接続の詳細の参照
この要求は、Business Warehouse 接続の詳細を返します。この URL を使用すると、不完全な BW 接続の詳細を、その ID
を使用して参照し、接続を完全にする BEx クエリを選択できます。次の 2 つの参照メソッドを使用できます。パスを指定する
メソッドと、パターンによって検索するメソッドです。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/bwconnections/{BwConnectionId}
ヘッダ
Accept
X-SAP-LogonToken
値
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
BwConnectionId
必須入力項目です。 BW 接続の ID。
要求本文 (XML)
パスまたは検索パターンを定義します。
パスの場合:
<bwnode>
<path>[path/to/the/required/node]</path>
</bwnode>
検索パターンの場合:
<bwnode>
<pattern>[pattern to be used for the search]</pattern>
</bwnode>
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
263
本文 (XML)
表示/アクセスする権限がある BW 接続のリストを提供します。
例
1: パスを使用して参照し、BW 接続内で BEx クエリのリストを取得する
注記
BW 接続内で BEx クエリのリストを取得します。
Windows
curl "PUT" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@browsepath" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@browsepath" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}
要求本文 (XML) "browsepath.xml"
<bwnode>
<path>/SystemInfoareaTopLevel/BUSINESSOBJECTS_QA/Z_BOBJ/TEST_DATE</path>
</bwnode>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<bwconnection type="System">
<id>11990</id>
<cuid>Aaj0N_I.bSJElyDKk08sxTU</cuid>
<name>raylight_BOF</name>
<folderId>11484</folderId>
<bwnodes>
<bwnode type="Query">
<id>11990;TEST_DATE</id>
<name>test_data</name>
<technicalName>TEST_DATE</technicalName>
<mdxCompliant>true</mdxCompliant>
<path>/SystemInfoareaTopLevel/BUSINESSOBJECTS_QA/Z_BOBJ/TEST_DATE</
path>
</bwnode>
</bwnodes>
</bwconnection>
264
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
例
2: パターンを使用して参照し、BW 接続内で BEx クエリのリストを取得する
注記
パターンが一致する BW 接続内で BEx クエリのリストを取得します。
Windows
curl "PUT" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@browsepattern" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@browsepattern" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}
要求本文 (XML) "browsepattern.xml"
<bwnode>
<pattern>*BOBJ*</pattern>
</bwnode>
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<bwconnection type="System">
<id>11990</id>
<cuid>Aaj0N_I.bSJElyDKk08sxTU</cuid>
<name>raylight_BOF</name>
<folderId>11484</folderId>
<bwnodes>
<bwnode type="Query">
<id>11990;Z_BOBJ;BOBJ_TEST_ROLE</id>
<name>BOBJ_TEST_ROLE</name>
<technicalName>BOBJ_TEST_ROLE</technicalName>
<mdxCompliant>false</mdxCompliant>
</bwnode>
<bwnode type="Query">
<id>11990;Z_BOBJ;IE_ZBOBJ_COUNTRYVAR</id>
<name>IE_ZBOBJ_COUNTRYVAR</name>
<technicalName>IE_ZBOBJ_COUNTRYVAR</technicalName>
<mdxCompliant>true</mdxCompliant>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
265
</bwnode>
<bwnode type="Query">
<id>11990;T_BOBJ;ZCR_BOBJ_ALLF_MHIER_FCHAR_1</id>
<name>ZCR BOBJ all_fields mult_hier free_chars</name>
<technicalName>ZCR_BOBJ_ALLF_MHIER_FCHAR_1</technicalName>
<mdxCompliant>false</mdxCompliant>
</bwnode>
<bwnode type="Query">
<id>11990;Z_BOBJ;Z_BOBJ_HB_SIMPLE</id>
<name>Z_BOBJ_HB_simple</name>
<technicalName>Z_BOBJ_HB_SIMPLE</technicalName>
<mdxCompliant>true</mdxCompliant>
</bwnode>
</bwnodes>
</bwconnection>
注記
BEx クエリの ID は、BW 接続の ID および BEx クエリの技術名を ";" で区切って連結することで定義されます。
注記
MDX に準拠する BEx クエリのみが Web Intelligence ワークフローで使用できます。
3.6.4
BEx クエリのアウトラインの取得
BEx クエリのアウトラインの取得
この要求は、Business Warehouse 接続の詳細を返します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/bwconnections/{bwConnectionId}/outline
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
bwConnectionId
必須入力項目です。 BW 接続の ID。
266
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
オプションの要求本文 (XML)
<bwnode>
<id>The ID of the BEx query</id>
</bwnode>
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
表示/アクセスする権限がある BEx クエリのアウトラインを提供します。
<outline>
<item type="Dimension">
<name>Country</name>
<description>Country</description>
<item type="Hierarchy">
<name>Country</name>
<description>Country</description>
<id>HZ_COUNTRY</id>
</item>
<item type="Hierarchy">
<name>Country Hierarchy 01</name>
<description>Country Hierarchy 01</description>
<item type="Level">
<name>Level 01</name>
<description>Level 01</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#1</id>
</item>
<item type="Level">
<name>Level 02</name>
<description>Level 02</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#2</id>
</item>
<item type="Level">
<name>Level 03</name>
<description>Level 03</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#3</id>
</item>
<id>HCOUNTRY_HIERARCHY_01|Z_COUNTRY</id>
</item>
. . .
<item type="Measure">
<name>Voyager Training 01 - Restricted KF</name>
<description>Voyager Training 01 - Restricted KF</description>
<item type="Attribute">
<name>Voyager Training 01 - Restricted KF Currency</name>
<id>MD4NUM119ATNWC7USQ4XYSA0QY.Currency</id>
</item>
<item type="Attribute">
<name>Voyager Training 01 - Restricted KF Formatted Value</name>
<id>MD4NUM119ATNWC7USQ4XYSA0QY.FormattedValue</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
267
本文 (XML)
</item>
<id>MD4NUM119ATNWC7USQ4XYSA0QY</id>
</item>
</outline>
例
BEx クエリのアウトラインを取得する
注記
使用可能な BW 接続のリストを取得します。
要求本文:
要求本文 (XML) bexqueryid.xml
<bwnode>
<id>The ID of the BEx query</id>
</bwnode>
<bwnode>
<id>11990;ROLE_ST_BEX5</id>
</bwnode>
Windows
curl "PUT" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%""" d "@bexqueryid.xml" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}/outline
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@bexqueryid.xml" http://<serverName>:6405/biprws/raylight/v1/bwconnections/
{BwConnectionId}/outline
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<outline>
<item type="Dimension">
<name>Country</name>
<description>Country</description>
<item type="Hierarchy">
268
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<name>Country</name>
<description>Country</description>
<id>HZ_COUNTRY</id>
</item>
<item type="Hierarchy">
<name>Country Hierarchy 01</name>
<description>Country Hierarchy 01</description>
<item type="Level">
<name>Level 01</name>
<description>Level 01</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#1</id>
</item>
<item type="Level">
<name>Level 02</name>
<description>Level 02</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#2</id>
</item>
<item type="Level">
<name>Level 03</name>
<description>Level 03</description>
<id>LCOUNTRY_HIERARCHY_01|Z_COUNTRY.#3</id>
</item>
<id>HCOUNTRY_HIERARCHY_01|Z_COUNTRY</id>
</item>
. . .
<item type="Measure">
<name>Voyager Training 01 - Restricted KF</name>
<description>Voyager Training 01 - Restricted KF</description>
<item type="Attribute">
<name>Voyager Training 01 - Restricted KF Currency</name>
<id>MD4NUM119ATNWC7USQ4XYSA0QY.Currency</id>
</item>
<item type="Attribute">
<name>Voyager Training 01 - Restricted KF Formatted Value</name>
<id>MD4NUM119ATNWC7USQ4XYSA0QY.FormattedValue</id>
</item>
<id>MD4NUM119ATNWC7USQ4XYSA0QY</id>
</item>
</outline>
3.6.5
BEx クエリの機能の取得
BEx クエリの機能の取得
この要求は、BEx クエリの機能を返します。
要求:
PUT http://<serverName>:6405/biprws/raylight/vx/bwconnections/{bwConnectionId}/
capabilities
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
269
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
パラメータ
説明
bwConnectionId
必須入力項目です。 BW 接続の ID。
オプションの要求本文 (XML)
<bwnode>
<id>11990;Z_BOBJ;ROLE_ST_BEX5</id>
</bwnode>
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
表示/アクセスする権限がある BEx クエリの機能を提供します。
<datasource:QueryCapability xmlns:datasource="http://com.sap.sl.datasource">
<generalCapability customQueryScriptSupported="false"
showHideScopeSupported="false"/>
<dataProcessingCapability removeEmptyRowsAvailable="true"
maxRetrievalTimeAvailable="false" queryStrippingAvailable="true"/>
<filterCapability resultHierarchyInFilterSupported="false"
constantComparisonSupported="true" hierarchyConstantOperandSupported="true">
<supportedComparisonOperators>equal</supportedComparisonOperators>
<supportedComparisonOperators>notEqual</supportedComparisonOperators>
<supportedComparisonOperators>inList</supportedComparisonOperators>
<supportedComparisonOperators>notInList</supportedComparisonOperators>
<supportedComparisonOperators>between</supportedComparisonOperators>
<supportedComparisonOperators>notBetween</supportedComparisonOperators>
<supportedComparisonOperators>greater</supportedComparisonOperators>
<supportedComparisonOperators>greaterOrEqual</supportedComparisonOperators>
<supportedComparisonOperators>less</supportedComparisonOperators>
<supportedComparisonOperators>lessOrEqual</supportedComparisonOperators>
<supportedValueBasedHierarchyComparisonOperators>equal</
supportedValueBasedHierarchyComparisonOperators>
<supportedValueBasedHierarchyComparisonOperators>inList</
supportedValueBasedHierarchyComparisonOperators>
<supportedLevelBasedHierarchyComparisonOperators>equal</
supportedLevelBasedHierarchyComparisonOperators>
<supportedLevelBasedHierarchyComparisonOperators>inList</
supportedLevelBasedHierarchyComparisonOperators>
<supportedLogicalOperators>and</supportedLogicalOperators>
<supportedObjects>attribute</supportedObjects>
270
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
<supportedObjects>dimension</supportedObjects>
<supportedObjects>hierarchy</supportedObjects>
<supportedObjects>level</supportedObjects>
</filterCapability>
<resultObjectCapability useAttributeSeparatelyAvailable="true"
buildLogicalSetWithMetadataFunctionsAvailable="true"
buildLogicalSetWithMemberFunctionsAvailable="true"
memberSelectionPromptSupported="true" supportsMemberSelectionCompletion="true"/>
</datasource:QueryCapability>
例
BEx クエリの機能を取得する
注記
使用可能な BW 接続のリストを取得します。
Windows
curl "PUT" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/bwconnections/{BwConnectionId}/
capabilities
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/bwconnections/{BwConnectionId}/capabilities
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 12:06:42 GMT
Content-Type: application/xml
Content-Length: 544
<datasource:QueryCapability xmlns:datasource="http://com.sap.sl.datasource">
<generalCapability customQueryScriptSupported="false"
showHideScopeSupported="false"/>
<dataProcessingCapability removeEmptyRowsAvailable="true"
maxRetrievalTimeAvailable="false" queryStrippingAvailable="true"/>
<filterCapability resultHierarchyInFilterSupported="false"
constantComparisonSupported="true" hierarchyConstantOperandSupported="true">
<supportedComparisonOperators>equal</supportedComparisonOperators>
<supportedComparisonOperators>notEqual</supportedComparisonOperators>
<supportedComparisonOperators>inList</supportedComparisonOperators>
<supportedComparisonOperators>notInList</supportedComparisonOperators>
<supportedComparisonOperators>between</supportedComparisonOperators>
<supportedComparisonOperators>notBetween</supportedComparisonOperators>
<supportedComparisonOperators>greater</supportedComparisonOperators>
<supportedComparisonOperators>greaterOrEqual</supportedComparisonOperators>
<supportedComparisonOperators>less</supportedComparisonOperators>
<supportedComparisonOperators>lessOrEqual</supportedComparisonOperators>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
271
<supportedValueBasedHierarchyComparisonOperators>equal</
supportedValueBasedHierarchyComparisonOperators>
<supportedValueBasedHierarchyComparisonOperators>inList</
supportedValueBasedHierarchyComparisonOperators>
<supportedLevelBasedHierarchyComparisonOperators>equal</
supportedLevelBasedHierarchyComparisonOperators>
<supportedLevelBasedHierarchyComparisonOperators>inList</
supportedLevelBasedHierarchyComparisonOperators>
<supportedLogicalOperators>and</supportedLogicalOperators>
<supportedObjects>attribute</supportedObjects>
<supportedObjects>dimension</supportedObjects>
<supportedObjects>hierarchy</supportedObjects>
<supportedObjects>level</supportedObjects>
</filterCapability>
<resultObjectCapability useAttributeSeparatelyAvailable="true"
buildLogicalSetWithMetadataFunctionsAvailable="true"
buildLogicalSetWithMemberFunctionsAvailable="true"
memberSelectionPromptSupported="true" supportsMemberSelectionCompletion="true"/>
</datasource:QueryCapability>
3.7
ドキュメントのスケジュール
この節では、Web Intelligence ドキュメントをスケジュールする以下の主要な操作について説明します。
●
既存の Web Intelligence ドキュメントのスケジュールの一覧を取得する方法
●
スケジュールアクションの詳細を取得する方法
●
スケジュールを追加する方法
●
既存のスケジュールを削除する方法
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
関連リンク
ドキュメントのスケジュール一覧の取得 [ページ 273]
ドキュメントへのスケジュールの追加 [ページ 275]
スケジュールの詳細の取得 [ページ 293]
ドキュメントスケジュールの削除またはキャンセル [ページ 295]
272
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.7.1
日時形式について
Raylight は、以下の日時形式をサポートします。日付時刻の字句表現は、長さに限りがある、以下の形式の文字シーケンス
で構成されます。
yyyy-mm-ddThh:mm:ss(zzzzzz)。以下は各要素の説明です。
文字列
説明
yyyy
年を表す 4 桁です。
-
日付の部分の一部を区切る、区切り文字です。
最初の mm
月を表す 2 桁の数字です。
dd
日を表す 2 桁の数字です。
T
時刻が続くことを表す区切り文字です。
hh
時を表す 2 桁の数字です。
:
時刻の部分の一部を区切る、区切り文字です。
2 番目の mm
分を表す 2 桁の数字です。
tt
整数の秒を表す 2 桁の整数です。
zzzzzz
zzzzzz は、(指定された場合) 次の W3C 勧告に沿ったタイムゾ
ーンを表します: http://www.w3.org/TR/xmlschema-2/
または
#dateTime。 zzzzzzz が指定されていない場合は、指定された
時刻は GMT です。 offset を含むことができます。たとえ
offset
ば、-5:00 は、米国の中部夏時間と東部標準時に対応します。
例
2002-10-10T12:00:00-05:00 (米国中部夏時間および東部標準時の 2002 年 10 月 10 日)
2002-10-10T12:00:00Z (タイムゾーンを指定した同じ日時)
3.7.2
ドキュメントのスケジュール一覧の取得
この URL は以下の操作を行います。
●
Web Intelligence ドキュメントの既存のスケジュール一覧の取得 (GET <url>/documents/{documentId}/
schedules)。
スケジュールの詳細については、ヘルプポータルの SAP Business Objects Business Intelligence プラットフォーム、BI 起
動パッドユーザガイドを参照してください。リンクは、このセクションの最後にあります。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。 GET
http://<serverName>:6405/biprws/raylight/vx/documents。ドキュメントがスケジュールされているかど
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
273
うかは、 GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId} を使用して
ドキュメントの詳細を取得することによって確認できます。応答本文で返される <scheduled> 要素は、ドキュメントがス
ケジュールされている場合は true、それ以外の場合は false になります。
既存のスケジュール一覧の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
各スケジュールに対して、id、name、format、および status。
ステータスは、待機、実行中、一時停止、完了、または失敗です。
例
ドキュメントのスケジュールインスタンスの一覧を取得する
Windows
curl -i -G -H "accept:application/xml" -H X-SAP-logonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/4986/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/4986/schedules
274
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 188
<schedules>
<schedule>
<id>28600</id>
<name>instanceWebi2Inbox</name>
<format>Webi</format>
<status>Completed</status>
</schedule>
<schedule>
<id>28609</id>
<name>instancePDF</name>
<format>Pdf</format>
<status>Completed</status>
</schedule>
<schedule>
<id>28651</id>
<name>instanceWebi2Inbox</name>
<format>Webi</format>
<status>Completed</status>
</schedule>
<schedule>
<id>28810</id>
<name>instanceWebI</name>
<format>Webi</format>
<status>Completed</status>
</schedule>
</schedules>
関連リンク
ドキュメントへのスケジュールの追加 [ページ 275]
スケジュールの詳細の取得 [ページ 293]
ドキュメントスケジュールの削除またはキャンセル [ページ 295]
3.7.3
ドキュメントへのスケジュールの追加
この URL は以下の操作を行います。
●
ドキュメントへの新しいスケジュールの追加 (POST <url>/documents/{documentId}/schedules)
スケジュールの詳細については、ヘルプポータルの SAP Business Objects Business Intelligence プラットフォーム、BI 起
動パッドユーザガイドを参照してください。リンクは、このセクションの最後にあります。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。 GET
http://<serverName>:6405/biprws/raylight/vx/documents。ドキュメントがスケジュールされているかど
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
275
うかは、 GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId} を使用して
ドキュメントの詳細を取得することによって確認できます。応答本文で返される <scheduled> 要素は、ドキュメントがス
ケジュールされている場合は true、それ以外の場合は false になります。
新しいスケジュールの追加
Web Intelligence ドキュメントの新しいスケジュールを追加できます。
スケジュールはさまざまな形式で複数の宛先へ送信でき、1 回限り、毎日、毎時、毎月で設定できます。また、スケジュールの
実行に使用するサーバグループを選択できます。これらの設定は要求の本文内に記述されます。
要求:
POST http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
新しいスケジュールの場合、要求本文内で以下を指定します。
●
名前
●
送信先。 <inbox/> BI 起動パッドの受信ボックスまたは <mail/> アドレス、<ftp/>、および <file system/>。
●
ドキュメント形式の種類。 "webi"、"pdf"、"xls"、"csv" を指定できます。デフォルトの形式は "webi" です。"csv"
の種類には固有のオプションがあります。下記を参照してください。
●
繰り返しは、<once>、<now>、<hourly>、<daily>、<monthly> を指定できます。
●
スケジュールの実行に使用されるサーバグループ。
これらのパラメータについては、後にある別表で詳しく説明されています。
次の表で、XML 要求本文の <destination/> 部分について説明します。
表 25: <mail> の XML 要求本文
<mail> 送信先の本文 XML
<schedule/>
<name/>
<destination/> <keepInstanceInHistory/>。論理値。デフォルト値は true。スケジュールドキュメントのイン
スタンスを履歴に保持します。
すべての使用可能な送信先について、以下を指定します。
<useSpecificName/>: 送信先におけるスケジュールドキュメントの特定の名前。指定しない場合、デフォルト名が使用さ
れます。
送信先の <mail>
276
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<mail> 送信先の本文 XML
<mail>
<from>[email protected]</from>
<to>[email protected]</to>
<cc>[email protected]</cc>
<bcc>[email protected]</bcc>
<subject>Web Intelligence Restful WS</subject>
<message>Text to send</message>
<addAttachment>true</addAttachment>
</mail>
表 26: <inbox> の XML 要求本文
<ftp> 送信先の本文 XML
<schedule/>
<name>instanceToWebIntelligenceInbox </name>
<format type="webi"/>
<destination> <inbox/> </destination>。
表 27: <ftp> の XML 要求本文
<ftp> 送信先の本文 XML
<schedule/>
<name/>
<destination/> <keepInstanceInHistory/>。論理値。デフォルト値は true。スケジュールドキュメントのイン
スタンスを履歴に保持します。
すべての使用可能な送信先について、以下を指定します。
<useSpecificName/>: 送信先におけるスケジュールドキュメントの特定の名前
<useDefaultSettings/>。論理値。デフォルト値は false。
送信先の <ftp>
<ftp>
<host>host_name </host>
<port>port_numer</port>
<username>user_name</username>
<password>password</password>
<account>account_name</account>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
277
<ftp> 送信先の本文 XML
<directory>directory_name</directory>
</ftp>
表 28: <filesystem> の XML 要求本文
<filesystem> 送信先の本文 XML
<schedule/>
<name/>
<destination/> <keepInstanceInHistory/>。論理値。デフォルト値は true。スケジュールドキュメントのイン
スタンスを履歴に保持します。
すべての使用可能な送信先について、以下を指定します。
<useSpecificName/>: <useAutomaticName=false/> の場合、送信先におけるスケジュールドキュメントの特定の
名前
<useDefaultSettings/>。論理値。デフォルト値は false。
送信先の <filesystem>
<filesystem>
<username>user_name</username>
<password>password</password>
<directory>directory_name</directory>
</filesystem>
表 29: <format> の XML 要求本文
<format> 送信先の本文 XML
<format type= "webi"/> または
<format type= "pdf"/> または
<format type= "xls"/> または
<format type= "csv">...</csv>
以下は "csv" 形式の種類に固有です。
<format type="csv">
<properties>
<property key= "textQualifier" >'</property> ' または " を指定できます
<property key= "columnDelimiter" >,</property>。 ,、;、または Tab を指定できます。
<property key= "charset" >UTF-8</property>。有効なサーバ文字セット。
<property key= "onePerDataProvider" > false </property>
278
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<format> 送信先の本文 XML
</properties>
</format>
表 30: 繰り返しの XML 要求本文
繰り返しの本文 XML
<schedule/>
今すぐスケジュールします
<destination/>
<name/>
<format type=/>
<once retriesAllowed="2"
retryIntervalInSeconds= "60" >
<startdate>2012-08-26T15:58:51.000+02:00</
startdate>
1 回だけスケジュールします。
このスケジュールは開始日のみに起動されます。
<enddate>2013-08-27T15:58:51.000+02:00</
enddate>
</once>
<daily retriesAllowed="2"
毎日スケジュールします
retryIntervalInSeconds= "60"
><startdate>2012-08-26T15:58:51.000+02:00< ● retriesAllowed="2" retryIntervalInSeconds= "60"
(60 秒間隔で 2 回再試行します)
/startdate>
● スケジュールを起動する日時
<enddate>2012-09-14T15:58:51.000+02:00</
● スケジュールを停止する日時
enddate>
● スケジュールを繰り返す日数間隔
<dayinterval>1</dayinterval>
</daily>
<hourly retriesAllowed="2"
retryIntervalInSeconds="60" >
<startdate>2012-08-26T15:58:51.000+02:00</
startdate>
<enddate>2012-09-14T15:58:51.000+02:00</
enddate>
毎時スケジュールします
●
retriesAllowed="2" retryIntervalInSeconds= "60"
(60 秒間隔で 2 回再試行します)
●
スケジュールを起動する日時
●
スケジュールを停止する日時
●
スケジュールを繰り返す時間間隔
<hour>1</hour>
<minute>30</minute>
</hourly>
<monthly retriesAllowed="2"
retryIntervalInSeconds= "60" >
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
毎月スケジュールします
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
279
繰り返しの本文 XML
<startdate>2012-08-26T15:58:51.000+02:00</ ●
startdate>
<enddate>2013-09-14T15:58:51.000+02:00</
enddate>
<month>1</month>
retriesAllowed="2" retryIntervalInSeconds= "60"
(60 秒間隔で 2 回再試行します)
●
スケジュールを起動する日時
●
スケジュールを停止する日時
●
スケジュールを繰り返す月間隔
</monthly>
表 31: サーバグループの XML 要求本文
サーバグループの本文 XML
<serverGroup id="1236" required="false"/>
説明
スケジュールの実行に使用するサーバグループを選択でき
ます。
●
id: 整数。 Console Management System で定義され
ているサーバグループの ID
●
required: 論理値。デフォルト値は false。スケジュ
ールはできるだけ、指定されたサーバグループに属する
サーバで実行されます。指定されたサーバが使用でき
ない場合、オブジェクトは次の使用可能なサーバで処理
されます。それ以外の場合: true。
true の場合、選択されたサーバグループ内で見つかった、
指定されたサーバのみが使用されます。サーバグループの
すべてのサーバが使用できない場合、スケジュールは処理
されません。
表 32: <CSV> 形式ファイルの XML 要求本文
<mail> 送信先の本文 XML
<Format type=CSV>
<name/>
<destination/>
すべての使用可能な送信先について、以下を指定します。
<useAutomaticName/>: 論理値。デフォルト値は true。スケジュールドキュメントの名前。 true の場合、名前は
<name/> で指定されたものと同じです。
<useSpecificName/>: <useAutomaticName=false/> の場合、送信先におけるスケジュールドキュメントの特定の
名前
<keepInstanceInHistory/>。論理値。デフォルト値は true。スケジュールドキュメントのインスタンスを履歴に保持
します。
<useDefaultSettings/>。論理値。デフォルト値は false。
送信先の <mail>
280
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<mail> 送信先の本文 XML
<mail>
<from>[email protected]</from>
<to>[email protected]</to>
<cc>[email protected]</cc>
<bcc>[email protected]</bcc>
<subject>Web Intelligence Restful WS</subject>
<message>Text to send</message>
<addAttachment>true</addAttachment>
</mail>
表 33: <CSV> 出力の XML 要求本文
<mail> 送信先の本文 XML
<format type="csv">
<properties>
<property key="textQualifier">"</property>
<property key="columnDelimiter">,</property>
<property key="charset">UTF-8</property>
<property key="onePerDataProvider">false</property>
</properties>
</format>
すべての使用可能な送信先について、以下を指定します。
<useAutomaticName/>: 論理値。デフォルト値は true。スケジュールドキュメントの名前。 true の場合、名前は
<name/> で指定されたものと同じです。
<useSpecificName/>: <useAutomaticName=false/> の場合、送信先におけるスケジュールドキュメントの特定の
名前
<keepInstanceInHistory/>。論理値。デフォルト値は true。スケジュールドキュメントのインスタンスを履歴に保持
します。
<useDefaultSettings/>。論理値。デフォルト値は false。
送信先の <mail>
<mail>
<from>[email protected]</from>
<to>[email protected]</to>
<cc>[email protected]</cc>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
281
<mail> 送信先の本文 XML
<bcc>[email protected]</bcc>
<subject>Web Intelligence Restful WS</subject>
<message>Text to send</message>
<addAttachment>true</addAttachment>
</mail>
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json。
応答本文のコンテンツの長さ
ボディ
スケジュールステータスを示すメッセージを返します。成功の場合、新しいスケジュールドキュメントの ID が示されます。
スケジュール機能の詳細については、このセクションの末尾にあるリンクにあるヘルプポータルの BI 起動パッドユーザガイ
ドを参照してください。
例
1: BI 受信ボックスへの 1 回のスケジュール
注記
ドキュメント ID 8002 をスケジュールします。スケジュールパラメータは scheduleOnce.xml ファイルで指定され、こ
のファイルは cURL コマンドの -d "@scheduleOnce.xml" で呼び出されます。 ID 9354 がスケジュールされたドキ
ュメントに設定されています。この例では、1 回のスケジュールを設定する方法を示します。結果は受信ボックスに送信
され、使用されます。スケジュールが失敗した場合、再試行はありません。
この例では、送信先オプションを使用し、送信先への新しいスケジュールを追加する方法を示します。
●
keepInstanceInHistory: インスタンスを履歴に保持します。"destination" タグ内の値 true/false で属性を
指定します。デフォルト設定は "true" です。
●
useSpecificName: "useSpecificName" タグ内に、特定の名前を宣言します。このタグが指定されていない場
合は自動の名前が使用されます。
●
fileExtension: "useSpecificName" タグ内の値 true/false で、"fileExtension" 属性を指定します。デフォ
ルト設定は "true" です。
scheduleOnce.xml の詳細
<schedule>
<name>schedTest</name>
282
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<format type="webi"/>
<destination keepInstanceInHistory="false">
<useSpecificName fileExtension="false">-customTest</useSpecificName>
<inbox/>
</destination>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduleOnce.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduleOnce.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Mon, 11 Jun 2012 08:38:03 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>Schedule has been done.</message>
<id>8002</id>
</success>
例
2: BI 受信ボックスへの毎日のスケジュール
注記
ドキュメント ID 8002 を毎日スケジュールし、60 秒間隔で 2 回の再試行を許可します。スケジュールパラメータは
scheduledDaily.xml ファイルで指定され、このファイルは cURL コマンドの -d "@scheduleDaily.xml" で呼
び出されます。 ID 9354 がスケジュールされたドキュメントに設定されています。
scheduledDaily.xml の詳細
<schedule>
<name>test_daily_inbox</name>
<format type="webi"/>
<destination><inbox/></destination>
<daily retriesAllowed="2" retryIntervalInSeconds="60">
<startdate>2012-08-26T14:00:00</startdate>
<enddate>2012-09-14T16:00:00</enddate>
<dayinterval>1</dayinterval>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
283
</daily>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledDaily.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledDaily.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
例
3: BI 受信ボックスへの 90 分ごとのスケジュール
注記
ドキュメント ID 8002 を 1 時間半ごとでスケジュールし、60 秒間隔で 2 回の再試行を許可します。スケジュールパラメ
ータは scheduledHourly.xml ファイルで指定され、このファイルは cURL コマンドの -d
"@scheduledHourly.xml" で呼び出されます。 ID 9354 がスケジュールされたドキュメントに設定されています。
scheduledHourly.xml の詳細
<schedule>
<name>test_90min_inbox</name>
<format type="webi"/>
<destination><inbox/></destination>
<hourly retriesAllowed="2" retryIntervalInSeconds="60">
<startdate>2012-08-26T14:00:00</startdate>
<enddate>2012-09-14T16:00:00</enddate>
<hour>1</hour>
<minute>30</minute>
</hourly>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourly.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
284
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourlyFilesyst.xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
例
4: 毎月のスケジュールの追加
注記
ドキュメント ID 8002 をスケジュールします。スケジュールパラメータは scheduledMonthly.xml ファイルで指定さ
れ、このファイルは cURL コマンドの -d "@scheduledMonthlyFtp.xml" で呼び出されます。 ID 9354 がスケジ
ュールされたドキュメントに設定されています。
scheduledMonthly.xml の詳細
<schedule>
<name>test_monthly_inbox</name>
<format type="webi"/>
<destination><inbox/></destination>
<monthly retriesAllowed="2" retryIntervalInSeconds="30">
<startdate>2012-08-26T14:00:00</startdate>
<enddate>2012-09-14T16:00:00</enddate>
<month>1</month>
</monthly>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledMonthly.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledMonthly.xml.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
285
例
5: 新しい 1 回のスケジュールの追加
注記
ドキュメント ID 8002 をスケジュールします。スケジュールパラメータは now.xml ファイルで指定され、このファイルは
cURL コマンドの -d "@now.xml" で呼び出されます。 ID 9354 がスケジュールされたドキュメントに設定されていま
す。
now.xml の詳細
<schedule>
<name>test_once_inbox</name>
<format type="webi"/>
<destination><inbox/></destination>
<monthly retriesAllowed="2" retryIntervalInSeconds="30">
<startdate>2012-08-26T14:00:00</startdate>
<enddate>2012-09-14T16:00:00</enddate>
<month>1</month>
</monthly>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@now.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@now.xml.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/
raylight/v1/documents/8002/schedules
例
6: 特定ユーザの受信ボックスを送信先とする新しい 1 回のスケジュールの追加
注記
この例では、ユーザ ID を 4 つ指定して、受信ボックスを送信先とする新しいスケジュールを追加する方法を示します。
デフォルトでは、スケジュールされたドキュメントは常に送信者へ送信されます。 sendAs タグで値 shortcut (デフォル
ト値は copy) を指定することにより、スケジュールされたドキュメントをショートカットとして送信できます。ドキュメント ID
8002 をスケジュールします。スケジュールパラメータは now.xml ファイルで指定され、このファイルは cURL コマンド
の -d "@now.xml" で呼び出されます。 ID 9354 がスケジュールされたドキュメントに設定されています。
now.xml の詳細
<schedule>
<name>test_once_inbox_users</name>
286
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<format type="webi"/>
<destination>
<inbox>
<to>11,12,1,2
<sendAs type="shortcut"/>
</inbox>
</destination>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@now.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@now.xml.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/
raylight/v1/documents/8002/schedules
例
7: 電子メール受信者への新しい今すぐのスケジュールの追加
注記
この例では、新しい毎時タイプのスケジュール (2012 年 8 月 26 日から 2012 年 9 月 14 日まで 1 時間半ごと) を追加
する方法を示します。スケジュールが失敗した場合、60 秒間隔で 2 回の再試行が行われます。ドキュメント ID 8002
をスケジュールします。スケジュールパラメータは scheduledHourlyMail.xml ファイルで指定され、このファイル
は cURL コマンドの -d "@scheduledHourlyMail.xml" で呼び出されます。 ID 9354 がスケジュールされたドキ
ュメントに設定されています。
scheduledHourlyMail.xml の詳細
<schedule>
<name>instancePDFFormatToMultiEmailWithBccAndCcEmpty</name>
<format type="pdf"/>
<destination>
<mail>
<from>[email protected]</from>
<to>[email protected];[email protected]</to>
<subject>Web Intelligence document</subject>
<message>New version of pdf document for your attention.</
message>
<addAttachment>true</addAttachment>
</mail>
</destination>
</schedule>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
287
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourlyMail.xml" -H X-SAP-logonToken:"""<tokenValue>""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourlyMail.xml" -H "X-SAP-LogonToken:$logtok" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
例
8: 毎時のメールによる pdf ドキュメントのスケジュール
注記
この例では、新しい毎時タイプのスケジュール (2012 年 8 月 26 日から 2012 年 9 月 14 日まで 1 時間ごと) を追加す
る方法を示します。スケジュールが失敗した場合、60 秒間隔で 2 回の再試行が行われます。ドキュメント ID 8002 を
スケジュールします。スケジュールパラメータは scheduledHourlyMail.xml ファイルで指定され、このファイルは
cURL コマンドの -d "@scheduledHourlyMail.xml" で呼び出されます。 ID 9354 がスケジュールされたドキュ
メントに設定されています。
scheduledHourlyMail.xml の詳細
<schedule>
<name>test_hourly_mail</name>
<format type="pdf"/>
<destination>
<mail>
<from>[email protected]</from>
<to>[email protected];[email protected]</to>
<cc>[email protected]</cc>
<bcc>list_of_people_in_blind_copy.company.com</bcc>
<subject>Web Intelligence Restful WS</subject>
<message>Text to send</message>
<addAttachment>true</addAttachment>
</mail>
</destination>
<hourly retriesAllowed="2" retryIntervalInSeconds="30">
<startdate>2012-08-26T14:00:00</startdate>
<enddate>2012-09-14T16:00:00</enddate>
<hour>1</hour>
<minute>0</minute>
</hourly>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourlyMail.xml" -H X-SAP-logonToken:"""<tokenValue>""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
288
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduledHourlyMail.xml" -H "X-SAP-LogonToken:$logtok" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
例
9: 受信ボックスを送信先とする、プロンプト 1 つを含むドキュメントの新しい 1 回のスケジュールの追加
注記
この例では、受信ボックスを送信先とする新しいスケジュールを追加する方法を示します。デフォルトでは、スケジュー
ルされたドキュメントは常に送信者へ送信されます。ドキュメントにプロンプトが含まれているため、本文 xml ファイルで
プロンプトに対する応答も示されます。この例では、新しい 1 回のスケジュール (2012 年 8 月 26 日開始) を追加する
方法と、DP で "DP0" を ID として使用し、"Enter State:" という名前のプロンプトテキストに値 "Texas" を入力する方
法を示します。ドキュメント ID 8002 をスケジュールします。スケジュールパラメータは nowPrompt.xml ファイルで指
定され、このファイルは cURL コマンドの -d "@nowPrompt.xml" で呼び出されます。 ID 9354 がスケジュールされ
たドキュメントに設定されています。
nowPrompt.xml の詳細
<schedule>
<name>test_monthly_ftp</name>
<format type="webi"/>
<destination><inbox/></destination>
<once retriesAllowed="2" retryIntervalInSeconds="60">
<startdate>2012-08-26T15:58:51.000+02:00</startdate>
<enddate>2013-08-27T15:58:51.000+02:00</enddate>
</once>
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>Enter State:</technicalName>
<answer constrained="false" type="text">
<values>
<value>Texas</value>
</values>
</answer>
</parameter>
</parameters>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@nowPrompt.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
289
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@nowPrompt.xml.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
例
10: ファイルシステムを送信先とする新しい今すぐのスケジュールの追加
この例では、特定のフォルダを送信先に指定し、ファイルシステムを送信先とする新しい今すぐのスケジュールを追加する
方法を示します。デフォルトフォルダは使用されません。ドキュメントは、ドライブ C の tmp ディレクトリに保存されます。
filesystem.xml の詳細
<schedule>
<name>SystemDestinationAndSpecificFolder</name>
<format type="pdf"/>
<destination>
<filesystem>
<username>{name of user}</username>
<password>{user's password}</password>
<directory>c:/tmp/</directory>
</filesystem>
</destination>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@filesystem.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@filesystem.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
例
11: FTP を送信先とする新しい今すぐのスケジュールの追加
この例では、ディレクトリを送信先に指定し、ftp を送信先とする新しい今すぐのスケジュールを追加する方法を示します。
290
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
sched_toFTPdestination.xml の詳細
<schedule>
<name>nowschedTest_ftp</name>
<format type="xls"/>
<destination>
<ftp>
<host>vs0202.dhcp.pgdev.sap.corp</host>
<port>21</port>
<username>admin</username>
<password>admin</password>
<directory>\vs0202.dhcp.pgdev.sap.corp\FTP</directory>
</ftp>
</destination>
<serverGroup id="10696" required="true"/>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_toFTPdestination.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_toFTPdestination.xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
例
12: 特定のグループのサーバで実行される新しい今すぐのスケジュールの追加
この例では、CMS の特定のサーバグループのサーバで実行される新しい今すぐのスケジュールを追加する方法を示しま
す。
sched_toservergrp.xml の詳細
<schedule>
<name>scheduleInAServerGroup</name>
<format type="webi"/>
<serverGroup id="6839" required="true"/>
</schedule>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
291
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_toservergrp.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_toservergrp.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
例
13: 優先サーバグループのサーバで実行される新しい今すぐのスケジュールの追加
この例では、優先サーバグループのサーバで実行される新しい今すぐのスケジュールを追加する方法を示します。
sched_tospecificservergrp.xml の詳細
<schedule>
<name>scheduleInAServerGroup</name>
<format type="webi"/>
<serverGroup id="6839"/>
</schedule>
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_tospecificservergrp.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@sched_tospecificservergrp.xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8002/schedules
例
例 14: 送信先オプションを使用した新しいスケジュールの追加
この例では、以下の送信先オプションを使用し、受信ボックスへの新しいスケジュールを追加する方法を示します。
292
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
●
履歴にインスタンスを保持する: "destination" タグ内の値 true/false で、"keepInstanceInHistory" 属性を指定しま
す。属性が指定されていない場合、True に設定されます。
●
特定の名前を使用する: "useSpecificName" タグ内に、特定の名前を指定します。タグが指定されていない場合は
自動の名前が使用されます。
●
ファイル拡張子を追加する: "useSpecificName" タグ内の値 true/false で、"fileExtension" 属性を指定します。属
性が指定されていない場合、True に設定されます。
xml ファイルの詳細:
<schedule>
<name>schedTest</name>
<format type="webi"/>
<destination keepInstanceInHistory="false">
<useSpecificName fileExtension="false">-customTest</useSpecificName>
<inbox/>
</destination>
</schedule>
関連リンク
ドキュメントのスケジュール一覧の取得 [ページ 273]
スケジュールの詳細の取得 [ページ 293]
ドキュメントスケジュールの削除またはキャンセル [ページ 295]
3.7.4
スケジュールの詳細の取得
この URL を使用して、以下の操作を行います。
●
URL パラメータ scheduleId で指定されたスケジュールの詳細の取得 (GET <url>/documents/{documentId}/
schedules/{scheduleId})。
●
スケジュールの削除 (DELETE <url>/documents/{documentId}/schedules/{scheduleId})。
注記
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます。 GET
http://<serverName>:6405/biprws/raylight/vx/documents。
●
{scheduleId}: ドキュメントで使用できるスケジュールの識別子は、以下によって取得されます: GET http://
<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
293
スケジュールの詳細の取得
要求:
GET http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules/
{scheduleId}
ヘッダ
値
Accept
X-SAP-LogonToken
application/xml または application/json
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
指定されたスケジュールの id、name、format、および status を示します。
例
ドキュメントのスケジュールのステータスを取得する
注記
ドキュメント 8023 に基づくスケジュールされたインスタンス ID 9439 のスケジュールの情報を取得します
Windows
curl -i -G -H "accept:application/xml" -H X-SAP-logonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8023/schedules/9439
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8023/schedules/9439
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 15 Jun 2012 09:32:45 GMT
294
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Content-Type: application/xml
Content-Length: 184
<schedule>
<id>9439</id>
<name>GC-now-schedule</name>
<format type="webi"/>
<status>Completed</status>
</schedule>
関連リンク
ドキュメントのスケジュール一覧の取得 [ページ 273]
ドキュメントへのスケジュールの追加 [ページ 275]
ドキュメントスケジュールの削除またはキャンセル [ページ 295]
3.7.5
ドキュメントスケジュールの削除またはキャンセル
明細表の削除
要求:
DELETE http://<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules/
{scheduleId}
注記
●
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
●
{scheduleId}: ドキュメントで使用できるスケジュールの識別子は、以下によって取得されます: GET http://
<serverName>:6405/biprws/raylight/vx/documents/{documentId}/schedules
ヘッダ
Accept
値
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識別
子。documentId: (型 = 整数、最小 = 1、最大 = 既存ドキュ
メントの最大ドキュメント番号)。
scheduleId
必須。整数。Web Intelligence ドキュメントスケジュールの
識別子。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
295
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード。
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
削除アクションのステータスを提供します。
message のステータスと、削除されたスケジュールの id です。
例
スケジュールされたドキュメントインスタンスを削除する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H X-SAPLogonToken:"""<TokenValue>""" http://<serverName>:6405/biprws/raylight/v1/
documents/4986/schedules/9372
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "X-SAP-LogonToken:$logtok"
http://<serverName>:6405/biprws/raylight/v1/documents/4986/schedules/9372
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 15 Jun 2012 10:14:15 GMT
Content-Type: application/xml
Content-Length: 204
<success>
<message>The resource of type 'schedule' with identifier '9372' has been
successfully removed
<id>9372</id>
</success>
関連リンク
ドキュメントのスケジュール一覧の取得 [ページ 273]
ドキュメントへのスケジュールの追加 [ページ 275]
296
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
スケジュールの詳細の取得 [ページ 293]
3.8
ドキュメントの最新表示
このセクションでは、ドキュメントの最新表示の操作について説明します。ドキュメントを最新表示する場合は、コンテキストと
プロンプトを確認してから入力する必要があります。
●
パラメータなしでのドキュメントの最新表示
●
パラメータありでのドキュメントの最新表示
●
パラメータへの入力（context および prompt）
注記
このバージョンでサポートされているプロンプト:
●
テキストおよびテキスト (長) のデータを受け取るプロンプト
●
数値を受け取るプロンプト
●
dateTime 値を受け取るプロンプト (単一の値、複数の値、間隔値)
●
1 つの値を受け取るプロンプト
●
複数の値を受け取るプロンプト
●
オプションおよびオプションでないプロンプト
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。
http://<serverName>:6405/biprws/raylight/vx
GET メソッドを使用して取得するパラメータを指定することにより、ドキュメントを最新表示できます。
パラメータなし (要求本文なし) で最新表示を求めることもできます。この場合、context または prompt を指定する必要があ
るときは、Web Intelligence Restful Web サービスからそれが返されます。パラメータの入力が必要ない場合ドキュメントは
最新表示されます。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
関連リンク
ドキュメントの最新表示前におけるドキュメント最新表示パラメータの取得 [ページ 298]
ドキュメントの最新表示 [ページ 303]
ドキュメントの最新表示のキャンセル [ページ 334]
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
297
3.8.1 ドキュメントの最新表示前におけるドキュメント最新表示パラメータ
の取得
この URL を使用して、以下の操作を行います。
●
最新表示の実行前に、入力される最新表示パラメータを取得します。
●
最新表示パラメータに入力し (必要な場合)、ドキュメントのクエリを実行 (最新表示) します。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
パラメータが 'オプション' とマークされている場合、このパラメータは必須ではないことを表します。パラメータを更新して最新
表示をトリガする場合、省略できます。カーディナリティは、予期される値の数の情報を示します。 '単一' (1 つの値)、'複
数' (多数の値)、または '間隔' (2 つの値) のいずれかです。 "parameter/answer/values" ノードで、クライアントの応答値
を入力できます。 Raylight によって、前の値が存在する場合は前の値、存在しない場合はデフォルト値が自動的に事前入力
されます。
最新表示パラメータの取得
要求
GET http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
ヘッダ
説明
Accept
application/xml または application/json
X-SAP-LogonToken
引用符で囲んだログオントークンの値。
パラメータ
説明
documentId
必須。整数。取得する Web Intelligence ドキュメントの識
別子。 documentId: (型は整数で、最小値は 1、最大値は
既存ドキュメントの最大ドキュメント番号です)。
応答
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-type
Content-length
298
application/xml または application/json
応答本文のコンテンツの長さ。
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ボディ
ドキュメントを最新表示する際に入力されるパラメータのセット。事前入力されたデフォルト値の場合、コンテキストまたはプ
ロンプト、ID、名前、応答タイプおよび値。
例
最新表示パラメータを取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
応答
注記
コンテキストの場合
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Mon, 03 Sep 2012 14:10:42 GMT
Content-Type: application/xml
Content-Length: 689
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameters>
<parameter type="context" optional="false">
<id>0</id>
<name>Select a context</name>
<answer type="text" constrained="true">
<info cardinality="single">
<values>

<value id="2">Reservations</value>
<value id="1">Sales</value>
</values>
<previous>

<value id="2">Reservations</value>
</previous>
<values>
</info>

<values>
<value
id="2">Reservations</value>
</values>
</answer>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
299
</parameters>
</parameter>
注記
パラメータなしの場合
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Mon, 03 Sep 2012 14:21:05 GMT
Content-Type: application/xml
Content-Length: 70
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameters/>
例
コンテキスト (XML 形式)
<parameters>
<parameter optional="false" type="context">
<id>0</id>
<name>Select a context</name>
<answer constrained="true" type="Text">
<info cardinality="Single">
<values>

<value id="2">Reservations</value>
<value id="1">Sales</value>
</values>
<previous>

<value id="2">Reservations</value>
</previous>
</info>

<values>
<value id="2">Reservations</value>
</values>
</answer>
</parameter>
</parameters>
例
'dateTime' 型のプロンプト (XML 形式)
<parameters>
<parameter optional="false" type="prompt">
<id>0</id>
<name>Enter Open Date:</name>
<answer constrained="false" type="DateTime">
<info cardinality="single">
<previous>
<value>1992-09-03T17:15:00.000+02:00</value>
300
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</previous>
</info>
<values>
<value>1992-09-03T17:15:00.000+02:00</value>
</values>
</answer>
</parameter>
</parameters>
例
LOV 詳細 (XML 形式)
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>Enter values for Customer:</technicalName>
<name>Enter values for Customer:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS0.DOd</id>
<intervals>
<interval id="0">
<value>Arai</value>
<value>Okumura</value>
</interval>
<interval id="1">
<value>Oneda</value>
<value>Wilson</value>
</interval>
</intervals>
<values>
<value>Arai</value>
<value>Baker</value>
<value>Brendt</value>
. . .
<value>Okumura</value>
</values>
<columns mappingId="0">
<column id="0" type="string">Customer </column>
</columns>
</lov>
<previous>
<value>Arai</value>
<value>Baker</value>
<value>Brendt</value>
<value>Diemers</value>
<value>Dupont</value>
<value>Durnstein</value>
<value>Edwards</value>
</previous>
<values>
<value>Arai</value>
<value>Baker</value>
<value>Brendt</value>
<value>Diemers</value>
<value>Dupont</value>
<value>Durnstein</value>
<value>Edwards</value>
</values>
</answer>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
301
</parameter>
. . .
</parameters>
注記
間隔が 1 つのみの場合、<intervals/> は LOV 詳細に含まれません。
例
複数列の LOV 詳細 (XML 形式):
LOV で複数列の値が使用できる場合、すべての <value> は拡張 <cvalue> 型で示され、値の各列が指定されます。
<cvalue>
<column
<column
<column
. . .
<column
</cvalue>
id="0">. . .</column>
id="1">. . .</column>
id="2">. . .</column>
id="n">. . .</column>
対応するヘッダ (列のインデックス、型、および名前) は、LOV 情報の <columns> 型で返されます。
<columns mappingId="m">
<column id="0" type=". . .">. . .</column>
<column id="1" type=". . .">. . .</column>
. . .
<column id="n" type=". . .">. . .</column>
</columns>
mappingId は、WebI ドキュメントを更新する際に応答で値が示される必要がある列インデックスを示しますが、並べ替え
のキーとしても使用されます。
<parameter optional="false" type="prompt" dpId="DP15">
<id>6</id>
<technicalName>Enter values for CustomLOV_3colonnes_AllDataType:</
technicalName>
<name>Enter values for CustomLOV_3colonnes_AllDataType:</name>
<answer constrained="false" type="Text">
<info cardinality="Single">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS2.DOea</id>
<intervals>
<interval id="0">
<cvalue>
<column id="0">William</column>
<column id="1">64</column>
<column id="2">1995-12-19T02:00:00.000+01:00</column>
</cvalue>
<cvalue>
<column id="0">Silke</column>
<column id="1">63</column>
<column id="2">1994-03-25T02:00:00.000+01:00</column>
</cvalue>
302
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</column>
</interval>
<interval id="1">
. . .
</interval>
</intervals>
<cvalues>
<cvalue>
<column id="0">Werner</column>
<column id="1">42</column>
<column id="2">1995-06-08T08:28:00.000+02:00</column>
</cvalue>
. . .
<cvalue>
<column id="0">Tony</column>
<column id="1">55</column>
<column id="2">1995-07-05T04:00:00.000+02:00</column>
</cvalue>
</cvalues>
<columns mappingId="0">
<column id="0" type="string">CustomLOV_3colonnes_AllDataType
<column id="1" type="double">Age </column>
<column id="2" type="date_time">Invoice Date </column>
</columns>
</lov>
<previous>
<value>Andre</value>
</previous>
</info>
<values>
<value>Andre</value>
</values>
</answer>
</parameter>
関連リンク
BI プラットフォームにログオンする [ページ 10]
ドキュメント: 取得、コピー、または作成 [ページ 16]
3.8.2
ドキュメントの最新表示
この URL を使用してドキュメントを最新表示します。
要求
PUT http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
ヘッダ
Content-Type
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
値
application/xml または application/json
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
303
ヘッダ
値
Accept
application/xml または application/json
パラメータ
値
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
context
オプションまたは必須。コンテキストは、Reservations や
Sales などのクエリで使用されるオブジェクトです。コンテキ
ストは、制約したり、1 つまたは複数の値にすることができま
す。
prompt
オプションまたは必須。テキスト、数値、日付時刻
name
ドキュメントの名前
answer type
テキスト、数値、または日付時刻
ボディ
説明
XML 形式:
オプション。コンテキストおよびプロンプトがない場合、本文
<parameters>
<parameter>
<id>0</id>
<answer>
id="x"/>
</answer>
</parameter>
</parameters>
は不要です。
コンテキストの場合、GET 要求の本文で返されるコンテキス
トタイプと ID 番号によって異なります。ID 値は <info/
<values>
><values><value> で返されます。
</values>
プロンプトはテキスト、数値、または日付時刻で、必須または
オプションにすることができます。
<value
日付時刻は yyyy-mm-ddThh:mm:ss.sss+HH:MM の形
式です。 HH:MM は、タイムゾーンのオフセットです。例:
1992-09-03T17:15:00.000+02:00
Json 形式:
{"parameters":{"parameter":{"id":
0,"answer":{"values":{"value":
{"@id":"2"}}}}}}
応答
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
最新表示のステータス。
304
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
ドキュメントで最新表示するパラメータが不要な場合は、要求本文を送信しません。
注記
ユーザがパラメータを指定しないと、サーバによって必要なパラメータが繰り返し一覧表示されます。
注記
パラメータが必要なドキュメントで、ユーザがいずれのパラメータも送信しない場合、パラメータは送信する必要があります
が応答はブロックされません。
関連リンク
ドキュメントの最新表示前におけるドキュメント最新表示パラメータの取得 [ページ 298]
ドキュメントの最新表示のキャンセル [ページ 334]
3.8.2.1
例 1: パラメータありでのドキュメントの最新表示
パラメータは、cURL コマンドの -d "@fillRefreshParameter.xml" によって呼び出される
fillRefreshParameter.xml の中で指定します。
fillRefreshParameter.xml の詳細
<parameters>
<parameter>
<id > 0 </ id>
<answer>
</answer>
</parameter>
</parameters>
<values>
</values>
<value id="x"/>value</value>
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@fillRefreshParameter.xml" http://
<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
305
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@fillRefreshParameter.xml" http://<serverName>:
6405/biprws/raylight/v1/documents/{documentId}/parameters
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'document' with identifier 'xxx' has been
successfully updated.</message>
<id>xxx</id>
</success>
例
3.8.2.2
例 2: 日時型のプロンプトを含むドキュメントの最新表示
プロンプトのカーディナリティは '単一' (1 つの値)、'複数' (多数の値)、または '間隔' (開始時刻と終了時刻) です。
<?xml version=1.0" encoding="UTF-8" standalone="yes"?>
<parameters>
<parameter optional="false" type="content">
<id > 0 </ id>
<name>Enter open Date </name>
<answer constrained="true" type="text">
<info cardinality="single">
<values>
<value>1992-09-03T17:15:00.000+02:00</value>
</values>
</info>
<values>
<value id="1">1992-09-03T17:15:00.000+02:00</value>
</values>
</answer>
</parameter>
</parameters>
例
306
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
3.8.2.3 例 3: 'context' タイプの 1 つと、'prompt' タイプのいずれか
のパラメータを 1 つ含むドキュメント
例
'context' タイプの 1 つと、'prompt' タイプのいずれかのパラメータを 1 つ使用してドキュメント (XML 形式) を最新表示：
RESTful サービスはステートレスなので、ユーザはその後に返されるプロンプトに回答する前に最初の応答に回答する必
要があります。コンテキストが提供されない場合、ドキュメントは最新表示できず、応答に必要な関連情報が含まれます。
応答本文:
<?xml version=1.0" encoding="UTF-8" standalone="yes"?>
<parameters>
<parameter optional="false" type="content">
<id > 0 </ id>
<name>Select a context</name>
<answer constrained="true" type="text">
<info cardinality="single">
<values>
<value id="2">Reservations</value>
<value id="1">Sales</value>
</values>
<previous>
<value id="1">Sales</value>
</previous>
</info>
<values>
<value id="1">Sales</value>
</values>
</answer>
</parameter>
</parameters>
ユーザは、サーバの要求に応じて、要求本文 (xml ファイル) で必要なコンテキスト値を提供します。
要求本文の xml ファイルの内容:
<parameters>
<parameter optional="false" type="content">
<id > 0 </ id>
<answer type="text">
<info cardinality="single">
<values>
<value id="1">Sales</value>
</values>
</answer>
</parameter>
</parameters>
プロンプトに対してさらに入力が必要です。応答本文に以下が示されます。
<?xml version=1.0" encoding="UTF-8" standalone="yes"?>
<parameters>
<parameter optional="false" type="content">
<id > 1 </ id>
<name>Enter a value for Country:</name>
<answer constrained="false" type="text">
<info cardinality="single">
<previous>
<value>France</value>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
307
</previous>
</info>
<values>
</answer>
</parameter>
</parameters>
</values>
<value>France</value>
ユーザは、サーバの要求に応じて必要なコンテキスト値およびプロンプトの応答を提供します。
要求本文:
<parameters>
<parameter optional="false" type="content">
<id > 0 </ id>
<answer type="text">
<values>
<value id="1">Sales</value>
</values>
</answer>
</parameter>
</parameters>
<parameters>
<parameter type="prompt">
<id > 1 </ id>
<answer type="text">
<values>
<value>France</value>
</values>
</answer>
</parameter>
</parameters>
応答本文:
<?xml version=1.0" encoding="UTF-8" standalone="yes"?>
<success>
<message>The resource of type 'document' with identifier '23535' has been
successfully updated.</message>
<id>23535
</id>
</success>
3.8.2.4
例 4: LOV 値を返す方法の指定
クエリを実行して、LOV 値を返す方法と (LOV が許可している場合に) 最新表示する方法を指定するか、またはいずれかを
指定することができます。
要求
PUT http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
ヘッダ
値
Content-Type
308
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
application/xml または application/json
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
Accept
application/xml または application/json
パラメータ
値
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
context
オプションまたは必須。コンテキストは、Reservations や
Sales などのクエリで使用されるオブジェクトです。コンテキ
ストは、制約したり、1 つまたは複数の値にすることができま
す。
prompt
オプションまたは必須。テキスト、数値、日時
name
ドキュメントの名前
answer type
テキスト、数値、または日時
ボディ
説明
XML 形式:
オプション。ここでは、以下のようになります。 .
<parameter>
<id>1</id>
<answer>
<info>
<lov>
<query intervalId="2"
intervalSize="6" refresh="true">
<sort order="Descending" />
<search>pattern</search>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
intervalId: (型 = 整数、オプション) 返される間隔の値を
指定します。 (値の数によっては) このインデックスが範囲外
となる場合、エラーが返されます。
intervalSize: (型 = 整数、オプション) 返される値の数と
返される値を指定します。
refresh: (型 = 論理値、オプション) LOV 値を最新表示し
ます。 LOV が最新表示を許可していない場合は、エラーが
返されます。
sort: (型 = 文字列、値 = "None" または "Ascending"、デ
フォルト = "Descending"、オプション)
search pattern: (型 = 文字列、オプション) 次のワイル
ドカード文字列は、パターン文字列で使用できます。"?" は 0
または 1 文字に対して、"*" は 0 または n 文字に対して使用
できます。たとえば、"M?Gregor" と指定すると値
McGregor が取得され、"M*Gregor" と指定すると値
McGregor および MacGregor が取得されます。
応答
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
application/xml または application/json
応答本文のコンテンツの長さ
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
309
ボディ
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>1</id>
<technicalName>Select Max Age</technicalName>
<name>Select Max Age</name>
<answer constrained="false" type="Numeric">
<info cardinality="Single">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO58</id>
<intervals>
<interval id="0">
<value>74</value>
<value>64</value>
</interval>
<interval id="1">
<value>63</value>
<value>45</value>
</interval>
<interval id="2">
<value>42</value>
<value>24</value>
</interval>
<interval id="3">
<value>22</value>
<value>18</value>
</interval>
</intervals>
<values>
<value>42</value>
<value>38</value>
<value>36</value>
<value>34</value>
<value>29</value>
<value>24</value>
</values>
<columns mappingId="0">
<column id="0" type="double">Age </column>
</columns>
</lov>
<previous>
value>67</value>
</previous>
</info>
<values>
<value>67</value>
</values>
</answer>
</parameter>
. . .
</parameters>
.
注記
複数列のパラメータを使用した Web Intelligence ドキュメントの最新表示は、mappingId と一致するインデックスがある
セルのみを指定して、単一列の値の場合と同じ方法で行われる必要があります。
310
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
注記
LOV 情報の partial = "true" は、LOV のサイズがサーバ設定またはユニバースのクエリ制限によって制限されている
ため、LOV 値が一部のみ返される可能性があることを意味します。
3.8.2.5
例 5: 階層の値の一覧を含むレポート
階層の LOV では、<query> セクション内の追加の <path> 要素を受け入れることで、階層の各レベルにまで移動することが
できます。ノードの最後のリーフに到達するまで、クエリを繰り返す必要があります。以下の階層を考えてみます。
最新表示は、次のように実行されます。
1.
階層が存在しないものとして、<path> エントリを指定しないで最初の呼び出しを送信し、最初のレベルを取得します。た
だし、hierarchical="true" タグは指定します。final="false" は、値が階層のノードであることを意味し、final=true また
はタグがまったくない場合は、値がリーフであることを意味します。
2.
既知の最初のレベルの値のうち、いずれかを指定して 2 番目の呼び出しを送信すると、対応する 2 番目のレベルの値
3.
呼び出しを繰り返し、クエリボディを各レベルに必要な値で更新します。このことを、ノードがなくなるまで、つまりユーザが
最後のリーフに到達するまで行います。
4.
すべての必要な <value> および必須の <path> を指定して、ドキュメントを通常どおり最新表示します。
が取得されます。
例
最初呼び出しの送信
<path> エントリを指定しない最初の呼び出しは、hierarchical="true" タグは指定されていますが、階層が存在しないも
のとして、最初のレベルを取得します。final=false は、値が階層のノードであることを意味し、final=true またはタグがまっ
たくない場合は、値がリーフであることを意味します。
Windows
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/9586/parameters
応答は、階層の最初のレベルでプロンプトを返します。
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
311
Content-Length: 355
<parameters>
<parameter optional="false" type="prompt" dpId="DPe">
<id>0</id>
<technicalName>Enter values for Customer in TreeViewLov:</technicalName>
<name>Enter values for Customer in TreeViewLov:</name>
<answer constrained="true" type="Text">
<info cardinality="Multiple">
<lov hierarchical="true" refreshable="true">
<id>UNIVERSELOV_DS2.DObb</id>
<intervals>
<interval id="0">
<value final="false">Australia</value>
<value final="false">US</value>
</interval>
</intervals>
<values>
<value final="false">Australia</value>
<value final="false">France</value>
<value final="false">Germany</value>
<value final="false">Holland</value>
<value final="false">Japan</value>
<value final="false">Madagascar</value>
<value final="false">Middle East</value>
<value final="false">Nepal</value>
<value final="false">South Africa</value>
<value final="false">UK</value>
<value final="false">US</value>
</values>
</lov>
</info>
</answer>
</parameter>
</parameters>
応答から取得した情報を使用して、たとえば request2.xml ファイルを記述し、2 番目の要求の本文に使用します。
要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value>France</value>
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
要求を再度送信します。今回は request2.xml ファイルを参照します。
312
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
応答は、階層の次のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DPe">
<id>0</id>
<technicalName>Enter values for Customer in TreeViewLov:</technicalName>
<name>Enter values for Customer in TreeViewLov:</name>
<answer constrained="true" type="Text">
<info cardinality="Multiple">
<lov hierarchical="true" refreshable="true">
<id>UNIVERSELOV_DS2.DObb</id>
<intervals>
<interval id="0">
<value final="false">French Alps</value>
<value final="false">Provence</value>
</interval>
</intervals>
<values>
<value final="false">French Alps</value>
<value final="false">Normandy</value>
<value final="false">Paris</value>
<value final="false">Provence</value>
</values>
</lov>
</info>
</answer>
</parameter>
</parameters>
応答から取得した情報を使用して、本文の xml ファイルを更新します。
要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
313
要求本文
<value>France</value>
<value>Provence</value>
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
要求を再度送信します。更新した request2.xml ファイルを参照します。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
応答は、階層の次のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DPe">
<id>0</id>
<technicalName>Enter values for Customer in TreeViewLov:</technicalName>
<name>Enter values for Customer in TreeViewLov:</name>
<answer constrained="true" type="Text">
<info cardinality="Multiple">
<lov hierarchical="true" refreshable="true">
<id>UNIVERSELOV_DS2.DObb</id>
<intervals>
<interval id="0">
<value final="false">Bordeaux</value>
<value final="false">Nice</value>
</interval>
</intervals>
<values>
<value final="false">Bordeaux</value>
<value final="false">Marseille</value>
<value final="false">Nice</value>
</values>
</lov>
</info>
</answer>
</parameter>
</parameters>
応答から取得した情報を使用して、本文の xml ファイルを更新します。
314
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value>France</value>
<value>Provence</value>
<value>Bordeaux</value>
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
要求を再度送信します。更新した request2.xml ファイルを参照します。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
応答は、階層の次のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DPe">
<id>0</id>
<technicalName>Enter values for Customer in TreeViewLov:</technicalName>
<name>Enter values for Customer in TreeViewLov:</name>
<answer constrained="true" type="Text">
<info cardinality="Multiple">
<lov hierarchical="true" refreshable="true">
<id>UNIVERSELOV_DS2.DObb</id>
<updated>2012-12-11T15:59:15.000+01:00</updated>
<intervals>
<interval id="0">
<value>Piaget</value>
<value>Piaget</value>
</interval>
</intervals>
<values>
<value>Piaget</value>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
315
</values>
<columns mappingId="0">
<column id="0" type="string">Customer in TreeViewLov </
column>
</columns>
</lov>
</info>
</answer>
</parameter>
</parameters>
これで、<value> を指定して、ドキュメントが通常どおり最新表示できるようになります (値がわかったので、<path> は必
須ではなくなりました)。
応答から取得した情報を使用して、本文の xml ファイルを更新します。
要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<values>
<value>Piaget</value>
</values>
</answer>
</parameter>
</parameters>
これで、すべての情報が本文のファイルに反映されたので、PUT コマンドと request2.xml ファイルを使用して、ドキュメン
トを最新表示できます。最新表示に成功すると、以下の応答を取得します。
<success>
<message>The resource of type 'Document' with identifier '9586' has been
successfully updated.</message>
<id>9586</id>
</success>
3.8.2.6
例 6: 階層の混在した LOV を含むレポートの最新表示
ドキュメントには、階層の各レベルに特定の列数とタイプを含む階層の LOV が含まれます。
316
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
最初の呼び出し: "GET"
<path> エントリを指定しない最初の呼び出しは、hierarchical="true" タグは指定されていますが、階層が存在しないものと
して、最初の階層レベルを取得します。final="false" は、値が階層のノードであることを意味し、final=true またはタグがまっ
たくない場合は、値がリーフであることを意味します。
Windows
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/{documentId}/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
{documentId}/parameters
応答は、階層の最初のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>Saisir une ou plusieurs valeurs pour Invoice Date</
technicalName>
<name>Saisir une ou plusieurs valeurs pour Invoice Date</name>
<answer constrained="false" type="DateTime">
<info cardinality="Multiple">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO119</id>
<intervals>
<interval id="0">
<value final="false">FY1992</value>
<value final="false">FY1995</value>
</interval>
</intervals>
<values>
<value final="false">FY1992</value>
<value final="false">FY1993</value>
<value final="false">FY1994</value>
<value final="false">FY1995</value>
</values>
<columns mappingId="0">
<column id="0" type="String">Year </column>
</columns>
</lov>
</info>
</answer>
</parameter>
</parameters>
1 番目のレベルには、1 列しかなく、文字列型です。
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
317
既知の最初のレベルの値を指定した、2 番目の呼び出しの送信
既知の最初のレベルの値のうち、いずれかを指定して 2 番目の呼び出しを行い、対応する 2 番目のレベルの値を取得しま
す。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value>FY1993</value>
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
応答は、階層の次のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>Saisir une ou plusieurs valeurs pour Invoice Date</
technicalName>
<name>Saisir une ou plusieurs valeurs pour Invoice Date</name>
<answer constrained="false" type="DateTime">
<info cardinality="Multiple">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO119</id>
<intervals>
<interval id="0">
<cvalue final="false">
<column id="0">Q1</column>
<column id="1">FY1993</column>
318
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</cvalue>
<cvalue final="false">
<column id="0">Q4</column>
<column id="1">FY1993</column>
</cvalue>
</interval>
</intervals>
<cvalues>
<cvalue final="false">
<column id="0">Q1</column>
<column id="1">FY1993</column>
</cvalue>
<cvalue final="false">
<column id="0">Q2</column>
<column id="1">FY1993</column>
</cvalue>
<cvalue final="false">
<column id="0">Q3</column>
<column id="1">FY1993</column>
</cvalue>
<cvalue final="false">
<column id="0">Q4</column>
<column id="1">FY1993</column>
</cvalue>
</cvalues>
<columns mappingId="0">
<column id="0" type="String">Quarter </column>
<column id="1" type="String">Year </column>
</columns>
</lov>
</info>
</answer>
</parameter>
</parameters>
ここでは、2 番目のレベルは、ともに文字列型の 2 つの列を取得します。1 番目の選択が先頭になります (mappingId="0")。
呼び出しを繰り返す
階層の最後のレベルまで繰り返す:
要求本文:
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
319
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value>FY1993</value>
<value>Q2</value>
<value>06</value>
<value>25</value>
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
応答本文:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>Saisir une ou plusieurs valeurs pour Invoice Date</
technicalName>
<name>Saisir une ou plusieurs valeurs pour Invoice Date</name>
<answer constrained="false" type="DateTime">
<info cardinality="Multiple">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO119</id>
<intervals>
. . .
</intervals>
<cvalues>
<cvalue>
<column id="0">1993-06-19T02:00:00.000+02:00</column>
<column id="1">06</column>
<column id="2">FY1993</column>
</cvalue>
. . .
<cvalue>
<column id="0">1995-06-24T02:00:00.000+02:00</column>
<column id="1">06</column>
<column id="2">FY1995</column>
</cvalue>
</cvalues>
<columns mappingId="0">
<column id="0" type="DateTime">Invoice Date </column>
<column id="1" type="String">Month </column>
<column id="2" type="String">Year </column>
</columns>
</lov>
</info>
</answer>
</parameter>
320
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</parameters>
final="false" タグはこれ以上ありません。階層の最後のレベルに到達し、そのレベルには 3 つの列が含まれ、日時型の 1
番目の選択が先頭になります (mappingId="0")。
最終段階でのドキュメントの最新表示
これで、<value> を指定して、ドキュメントが通常どおり最新表示できるようになります (値がわかったので、<path> は必須で
はなくなりました)。
要求本文:
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/9586/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/9586/parameters
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<values>
<value>1995-06-19T02:00:00.000+02:00</value>
</values>
</answer>
</parameter>
</parameters>
応答:
<success>
<message>The resource of type 'Document' with identifier '9586' has been
successfully updated.</message>
<id>9586</id>
</success>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
321
3.8.2.7 例 7: 階層のインデックス化された値の一覧を含むドキュメント
(XML 形式)
LOV の値がインデックス化されている場合は (つまり、"<value id="...">...</value>")、ID だけが必須です。
最初の呼び出しで <path> エントリを指定せずに階層がないものとして、最初のレベルを取得します (ただし、
hierarchical="true" タグはあります)。
Windows
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
8816/parameters
応答は、階層の最初のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>customer Hierarchy Node variable mandatory</technicalName>
<name>customer Hierarchy Node variable mandatory</name>
<answer constrained="true" type="Text">
<info cardinality="Single">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO48</id>
<intervals>
<interval id="0">
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD
0HIER_NODE]" final="false">
<column id="0">WORLD 0HIER_NODE</column>
<column id="1">WORLD</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[REST_H
1HIER_REST]" final="false">
<column id="0">REST_H 1HIER_REST</column>
<column id="1">Not Assigned Country (s)</column>
</cvalue>
</interval>
</intervals>
<cvalues>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD
0HIER_NODE]" final="false">
<column id="0">WORLD 0HIER_NODE</column>
<column id="1">WORLD</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[REST_H
1HIER_REST]" final="false">
<column id="0">REST_H 1HIER_REST</column>
<column id="1">Not Assigned Country (s)</column>
</cvalue>
322
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
column>
column>
</cvalues>
<columns mappingId="0">
<column id="0" type="String">LovHierNodeL00 CountryBase </
<column id="1" type="String">LovHierNodeL00 Country </
</columns>
</lov>
<previous>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</previous>
</info>
<values>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</values>
</answer>
</parameter>
</parameters>
既知の最初のレベルの値を指定した、2 番目の呼び出しの送信
既知の最初のレベルの値のうち、いずれかを指定して 2 番目の呼び出しを行い、対応する 2 番目のレベルの値を取得しま
す。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/8816/parameters
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value id="[Z_COUNTRY
0HIER_NODE]" />
</path>
</query>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
COUNTRY_HIERARCHY_01].[WORLD
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
323
request2.xml ファイルの要求本文
</lov>
</info>
</answer>
</parameter>
</parameters>
応答は、階層の次のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
<technicalName>customer Hierarchy Node variable mandatory</technicalName>
<name>customer Hierarchy Node variable mandatory</name>
<answer constrained="true" type="Text">
<info cardinality="Single">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO48</id>
<intervals>
<interval id="0">
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[EUROPE
0HIER_NODE]" final="false">
<column id="0">EUROPE 0HIER_NODE</column>
<column id="1">EUROPE</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[MIDDLE_EAST 0HIER_NODE]" final="false">
<column id="0">MIDDLE_EAST 0HIER_NODE</column>
<column id="1">MIDDLE_EAST</column>
</cvalue>
</interval>
</intervals>
<cvalues>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[EUROPE
0HIER_NODE]" final="false">
<column id="0">EUROPE 0HIER_NODE</column>
<column id="1">EUROPE</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[NORTH_AMERICA
0HIER_NODE]" final="false">
<column id="0">NORTH_AMERICA 0HIER_NODE</column>
<column id="1">NORTH_AMERICA</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[ASIA_PAC
0HIER_NODE]" final="false">
<column id="0">ASIA_PAC 0HIER_NODE</column>
<column id="1">ASIA_PAC</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[MIDDLE_EAST
0HIER_NODE]" final="false">
<column id="0">MIDDLE_EAST 0HIER_NODE</column>
<column id="1">MIDDLE_EAST</column>
</cvalue>
</cvalues>
<columns mappingId="0">
<column id="0" type="String">LovHierNodeL01 CountryBase </
column>
<column id="1" type="String">LovHierNodeL01 Country </
column>
</columns>
</lov>
<previous>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</previous>
324
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</info>
<values>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</values>
</answer>
</parameter>
</parameters>
2 番目のレベルの繰り返し
要求本文:
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/8816/parameters
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<info>
<lov>
<query>
<path>
<value id="[Z_COUNTRY
0HIER_NODE]" />
<value id="[Z_COUNTRY
0HIER_NODE]" />
</path>
</query>
</lov>
</info>
</answer>
</parameter>
</parameters>
COUNTRY_HIERARCHY_01].[WORLD
COUNTRY_HIERARCHY_01].[ASIA_PAC
応答本文:
<parameters>
<parameter optional="false" type="prompt" dpId="DP0">
<id>0</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
325
<technicalName>customer Hierarchy Node variable mandatory</technicalName>
<name>customer Hierarchy Node variable mandatory</name>
<answer constrained="true" type="Text">
<info cardinality="Single">
<lov hierarchical="true" partial="false" refreshable="true">
<id>UNIVERSELOV_DS0.DO48</id>
<intervals>
<interval id="0">
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000003]">
<column id="0">000000000000000000000000000003</column>
<column id="1">Australia</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000063]">
<column id="0">000000000000000000000000000063</column>
<column id="1">Thailand</column>
</cvalue>
</interval>
</intervals>
<cvalues>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000003]">
<column id="0">000000000000000000000000000003</column>
<column id="1">Australia</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000006]">
<column id="0">000000000000000000000000000006</column>
<column id="1">Bangladesh</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000015]">
<column id="0">000000000000000000000000000015</column>
<column id="1">China</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000030]">
<column id="0">000000000000000000000000000030</column>
<column id="1">Indonesia</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000035]">
<column id="0">000000000000000000000000000035</column>
<column id="1">Japan</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000038]">
<column id="0">000000000000000000000000000038</column>
<column id="1">Malaysia</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000041]">
<column id="0">000000000000000000000000000041</column>
<column id="1">Nepal</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000050]">
<column id="0">000000000000000000000000000050</column>
<column id="1">Philippines</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000058]">
<column id="0">000000000000000000000000000058</column>
<column id="1">Singapore</column>
</cvalue>
<cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000063]">
326
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
column>
column>
<column id="0">000000000000000000000000000063</column>
<column id="1">Thailand</column>
</cvalue>
</cvalues>
<columns mappingId="0">
<column id="0" type="String">LovHierNodeL02 CountryBase </
<column id="1" type="String">LovHierNodeL02 Country </
</columns>
</lov>
<previous>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</previous>
</info>
<values>
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000013]">000000000000000000000000000013</value>
</values>
</answer>
</parameter>
</parameters>
final="false" タグはこれ以上ありません。階層の最後のレベルに到達しました。
最終段階でのドキュメントの最新表示
これで、<value> を指定して、ドキュメントが通常どおり最新表示できるようになります (値がわかったので、<path> は必須で
はなくなりました)。
要求本文:
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@request2.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@request2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/8816/parameters
request2.xml ファイルの要求本文
<parameters>
<parameter>
<id>0</id>
<answer>
<values>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
327
request2.xml ファイルの要求本文
<value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].
[000000000000000000000000000015]" />
</values>
</answer>
</parameter>
</parameters>
応答:
<success>
<message>The resource of type 'Document' with identifier '8816' has been
successfully updated.</message>
<id>8816</id>
</success>
3.8.2.8 例 8: 値の一覧のネストされたパラメータを含むドキュメント
(XML 形式)
ネストされたパラメータは、カスケードパラメータとも呼ばれます。場合によっては、値の一覧は、他のパラメータ値に依存する
ことがあります。 Raylight は、依存するパラメータが値の一覧情報の XML ブロックに示されていなければ、このような場合を
以前と同じように扱います。
手順 1: 要求本文を使用しない、最初の GET 呼び出しの送信:
Windows
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "GET" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/documents/
8816/parameters
応答は、階層の最初のレベルでプロンプトを返します。
<parameters>
<parameter optional="false" type="prompt" dpId="DP11">
<id>1</id>
<technicalName>Age from:</technicalName>
<name>Age from:</name>
328
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<answer constrained="false" type="Numeric">
<info cardinality="Single">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO9</id>
<intervals>
<interval id="0">
<value>18</value>
<value>2600</value>
</interval>
</intervals>
<values>
<value>18</value>
<value>19</value>
. . .
<value>2600</value>
</values>
<columns mappingId="0">
<column id="0" type="Numeric">Age </column>
</columns>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt" dpId="DP11">
<id>2</id>
<technicalName>Date greater than</technicalName>
<name>Date greater than</name>
<answer constrained="false" type="DateTime">
<info cardinality="Single">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO17</id>
<intervals>
<interval id="0">
<value>1992-02-29T22:45:00.000+01:00</value>
<value>1992-11-11T03:55:00.000+01:00</value>
</interval>
. . .
<interval id="9">
<value>1995-10-13T01:00:00.000+01:00</value>
<value>1995-12-29T01:00:00.000+01:00</
value>
</interval>
</
intervals>
<values>
<value>1992-02-29T22:45:00.000+01:00</value>
<value>1992-09-03T17:15:00.000+02:00</value>
. . .
<value>1992-11-11T03:55:00.000+01:00</value>
</values>
<columns mappingId="0">
<column id="0" type="DateTime">Invoice Date </column>
</columns>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt" dpId="DP11">
<id>3</id>
<technicalName>Region in list:</technicalName>
<name>Region in list:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO12</id>
<intervals>
<interval id="0">
<value>Arabia</value>
<value>Western Cape</value>
</interval>
</intervals>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
329
<values>
<value>Arabia</value>
<value>Bavaria</value>
. . .
<value>Western Cape</value>
</values>
<columns mappingId="0">
<column id="0" type="String">Region </column>
</columns>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt" dpId="DP11">
<id>4</id>
<technicalName>To:</technicalName>
<name>To:</name>
<answer constrained="false" type="Numeric">
<info cardinality="Single">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO9</id>
<intervals>
<interval id="0">
<value>18</value>
<value>2600</value>
</interval>
</intervals>
<values>
<value>18</value>
<value>19</value>
. . .
<value>2600</value>
</values>
<columns mappingId="0">
<column id="0" type="Numeric">Age </column>
</columns>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt" dpId="DP11">
<id>0</id>
<technicalName>Enter values for CustomLOV_3promptDependant:</technicalName>
<name>Enter values for CustomLOV_3promptDependant:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO10c</id>
<parameters>
<id>1</id>
<id>2</id>
<id>3</id>
<id>4</id>
</parameters>
</lov>
</info>
</answer>
</parameter>
</parameters>
注記
最後のパラメータ内に、ネストされた <parameters><id>1</id><id>2</id><id>3</id><id>4</id></
parameters> ブロックがあります。
330
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
手順 2: メイン LOV への値の入力を可能にするネストされたパラメータの解決
以下の要求本文を XML ファイルに含めます。
要求本文
nestedparams.xml ファイルの要求本文
<parameters>
<parameter>
<id>1</id>
<answer>
<values>
<value>1</value>
</values>
</answer>
</parameter>
<parameter>
<id>2</id>
<answer>
<values>
<value>1970-01-01T00:00:00.000+00:00</value>
</values>
</answer>
</parameter>
<parameter>
<id>3</id>
<answer>
<values>
<value>Arabia</value>
<value>Bavaria</value>
. . .
<value>West Nepal</value>
<value>Western Cape</value>
</values>
</answer>
</parameter>
<parameter>
<id>4</id>
<answer>
<values>
<value>150</value>
</values>
</answer>
</parameter>
</parameters>
nestedparams.xml ファイルへの参照を含む 2 番目の呼び出しは、対応する 2 番目のレベルの値を取得します。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@nestedparams.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
UNIX
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
331
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@nestedparams.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
応答本文:
<parameters>
<parameter optional="false" type="prompt" dpId="DP11">
<id>0</id>
<technicalName>Enter values for CustomLOV_3promptDependant:</technicalName>
<name>Enter values for CustomLOV_3promptDependant:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" partial="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO10c</id>
<intervals>
<interval id="0">
<value>AKOUTEY</value>
<value>du Toit</value>
</interval>
</intervals>
<values>
<value>AKOUTEY</value>
<value>Arai</value>
<value>Baker</value>
. . .
<value>du Randt</value>
<value>du Toit</value>
</values>
<columns mappingId="0">
<column id="0" type="String">CustomLOV_3promptDependant </
column>
</columns>
</lov>
</info>
</answer>
</parameter>
</parameters>
指定した、ネストされたパラメータのリストが不完全な場合
ネストされたパラメータの一部だけが解決されても、メイン LOV に値を入力できません。以下の本文の例では、パラメータ 1
および 4 だけが指定されています。応答は、パラメータ 3 および 4 を、以下の応答に示されているとおりに要求します。
newparams.xml ファイルの要求本文
<parameters>
<parameter>
<id>1</id>
<answer>
<values>
<value>29</value>
332
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
newparams.xml ファイルの要求本文
</values>
</answer>
</parameter>
<parameter>
<id>4</id>
<answer>
<values>
<value>72</value>
</values>
</answer>
</parameter>
</parameters>
上記の newparams.xml ファイルへの参照を含む呼び出しは、以下の応答を取得します。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@nestedparams.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' -d "@nestedparams.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/8816/parameters
応答本文:
<parameters>
<parameter optional="false" type="prompt">
<id>2</id>
<technicalName>Date greater than</technicalName>
<name>Date greater than</name>
<answer constrained="false" type="DateTime">
<info cardinality="Single">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO17</id>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt">
<id>3</id>
<technicalName>Region in list:</technicalName>
<name>Region in list:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO12</id>
</lov>
</info>
</answer>
</parameter>
<parameter optional="false" type="prompt" dpId="DP11">
<id>0</id>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
333
<technicalName>Enter values for CustomLOV_3promptDependant:</technicalName>
<name>Enter values for CustomLOV_3promptDependant:</name>
<answer constrained="false" type="Text">
<info cardinality="Multiple">
<lov hierarchical="false" refreshable="true">
<id>UNIVERSELOV_DS2.DO10c</id>
<parameters>
<id>2</id>
<id>3</id>
</parameters>
</lov>
</info>
</answer>
</parameter>
</parameters>
3.8.3
ドキュメントの最新表示のキャンセル
以下の URL を使用してドキュメントの最新表示をキャンセルします。
PUT <url>/documents/{documentId}/parameters/execution?cancel=<mode>
ドキュメントの最新表示のキャンセル
最新表示中のドキュメントの最新表示をキャンセルできます。現在実行されていない場合、影響はありません。
注記
{documentId}: Web Intelligence ドキュメントの識別子は、以下によってドキュメント一覧から取得されます: GET
http://<serverName>:6405/biprws/raylight/vx/documents
要求
PUT http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters/
execution?cancel=<mode>
ヘッダ
値
Content-Type
Accept
application/xml または application/json
application/xml または application/json
パラメータ
値
documentId
必須。整数。Web Intelligence ドキュメントの識別子。
mode
必須入力項目です。キャンセルの管理方法を定義します。
使用できる値は、'partial'、'restore'、および 'purge' です。
334
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
値
●
partial: キャンセルが実行されると、これまでに取得
した新しい値がドキュメントの適切な部分に表示されま
す。それ以外の部分については、前回のクエリ実行時
に受信したデータが表示されます。
●
restore: キャンセルが実行されると、前回のクエリ実
行時に取得した値がドキュメントに復元されます。表示
される値は、データベースにある最新の情報ではありま
せん。後でクエリを実行して、データベースから最新情
報を受信することができます。
●
purge: キャンセルが実行されると、ドキュメントに空の
値が表示されます。ドキュメントの構造と書式はそのま
まです。後でクエリを実行して、データベースから最新
情報を受信することができます。
応答
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
ボディ
キャンセルのステータス。
例
ドキュメントの最新表示をキャンセルする
キャンセルの管理方法は、mode パラメータで指定します。
Windows
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/{documentId}/parameters/execution?cancel=partial
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "content-type:application/xml" -H "accept:application/xml" -H
'"X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/{documentId}/parameters/execution?cancel=partial
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
335
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Tue, 05 Jun 2012 08:10:36 GMT
Content-Type: application/xml
Content-Length: 355
<success>
<message>The resource of type 'document' with identifier 'xxx' has been
successfully updated.</message>
<id>xxx</id>
</success>
関連リンク
ドキュメントの最新表示前におけるドキュメント最新表示パラメータの取得 [ページ 298]
ドキュメントの最新表示 [ページ 303]
3.9
ユニバースの管理
この節では、ユニバースで使用できる主な操作について説明します。
●
ユーザ権限に基づいてユーザがアクセスできるユニバースの一覧を取得する。
●
ユニバースの詳細を取得する。
●
ユニバースのクエリ機能を取得する。
Web Intelligence RESTful Web サービスを要求するデフォルトの URL は以下のとおりです。 http://<serverName>:
6405/biprws/raylight/vx
3.9.1
使用可能なユニバースの一覧の取得
ユーザがユーザアクセス権に応じてアクセスできるユニバースの一覧を取得します。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/universes
ヘッダ
値
Accept
X-SAP-LogonToken
336
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
application/xml または application/json
引用符で囲んだログオントークンの値
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
パラメータ
説明
limit
オプション。デフォルト値: 10。返すユニバースの数。
type
オプション。ユニバースタイプ: unv、unx、all。デフォルト
値: all。
offset
オプション。デフォルト値: 0。ユニバースの一覧の先頭。
応答:
ヘッダ
値
ステータスコード
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ。
ボディ
ユーザのユニバースの一覧。 CMS 内のユニバースの id、cuid、name、type、および folderId。
例
ユニバースの一覧を取得する
注記
2 つの .unx ユニバースを取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/universes?type=unx&limit=2
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/universes\?type=unx\&limit=2
<universes>
<universe>
<id>5588</id>
<cuid>AWlhsUlpz7lDlnnFr3qMZZ8</cuid>
<name>ADAPT (2)</name>
<type>unv</type>
<folderId>509</folderId>
</universe>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
337
<universe>
<id>5612</id>
<cuid>AYCKrid6ngFGvrKlwVfZKj4</cuid>
<name>ADAPT_LiveTest</name>
<type>unv</type>
<folderId>509</folderId>
</universe>
<universe>
<id>5580</id>
<cuid>AXx7quD3gJhOtAr7gxQ5rI4</cuid>
<name>ADAPT_LiveTest_ODBC</name>
<type>unv</type>
<folderId>509</folderId>
</universe>
<universe>
<id>5604</id>
<cuid>AYG2Z0qbpPxOs8U8_c7nva0</cuid>
<name>ADAPT_LiveTest_OLEDB</name>
<type>unv</type>
<folderId>509</folderId>
</universe>
<universe>
<id>6939</id>
<cuid>AVWbGLO_Q5VAvY.EPw18i2w</cuid>
<name>AdventureWorks.unx</name>
<type>unx</type>
<folderId>6870</folderId>
</universe>
</universes>
関連リンク
BI プラットフォームにログオンする [ページ 10]
3.9.2
ユニバースの詳細の取得
ユニバースの ID を参照して、ユニバースの詳細を取得します。
要求:
GET http://<serverName>:6405/biprws/raylight/vx/universes/{universeId}
注記
{universeId}: ユニバースの識別子は、以下によってユニバース一覧から取得されます: GET http://
<serverName>:6405/biprws/raylight/vx/universes
ヘッダ
値
Accept
338
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
application/xml または application/json
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
ヘッダ
値
X-SAP-LogonToken
引用符で囲んだログオントークンの値
応答:
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
以下によって識別されるユニバースの詳細:
<id>、<cuid>、<name>、<type>、<folderId>、<connected> (RDBMS を使用する接続が設定されている)、お
よび <outline> (ユニバース要素の説明)。
例
ユニバース ID 9100 の詳細
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""<TokenValue>"""
http://<serverName>:6405/biprws/raylight/v1/universes/9100
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/universes/9100
応答
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<universe>
<id>9100</id>
<cuid>AftJgs7FPGNBmkdNDnoG8Aw</cuid>
<name>unv2</name>
<type>unv</type>
<folderId>9089</folderId>
<connected>true</connected>
<outline>
<folder>
<name>City</name>
<item type="BODimension">
<name>City Id</name>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
339
<id>DO1</id>
</item>
<item type="BODimension">
<name>City</name>
<id>DO2</id>
</item>
<item type="BODimension">
<name>Region Id</name>
<id>DO3</id>
</item>
</folder>
<folder>
<name>Country</name>
<item type="BODimension">
<name>Country Id</name>
<id>DO4</id>
</item>
<item type="BODimension">
<name>Country</name>
<id>DO5</id>
</item>
</folder>
<folder>
<name>Customer</name>
<item type="BODimension">
<name>Cust Id</name>
<id>DO6</id>
</item>
<item type="BODimension">
<name>First Name</name>
<id>DO7</id>
</item>
<item type="BODimension">
<name>Last Name</name>
<id>DO8</id>
</item>
<item type="BODimension">
<name>Age</name>
<id>DO9</id>
</item>
<item type="BODimension">
<name>Phone Number</name>
<id>DOa</id>
</item>
<item type="BODimension">
<name>Address</name>
<id>DOb</id>
</item>
<item type="BODimension">
<name>City Id</name>
<id>DOc</id>
</item>
<item type="BODimension">
<name>Sales Id</name>
<id>DOd</id>
</item>
<item type="BODimension">
<name>Sponsor Id</name>
<id>DOe</id>
</item>
<item type="BODimension">
<name>Country Id</name>
<id>DOf</id>
</item>
<item type="BODimension">
<name>Nickname</name>
<id>DO10</id>
</item>
340
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<item type="BODimension">
<name>Birthdate</name>
<id>DO11</id>
</item>
</folder>
<folder>
<name>Defect</name>
<item type="BODimension">
<name>Item Id</name>
<id>DO12</id>
</item>
<item type="BODimension">
<name>Inspection Time</name>
<id>DO13</id>
</item>
<item type="BODimension">
<name>Defect Type Id</name>
<id>DO14</id>
</item>
<item type="BODimension">
<name>Nb Of Units</name>
<id>DO15</id>
</item>
<item type="BODimension">
<name>Nb Of Defects</name>
<id>DO16</id>
</item>
</folder>
<folder>
<name>Invoice Line</name>
<item type="BODimension">
<name>Inv Id</name>
<id>DO17</id>
</item>
<item type="BODimension">
<name>Service Id</name>
<id>DO18</id>
</item>
<item type="BODimension">
<name>Days</name>
<id>DO19</id>
</item>
<item type="BODimension">
<name>Nb Guests</name>
<id>DO1a</id>
</item>
</folder>
<folder>
<name>Region</name>
<item type="BODimension">
<name>Region Id</name>
<id>DO1b</id>
</item>
<item type="BODimension">
<name>Region</name>
<id>DO1c</id>
</item>
<item type="BODimension">
<name>Country Id</name>
<id>DO1d</id>
</item>
</folder>
<folder>
<name>Reject</name>
<item type="BODimension">
<name>Item Id</name>
<id>DO1e</id>
</item>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
341
<item type="BODimension">
<name>Inspection Time</name>
<id>DO1f</id>
</item>
<item type="BODimension">
<name>Defect Type</name>
<id>DO20</id>
</item>
<item type="BODimension">
<name>Nb Rejected</name>
<id>DO21</id>
</item>
</folder>
<folder>
<name>Inspection</name>
<item type="BODimension">
<name>Item Id</name>
<id>DO22</id>
</item>
<item type="BODimension">
<name>Inspection Time</name>
<id>DO23</id>
</item>
<item type="BODimension">
<name>Nb Inspected</name>
<id>DO24</id>
</item>
</folder>
<folder>
<name>Service Line</name>
<item type="BODimension">
<name>Sl Id</name>
<id>DO25</id>
</item>
<item type="BODimension">
<name>Service Line</name>
<id>DO26</id>
</item>
<item type="BODimension">
<name>Resort Id</name>
<id>DO27</id>
</item>
</folder>
<folder>
<name>Service</name>
<item type="BODimension">
<name>Service Id</name>
<id>DO28</id>
</item>
<item type="BODimension">
<name>Service</name>
<id>DO29</id>
</item>
<item type="BODimension">
<name>Sl Id</name>
<id>DO2a</id>
</item>
<item type="BODimension">
<name>Price</name>
<id>DO2b</id>
</item>
<item type="BODimension">
<name>Open Date</name>
<id>DO2c</id>
</item>
<item type="BODimension">
<name>Last Sales Date By Service</name>
<id>DO2d</id>
342
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
</item>
<item type="BODimension">
<name>Last Resa Date By Service</name>
<id>DO2e</id>
</item>
</folder>
<folder>
<name>Sales</name>
<item type="BODimension">
<name>Inv Id</name>
<id>DO2f</id>
</item>
<item type="BODimension">
<name>Cust Id</name>
<id>DO30</id>
</item>
<item type="BODimension">
<name>Invoice Date</name>
<id>DO31</id>
</item>
</folder>
<folder>
<name>Resort</name>
<item type="BODimension">
<name>Resort Id</name>
<id>DO32</id>
</item>
<item type="BODimension">
<name>Resort</name>
<id>DO33</id>
</item>
<item type="BODimension">
<name>Country Id</name>
<id>DO34</id>
</item>
</folder>
<folder>
<name>unv2 Measures</name>
<item type="Measure">
<name>Number of Measuremt Value</name>
<id>DO35</id>
</item>
<item type="Measure">
<name>Min of Measuremt Value</name>
<id>DO36</id>
</item>
<item type="Measure">
<name>Max of Measuremt Value</name>
<id>DO37</id>
</item>
<item type="Measure">
<name>Number of Nb Inspected</name>
<id>DO38</id>
</item>
<item type="Measure">
<name>Number of Nb Rejected</name>
<id>DO39</id>
</item>
</folder>
</outline>
</universe>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
343
関連リンク
使用可能なユニバースの一覧の取得 [ページ 336]
BI プラットフォームにログオンする [ページ 10]
3.9.3
ユニバースのクエリ機能の取得
ユニバースのクエリ機能を取得します。
注記
{universeId}: ユニバースの識別子は、以下によってユニバース一覧から取得されます: GET http://
<serverName>:6405/biprws/raylight/vx/universes
要求:
GET http://<serverName>:6405/biprws/raylight/vx/universes/{universeId}/capabilities
ヘッダ
値
Accept
text/xml
X-SAP-LogonToken
必須入力項目です。引用符で囲まれた SAP ログオントーク
ン
パラメータ
universeId
説明
必須。整数。取得する Web Intelligence ユニバースの識別
子。universeId: (型 = 整数、最小 = 1、最大 = 既存ユニバ
ースの最大ユニバース番号)。
応答:
ドキュメント一覧を含む XML または Json フロー。
ヘッダ
値
Status Code
HTTP 応答コード
Content-Type
Content-Length
application/xml または application/json
応答本文のコンテンツの長さ
本文 (XML)
Web Intelligence ドキュメントのクエリ機能。一覧はユーザアクセス権に依存します。ドキュメントごとに、以下が示されま
す。
一般的なクエリ機能
344
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
本文 (XML)
データ処理機能
フィルタ機能: サポートされるサブクエリ、フィルタの結果階層、オブジェクト比較、定数比較、クエリオンクエリ
サポートされる比較演算子の一覧
クエリオンクエリのサポートされる比較演算子の一覧
例
ユニバース ID 2234 の機能を CMS から取得する
Windows
curl -G -i -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/universe/2234/capabilities
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:text/xml" 'X-SAP-LogonToken:"$logtok"' http://<serverName>:
6405/biprws/raylight/v1/universe/2234/capabilities
応答
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Fri, 01 Jun 2012 09:49:52 GMT
Content-Type: application/xml
Content-Length: 217
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<datasource:QueryCapability xmlns:datasource="http://com.sap.sl.datasource">
<generalCapability combinedQueriesSupported="true"
viewQueryScriptAvailable="true" maxValuesForInList="999"/>
<dataProcessingCapability removeDuplicateRowsAvailable="true"/>
<filterCapability subQueriesSupported="true"
resultHierarchyInFilterSupported="false" objectComparisonSupported="true"
constantComparisonSupported="true" queryOnQuerySupported="true">
<supportedComparisonOperators>equal</supportedComparisonOperators>
<supportedComparisonOperators>notEqual</supportedComparisonOperators>
<supportedComparisonOperators>between</supportedComparisonOperators>
<supportedComparisonOperators>notBetween</supportedComparisonOperators>
<supportedComparisonOperators>like</supportedComparisonOperators>
<supportedComparisonOperators>notLike</supportedComparisonOperators>
<supportedComparisonOperators>exists</supportedComparisonOperators>
<supportedComparisonOperators>greater</supportedComparisonOperators>
<supportedComparisonOperators>greaterOrEqual</supportedComparisonOperators>
<supportedComparisonOperators>less</supportedComparisonOperators>
<supportedComparisonOperators>lessOrEqual</supportedComparisonOperators>
<supportedComparisonOperators>inList</supportedComparisonOperators>
<supportedComparisonOperators>notInList</supportedComparisonOperators>
<supportedComparisonOperators>both</supportedComparisonOperators>
<supportedComparisonOperators>except</supportedComparisonOperators>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
345
<supportedComparisonOperators>isNull</supportedComparisonOperators>
<supportedComparisonOperators>notIsNull</supportedComparisonOperators>
<supportedLogicalOperators>or</supportedLogicalOperators>
<supportedLogicalOperators>and</supportedLogicalOperators>
<supportedObjects>attribute</supportedObjects>
<supportedObjects>dimension</supportedObjects>
<supportedObjects>measure</supportedObjects>
<queryOnQueryCapability>
<supportedCorrelationTypesByComparisonOperator>
<value>Any</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="notEqual">
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="greater">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="greaterOrEqual">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="less">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="lessOrEqual">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="between"/>
<supportedCorrelationTypesByComparisonOperator key="notBetween"/>
<supportedCorrelationTypesByComparisonOperator key="inList">
<value>None</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="notInList">
<value>None</value></supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="isNull"/>
<supportedCorrelationTypesByComparisonOperator key="notIsNull"/>
<supportedCorrelationTypesByComparisonOperator key="like"/>
<supportedCorrelationTypesByComparisonOperator key="notLike"/>
<supportedCorrelationTypesByComparisonOperator key="both"/>
<supportedCorrelationTypesByComparisonOperator key="except"/>
<supportedCorrelationTypesByComparisonOperator key="exists"/>
<supportedComparisonOperatorsByCorrelationType>
<value>inList</value>
<value>notInList</value>
</supportedComparisonOperatorsByCorrelationType>
<supportedComparisonOperatorsByCorrelationType key="All">
<value>greater</value>
<value>greaterOrEqual</value>
<value>less</value>
<value>lessOrEqual</value>
<value>notEqual</value>
</supportedComparisonOperatorsByCorrelationType>
<supportedComparisonOperatorsByCorrelationType key="Any">
<value>greater</value>
<value>greaterOrEqual</value>
<value>less</value>
<value>lessOrEqual</value>
<value>equal</value>
</supportedComparisonOperatorsByCorrelationType>
<supportedComparisonOperatorsByCorrelationType key="Foreach"/>
</queryOnQueryCapability>
<subQueryCapability><supportedCorrelationTypesByComparisonOperator>
346
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
<value>Any</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="notEqual">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="greater">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="greaterOrEqual">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="less">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="lessOrEqual">
<value>Any</value>
<value>All</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="between"/>
<supportedCorrelationTypesByComparisonOperator key="notBetween"/>
<supportedCorrelationTypesByComparisonOperator key="inList">
<value>Any</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="notInList">
<value>Any</value>
</supportedCorrelationTypesByComparisonOperator>
<supportedCorrelationTypesByComparisonOperator key="isNull"/>
<supportedCorrelationTypesByComparisonOperator key="notIsNull"/>
<supportedCorrelationTypesByComparisonOperator key="like"/>
<supportedCorrelationTypesByComparisonOperator key="notLike"/>
<supportedCorrelationTypesByComparisonOperator key="both"/>
<supportedCorrelationTypesByComparisonOperator key="except"/>
<supportedCorrelationTypesByComparisonOperator key="exists"/>
<supportedComparisonOperatorsByCorrelationType/>
<supportedComparisonOperatorsByCorrelationType key="All">
<value>greater</value>
<value>greaterOrEqual</value>
<value>less</value>
<value>lessOrEqual</value>
<value>equal</value>
</supportedComparisonOperatorsByCorrelationType>
<supportedComparisonOperatorsByCorrelationType key="Any">
<value>greater</value>
<value>greaterOrEqual</value>
<value>less</value>
<value>lessOrEqual</value><value>equal</value>
<value>notEqual</value>
<value>inList</value>
<value>notInList</value>
</supportedComparisonOperatorsByCorrelationType>
<supportedComparisonOperatorsByCorrelationType key="Foreach"/>
</subQueryCapability>
</filterCapability>
<resultObjectCapability useAttributeSeparatelyAvailable="true"
sortObjectsAvailable="true" sortNonResultObjectsAvailable="true"/>
</datasource:QueryCapability>
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
API リファレンス
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
347
4 ワークフローの例: ドキュメントを開き、最新表示、
保存し、レポートをエクスポートする
以下の例では、ドキュメントを開いて、最新表示し、プロンプトに回答してからドキュメントのレポートをエクスポートする方法に
ついて説明します。次の操作を実行します。
●
ログオン
●
CMS からドキュメントを開く
●
ドキュメントを最新表示する
●
PDF 形式で、ドキュメントのレポートをエクスポートする
●
ドキュメントを保存し、閉じる
●
ログオフする
この例の 2 番目の部分では、必要に応じてドキュメントとレポート ID を取得する方法を示します。
例
348
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
ワークフローの例: ドキュメントを開き、最新表示、保存し、レポートをエクスポートする
5
RESTful サービスのクイックリファレンスセクション
この節には、Web Intelligence RESTful サービス API のさまざまな領域に関するカンニングペーパーを掲載しています。各
シートにコマンドの表を用意し、基本的な操作の例を記載しています。
関連リンク
ドキュメントの管理 [ページ 349]
ドキュメントライフサイクルの管理 (LCM) [ページ 353]
レポートの管理 [ページ 355]
データプロバイダの管理 [ページ 359]
ドキュメントのスケジュールと最新表示 [ページ 362]
ユニバースの管理 [ページ 363]
5.1
ドキュメントの管理
以下に、主要なコマンドを機能領域ごとにグループ化して示します。詳細については、このユーザーズガイドの関連する節を
参照してください。
表 34: ドキュメント管理
対処方法
要求
アラータ: ドキュメントへの新しいアラータの追加
POST <url>/documents/{documentId}/alerters
アラータ: アラータの削除
DELETE <url>/document/{documentId}/
alerters/{alerterId}
アラータ: アラータの完全な説明の取得
GET <url>/document/{documentId}/alerters/
{alerterId}
アラータ: ドキュメントに定義されているすべてのアラータの
GET <url>/documents/{documentId}/alerters
一覧の取得
アラータ: アラータの説明の更新
PUT <url>/document/{documentId}/alerters/
{alerterId}
添付ファイル: ドキュメントへの添付ファイルの追加
POST <url>/documents/{documentId}/
attachments/
添付ファイル: ドキュメントの添付ファイルの一覧の取得
GET <url>/documents/{documentId}/
attachments/
キャッシュ: キャッシュエントリの追加
POST <url>/documents/{documentId}/cache
ドキュメントのコピー
POST <url>/documents
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
349
対処方法
要求
空のドキュメントの作成
POST <url>/documents
CSS: ドキュメントの CSS の取得
GET <url>/documents/{documentId}/css
CSS: ドキュメントの CSS の更新
PUT <url>/documents/{documentId}/css
カスタム書式の数値: ドキュメントに定義されたカスタム書式 GET <url>/documents/{documentId}/formats
の数値の一覧の取得
ドキュメントの削除
DELETE <URL>/documents/{documentId}
ドキュメントの詳細: ドキュメントの詳細の取得
GET <url>/documents/{documentId}
ドキュメント一覧: CMS からのドキュメント一覧の取得
GET <url>/documents
ドキュメントのプロパティ: ドキュメントのプロパティの更新
PUT <url>/documents/{documentId}/
properties
ドキュメント一覧: CMS からのドキュメント一覧の取得
GET <url>/documents
ドキュメントのエクスポート
GET <URL>/documents/{documentId}[?
parameters]
ページ区切りモードでのドキュメントのエクスポート
GET <url>/documents/{documentId}/pages
選択した出力ファイル形式によっては、dpi、最適化、幅など
の追加のパラメータを定義できます。
形式: デフォルトのロケール用に、Web Intelligence サーバ GET <url>/configuration/formats
で宣言したすべての形式の一覧の取得
フォントマッピング: Web Intelligence サーバのすべての宣
GET <url>/configuration/fontmappings
言済みフォントマッピングのリストの取得
関数: 式エンジンのすべての使用可能な関数の取得
GET <url>/configuration/functions
リンク: ドキュメントの式の辞書に対するリンクの追加
POST <url>/documents/{documentId}/links
リンク: ドキュメントリンクの辞書のコンテンツの取得
GET <url>/documents/{documentId}/links
リンク: ドキュメントのリンクの説明の取得
GET <url>/documents/{documentId}/links/
{linkId}
リンク: ドキュメントのリンクの変更
PUT <url>/documents/{documentId}/links/
{linkId}
リンク: ドキュメントからのリンクの削除
DELETE <url>/documents/{documentId}/links/
{linkId}
演算子: 式エンジンのすべての使用可能な演算子の取得
GET <url>/vx/configuration/operators
スキン: Web Intelligence サーバにあるすべての宣言され
GET <url>/configuration/skins
たスキンの一覧の取得
スタイル: ドキュメントに定義されているすべてのスタイルの
GET <url>/documents/{documentId}/styles
一覧の取得
スタイル: ドキュメントへの新しいスタイルの追加
350
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
POST <url>/documents/{documentId}/styles
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
対処方法
要求
スタイル: スタイル定義の削除
DELETE <url>/documents/{documentId}/
styles/{styleId}
スタイル: スタイルの詳細な説明の取得
GET <url>/documents/{documentId}/styles/
{styleId}
スタイル: スタイル定義の更新
PUT <url>/documents/{documentId}/styles/
{styleId}
変更の追跡: ドキュメントの現在の追跡データ定義の取得
GET <url>/documents/{documentId}/tracker
変更の追跡: トラッカリソースの有効化
POST <url>/documents/{documentId}/tracker
変更の追跡: トラッカリソースの無効化
GET http://<serverName>:6405/biprws/
raylight/vx/documents
変更の追跡: 追跡データ情報の変更
DELETE <url>/documents/{documentId}/
tracker
ドキュメントの更新 (閉じる/保存)
PUT <url>/documents/{documentId}
変数: ドキュメントの変数辞書のコンテンツの取得
GET <url>/documents/{documentId}/variables
変数: ドキュメントの変数辞書に対する新しい式の追加
POST <url>/documents/{documentId}/
variables
変数: ドキュメントの変数辞書からの変数の削除
DELETE <url>/documents/{documentId}/
variables/{variableId}
変数: ドキュメントの変数辞書からの変数の定義の取得
GET <url>/documents/{documentId}/
variables/{variableId}
変数: ドキュメントの変数辞書の変数の定義の変更
PUT <url>/documents/{documentId}/
variables/{variableId}
例
CMS からドキュメントの一覧を取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
351
例
ドキュメント ID 1223 に新しいアラータを追加する
Windows
curl -i -X "POST" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" -d "@newalerter.xml" http://<serverName>:6405/biprws/raylight/v1/documents/
1223/alerters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' -d
"@newalerter.xml"
http://<serverName>:6405/biprws/raylight/v1/documents/1223/alerters
例
リンクを変更する
現在のパス (通常は cURL ツールと同じパス) に保存されている XML ファイルに定義されている本文のリンクを定義しま
す。たとえば、link2.xml です。
要求:
Windows
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@link2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/links/L2
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "PUT" -i -H "accept:application/xml" -H "content-type:application/xml" -H 'XSAP-LogonToken:"$logtok"' -d "@link2.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/links/L2
例
ドキュメントを Excel 2007 形式でエクスポートする
結果を excel2007.xls ファイルにエクスポートします。出力は Excel 内の計算用に最適化されます。
352
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
Windows
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/8022?optimized=true
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/8022?optimized=true
例
ドキュメント 5022 のスタイルを削除する
Windows
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H X-SAP-LogonToken:"""%tokenValue%""" -d "@copy.xml" http://<serverName>:6405/
biprws/raylight/v1/documents/5022/styles/?xxxx
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "DELETE" -H "accept:application/xml" -H "content-type:application/xml"
-H 'X-SAP-LogonToken:"$logtok"' -d "@copy.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/5022/styles/?xxxx
5.2
ドキュメントライフサイクルの管理 (LCM)
表 35: ドキュメントライフサイクル管理
対処方法
要求
メモリを管理するため、ドキュメントの状態を変更します。
PUT <url>/documents/{documentId}
スナップショット: ドキュメントのスナップショットの一覧を取得
GET <url>/documents/{documentId}/snapshots
します。
スナップショット: ドキュメントのスナップショットを作成します。 POST <url>/documents/{documentId}/
snapshots
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
353
対処方法
要求
スナップショット: ドキュメントのスナップショットを作成します。 POST <url>/documents/{documentId}/
snapshots
スナップショット: ドキュメントを、指定のスナップショットに対
応する状態に復元します。
PUT <url>/documents/{documentId}?
snapshotId={token}
例
変更されていないドキュメントを閉じる
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
documents/8009
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<servername>:6405/biprws/raylight/v1/
documents/8009
例
ドキュメント ID 8022 の ID トークンを取得する
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
./curl.exe -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/8022/snapshots
例
ドキュメント 5022 をスナップショット ID we00000000e5df6062ca2a に復元する
Windows
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
X-SAP-LogonToken:"""%tokenValue%""" http://<serverName>:6405/biprws/raylight/v1/
354
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
documents/5022?snapshotId=we00000000e5df6062ca2a
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "PUT" -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/raylight/v1/
documents/5022?snapshotId=we00000000e5df6062ca2a
5.3
レポートの管理
表 36: レポート管理
対処方法
要求
ドキュメントのレポートをコピーする
POST http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/reports
ドキュメントのレポートを開く
POST <url>/documents/{documentId}/reports
レポートを削除する
DELETE <url>documents/{documentId}/
reports/{reportId}
ドリル: ドリル出力モードを変更する
PUT <url>/documents/{documentId}/reports/
{reportId}/driller
ドリル: ドリルフィルタを作成する
POST <url>/documents/{documentId}/reports/
{reportId}/driller/filters
ドリル: ドリルモードでのスナップショットの作成
POST http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/
reports/{reportId}/driller/snapshot
ドリル: ドリルを無効にする
DELETE <url>/documents/{documentId}/
reports/{reportId}/driller
ドリル: クエリドリルを有効にする
POST <url>/documents/{documentId}/reports/
{reportId}/driller
ドリル: クエリドリルに関する情報を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/driller
ドリル: クエリドリル階層に関する情報を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/driller/hierarchies
ドリル: レポートのドリルフィルタの一覧を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/driller/filters
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
355
対処方法
要求
ドリル: ドリルフィルタの詳細を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/driller/filters/{filterId}
ドリル: 空きドリル要素の一覧を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/driller/drillelements
ドリル: ドリルフィルタを削除する
DELETE <url>/documents/{documentId}/
reports/{reportId}/driller/filters/
{filterId}
ドリル: ドリルフィルタを更新する
PUT <url>/documents/{documentId}/reports/
{reportId}/driller/filters/{filterId}
ドリル: ドリルアクションの実行
POST <url>/documents/{documentId}/reports/
{reportId}/driller/instructions
レポートを定められた形式でエクスポートする
GET -s <url>/documents/{documentId}/
reports/{reportId} > <reportName.fff>
fff はエクスポートされたドキュメントの形式: xml、pdf、
htm、xls、または xlsx。
ページ区切りモードのレポートをさまざまな形式でエクスポー GET -s <url>/documents/{documentId}/
reports/{reportId}/pages >
トする
<reportName.fff>
fff はエクスポートされたドキュメントの形式: xml、pdf、xls、
または xlsx。
出力形式に応じて、その他のパラメータを設定することもでき
ます。詳細については、メイントピックを参照してください。
レポートページをさまざまな形式にエクスポートする
GET -s <url>/documents/{documentId}/
reports/{reportId}/pages/{pageIndex} >
<reportName.fff>
fff はエクスポートされたドキュメントの形式: xml、pdf、
htm、xls、または xlsx。
出力形式に応じて、その他のパラメータを設定することもでき
ます。詳細については、メイントピックを参照してください。
要素: レポートの要素を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/elements
要素: レポート要素の詳細を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/elements/{elementId}
要素: レポートの要素をさまざまな形式にエクスポートする
GET -s <url>/documents/{documentId}/
reports/{reportId}/elements/{elementId} >
<reportelementn.fff>
fff はエクスポートされたドキュメントの形式: xml、pdf、
htm、xls、または xlsx。
356
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
対処方法
要求
出力形式に応じて、その他のパラメータを設定することもでき
ます。詳細については、メイントピックを参照してください。
ドキュメントのすべてのレポートを取得する
GET <url>/documents/{documentId}/reports
レポートの詳細を取得する
GET <url>documents/{documentId}/reports/
{reportId}
マップ: レポートマップを取得する
GET <url>/documents/{documentId}/reports/
{reportId}/map
ドキュメント内のレポートを移動する
POST <url>/documents/{documentId}/reports?
fromId=<fromId>&toId=<toId>
構造: 指定したレポートのレポート構造を取得する
GET <url>/documents/{documentId}/reports/
{reportId}/specification
構造: 指定したレポートのレポート構造を更新する
PUT <url>/documents/{documentId}/reports/
{reportId}/specification
レポートの詳細を更新する
PUT http://<serverName>:6405/biprws/
raylight/vx/documents/{documentId}/
reports/{reportId}
例
レポートページ 1 を XML 形式でエクスポートする
注記
page1.xml ファイルとして最初のレポートページをエクスポートします。
Windows
curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/0 >page1.xml
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -s -H "accept:text/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/9646/reports/479/pages/0 >page1.xml
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
357
例
ドキュメント 12782 のレポートを作成する
注記
ドキュメント ID が 12782 のレポートを取得します。
Windows
curl -POST -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/12782/reports
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -POST -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/12782/reports
例
ドキュメント ID 9512 のレポート 67 を削除する
Windows
curl -DELETE -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H X-SAP-LogonToken:"""%tokenValue%""" http://
<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl DELETE -H "accept:application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/9512/reports/67
例
レポートの詳細を取得する
注記
ドキュメント (ID 7858) からレポート (ID 3) の詳細を取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/7858/reports/3
358
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7858/reports/3
5.4
データプロバイダの管理
表 37: データプロバイダの管理
対処方法
要求
ドキュメントへのデータプロバイダの追加
POST <url>/documents/{documentId}/
dataproviders
データソースの変更 (データプロバイダマッピングの更新)
POST <url>/documents/{documentId}/
dataproviders/{dataproviderId}/mappings?
originDataproviderIds={DP1Id},
{DP2Id}&targetDatasourceId={DatasourceId}
データプロバイダの削除
DELETE <url>/documents/{documentId}/
dataproviders/{dataproviderId}
ドキュメントのデータプロバイダの詳細の取得
GET <url>/documents/{documentId}/
dataproviders/{dataproviderId}
XML 形式または CSV 形式でのデータプロバイダフローの
GET <url>/documents/{documentId}/
dataproviders/{dataproviderId}/flows/
{flowIndex}
詳細の取得。
ドキュメントのデータプロバイダの一覧の取得
GET <url>/documents/{documentId}/
dataproviders
使用可能なデータプロバイダマッピングの一覧の取得
GET <url>/documents/{documentId}/
dataproviders/{dataproviderId}/mappings?
originDataproviderIds={DP1Id},
{DP2Id}&targetDatasourceId={DatasourceId}
データプロバイダの使用可能なフローの数の取得。
GET <url>/dataproviders/{dataproviderId}/
flows/count
ドキュメント内のデータプロバイダの移動
PUT <url>/documents/{documentId}/
dataproviders?fromId={DPn}&toId={DPx}
ドキュメントからのデータプロバイダの削除
DELETE <url>/documents/{documentId}/
dataproviders
データプロバイダの更新または消去。
PUT <url>/documents/{documentId}/
dataproviders/{dataproviderId}
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
359
対処方法
要求
指定したデータプロバイダに添付されているクエリ仕様の更
新。
PUT <url>/documents/{documentId}/
dataproviders/{dataproviderId}/
specification
例
ドキュメントのデータプロバイダの一覧を取得する
注記
ドキュメント ID は 7738 です。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders
例
データプロバイダを追加する
現在のパス (通常は cURL ツールと同じパス) に保存されている .XML ファイルに定義されている本文に追加するデータ
プロバイダを定義します。たとえば、dp3.xml です。
要求:
Windows
curl "POST" -i -H "accept:application/xml" -H "content-type:application/xml" -H XSAP-LogonToken:"""%tokenValue%""" -d "@dp3.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/dataproviders
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl "POST" -i -H "accept:application/xml" -H "content-type:application/xml" -H
'X-SAP-LogonToken:"$logtok"' -d "@dp3.xml" http://<serverName>:6405/biprws/
raylight/v1/documents/3422/dataproviders
360
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
例
データプロバイダを更新 (消去) する
この例では、DP0 を更新 (消去) します。
Windows
curl - i -X "PUT" -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0?
purge=true
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -X "PUT" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0?
purge=true
例
(XML 形式) 最後のデータプロバイダの削除の失敗
要求
Windows
curl "DELETE" -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue
%""" http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl DELETE" -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"'
http://<serverName>:6405/biprws/raylight/v1/documents/7738/dataproviders/DP0
5.5
BW 接続および BEx クエリの管理
表 38: BW 接続および BEx クエリの管理
BW 接続のリストの取得
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
GET http://<serverName>:6405/biprws/
raylight/vx/bwconnections
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
361
BW 接続の詳細の取得
GET http://<serverName>:6405/biprws/
raylight/vx/bwconnections/{bwConnectionId}
BW 接続の詳細の参照
PUT http://<serverName>:6405/biprws/
raylight/vx/bwconnections/{BwConnectionId}
BEx クエリのアウトラインの取得
PUT http://<serverName>:6405/biprws/
raylight/vx/bwconnections/
{bwConnectionId}/outline
BEx クエリの機能の取得
PUT http://<serverName>:6405/biprws/
raylight/vx/bwconnections/
{bwConnectionId}/capabilities
5.6
ドキュメントのスケジュールと最新表示
表 39: スケジュールパラメータの管理
対処方法
要求
ドキュメントの既存のスケジュール一覧を取得します。
GET <url>/documents/{documentId}/schedules
ドキュメントの新しいスケジュールを追加します。
POST <url>/documents/{documentId}/
schedules
スケジュールの詳細を取得します。
GET <URL>/documents/{documentId}/
schedules/{scheduleId}
スケジュールを削除します。
DELETE <url>/documents/{documentId}/
schedules/{scheduleId}
表 40: 最新表示パラメータの管理
アクション
要求
ドキュメントの最新表示をキャンセルします。
PUT <url>/documents/{documentId}/
parameters/execution?cancel=<mode>
クエリの実行前に、最新表示パラメータに入力します。
GET <url>/documents/{documentId}/
parameters
最新表示パラメータに入力し (必要な場合)、ドキュメントのク GET <url>/documents
エリを実行 (最新表示) します。
例
ドキュメントにスケジュールを追加する
ドキュメントにスケジュールを追加します。スケジュールは scheduleNow.xml という xml ファイルに定義され、次のよう
に参照されます。 -d "@scheduleNow.xml"。
362
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
Windows
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduleNow.xml" -H X-SAP-logonToken:"""%tokenValue%""" http://<serverName>:
6405/biprws/raylight/v1/documents/8002/schedules
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -i -X "POST" -H "content-type:application/xml" -H "accept:application/xml" d "@scheduleNow.xml" -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/
biprws/raylight/v1/documents/8002/schedules
例
最新表示パラメータを取得する
ドキュメントの最新表示パラメータを取得する:
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H "accept:application/xml" -H 'X-SAP-LogonToken:"$logtok"' http://
<serverName>:6405/biprws/raylight/v1/documents/{documentId}/parameters
5.7
ユニバースの管理
表 41: ユニバースの管理
対処方法
要求
ユーザがユーザアクセス権に応じてアクセスできるユニバー
スの一覧を取得します。
GET <url>/universes
ユニバースの詳細を取得します。
GET <url>/universes/{universeId}
ユニバースのクエリ機能を取得します。
GET <url>/universes/{universeId}/
capabilities
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
363
例
ユニバースのクエリ機能を取得します。
Windows
curl -G -i -H "accept:application/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
http://<serverName>:6405/biprws/raylight/v1/universe/2234/capabilities
UNIX
注記
ログイン時に設定される logtok 変数を使用します。
curl -G -i -H 'X-SAP-LogonToken:"$logtok"' http://<serverName>:6405/biprws/
raylight/v1/universe/2234/capabilities
364
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Web Intelligence RESTful Web サービス SDK 開発者ガイド
RESTful サービスのクイックリファレンスセクション
www.sap.com/contactsap
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
本書のいかなる部分も SAP AG の明示的許可なしに、いかなる形式、目
的を問わず、複写、または送信することを禁じます。本書に記載された情報
は、予告なしに変更されることがあります。
SAP AG がライセンス、またはその頒布業者が頒布するソフトウェア製品に
は、他のソフトウェア会社の専有ソフトウェアコンポーネントが含まれていま
す。製品仕様は、国ごとに変わる場合があります。
これらの文書は SAP AG およびその関連会社（「SAP グループ」）が情報
提供のためにのみ提供するもので、いかなる種類の表明および保証を伴う
ものではなく、SAP グループは文書に関する錯誤又は脱漏等に対する責
任を負うものではありません。SAP グループの製品およびサービスに対す
る唯一の保証は、当該製品およびサービスに伴う明示的保証がある場合
に、これに規定されたものに限られます。本書のいかなる記述も、追加の
保証となるものではありません。
SAP、および本書で言及されるその他 SAP の製品およびサービス、ならび
にそれらのロゴは、ドイツおよびその他諸国における SAP AG の商標また
は登録商標です。
商標に関する情報および表示の詳細については、 http://
www.sap.com/corporate-en/legal/copyright/index.epx をご覧くださ
い。