移動先

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

フィルタ行の取得

get

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

指定されたフィルタからアクセス定義行を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• filterName(required): string

  フィルタ名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

フィルタ行を正常に取得しました。

本体()

ルート・スキーマ : FilterRowList

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FilterRow"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object FilterRow

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

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

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

400 レスポンス

不正なリクエスト

フィルタ行の取得に失敗しました。アプリケーション名、データベース名またはフィルタ名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbase REST APIを使用して、名前付きセキュリティ・フィルタのアクセス定義詳細を取得する方法を示します。フィルタの行の内容によって、アクセス詳細が定義されます。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter/rows?links=none" -H "Accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "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\")"
  } ]
}

先頭に戻る