1. Oracle EssbaseのREST API
  2. タスク
  3. パーティション

パーティションの取得

get

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

データベース上で定義されているパーティションのリスト、または特定のパーティションを返します。

  • パラメータがない場合: 使用可能なすべてのパーティションを返します。
  • typeパラメータがある場合: フィルタ済のパーティション・リストを返します。
  • パーティション・タイプ、ソース・サーバー、ソース・アプリケーションおよびソース・データベースのパラメータがある場合: 指定されたパーティションの詳細を返します。

リクエスト

パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

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

200 レスポンス

OK

パーティション・リストまたはパーティション詳細が正常に返されました。

本体()
ルート・スキーマ : PartitionList
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : PartitionBean
型: object
ソースの表示
ネストされたスキーマ : areas
型: array
ソースの表示
ネストされたスキーマ : mappings
型: array
ソースの表示
ネストされたスキーマ : ConnectionInfoBean
型: object
ソースの表示
ネストされたスキーマ : AreaBean
型: object
ソースの表示
  • slices

    ソースおよびターゲット・メンバーのマッピングを定義するオプションのスライス定義。ターゲットとソースで一部のメンバーおよびディメンションに異なる名前を使用している場合、Essbaseではこの情報を使用して、ターゲットにデータを入力する方法が決定します。

  • パーティションのソース領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。

  • パーティションのソース領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。

  • パーティションのターゲット領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。

  • パーティションのターゲット領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。

ネストされたスキーマ : slices
型: array

ソースおよびターゲット・メンバーのマッピングを定義するオプションのスライス定義。ターゲットとソースで一部のメンバーおよびディメンションに異なる名前を使用している場合、Essbaseではこの情報を使用して、ターゲットにデータを入力する方法が決定します。

ソースの表示
ネストされたスキーマ : MemberMappingBean
型: object
ソースの表示

  • ターゲットの一致するリージョンにマップするパーティション・ソースのメンバー名。

  • ソースの一致するリージョンにマップするパーティション・ターゲットのメンバー名。

ネストされたスキーマ : EsbToColMap
型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示
ネストされたスキーマ : EssToDsMapDTO
型: object
ソースの表示
ネストされたスキーマ : arr
型: array
ソースの表示
  • EsbToColMapInfo

    フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ネストされたスキーマ : EsbToColMapInfo
