移動先

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

グローバル・データソースの取得

get

/essbase/rest/v1/datasources/{datasourceName}

指定されたグローバル・データソースについて詳細を返します。

リクエスト

パス・パラメータ

• datasourceName(required): string

  データソース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

データソースの詳細が正常に返されました。

本体()

ルート・スキーマ : datasource

型: object

ソースの表示

• application(required): string

  データソースのtypeがESSBASEである場合に適用可能。Essbaseアプリケーション名。

• columns(required): object ColumnsType
• connection(required): string

  このデータソースで使用される接続。

• cube(required): string

  データソースのtypeがESSBASEである場合に適用可能。Essbaseデータベース名。

• customDelimiter: string

  delimiterに指定されている値がCustomである場合の、データ・レコードのカスタム・デリミタ。

• delimeter: string

  データソースのtypeがDELIMITEDFILEである場合の、データ・レコードのデリミタ。デリミタは、CSVフォーマットの場合はComma、タブ区切りフォーマットの場合はTabにできます。カスタム・デリミタを使用するには、値Customを使用し、デリミタをcustomDelimiterの値として指定します。

• description(required): string

  このデータソースのオプションの説明。

• endRow: integer(int64)

  データソースがExcelファイルまたはテキスト・ファイルである場合の、終了行番号。

• headerRow: integer(int64)

  データソースがExcelファイルまたはテキスト・ファイルである場合の、ヘッダー行番号。ヘッダーがない場合は0。

• headers: array headers
• ignoreErrorRecords: boolean
• links: array links
• name: string

  データソース名。先頭は文字である必要があります。文字、アンダースコア文字および数字のみを含めることができます。

• query(required): string

  データソースに関連付けられている問合せ。たとえば、外部データベースの場合はSQL問合せ、または別のEssbaseキューブの場合はMDX問合せ。問合せによって、このデータソース内の使用可能にするデータが選択されます。

• queryParameters: array queryParameters

  データソース問合せがパラメータ化されている場合の、パラメータ実装詳細。たとえば、問合せselect * from profit_data where year=?のように、パラメータを渡すための?プレースホルダが問合せに含まれる場合、実装詳細を定義する必要があります。

• sheet(required): string

  データソースがExcelファイルである場合の、ワークシート名。

• skipHiddenRows: boolean
• startRow(required): integer(int64)

  オプション(指定されていない場合、デフォルトは1です)。データソースがExcelファイルまたはテキスト・ファイルである場合の、(headerRowが存在する場合はこれを除いた)データ開始行番号。たとえば、headerRowが1として指定され、startRowが10として指定されている場合、実際のデータ開始行は11になります。

• type(required): string
  指定可能な値: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "BI", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]
• widths(required): array widths

