Skip to main content

/Info/Listings/:cube

指定されたキューブで使用できる詳細リストに関する情報を返します。

要求のメソッド

GET または POST

URL パラメータ

cube

必須項目。キューブの論理名。この名前にはスラッシュを使用できます。"キューブ名と KPI 名でのスラッシュの使用" を参照してください。

要求の本文の詳細

このエンドポイントでは、要求の本文の以下のプロパティが使用されます。

TYPE

オプション。このプロパティには、map または table を指定できます。このプロパティが map の場合は、サーバはマップ・リストに関する情報のみを送信します。このプロパティが table の場合は、サーバは非マップ・リストに関する情報のみを送信します。このプロパティを指定しない場合は、サーバはすべての種類のリストに関する情報を送信します。

要求の例

  • 要求のメソッド :

    POST

  • 要求の URL :

    https://localhost/api/deepsee/v3/Info/Listings/:holefoods

    URL の有効な形式に関する説明は、"Business Intelligence REST API の概要" を参照してください。

  • 要求の本文 :

    {"TYPE":"map"}
    

応答の例

別の例を示します。

{
    "Info": {
        "Error":"",
        "DataSource":"holefoods",
        "Type":"all"
    },
    "Result": {
        "Listings": [
            {"name":"Custom Listing"},
            {"name":"Another Sample Listing by Date",
            "fields":"%ID As \"ID #\",DateOfSale As \"Sale Date\"",
            "order":"DateOfSale,%ID",
            "type":"table",
            "source":"listingGroup",
            "edit":1},
            {"name":"Another Sample Listing with Customer Info",
            "fields":"%ID,Outlet->City \"Store Location\",Outlet->Country->Name Country,Product->Name Product,ZipCode \"Customer ZipCode\",Latitude,Longitude","order":"",
            "type":"map",
            "source":"listingGroup",
            "edit":1},
            {"name":"Customer Info",
            "fields":"%ID,Outlet->City \"Store Location\",Outlet->Country->Name Country,Product->Name Product,ZipCode \"Customer ZipCode\",Latitude,Longitude","order":"",
            "type":"map",
            "source":"cube",
            "edit":0},
        ...]
    }
}

この応答オブジェクト内では、Result プロパティに Listings プロパティが含まれています。このプロパティにはオブジェクトの配列が含まれていて、詳細リストごとに 1 つのオブジェクトがあります。

すべての応答オブジェクトに適用される情報は、"応答オブジェクトに関する注意事項" を参照してください。

FeedbackOpens in a new tab