Oracle Essbase REST API

複数のフィルタの取得

get

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

指定されたアプリケーションおよびデータベースからすべてのフィルタを返します。

リクエスト

パス・パラメータ

applicationName(required): string

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

データベース名。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : schema

型: array

ソースの表示

配列: object FilterList

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

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

型: 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/FilterBean"
            }
        },
        "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 FilterBean

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

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

型: object

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

ソースの表示

string

{
    "type":"object",
    "additionalProperties":{
        "type":"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"
        }
    }
}

400 レスポンス

不正なリクエスト

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

500 レスポンス

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

先頭に戻る

例

次の例では、特定のEssbaseデータベース(キューブ)に定義されているすべてのセキュリティ・フィルタを取得する方法を示します。

この例では、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 -H "Accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "name" : "dslookupfilter",
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
      "method" : "PUT"
    }, {
      "rel" : "rows",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter/rows",
      "method" : "GET"
    } ]
  }, {
    "name" : "dslookupfilter2",
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter2",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter2",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter2",
      "method" : "PUT"
    }, {
      "rel" : "rows",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter2/rows",
      "method" : "GET"
    } ]
  } ]
}

先頭に戻る