移動先

• リクエスト
• レスポンス
• 例

フィルタの作成

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/filters

指定されたアプリケーションおよびデータベース内にフィルタを作成し、作成したフィルタを返します。

フィルタは、Essbaseデータベース(キューブ)の特定のセルに対するアクセス制限を提供します。システム管理者は誰に対してもフィルタを適用でき、フィルタの影響を受けません。パワー・ユーザーは、自分が作成したアプリケーションにフィルタを定義して適用できます。アプリケーション・マネージャおよびデータベース・マネージャは、アプリケーションまたはキューブ内でフィルタを定義および適用できます。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

本体()

フィルタの詳細。

ルート・スキーマ : FilterBean

型: object

ソースの表示

• links: array links
• name: string
• rows: array rows

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "rows":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FilterRow"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースの表示

• 配列: object FilterRow

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FilterRow"
    }
}

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

型: object

ソースの表示

• access(required): string
• mbrSpec(required): string

{
    "type":"object",
    "required":[
        "access",
        "mbrSpec"
    ],
    "properties":{
        "access":{
            "type":"string"
        },
        "mbrSpec":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

フィルタが正常に作成されました。フィルタの詳細、フィルタを取得、編集または削除するためのリンク、およびフィルタ行を取得するためのリンクを返します。

本体()

ルート・スキーマ : FilterBean

型: object

ソースの表示

• links: array links
• name: string
• rows: array rows

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "rows":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FilterRow"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースの表示

• 配列: object FilterRow

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FilterRow"
    }
}

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

型: object

ソースの表示

• access(required): string
• mbrSpec(required): string

{
    "type":"object",
    "required":[
        "access",
        "mbrSpec"
    ],
    "properties":{
        "access":{
            "type":"string"
        },
        "mbrSpec":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

フィルタの作成に失敗しました。アプリケーション名またはデータベース名が正しくないか、そのフィルタがすでに存在する可能性があります。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseセキュリティ・フィルタを作成する方法を示します。

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

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters?links=none" -H "Accept: application/json" -H "Content-Type: application/json" --data "@./lookup_filter_def.json" -u %User%:%Password%

要求本文の例

入力ファイルlookup_filter_def.jsonは、次のJSON情報で構成されます。

{"name": "dslookupfilter",
  "rows":
   [
     {
      "access": "MetaRead",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COUNTRY\")"
     },
     {
      "access": "MetaRead",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"BUSINESSUNIT\")"
     },
     {
      "access": "MetaRead",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COSTCENTER\")"
     }
   ]
}

レスポンス本体の例

{
  "name" : "dslookupfilter"
}

先頭に戻る