HypSetCustomHeader

データ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Planning、Planning Modules、Financial Consolidation and Close、Tax Reporting

説明

この関数を使用してカスタムHTTPヘッダーを追加します。一度設定すると、Oracle Smart View for Officeによって行われたすべての要求に、要求の一部としてこのヘッダーが含まれるようになります。

この関数は、Oracle Analytics Cloud - Essbaseなど、認証にOAuth 2.0トークンを使用するプロバイダにサインオンするために使用できます。

たとえば、Oracle Analytics Cloud - Essbaseで、Oracle Identity Services Cloudに接続して必要な情報(「クライアントID」、「クライアント・シークレット」など)を入力することによって、ユーザーはOAuthベアラー・トークンを生成できます。トークンが生成されると、このトークンをヘッダーに追加できます。

HypCustomHeader関数は、Oracle Enterprise Performance Management Cloudを介してPlanning、Planning Modules、Financial Consolidation and Close、Tax Reportingの基本認証もサポートしています。

構文

HypSetCustomHeader Lib "HsAddin" (vtHeader) As Long

ByVal vtHeader As Variant

パラメータ

vtHeader: このパラメータのコンテンツが既存のHTTPヘッダーに追加されます。パラメータ・コンテンツはHTTPヘッダー・セマンティクスに従う必要があります。このパラメータを認証ヘッダーに追加できます。詳細は、例 - OAuthおよび例 - 基本認証を参照してください。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例 - OAuth

Public Declare PtrSafe Function HypSetCustomHeader Lib "HsAddin" (ByVal vtHeader As Variant) As Long

AuthHeader = "Authorization: Bearer " + token sts = HypSetCustomHeader(AuthHeader)

例 - 基本認証

HypCustomHeader関数は、/HyperionPlanning/rest/SmartView形式で基本認証をサポートします。この例では、トークンはBase64でエンコードされた文字列です。

Public Declare PtrSafe Function HypSetCustomHeader Lib "HsAddin" (ByVal vtHeader As Variant) As Long

AuthHeader = "Authorization: Basic " + token sts = HypSetCustomHeader(AuthHeader)