移動先

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

アプリケーションおよびデータベースの作成

post

/essbase/rest/v1/applications

指定された詳細でアプリケーションおよびデータベース(キューブ)を作成します。

リクエスト

本体()

アプリケーションの詳細。

ルート・スキーマ : CreateApplication

型: object

ソースの表示

• allowDuplicates: boolean

  重複メンバー名を許可する場合はtrue。Essbaseアウトラインでのメンバー名の重複を可能にすると、メンバー名が一意である必要はなくなります。同じ名前を使用する複数のメンバーをアウトラインに含めることができます。

• applicationName: string

  アプリケーション名は30文字を超えることはできません。スペースは使用しないでください。アプリケーション名では大文字と小文字は区別されません。

• appType: string
  指定可能な値: [ "NATIVE", "UTF8" ]
• databaseName: string

  データベース(キューブ)名。名前では、大文字と小文字は区別されません。名前ではスペースを使用しないでください。名前には、次の特殊文字のみを使用できます: %$-{}()!~`#&@^。

• databaseType: string

  作成するデータベース(キューブ)のタイプ。値: ブロック・ストレージ・キューブの場合はBSO、集約ストレージ・キューブの場合はASO。

• dbType: string
  指定可能な値: [ "NORMAL", "CURRENCY", "ASO" ]
• enableScenario: boolean

  シナリオ管理に対してキューブを有効にする場合はtrue。シナリオ管理は、ブロック・ストレージ・キューブでのみサポートされています。集約ストレージ・キューブの場合、このパラメータでサポートされる値はfalseのみです。

• memberCount: integer(int32)
• memberPrefix: string

{
    "type":"object",
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"<p>The application name must not exceed 30 characters. Avoid using spaces. Application names are not case-sensitive.</p>"
        },
        "databaseName":{
            "type":"string",
            "description":"<p>The database (cube) name. The name is not case sensitive. Do not use spaces in the name. Only the following special characters are allowed in the name: <code>%$-{}()!~`#&@^</code>.</p>"
        },
        "allowDuplicates":{
            "type":"boolean",
            "description":"<p><b>true</b> if duplicate member names are permitted. When you enable duplicate member names in an Essbase outline, then member names do not have to be unique. You can have multiple members using the same name in the outline.</p>"
        },
        "enableScenario":{
            "type":"boolean",
            "description":"<p><b>true</b> if cubes can be enabled for scenario management. Note that scenario management is supported only for block storage cubes. For aggregate storage cubes, the only supported value for this parameter is <b>false</b>.</p>"
        },
        "memberCount":{
            "type":"integer",
            "format":"int32"
        },
        "databaseType":{
            "type":"string",
            "description":"<p>The type of database (cube) to create. Values: <b>BSO</b> for block storage cube, or <b>ASO</b> for aggregate storage cube.</p>"
        },
        "appType":{
            "type":"string",
            "enum":[
                "NATIVE",
                "UTF8"
            ]
        },
        "memberPrefix":{
            "type":"string"
        },
        "dbType":{
            "type":"string",
            "enum":[
                "NORMAL",
                "CURRENCY",
                "ASO"
            ]
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

アプリケーションは正常に作成されました。

400 レスポンス

不正なリクエスト

アプリケーションの作成に失敗しました。

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 -H "Accept:application/json" -H "Content-Type:application/json" -d '{"applicationName": "MyApp", "databaseName":"Basic", "databaseType":"ASO", "allowDuplicates": true, "enableScenario": false}' -u %User%:%Password%

先頭に戻る