{
    "type":"object",
    "required":[
        "application",
        "columns",
        "connection",
        "cube",
        "description",
        "query",
        "sheet",
        "startRow",
        "type",
        "widths"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "TEMPLATE",
                "EXCELFILE",
                "DB",
                "DELIMITEDFILE",
                "FIXEDWIDTHFILE",
                "BI",
                "ESSBASE",
                "JDBC",
                "SPARK",
                "MS_SQL",
                "MYSQL",
                "DB2",
                "ORACLE",
                "FILE"
            ]
        },
        "connection":{
            "type":"string",
            "description":"<p>Connection used for this Datasource.</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>Optional description of this Datasource.</p>"
        },
        "columns":{
            "$ref":"#/definitions/ColumnsType"
        },
        "name":{
            "type":"string",
            "description":"<p>Datasource name. Must begin with a letter. Can contain only letters, underscore character, and digits.</p>"
        },
        "ignoreErrorRecords":{
            "type":"boolean"
        },
        "delimeter":{
            "type":"string",
            "description":"<p>Delimiter of the data records, if Datasource <i>type</i> is <code>DELIMITEDFILE</code>. Delimiter can be <code>Comma</code> for CSV format or <code>Tab</code> for tab-separated format. To use a custom delimiter, use value <code>Custom</code>, and provide the delimiter as a value to <i>customDelimiter</i>.</p>",
            "xml":{
                "name":"delimiter"
            }
        },
        "customDelimiter":{
            "type":"string",
            "description":"<p>Custom delimiter of the data records, if the value provided for <i>delimiter</i> is <code>Custom</code>.</p>"
        },
        "query":{
            "type":"string",
            "description":"<p>Query associated with the Datasource. For example, a SQL query for an external database, or an MDX query for another Essbase cube. The query selects which data you want to make available in this Datasource.</p>"
        },
        "application":{
            "type":"string",
            "description":"<p>Applicable if the <i>type</i> of Datasource is ESSBASE. The Essbase application name.</p>"
        },
        "cube":{
            "type":"string",
            "description":"<p>Applicable if the <i>type</i> of Datasource is ESSBASE. The Essbase database name.</p>"
        },
        "startRow":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Optional (default is 1 if not given). For a Datasource that is an Excel or text file, the starting data row number, excluding headerRow if one exists. For example, if headerRow is specified as 1 and startRow is specified as 10, the actual starting data row will be 11.</p>"
        },
        "endRow":{
            "type":"integer",
            "format":"int64",
            "description":"<p>For a Datasource that is an Excel or text file, the ending row number.</p>"
        },
        "headerRow":{
            "type":"integer",
            "format":"int64",
            "description":"<p>For a Datasource that is an Excel or text file, the header row number. 0 if there is no header.</p>"
        },
        "sheet":{
            "type":"string",
            "description":"<p>For a Datasource that is an Excel file, the worksheet name.</p>"
        },
        "skipHiddenRows":{
            "type":"boolean"
        },
        "widths":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64",
                "xml":{
                    "name":"widths"
                }
            }
        },
        "queryParameters":{
            "type":"array",
            "description":"<p>Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a <code>?</code> placeholder for passing a parameter, as in the following query: <code>select * from profit_data where year=?</code>, then you need define the implementation details.</p>",
            "items":{
                "xml":{
                    "name":"queryParameters"
                },
                "$ref":"#/definitions/QueryParamsInfo"
            }
        },
        "headers":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"headers"
                },
                "$ref":"#/definitions/HeaderType"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"datasource"
    }
}

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

型: object

ソースの表示

• column(required): array Column