型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示
ネストされたスキーマ : dimensions
型: array
ソースの表示
ネストされたスキーマ : Dimension
型: object
ソースの表示

  • アウトラインにまだ存在しない新しいディメンションの場合は、trueに設定します。trueの場合、新しいディメンションがディメンション構築中に作成されます。falseの場合、新しいディメンションのディメンション構築は失敗します。

  • 指定可能な値: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]

    このディメンションに含まれるディメンション、メンバーおよび別名を追加、変更または削除する構築方法アルゴリズム。ソース・データのプロパティに基づいている必要があります。たとえば、各レコードで親、その後に子メンバーをこの順序で指定している場合、PARENT_CHILDが適切な方法です。

  • 指定可能な値: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]

    メンバーおよびその子を新しい親に移動できるようにする場合はOKに設定し、Essbaseがプライマリ・メンバーを認識してそれらをソース・データと照合できるようにします。重複メンバーのアウトラインには使用できません。updateOption = RESET_DIMENSIONの場合は、NOTOKのままにします。

  • AttributeOptions
  • 指定可能な値: [ "EXISTING", "DENSE", "SPARSE" ]

  • Essbaseで属性メンバーを作成できるようにするには、trueに設定します。falseの場合、Essbaseでは属性メンバーを作成できません。

  • ディメンションの解決順。

  • generations
  • 指定可能な値: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]

    このディメンションで複数の階層を有効にする必要がある場合はMULTIPLE (集約ストレージ・キューブにのみ適用可能)。設定をそのままにする場合はEXISTING。集約ストレージ保存階層タイプ(式なし)の場合はSTORED。式を使用して集約する集約ストレージ階層タイプ(勘定科目ディメンションを含む)の場合はDYNAMIC。

  • Essbaseがソース・データからのすべてのメンバーを処理および追加した後にメンバーをソートする場合は、trueに設定します。

  • levels
  • MeasureOptions

    主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

  • 子を追加する親メンバーの名前。「次の子として追加」構築方法とともに使用します。

  • ディメンションに共有メンバーが含まれる場合はtrueに設定します。

  • ディメンションまたはメンバーが計算される優先度(0から127)。解決順の値が大きいほどそのメンバーは後で計算されることになります。解決順が割り当てられていないメンバーは、そのディメンションから解決順を継承します。

  • 指定可能な値: [ "NONE", "ASCENDING", "DESCENDING" ]

    このディメンションの階層内の子をソートするかどうかと、ソート方法: なし(ソートしない)、昇順または降順。

  • 指定可能な値: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
  • 指定可能な値: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
  • 指定可能な値: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
  • 指定可能な値: [ "MERGE", "REMOVE_UNSPECIFIED", "RESET_DIMENSION" ]

    増分ディメンション構築の更新オプション。増分ディメンション構築は、メンバーの追加、移動、削除および順序変更によって既存のディメンションを更新するプロセスです。MERGE (デフォルト)では、新しいメンバーを追加しますが、既存のメンバーも保持します。REMOVE_UNSPECIFIEDでは、ソースで指定されていないメンバーを削除します(addMemberOption = GENERATION、LEVELまたはPARENT_CHILDの場合のみ使用可能)。メンバーの削除によってレベル0の式のない動的計算メンバーになる場合、アウトラインは無効です。RESET_DIMENSIONは、インデックスベースのルール(つまり、studio = true)にのみ使用可能です。ディメンションのリセットは、ディメンション全体を再構築します。このオプションでは、増分ディメンション構築中の挿入、順序変更、移動および削除操作を使用可能にし、階層内のメンバーの配置を最後に移動するのではなく、そのままにします。ディメンションのリセットを使用するには、allowMovesをNOTOKにする必要があります。そうしないと、共有階層を構築できません。

ネストされたスキーマ : AttributeOptions
型: object
ソースの表示
ネストされたスキーマ : generations
型: array
ソースの表示
ネストされたスキーマ : levels
型: array
ソースの表示
ネストされたスキーマ : MeasureOptions
型: object

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

ソースの表示

  • ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨カテゴリ。これは通貨キューブからの勘定科目メンバーです。例: P&L。

  • 指定可能な値: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]

    ディメンション構築中に実行する通貨換算アクション。通貨換算しないメンバーにはNO_CONVERSIONのマークを付けます。NONEは、換算しないことを示すのではなく、換算カテゴリが未指定である(つまり、継承される)ことを示します。

  • ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨名。これは通貨キューブからの国ディメンション・タイプ・メンバーです。例: USD、CND、GPB、EUR

  • 指定可能な値: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]

    timeBalanceOptionをFIRST、LASTまたはAVERAGEとして設定する場合は、スキップ・プロパティを使用して、欠落値またはゼロ値が出現した場合の親値の計算方法を示します。NONE: 親値を計算するときにデータをスキップしません。MISSING: #MISSINGデータをスキップします。ZERO: ゼロに等しい値をスキップします。MISSING_ZERO: #MISSINGデータとゼロに等しいデータをスキップします。

  • 指定可能な値: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]

    タイム・バランス・プロパティ(使用する場合)。デフォルトでは、時間ディメンション内の親はその子の集計および式に基づいて計算されます。たとえば、Sample.Basicデータベースでは、Qtr1メンバーはその子(Jan、FebおよびMar)の合計です。ただし、タイム・バランス・プロパティを設定すると、親(たとえば、Qtr1)は異なる方法でロールアップされます。

  • 2パス計算を使用するとしてディメンションにマークを付ける場合はtrue。

  • 指定可能な値: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

    勘定科目メンバーを費用アイテムとして処理します。現在の設定を保持する場合はEXISTING。

ネストされたスキーマ : indepDimensions
型: array
ソースの表示
ネストされたスキーマ : IndepDimension
型: object
ソースの表示
ネストされたスキーマ : Level
型: object
ソースの表示

400 レスポンス

不正なリクエスト

パーティション結果の取得に失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例では、現在のキューブに定義されているパーティションを取得する方法を示します。

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

