Oracle Essbase REST API

ユーティリティのリスト

get

/essbase/rest/v1/utilities

使用可能なユーティリティを返します。たとえば、エクスポート・ユーティリティ、Smart View for Essbaseです。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

ユーティリティが正常に返されました。

ルート・スキーマ : ResourceList

型: object

ソースの表示

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

使用可能なその他のプロパティ: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Resource"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

配列: object Resource

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

型: object

ソースの表示

category: string
description: string
id: string
links: array links
mimeType: string
name: string
path: string
provider: string
url: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "provider":{
            "type":"string"
        },
        "path":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

400 レスポンス

不正なリクエスト

ユーティリティの取得に失敗しました。

先頭に戻る

例

次の例では、使用可能なEssbaseユーティリティのリストを取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/utilities" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items" : [ {
    "id" : "exportutility",
    "name" : "11g Excel Export Utility",
    "description" : "Exports Essbase 11g applications to application workbooks. You can use the application workbooks to re-create the applications on the current Essbase version.",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Command Line Tools",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/exportutility",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "smartview",
    "name" : "Smart View for Essbase",
    "description" : "Smart View for Essbase",
    "provider" : "Oracle",
    "url" : "http://www.oracle.com/technetwork/middleware/smart-view-for-office/overview/index.html",
    "category" : "Smart View"
  }, {
    "id" : "lcm",
    "name" : "11g LCM Export Utility",
    "description" : "Exports artifacts from Essbase 11g On-Premise as a .zip file, which you can import in to Essbase 12c or higher. This Life Cycle Management (LCM) utility can also be used to export from, and import to, 11g releases of Essbase. This utility packages into a zip everything you need to support migration to the current version.",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Command Line Tools",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/lcm",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "cli",
    "name" : "Command Line Interface (CLI)",
    "description" : "A scripting interface that uses REST APIs to perform most common Essbase administrative actions. The CLI includes an LCMImport command you can use for migrating 11g LCM Export Utility .zip files exported from Essbase 11g On-Premise. The LCMExport and LCMImport commands also facilitate migrating applications between instances, on versions 12c or higher.",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Command Line Tools",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/cli",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "migrationTool",
    "name" : "Migration Utility",
    "description" : "Utility to manage migration of an entire Essbase instance, for Essbase 12c or higher. In addition to migrating application artifacts, this utility also helps you migrate user role assignments and users/groups from supported identity providers.",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Command Line Tools",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/migrationTool",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "EssbaseMaxlClient",
    "name" : "Essbase Maxl Client",
    "description" : "Essbase Maxl Client for Winamd64",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Maxl Clients",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseMaxlClient",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "EssbaseLinuxMaxlClient",
    "name" : "Essbase Linux Maxl Client",
    "description" : "Essbase Maxl Client for Linuxamd64",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Maxl Clients",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseLinuxMaxlClient",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "EssbaseClientLinux",
    "name" : "Essbase Client Linux",
    "description" : "Essbase Client Linux",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Essbase Clients",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientLinux",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "EssbaseClientWindows",
    "name" : "Essbase Client Windows",
    "description" : "Essbase Client Windows",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Essbase Clients",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientWindows",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "EssbaseClientMacosx",
    "name" : "Essbase Client Macosx",
    "description" : "Essbase Client Macosx",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Essbase Clients",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EssbaseClientMacosx",
      "method" : "get",
      "type" : "application/zip"
    } ]
  }, {
    "id" : "japi",
    "name" : "Essbase Java API",
    "description" : "Essbase Java API library, samples and Java documentation",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Essbase JAPI"
  }, {
    "id" : "esscdext",
    "name" : "Cube Designer Extension",
    "description" : "Cube Designer Extension for Essbase Smart View",
    "provider" : "Oracle",
    "mimeType" : "application/vnd.microsoft.portable-executable",
    "category" : "Smart View",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/esscdext",
      "method" : "get",
      "type" : "application/vnd.microsoft.portable-executable"
    } ]
  }, {
    "id" : "EASConsole",
    "name" : "Essbase Administration Services console",
    "description" : "Essbase Administration Services console",
    "provider" : "Oracle",
    "mimeType" : "application/zip",
    "category" : "Essbase Administration",
    "links" : [ {
      "rel" : "download",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/utilities/EASConsole",
      "method" : "get",
      "type" : "application/zip"
    } ]
  } ]
}

先頭に戻る