{
    "type":"object",
    "required":[
        "column"
    ],
    "properties":{
        "column":{
            "type":"array",
            "xml":{
                "name":"Column"
            },
            "items":{
                "xml":{
                    "name":"Column"
                },
                "$ref":"#/definitions/ColumnType"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object HeaderType

{
    "type":"array",
    "items":{
        "xml":{
            "name":"headers"
        },
        "$ref":"#/definitions/HeaderType"
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

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

型: array

データソース問合せがパラメータ化されている場合の、パラメータ実装詳細。たとえば、問合せselect * from profit_data where year=?のように、パラメータを渡すための?プレースホルダが問合せに含まれる場合、実装詳細を定義する必要があります。

ソースの表示

• 配列: object QueryParamsInfo

{
    "type":"array",
    "description":"<p>Parameter implementation details, if the Datasource query is parameterized. For example, if the query includes a <code>?</code> placeholder for passing a parameter, as in the following query: <code>select * from profit_data where year=?</code>, then you need define the implementation details.</p>",
    "items":{
        "xml":{
            "name":"queryParameters"
        },
        "$ref":"#/definitions/QueryParamsInfo"
    }
}

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

型: array

ソースの表示

• 配列: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64",
        "xml":{
            "name":"widths"
        }
    }
}

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

型: array

ソースの表示

• 配列: object ColumnType

{
    "type":"array",
    "xml":{
        "name":"Column"
    },
    "items":{
        "xml":{
            "name":"Column"
        },
        "$ref":"#/definitions/ColumnType"
    }
}

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

型: object

ソースの表示

• format: string
• index: integer(int32)
• name: string
• nullable: boolean
• system: boolean
• type: string
  指定可能な値: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "type":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "STRING",
                "DOUBLE",
                "DATE",
                "TIMESTAMP",
                "LONG"
            ]
        },
        "nullable":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "format":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "index":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "system":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

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

型: object

ソースの表示

• cell: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "cell":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

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

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

型: object

ソースの表示

• defaultValue: string

  実行時にパラメータに無効なコンテキストがある場合に、データソースがフォールバックとして使用する固定のデフォルト・パラメータ値。例: Jan。データソース問合せがパラメータ化されており(パラメータを渡すための?プレースホルダが含まれている)、かつプレースホルダが代替変数を参照することも、外部ソースで開発されたユーザー定義関数を参照することも意図されていない場合にのみ必須。

• index: integer(int32)

  データソース問合せパラメータの順序インデックス。たとえば、最初のパラメータの場合は1、2番目のパラメータの場合は2、など。

• name: string

  各自のユースケースに対して意味のある、データソース問合せパラメータのオプションの名前。たとえば、Param1のかわりにparam_G_monthを使用して、そのパラメータで現在の月のグローバル変数を使用することを示したり、名前をparam_appName_monthに変更して、そのパラメータで現在の月のアプリケーション・レベルの変数を使用することを示すことができます。

• required: boolean

  データソース問合せパラメータが必須の場合はtrue、それ以外の場合はfalse。

• subVariableName: string

  useSubVariableがtrueの場合、Essbase代替変数の名前。

• type: string
  指定可能な値: [ "STRING", "DOUBLE", "DATE", "TIMESTAMP", "LONG" ]

  データソース問合せパラメータのデータ型。

• useSubVariable: boolean

  データソース問合せパラメータでEssbase代替変数を参照する場合はtrue、それ以外の場合はfalse。

{
    "type":"object",
    "properties":{
        "index":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Ordinal index of the Datasource query parameter. For example, 1 for the first parameter, 2 for the second parameter, etc.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>Optional name for the Datasource query parameter, meaningful for your use case. For example, instead of Param1 you can use param_G_month to indicate that the parameter uses a global variable for the current month, or you can rename it to param_appName_month to indicate that the parameter uses an application-level variable for the current month.</p>"
        },
        "defaultValue":{
            "type":"string",
            "description":"<p>A fixed, default parameter value that the Datasource should use as a fallback in case the parameter has an invalid context at runtime. Example: <b>Jan</b>. Required only if the Datasource query is parameterized (it includes a <code>?</code> placeholder for passing a parameter) AND the placeholder is not intended to reference a substitution variable nor a user-defined function developed in the external source.</p>"
        },
        "required":{
            "type":"boolean",
            "description":"<p><b>true</b> if the Datasource query parameter is required, or <b>false</b> otherwise.</p>"
        },
        "useSubVariable":{
            "type":"boolean",
            "description":"<p><b>true</b> if the Datasource query parameter references an Essbase substitution variable, or <b>false</b> otherwise.</p>"
        },
        "subVariableName":{
            "type":"string",
            "description":"<p>If <i>useSubVariable</i> is <b>true</b>, the name of an Essbase substitution variable.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Datatype of the Datasource query parameter.</p>",
            "enum":[
                "STRING",
                "DOUBLE",
                "DATE",
                "TIMESTAMP",
                "LONG"
            ]
        }
    }
}

400 レスポンス

不正なリクエスト

データソース詳細の取得に失敗しました。

先頭に戻る

例

次の例では、特定のグローバル・データソースの詳細を取得する方法を示します。

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

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

次の例では、Orcl_DSという名前のグローバル・データソースの詳細を取得します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/datasources/Orcl_DS?links=none" -H Accept:application/json -u %User%:%Password%

レスポンス本体の例 - Oracle Database

次の例は、データソースがOracle Database用である場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "Orcl_DS",
  "description" : "Datasource to Oracle Database",
  "connection" : "oraConn",
  "type" : "DB",
  "columns" : {
    "Column" : [ {
      "name" : "DIMENSION_PRODUCT",
      "type" : "STRING",
      "index" : 1,
      "system" : false
    }, {
      "name" : "DIMENSION_MARKET",
      "type" : "STRING",
      "index" : 2,
      "system" : false
    }, {
      "name" : "DIMENSION_YEAR",
      "type" : "STRING",
      "index" : 3,
      "system" : false
    }, {
      "name" : "DIMENSION_SCENARIO",
      "type" : "STRING",
      "index" : 4,
      "system" : false
    }, {
      "name" : "SALES",
      "type" : "DOUBLE",
      "index" : 5,
      "system" : false
    }, {
      "name" : "COGS",
      "type" : "DOUBLE",
      "index" : 6,
      "system" : false
    }, {
      "name" : "MARKETING",
      "type" : "DOUBLE",
      "index" : 7,
      "system" : false
    }, {
      "name" : "PAYROLL",
      "type" : "DOUBLE",
      "index" : 8,
      "system" : false
    }, {
      "name" : "MISC",
      "type" : "DOUBLE",
      "index" : 9,
      "system" : false
    }, {
      "name" : "INITIAL_INVENTORY",
      "type" : "DOUBLE",
      "index" : 10,
      "system" : false
    }, {
      "name" : "ADDITIONS",
      "type" : "DOUBLE",
      "index" : 11,
      "system" : false
    } ]
  },
  "query" : "select * from SB_DATA where dimension_year=?",
  "queryParameters" : [ {
    "index" : 1,
    "name" : "Param1",
    "required" : false,
    "useSubVariable" : true,
    "subVariableName" : "CurrMonth",
    "type" : "STRING"
  } ],
  "links" : [ ]
}

