移動先

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

複数のドリル・スルー・レポートの取得

get

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

指定されたアプリケーションおよびデータベースからすべてのドリル・スルー・レポートを返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• keyword: string

  キーワードを使用してドリルスルー・レポートのリストをフィルタします。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ドリル・スルー・レポートを正常に取得しました。レポートを取得、編集または削除するためのリンクを返します。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object ReportList

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

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

型: 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/ReportBean"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object ReportBean

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

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

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

ネストされたスキーマ : 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 レスポンス

不正なリクエスト

ドリル・スルー・レポートの取得に失敗しました。アプリケーション名またはデータベース名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseキューブ内のすべてのドリル・スルー・レポートのリストを取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports" -H Accept:application/json -H Content-Type:application/octet-stream -u %User%:%Password%

レスポンス本体の例

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

{
  "items" : [ {
    "name" : "sampleDtr",
    "modifiedTime" : 1660068656087,
    "sizeInBytes" : 565,
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "PUT"
    } ]
  }, {
    "name" : "drill2",
    "modifiedTime" : 1660076664087,
    "sizeInBytes" : 912,
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "PUT"
    } ]
  } ],
  "totalResults" : 2,
  "count" : 2
}

先頭に戻る