Skip to main content

POST /Info/Listings/:cube

Returns information about the detail listings available for the given cube.

URL Parameters

cube Required. Logical name of the cube. This name can include slashes; see Use of Slashes in Cube and KPI Names.

Request Body Details

This service uses the following property of the request body:

TYPE Optional. This property can be map or table. If this property is map, the server sends information only about map listings. If this property is table, the server sends information only about non-map listings. If this property is not specified, the server sends information about all kinds of listings.

Example Request

  • Request Method:

    POST

  • Request URL:

    http://localhost:52773/api/deepsee/v1/Info/Listings/:holefoods

    For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

  • Request Body:

    {"TYPE":"map"}

Example Response

For another example:

{
            "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},
                ...]
            }
        }

In the response object, the Result property contains a property called Listings, which contains an array of objects, one for each detail listing.

For information that applies to all response objects, see Notes on the Response Objects.

FeedbackOpens in a new tab