レスポンス本体の例 - Essbase

次の例は、データソースが別のEssbaseキューブ用である場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "EssbaseDS",
  "connection" : "essconn",
  "type" : "ESSBASE",
  "columns" : {
    "Column" : [ {
      "name" : "Measures",
      "type" : "STRING",
      "index" : 1,
      "system" : false
    }, {
      "name" : "Oregon",
      "type" : "STRING",
      "index" : 2,
      "system" : false
    }, {
      "name" : "Florida",
      "type" : "STRING",
      "index" : 3,
      "system" : false
    }, {
      "name" : "Utah",
      "type" : "STRING",
      "index" : 4,
      "system" : false
    } ]
  },
  "query" : "select {Sales} on rows, {Oregon, Florida, Utah} on columns",
  "application" : "Sample",
  "cube" : "Basic",
  "queryParameters" : [ ],
  "links" : [ ]
}

レスポンス本体の例 - Excelワークブック

次の例は、データソースがExcelファイル用である場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "excelDS",
  "description" : "Datasource to Excel file",
  "connection" : "excel_conn",
  "type" : "EXCELFILE",
  "sheet" : "SpendHistory",
  "headerRow" : 1,
  "startRow" : 1,
  "columns" : {
    "Column" : [ {
      "name" : "Year",
      "type" : "STRING",
      "index" : 1,
      "system" : false
    }, {
      "name" : "Quarter",
      "type" : "STRING",
      "index" : 2,
      "system" : false
    }, {
      "name" : "Month",
      "type" : "STRING",
      "index" : 3,
      "system" : false
    }, {
      "name" : "Purchase Organization",
      "type" : "STRING",
      "index" : 4,
      "system" : false
    }, {
      "name" : "Category",
      "type" : "STRING",
      "index" : 5,
      "system" : false
    }, {
      "name" : "Product Name",
      "type" : "STRING",
      "index" : 6,
      "system" : false
    }, {
      "name" : "Org Name",
      "type" : "STRING",
      "index" : 7,
      "system" : false
    }, {
      "name" : "Suppliers",
      "type" : "STRING",
      "index" : 8,
      "system" : false
    }, {
      "name" : "Spend",
      "type" : "STRING",
      "index" : 9,
      "system" : false
    }, {
      "name" : "Addressable Spend",
      "type" : "STRING",
      "index" : 10,
      "system" : false
    }, {
      "name" : "Non-Addressable Spend",
      "type" : "STRING",
      "index" : 11,
      "system" : false
    }, {
      "name" : "Invoiced Quantity",
      "type" : "STRING",
      "index" : 12,
      "system" : false
    }, {
      "name" : "Invoiced Amount",
      "type" : "STRING",
      "index" : 13,
      "system" : false
    } ]
  },
  "queryParameters" : [ ],
  "links" : [ ]
}

レスポンス本体の例 - テキスト・ファイル

次の例は、データソースが区切りテキスト・ファイル用である場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "delimitedfile_DS",
  "description" : "Datasource to text file using custom delimiter",
  "connection" : "delimitedfile_conn",
  "type" : "DELIMITEDFILE",
  "delimiter" : "Custom",
  "customDelimiter" : "#",
  "headerRow" : 1,
  "startRow" : 1,
  "columns" : {
    "Column" : [ {
      "name" : "Product",
      "type" : "STRING",
      "index" : 0,
      "system" : false
    }, {
      "name" : "Scenario",
      "type" : "STRING",
      "index" : 1,
      "system" : false
    }, {
      "name" : "Measures",
      "type" : "STRING",
      "index" : 2,
      "system" : false
    }, {
      "name" : "Mar",
      "type" : "STRING",
      "index" : 3,
      "system" : false
    }, {
      "name" : "Apr",
      "type" : "STRING",
      "index" : 4,
      "system" : false
    } ]
  },
  "queryParameters" : [ ],
  "links" : [ ]
}

先頭に戻る