移動先

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

フィルタの検証

post

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

指定されたアプリケーションおよびデータベース内のフィルタを検証します。

リクエスト

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

• 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"
        }
    }
}

先頭に戻る

レスポンス

200 レスポンス

OK

フィルタが正常に検証されました。

400 レスポンス

不正なリクエスト

フィルタの検証に失敗しました。アプリケーション名またはデータベース名が正しくないか、フィルタ行が不完全である可能性があります。

415 レスポンス

受入れできません

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

500 レスポンス

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

先頭に戻る

例

次の例では、REST APIを使用してEssbaseセキュリティ・フィルタの構文を検証する方法を示します。

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

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

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/filters/filterops/validate -H "Accept: application/json" -H "Content-Type: application/json" --data "@./filter_validate.json" -u %User%:%Password%

要求本文の例

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

{"name": "filter8",
 "rows":
  [
    {
      "access": "MetaRead",
      "mbrSpec": "Qtr3"
    },
    {
      "access": "Read",
      "mbrSpec": "Qtr1"
    },
    {
      "access": "Write",
      "mbrSpec": "Qtr2"
    }
   ]
}

レスポンス本体の例

レスポンスが返されるのは、フィルタ定義にエラーがある場合のみです。

{
  "errorMessage" : "Invalid syntax in filter line [1] with error number [1200315] - see application log file",
  "errorCode" : 1054012
}

先頭に戻る