移動先

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

計算スクリプトの検証

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/validate

指定されたスクリプトを検証します。計算スクリプトの場合のみ適用可能です。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• file: string

  ファイル。

  デフォルト値: calc

本体()

スクリプトの詳細。

ルート・スキーマ : Script

型: object

ソースの表示

• content: string

  スクリプトの内容。

• links: array links
• locked: boolean
• lockedBy: string
• lockedTime: integer(int64)
• modifiedTime: integer(int64)
• name: string

  スクリプト名。

• sizeInBytes: integer(int64)

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string",
            "description":"<p>Script contents.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "lockedTime":{
            "type":"integer",
            "format":"int64"
        },
        "locked":{
            "type":"boolean"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "sizeInBytes":{
            "type":"integer",
            "format":"int64"
        },
        "lockedBy":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>Script name.</p>"
        }
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

ネストされたスキーマ : 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"
        }
    }
}

先頭に戻る

レスポンス

200 レスポンス

OK

スクリプトが正常に検証されました。

400 レスポンス

不正なリクエスト

スクリプトの検証に失敗しました。アプリケーション名またはデータベース名が正しくないか、指定したスクリプト名については内容が不完全である可能性があります。

415 レスポンス

受入れできません

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

500 レスポンス

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

先頭に戻る

例

次の例では、計算スクリプトを作成する前に、Essbase REST APIを使用して計算スクリプトの内容の構文を検証する方法を示します。

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

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

次のREST呼出しは、計算スクリプト構文SET UPDATECALC; CALC ALL;がSample Basicキューブに対して有効かどうかをチェックします。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/scriptops/validate -H "accept: application/json" -H "Content-Type:application/json" -d '{"content": "SET UPDATECALC; CALC ALL;"}' -u %User%:%Password%

レスポンス本体の例

レスポンスが返されるのは、計算スクリプトの内容に構文エラーがある場合のみです。

{
  "errorMessage" : "Invalid Calc Script syntax [SET UPDATECALC;]",
  "errorCode" : 1012001
}

SET UPDATECALCコマンドにはONまたはOFFパラメータが必要であるため、検証でエラーが返されました(合格しませんでした)。

先頭に戻る