透過パーティションを取得するcURLコマンドを含むスクリプト

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/SampTgt/databases/Basic/partitions?type=TRANSPARENT&links=none" -H "accept: application/json" -o output_partition_get.json -u %User%:%Password%

レスポンス本体の例(透過パーティションのターゲット・キューブ)

{
  "items": [
    {
      "type": "TRANSPARENT",
      "isNew": false,
      "updatable": false,
      "locked": false,
      "federatedTypeCR": false,
      "federatedTypeAV": false,
      "sourceInfo": {
        "connectionName": "",
        "serverName": "https://myserver.example.com:9001/essbase/agent",
        "alterCredentials": false,
        "applicationLevelConnection": false,
        "applicationLevelDatasource": false,
        "applicationName": "SampSrc",
        "databaseName": "Basic"
      },
      "targetInfo": {
        "serverName": "https://myserver.example.com:9001/essbase/agent",
        "alterCredentials": false,
        "applicationLevelConnection": false,
        "applicationLevelDatasource": false,
        "applicationName": "SampTgt",
        "databaseName": "Basic"
      },
      "areas": [
        {
          "sourceArea": "@idesc(\"100\")",
          "sourceCellCount": 0,
          "targetArea": "@idesc(\"100\")",
          "targetCellCount": 0,
          "slices": [
            {
              "sourceMember": "\"100-10\"",
              "targetMember": "\"555-55\""
            }
          ]
        }
      ],
      "mappings": [ ],
      "links": [ ],
  "totalResults": 1,
  "limit": 1,
  "count": 1
}

フェデレーテッド・パーティションを取得するcURLコマンドを含むスクリプト

call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/partitions?type=FEDERATED&links=none" -H  "accept: application/json" -o output_partition_get.json -u %User%:%Password%

レスポンス本体の例(フェデレーテッド・パーティション・キューブ)

{
  "items": [
    {
      "type": "FEDERATED",
      "isNew": false,
      "updatable": false,
      "locked": false,
      "federatedTypeCR": false,
      "federatedTypeAV": true,
      "sourceInfo": {
        "connectionName": "conn",
        "userName": "admin",
        "alterCredentials": false,
        "applicationLevelConnection": true,
        "applicationLevelDatasource": false,
        "measuresDimensionName": "Measures",
        "essbaseToColumnMap": {
          "arr": []
        },
        "essbaseToDataSourceMap": {
          "dimensions": [
            {
              "avDimensionId": 0,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Year",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "YEAR"
                }
              ]
            },
            {
              "avDimensionId": 2,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Product",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "PRODUCT"
                }
              ]
            },
            {
              "avDimensionId": 3,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Market",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "MARKET"
                }
              ]
            },
            {
              "avDimensionId": 4,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Scenario",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "SCENARIO"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Additions",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "ADDITIONS"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "COGS",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "COGS"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Ending Inventory",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Ending Inventory"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Margin %",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Margin %"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Marketing",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "MARKETING"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Misc",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "MISC"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Opening Inventory",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Opening Inventory"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Payroll",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "PAYROLL"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Profit %",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Profit %"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Sales",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "SALES"
                }
              ]
            }
          ]
        },
        "factTableName": "SAMPLE_FACT"
      },
      "targetInfo": {
        "userName": "admin",
        "alterCredentials": false,
        "applicationLevelConnection": false,
        "applicationLevelDatasource": false,
        "applicationName": "Sample",
        "databaseName": "Basic"
      },
      "areas": [
        {
          "sourceArea": "\"Additions\", \"COGS\", \"Ending Inventory\", \"Margin %\", \"Marketing\", \"Misc\", \"Opening Inventory\", \"Payroll\", \"Profit %\", \"Sales\"",
          "sourceCellCount": 0,
          "targetArea": "\"Additions\", \"COGS\", \"Ending Inventory\", \"Margin %\", \"Marketing\", \"Misc\", \"Opening Inventory\", \"Payroll\", \"Profit %\", \"Sales\"",
          "targetCellCount": 0
        }
      ],
      "mappings": [ ],
      "links": [ ]
    }
  ],
  "totalResults": 1,
  "limit": 1,
  "count": 1
}
先頭に戻る